<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ClutterText: Clutter Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="Clutter Reference Manual">
<link rel="up" href="ch02.html" title="Base actors">
<link rel="prev" href="ClutterClone.html" title="ClutterClone">
<link rel="next" href="ClutterScrollActor.html" title="ClutterScrollActor">
<meta name="generator" content="GTK-Doc V1.25.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#ClutterText.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#ClutterText.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#ClutterText.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#ClutterText.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#ClutterText.signals" class="shortcut">Signals</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ClutterClone.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ClutterScrollActor.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="ClutterText"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ClutterText.top_of_page"></a>ClutterText</span></h2>
<p>ClutterText — An actor for displaying and editing text</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="ClutterText.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-new" title="clutter_text_new ()">clutter_text_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-new-full" title="clutter_text_new_full ()">clutter_text_new_full</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-new-with-text" title="clutter_text_new_with_text ()">clutter_text_new_with_text</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-new-with-buffer" title="clutter_text_new_with_buffer ()">clutter_text_new_with_buffer</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-set-buffer" title="clutter_text_set_buffer ()">clutter_text_set_buffer</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="returnvalue">ClutterTextBuffer</span></a> *
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-get-buffer" title="clutter_text_get_buffer ()">clutter_text_get_buffer</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-set-text" title="clutter_text_set_text ()">clutter_text_set_text</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-set-markup" title="clutter_text_set_markup ()">clutter_text_set_markup</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-get-text" title="clutter_text_get_text ()">clutter_text_get_text</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-set-activatable" title="clutter_text_set_activatable ()">clutter_text_set_activatable</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-get-activatable" title="clutter_text_get_activatable ()">clutter_text_get_activatable</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-set-attributes" title="clutter_text_set_attributes ()">clutter_text_set_attributes</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">PangoAttrList</span> *
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-get-attributes" title="clutter_text_get_attributes ()">clutter_text_get_attributes</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-set-color" title="clutter_text_set_color ()">clutter_text_set_color</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-get-color" title="clutter_text_get_color ()">clutter_text_get_color</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-set-ellipsize" title="clutter_text_set_ellipsize ()">clutter_text_set_ellipsize</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">PangoEllipsizeMode</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-get-ellipsize" title="clutter_text_get_ellipsize ()">clutter_text_get_ellipsize</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-set-font-name" title="clutter_text_set_font_name ()">clutter_text_set_font_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-get-font-name" title="clutter_text_get_font_name ()">clutter_text_get_font_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-set-font-description" title="clutter_text_set_font_description ()">clutter_text_set_font_description</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">PangoFontDescription</span> *
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-get-font-description" title="clutter_text_get_font_description ()">clutter_text_get_font_description</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-set-password-char" title="clutter_text_set_password_char ()">clutter_text_set_password_char</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gunichar</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-get-password-char" title="clutter_text_get_password_char ()">clutter_text_get_password_char</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-set-justify" title="clutter_text_set_justify ()">clutter_text_set_justify</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-get-justify" title="clutter_text_get_justify ()">clutter_text_get_justify</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">PangoLayout</span> *
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-get-layout" title="clutter_text_get_layout ()">clutter_text_get_layout</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-set-line-alignment" title="clutter_text_set_line_alignment ()">clutter_text_set_line_alignment</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">PangoAlignment</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-get-line-alignment" title="clutter_text_get_line_alignment ()">clutter_text_get_line_alignment</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-set-line-wrap" title="clutter_text_set_line_wrap ()">clutter_text_set_line_wrap</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-get-line-wrap" title="clutter_text_get_line_wrap ()">clutter_text_get_line_wrap</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-set-line-wrap-mode" title="clutter_text_set_line_wrap_mode ()">clutter_text_set_line_wrap_mode</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">PangoWrapMode</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-get-line-wrap-mode" title="clutter_text_get_line_wrap_mode ()">clutter_text_get_line_wrap_mode</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-set-max-length" title="clutter_text_set_max_length ()">clutter_text_set_max_length</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gint</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-get-max-length" title="clutter_text_get_max_length ()">clutter_text_get_max_length</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-set-selectable" title="clutter_text_set_selectable ()">clutter_text_set_selectable</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-get-selectable" title="clutter_text_get_selectable ()">clutter_text_get_selectable</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-set-selection" title="clutter_text_set_selection ()">clutter_text_set_selection</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-get-selection" title="clutter_text_get_selection ()">clutter_text_get_selection</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-set-selection-bound" title="clutter_text_set_selection_bound ()">clutter_text_set_selection_bound</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gint</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-get-selection-bound" title="clutter_text_get_selection_bound ()">clutter_text_get_selection_bound</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-set-single-line-mode" title="clutter_text_set_single_line_mode ()">clutter_text_set_single_line_mode</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-get-single-line-mode" title="clutter_text_get_single_line_mode ()">clutter_text_get_single_line_mode</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-set-use-markup" title="clutter_text_set_use_markup ()">clutter_text_set_use_markup</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-get-use-markup" title="clutter_text_get_use_markup ()">clutter_text_get_use_markup</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-set-editable" title="clutter_text_set_editable ()">clutter_text_set_editable</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-get-editable" title="clutter_text_get_editable ()">clutter_text_get_editable</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-insert-text" title="clutter_text_insert_text ()">clutter_text_insert_text</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-insert-unichar" title="clutter_text_insert_unichar ()">clutter_text_insert_unichar</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-delete-chars" title="clutter_text_delete_chars ()">clutter_text_delete_chars</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-delete-text" title="clutter_text_delete_text ()">clutter_text_delete_text</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-delete-selection" title="clutter_text_delete_selection ()">clutter_text_delete_selection</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-get-chars" title="clutter_text_get_chars ()">clutter_text_get_chars</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-set-cursor-color" title="clutter_text_set_cursor_color ()">clutter_text_set_cursor_color</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-get-cursor-color" title="clutter_text_get_cursor_color ()">clutter_text_get_cursor_color</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-set-selection-color" title="clutter_text_set_selection_color ()">clutter_text_set_selection_color</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-get-selection-color" title="clutter_text_get_selection_color ()">clutter_text_get_selection_color</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-set-selected-text-color" title="clutter_text_set_selected_text_color ()">clutter_text_set_selected_text_color</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-get-selected-text-color" title="clutter_text_get_selected_text_color ()">clutter_text_get_selected_text_color</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-set-cursor-position" title="clutter_text_set_cursor_position ()">clutter_text_set_cursor_position</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gint</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-get-cursor-position" title="clutter_text_get_cursor_position ()">clutter_text_get_cursor_position</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-set-cursor-visible" title="clutter_text_set_cursor_visible ()">clutter_text_set_cursor_visible</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-get-cursor-visible" title="clutter_text_get_cursor_visible ()">clutter_text_get_cursor_visible</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-set-cursor-size" title="clutter_text_set_cursor_size ()">clutter_text_set_cursor_size</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-get-cursor-size" title="clutter_text_get_cursor_size ()">clutter_text_get_cursor_size</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-get-cursor-rect" title="clutter_text_get_cursor_rect ()">clutter_text_get_cursor_rect</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-activate" title="clutter_text_activate ()">clutter_text_activate</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gint</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-coords-to-position" title="clutter_text_coords_to_position ()">clutter_text_coords_to_position</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-position-to-coords" title="clutter_text_position_to_coords ()">clutter_text_position_to_coords</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-set-preedit-string" title="clutter_text_set_preedit_string ()">clutter_text_set_preedit_string</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="ClutterText.html#clutter-text-get-layout-offsets" title="clutter_text_get_layout_offsets ()">clutter_text_get_layout_offsets</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterText.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--activatable" title="The “activatable” property">activatable</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<span class="type">PangoAttrList</span> *</td>
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--attributes" title="The “attributes” property">attributes</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a> *</td>
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--buffer" title="The “buffer” property">buffer</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="clutter-Colors.html#ClutterColor"><span class="type">ClutterColor</span></a> *</td>
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--color" title="The “color” property">color</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="clutter-Colors.html#ClutterColor"><span class="type">ClutterColor</span></a> *</td>
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--cursor-color" title="The “cursor-color” property">cursor-color</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--cursor-color-set" title="The “cursor-color-set” property">cursor-color-set</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type"><span class="type">gint</span></td>
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--cursor-position" title="The “cursor-position” property">cursor-position</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gint</span></td>
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--cursor-size" title="The “cursor-size” property">cursor-size</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--cursor-visible" title="The “cursor-visible” property">cursor-visible</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--editable" title="The “editable” property">editable</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">PangoEllipsizeMode</span></td>
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--ellipsize" title="The “ellipsize” property">ellipsize</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<span class="type">PangoFontDescription</span> *</td>
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--font-description" title="The “font-description” property">font-description</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--font-name" title="The “font-name” property">font-name</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--justify" title="The “justify” property">justify</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">PangoAlignment</span></td>
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--line-alignment" title="The “line-alignment” property">line-alignment</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--line-wrap" title="The “line-wrap” property">line-wrap</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">PangoWrapMode</span></td>
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--line-wrap-mode" title="The “line-wrap-mode” property">line-wrap-mode</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gint</span></td>
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--max-length" title="The “max-length” property">max-length</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">guint</span></td>
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--password-char" title="The “password-char” property">password-char</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gint</span></td>
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--position" title="The “position” property">position</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--selectable" title="The “selectable” property">selectable</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="clutter-Colors.html#ClutterColor"><span class="type">ClutterColor</span></a> *</td>
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--selected-text-color" title="The “selected-text-color” property">selected-text-color</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--selected-text-color-set" title="The “selected-text-color-set” property">selected-text-color-set</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type"><span class="type">gint</span></td>
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--selection-bound" title="The “selection-bound” property">selection-bound</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a class="link" href="clutter-Colors.html#ClutterColor"><span class="type">ClutterColor</span></a> *</td>
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--selection-color" title="The “selection-color” property">selection-color</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--selection-color-set" title="The “selection-color-set” property">selection-color-set</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--single-line-mode" title="The “single-line-mode” property">single-line-mode</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<span class="type">gchar</span> *</td>
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--text" title="The “text” property">text</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type"><span class="type">gboolean</span></td>
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--use-markup" title="The “use-markup” property">use-markup</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterText.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signals_return">
<col width="300px" class="signals_name">
<col width="200px" class="signals_flags">
</colgroup>
<tbody>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="ClutterText.html#ClutterText-activate" title="The “activate” signal">activate</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="ClutterText.html#ClutterText-cursor-changed" title="The “cursor-changed” signal">cursor-changed</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="ClutterText.html#ClutterText-cursor-event" title="The “cursor-event” signal">cursor-event</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="ClutterText.html#ClutterText-delete-text" title="The “delete-text” signal">delete-text</a></td>
<td class="signal_flags">Action</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="ClutterText.html#ClutterText-insert-text" title="The “insert-text” signal">insert-text</a></td>
<td class="signal_flags">Action</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="ClutterText.html#ClutterText-text-changed" title="The “text-changed” signal">text-changed</a></td>
<td class="signal_flags">Run Last</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterText.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="ClutterText.html#ClutterText-struct" title="struct ClutterText">ClutterText</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="ClutterText.html#ClutterTextClass" title="struct ClutterTextClass">ClutterTextClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="ClutterText.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> GInitiallyUnowned
<span class="lineart">╰──</span> <a class="link" href="ClutterActor.html" title="ClutterActor">ClutterActor</a>
<span class="lineart">╰──</span> ClutterText
</pre>
</div>
<div class="refsect1">
<a name="ClutterText.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
ClutterText implements
<a class="link" href="ClutterContainer.html" title="ClutterContainer">ClutterContainer</a>, <a class="link" href="ClutterScriptable.html" title="ClutterScriptable">ClutterScriptable</a>, <a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable">ClutterAnimatable</a> and AtkImplementorIface.</p>
</div>
<div class="refsect1">
<a name="ClutterText.description"></a><h2>Description</h2>
<p><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> is an actor that displays custom text using Pango
as the text rendering engine.</p>
<p><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> also allows inline editing of the text if the
actor is set editable using <a class="link" href="ClutterText.html#clutter-text-set-editable" title="clutter_text_set_editable ()"><code class="function">clutter_text_set_editable()</code></a>.</p>
<p>Selection using keyboard or pointers can be enabled using
<a class="link" href="ClutterText.html#clutter-text-set-selectable" title="clutter_text_set_selectable ()"><code class="function">clutter_text_set_selectable()</code></a>.</p>
<p><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> is available since Clutter 1.0</p>
</div>
<div class="refsect1">
<a name="ClutterText.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="clutter-text-new"></a><h3>clutter_text_new ()</h3>
<pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
clutter_text_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor. This actor can be used to
display and edit text.</p>
<div class="refsect3">
<a name="clutter-text-new.returns"></a><h4>Returns</h4>
<p> the newly created <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor</p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-new-full"></a><h3>clutter_text_new_full ()</h3>
<pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
clutter_text_new_full (<em class="parameter"><code>const <span class="type">gchar</span> *font_name</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>,
<em class="parameter"><code>const <a class="link" href="clutter-Colors.html#ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);</pre>
<p>Creates a new <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor, using <em class="parameter"><code>font_name</code></em>
as the font
description; <em class="parameter"><code>text</code></em>
will be used to set the contents of the actor;
and <em class="parameter"><code>color</code></em>
will be used as the color to render <em class="parameter"><code>text</code></em>
.</p>
<p>This function is equivalent to calling <a class="link" href="ClutterText.html#clutter-text-new" title="clutter_text_new ()"><code class="function">clutter_text_new()</code></a>,
<a class="link" href="ClutterText.html#clutter-text-set-font-name" title="clutter_text_set_font_name ()"><code class="function">clutter_text_set_font_name()</code></a>, <a class="link" href="ClutterText.html#clutter-text-set-text" title="clutter_text_set_text ()"><code class="function">clutter_text_set_text()</code></a> and
<a class="link" href="ClutterText.html#clutter-text-set-color" title="clutter_text_set_color ()"><code class="function">clutter_text_set_color()</code></a>.</p>
<div class="refsect3">
<a name="clutter-text-new-full.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>font_name</p></td>
<td class="parameter_description"><p>a string with a font description</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>text</p></td>
<td class="parameter_description"><p>the contents of the actor</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>color</p></td>
<td class="parameter_description"><p>the color to be used to render <em class="parameter"><code>text</code></em>
</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-text-new-full.returns"></a><h4>Returns</h4>
<p> the newly created <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor</p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-new-with-text"></a><h3>clutter_text_new_with_text ()</h3>
<pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
clutter_text_new_with_text (<em class="parameter"><code>const <span class="type">gchar</span> *font_name</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>);</pre>
<p>Creates a new <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor, using <em class="parameter"><code>font_name</code></em>
as the font
description; <em class="parameter"><code>text</code></em>
will be used to set the contents of the actor.</p>
<p>This function is equivalent to calling <a class="link" href="ClutterText.html#clutter-text-new" title="clutter_text_new ()"><code class="function">clutter_text_new()</code></a>,
<a class="link" href="ClutterText.html#clutter-text-set-font-name" title="clutter_text_set_font_name ()"><code class="function">clutter_text_set_font_name()</code></a>, and <a class="link" href="ClutterText.html#clutter-text-set-text" title="clutter_text_set_text ()"><code class="function">clutter_text_set_text()</code></a>.</p>
<div class="refsect3">
<a name="clutter-text-new-with-text.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>font_name</p></td>
<td class="parameter_description"><p> a string with a font description. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>text</p></td>
<td class="parameter_description"><p>the contents of the actor</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-text-new-with-text.returns"></a><h4>Returns</h4>
<p> the newly created <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor</p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-new-with-buffer"></a><h3>clutter_text_new_with_buffer ()</h3>
<pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
clutter_text_new_with_buffer (<em class="parameter"><code><a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a> *buffer</code></em>);</pre>
<p>Creates a new entry with the specified text buffer.</p>
<div class="refsect3">
<a name="clutter-text-new-with-buffer.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>buffer</p></td>
<td class="parameter_description"><p>The buffer to use for the new <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-text-new-with-buffer.returns"></a><h4>Returns</h4>
<p> a new <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p>
</div>
<p class="since">Since: <a class="link" href="ix12.html#api-index-1.10">1.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-set-buffer"></a><h3>clutter_text_set_buffer ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_text_set_buffer (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
<em class="parameter"><code><a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a> *buffer</code></em>);</pre>
<p>Set the <a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a> object which holds the text for
this widget.</p>
<div class="refsect3">
<a name="clutter-text-set-buffer.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>buffer</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix12.html#api-index-1.10">1.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-get-buffer"></a><h3>clutter_text_get_buffer ()</h3>
<pre class="programlisting"><a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="returnvalue">ClutterTextBuffer</span></a> *
clutter_text_get_buffer (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
<p>Get the <a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a> object which holds the text for
this widget.</p>
<div class="refsect3">
<a name="clutter-text-get-buffer.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-text-get-buffer.returns"></a><h4>Returns</h4>
<p> A <span class="type">GtkEntryBuffer</span> object. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="ix12.html#api-index-1.10">1.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-set-text"></a><h3>clutter_text_set_text ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_text_set_text (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>);</pre>
<p>Sets the contents of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.</p>
<p>If the <a class="link" href="ClutterText.html#ClutterText--use-markup" title="The “use-markup” property"><span class="type">“use-markup”</span></a> property was set to <code class="literal">TRUE</code> it
will be reset to <code class="literal">FALSE</code> as a side effect. If you want to
maintain the <a class="link" href="ClutterText.html#ClutterText--use-markup" title="The “use-markup” property"><span class="type">“use-markup”</span></a> you should use the
<a class="link" href="ClutterText.html#clutter-text-set-markup" title="clutter_text_set_markup ()"><code class="function">clutter_text_set_markup()</code></a> function instead</p>
<div class="refsect3">
<a name="clutter-text-set-text.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>text</p></td>
<td class="parameter_description"><p> the text to set. Passing <code class="literal">NULL</code> is the same
as passing "" (the empty string). </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-set-markup"></a><h3>clutter_text_set_markup ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_text_set_markup (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *markup</code></em>);</pre>
<p>Sets <em class="parameter"><code>markup</code></em>
as the contents of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>.</p>
<p>This is a convenience function for setting a string containing
Pango markup, and it is logically equivalent to:</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="comment">/* the order is important */</span>
<span class="function"><a href="ClutterText.html#clutter-text-set-text">clutter_text_set_text</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">CLUTTER_TEXT</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">actor</span><span class="symbol">),</span><span class="normal"> markup</span><span class="symbol">);</span>
<span class="function"><a href="ClutterText.html#clutter-text-set-use-markup">clutter_text_set_use_markup</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">CLUTTER_TEXT</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">actor</span><span class="symbol">),</span><span class="normal"> TRUE</span><span class="symbol">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p></p>
<div class="refsect3">
<a name="clutter-text-set-markup.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>markup</p></td>
<td class="parameter_description"><p> a string containing Pango markup.
Passing <code class="literal">NULL</code> is the same as passing "" (the empty string). </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-get-text"></a><h3>clutter_text_get_text ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
clutter_text_get_text (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
<p>Retrieves a pointer to the current contents of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
actor.</p>
<p>If you need a copy of the contents for manipulating, either
use <code class="function">g_strdup()</code> on the returned string, or use:</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="normal">copy </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="ClutterText.html#clutter-text-get-chars">clutter_text_get_chars</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">text</span><span class="symbol">,</span><span class="normal"> </span><span class="number">0</span><span class="symbol">,</span><span class="normal"> </span><span class="symbol">-</span><span class="number">1</span><span class="symbol">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p></p>
<p>Which will return a newly allocated string.</p>
<p>If the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor is empty, this function will return
an empty string, and not <code class="literal">NULL</code>.</p>
<div class="refsect3">
<a name="clutter-text-get-text.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-text-get-text.returns"></a><h4>Returns</h4>
<p> the contents of the actor. The returned
string is owned by the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor and should never be modified
or freed. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-set-activatable"></a><h3>clutter_text_set_activatable ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_text_set_activatable (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> activatable</code></em>);</pre>
<p>Sets whether a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should be activatable.</p>
<p>An activatable <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor will emit the <a class="link" href="ClutterText.html#ClutterText-activate" title="The “activate” signal"><span class="type">“activate”</span></a>
signal whenever the 'Enter' (or 'Return') key is pressed; if it is not
activatable, a new line will be appended to the current content.</p>
<p>An activatable <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> must also be set as editable using
<a class="link" href="ClutterText.html#clutter-text-set-editable" title="clutter_text_set_editable ()"><code class="function">clutter_text_set_editable()</code></a>.</p>
<div class="refsect3">
<a name="clutter-text-set-activatable.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>activatable</p></td>
<td class="parameter_description"><p>whether the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should be activatable</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-get-activatable"></a><h3>clutter_text_get_activatable ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
clutter_text_get_activatable (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
<p>Retrieves whether a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> is activatable or not.</p>
<div class="refsect3">
<a name="clutter-text-get-activatable.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-text-get-activatable.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the actor is activatable</p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-set-attributes"></a><h3>clutter_text_set_attributes ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_text_set_attributes (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">PangoAttrList</span> *attrs</code></em>);</pre>
<p>Sets the attributes list that are going to be applied to the
<a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> contents.</p>
<p>The <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor will take a reference on the <span class="type">PangoAttrList</span>
passed to this function.</p>
<div class="refsect3">
<a name="clutter-text-set-attributes.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>attrs</p></td>
<td class="parameter_description"><p> a <span class="type">PangoAttrList</span> or <code class="literal">NULL</code> to unset the attributes. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-get-attributes"></a><h3>clutter_text_get_attributes ()</h3>
<pre class="programlisting"><span class="returnvalue">PangoAttrList</span> *
clutter_text_get_attributes (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
<p>Gets the attribute list that was set on the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor
<a class="link" href="ClutterText.html#clutter-text-set-attributes" title="clutter_text_set_attributes ()"><code class="function">clutter_text_set_attributes()</code></a>, if any.</p>
<div class="refsect3">
<a name="clutter-text-get-attributes.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-text-get-attributes.returns"></a><h4>Returns</h4>
<p> the attribute list, or <code class="literal">NULL</code> if none was set. The
returned value is owned by the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> and should not be unreferenced. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-set-color"></a><h3>clutter_text_set_color ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_text_set_color (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
<em class="parameter"><code>const <a class="link" href="clutter-Colors.html#ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);</pre>
<p>Sets the color of the contents of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.</p>
<p>The overall opacity of the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor will be the
result of the alpha value of <em class="parameter"><code>color</code></em>
and the composited
opacity of the actor itself on the scenegraph, as returned
by <a class="link" href="ClutterActor.html#clutter-actor-get-paint-opacity" title="clutter_actor_get_paint_opacity ()"><code class="function">clutter_actor_get_paint_opacity()</code></a>.</p>
<div class="refsect3">
<a name="clutter-text-set-color.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>color</p></td>
<td class="parameter_description"><p>a <a class="link" href="clutter-Colors.html#ClutterColor"><span class="type">ClutterColor</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-get-color"></a><h3>clutter_text_get_color ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_text_get_color (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
<em class="parameter"><code><a class="link" href="clutter-Colors.html#ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);</pre>
<p>Retrieves the text color as set by <a class="link" href="ClutterText.html#clutter-text-set-color" title="clutter_text_set_color ()"><code class="function">clutter_text_set_color()</code></a>.</p>
<div class="refsect3">
<a name="clutter-text-get-color.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>color</p></td>
<td class="parameter_description"><p> return location for a <a class="link" href="clutter-Colors.html#ClutterColor"><span class="type">ClutterColor</span></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Out parameter, where caller must allocate storage."><span class="acronym">out caller-allocates</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-set-ellipsize"></a><h3>clutter_text_set_ellipsize ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_text_set_ellipsize (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">PangoEllipsizeMode</span> mode</code></em>);</pre>
<p>Sets the mode used to ellipsize (add an ellipsis: "...") to the
text if there is not enough space to render the entire contents
of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor</p>
<div class="refsect3">
<a name="clutter-text-set-ellipsize.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>mode</p></td>
<td class="parameter_description"><p>a <span class="type">PangoEllipsizeMode</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-get-ellipsize"></a><h3>clutter_text_get_ellipsize ()</h3>
<pre class="programlisting"><span class="returnvalue">PangoEllipsizeMode</span>
clutter_text_get_ellipsize (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
<p>Returns the ellipsizing position of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor, as
set by <a class="link" href="ClutterText.html#clutter-text-set-ellipsize" title="clutter_text_set_ellipsize ()"><code class="function">clutter_text_set_ellipsize()</code></a>.</p>
<div class="refsect3">
<a name="clutter-text-get-ellipsize.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-text-get-ellipsize.returns"></a><h4>Returns</h4>
<p> <span class="type">PangoEllipsizeMode</span></p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-set-font-name"></a><h3>clutter_text_set_font_name ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_text_set_font_name (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *font_name</code></em>);</pre>
<p>Sets the font used by a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>. The <em class="parameter"><code>font_name</code></em>
string
must either be <code class="literal">NULL</code>, which means that the font name from the
default <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> will be used; or be something that can
be parsed by the <code class="function">pango_font_description_from_string()</code> function,
like:</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7
8</pre></td>
<td class="listing_code"><pre class="programlisting"><span class="comment">// Set the font to the system's Sans, 10 points</span>
<span class="function"><a href="ClutterText.html#clutter-text-set-font-name">clutter_text_set_font_name</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">text</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"Sans 10"</span><span class="symbol">);</span>
<span class="comment">// Set the font to the system's Serif, 16 pixels</span>
<span class="function"><a href="ClutterText.html#clutter-text-set-font-name">clutter_text_set_font_name</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">text</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"Serif 16px"</span><span class="symbol">);</span>
<span class="comment">// Set the font to Helvetica, 10 points</span>
<span class="function"><a href="ClutterText.html#clutter-text-set-font-name">clutter_text_set_font_name</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">text</span><span class="symbol">,</span><span class="normal"> </span><span class="string">"Helvetica 10"</span><span class="symbol">);</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p></p>
<div class="refsect3">
<a name="clutter-text-set-font-name.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>font_name</p></td>
<td class="parameter_description"><p> a font name, or <code class="literal">NULL</code> to set the default font name. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-get-font-name"></a><h3>clutter_text_get_font_name ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
clutter_text_get_font_name (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
<p>Retrieves the font name as set by <a class="link" href="ClutterText.html#clutter-text-set-font-name" title="clutter_text_set_font_name ()"><code class="function">clutter_text_set_font_name()</code></a>.</p>
<div class="refsect3">
<a name="clutter-text-get-font-name.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-text-get-font-name.returns"></a><h4>Returns</h4>
<p> a string containing the font name. The returned
string is owned by the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor and should not be
modified or freed</p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-set-font-description"></a><h3>clutter_text_set_font_description ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_text_set_font_description (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">PangoFontDescription</span> *font_desc</code></em>);</pre>
<p>Sets <em class="parameter"><code>font_desc</code></em>
as the font description for a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p>
<p>The <span class="type">PangoFontDescription</span> is copied by the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor
so you can safely call <code class="function">pango_font_description_free()</code> on it after
calling this function.</p>
<div class="refsect3">
<a name="clutter-text-set-font-description.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>font_desc</p></td>
<td class="parameter_description"><p>a <span class="type">PangoFontDescription</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix08.html#api-index-1.2">1.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-get-font-description"></a><h3>clutter_text_get_font_description ()</h3>
<pre class="programlisting"><span class="returnvalue">PangoFontDescription</span> *
clutter_text_get_font_description (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
<p>Retrieves the <span class="type">PangoFontDescription</span> used by <em class="parameter"><code>self</code></em>
</p>
<div class="refsect3">
<a name="clutter-text-get-font-description.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-text-get-font-description.returns"></a><h4>Returns</h4>
<p> a <span class="type">PangoFontDescription</span>. The returned value is owned
by the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor and it should not be modified or freed</p>
</div>
<p class="since">Since: <a class="link" href="ix08.html#api-index-1.2">1.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-set-password-char"></a><h3>clutter_text_set_password_char ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_text_set_password_char (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">gunichar</span> wc</code></em>);</pre>
<p>Sets the character to use in place of the actual text in a
password text actor.</p>
<p>If <em class="parameter"><code>wc</code></em>
is 0 the text will be displayed as it is entered in the
<a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.</p>
<div class="refsect3">
<a name="clutter-text-set-password-char.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>wc</p></td>
<td class="parameter_description"><p>a Unicode character, or 0 to unset the password character</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-get-password-char"></a><h3>clutter_text_get_password_char ()</h3>
<pre class="programlisting"><span class="returnvalue">gunichar</span>
clutter_text_get_password_char (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
<p>Retrieves the character to use in place of the actual text
as set by <a class="link" href="ClutterText.html#clutter-text-set-password-char" title="clutter_text_set_password_char ()"><code class="function">clutter_text_set_password_char()</code></a>.</p>
<div class="refsect3">
<a name="clutter-text-get-password-char.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-text-get-password-char.returns"></a><h4>Returns</h4>
<p> a Unicode character or 0 if the password
character is not set</p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-set-justify"></a><h3>clutter_text_set_justify ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_text_set_justify (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> justify</code></em>);</pre>
<p>Sets whether the text of the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should be justified
on both margins. This setting is ignored if Clutter is compiled
against Pango < 1.18.</p>
<div class="refsect3">
<a name="clutter-text-set-justify.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>justify</p></td>
<td class="parameter_description"><p>whether the text should be justified</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-get-justify"></a><h3>clutter_text_get_justify ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
clutter_text_get_justify (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
<p>Retrieves whether the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should justify its contents
on both margins.</p>
<div class="refsect3">
<a name="clutter-text-get-justify.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-text-get-justify.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the text should be justified</p>
</div>
<p class="since">Since: <a class="link" href="ix05.html#api-index-0.6">0.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-get-layout"></a><h3>clutter_text_get_layout ()</h3>
<pre class="programlisting"><span class="returnvalue">PangoLayout</span> *
clutter_text_get_layout (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
<p>Retrieves the current <span class="type">PangoLayout</span> used by a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.</p>
<div class="refsect3">
<a name="clutter-text-get-layout.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-text-get-layout.returns"></a><h4>Returns</h4>
<p> a <span class="type">PangoLayout</span>. The returned object is owned by
the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor and should not be modified or freed. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-set-line-alignment"></a><h3>clutter_text_set_line_alignment ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_text_set_line_alignment (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">PangoAlignment</span> alignment</code></em>);</pre>
<p>Sets the way that the lines of a wrapped label are aligned with
respect to each other. This does not affect the overall alignment
of the label within its allocated or specified width.</p>
<p>To align a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor you should add it to a container
that supports alignment, or use the anchor point.</p>
<div class="refsect3">
<a name="clutter-text-set-line-alignment.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>alignment</p></td>
<td class="parameter_description"><p>A <span class="type">PangoAlignment</span></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-get-line-alignment"></a><h3>clutter_text_get_line_alignment ()</h3>
<pre class="programlisting"><span class="returnvalue">PangoAlignment</span>
clutter_text_get_line_alignment (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
<p>Retrieves the alignment of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>, as set by
<a class="link" href="ClutterText.html#clutter-text-set-line-alignment" title="clutter_text_set_line_alignment ()"><code class="function">clutter_text_set_line_alignment()</code></a>.</p>
<div class="refsect3">
<a name="clutter-text-get-line-alignment.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-text-get-line-alignment.returns"></a><h4>Returns</h4>
<p> a <span class="type">PangoAlignment</span></p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-set-line-wrap"></a><h3>clutter_text_set_line_wrap ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_text_set_line_wrap (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> line_wrap</code></em>);</pre>
<p>Sets whether the contents of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should wrap,
if they don't fit the size assigned to the actor.</p>
<div class="refsect3">
<a name="clutter-text-set-line-wrap.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>line_wrap</p></td>
<td class="parameter_description"><p>whether the contents should wrap</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-get-line-wrap"></a><h3>clutter_text_get_line_wrap ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
clutter_text_get_line_wrap (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
<p>Retrieves the value set using <a class="link" href="ClutterText.html#clutter-text-set-line-wrap" title="clutter_text_set_line_wrap ()"><code class="function">clutter_text_set_line_wrap()</code></a>.</p>
<div class="refsect3">
<a name="clutter-text-get-line-wrap.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-text-get-line-wrap.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should wrap
its contents</p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-set-line-wrap-mode"></a><h3>clutter_text_set_line_wrap_mode ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_text_set_line_wrap_mode (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">PangoWrapMode</span> wrap_mode</code></em>);</pre>
<p>If line wrapping is enabled (see <a class="link" href="ClutterText.html#clutter-text-set-line-wrap" title="clutter_text_set_line_wrap ()"><code class="function">clutter_text_set_line_wrap()</code></a>) this
function controls how the line wrapping is performed. The default is
<code class="literal">PANGO_WRAP_WORD</code> which means wrap on word boundaries.</p>
<div class="refsect3">
<a name="clutter-text-set-line-wrap-mode.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>wrap_mode</p></td>
<td class="parameter_description"><p>the line wrapping mode</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-get-line-wrap-mode"></a><h3>clutter_text_get_line_wrap_mode ()</h3>
<pre class="programlisting"><span class="returnvalue">PangoWrapMode</span>
clutter_text_get_line_wrap_mode (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
<p>Retrieves the line wrap mode used by the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.</p>
<p>See <a class="link" href="ClutterText.html#clutter-text-set-line-wrap-mode" title="clutter_text_set_line_wrap_mode ()"><code class="function">clutter_text_set_line_wrap_mode()</code></a>.</p>
<div class="refsect3">
<a name="clutter-text-get-line-wrap-mode.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-text-get-line-wrap-mode.returns"></a><h4>Returns</h4>
<p> the wrap mode used by the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-set-max-length"></a><h3>clutter_text_set_max_length ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_text_set_max_length (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">gint</span> max</code></em>);</pre>
<p>Sets the maximum allowed length of the contents of the actor. If the
current contents are longer than the given length, then they will be
truncated to fit.</p>
<div class="refsect3">
<a name="clutter-text-set-max-length.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>max</p></td>
<td class="parameter_description"><p>the maximum number of characters allowed in the text actor; 0
to disable or -1 to set the length of the current string</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-get-max-length"></a><h3>clutter_text_get_max_length ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>
clutter_text_get_max_length (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
<p>Gets the maximum length of text that can be set into a text actor.</p>
<p>See <a class="link" href="ClutterText.html#clutter-text-set-max-length" title="clutter_text_set_max_length ()"><code class="function">clutter_text_set_max_length()</code></a>.</p>
<div class="refsect3">
<a name="clutter-text-get-max-length.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-text-get-max-length.returns"></a><h4>Returns</h4>
<p> the maximum number of characters.</p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-set-selectable"></a><h3>clutter_text_set_selectable ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_text_set_selectable (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> selectable</code></em>);</pre>
<p>Sets whether a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should be selectable.</p>
<p>A selectable <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> will allow selecting its contents using
the pointer or the keyboard.</p>
<div class="refsect3">
<a name="clutter-text-set-selectable.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>selectable</p></td>
<td class="parameter_description"><p>whether the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should be selectable</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-get-selectable"></a><h3>clutter_text_get_selectable ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
clutter_text_get_selectable (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
<p>Retrieves whether a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> is selectable or not.</p>
<div class="refsect3">
<a name="clutter-text-get-selectable.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-text-get-selectable.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the actor is selectable</p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-set-selection"></a><h3>clutter_text_set_selection ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_text_set_selection (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">gssize</span> start_pos</code></em>,
<em class="parameter"><code><span class="type">gssize</span> end_pos</code></em>);</pre>
<p>Selects the region of text between <em class="parameter"><code>start_pos</code></em>
and <em class="parameter"><code>end_pos</code></em>
.</p>
<p>This function changes the position of the cursor to match
<em class="parameter"><code>start_pos</code></em>
and the selection bound to match <em class="parameter"><code>end_pos</code></em>
.</p>
<div class="refsect3">
<a name="clutter-text-set-selection.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>start_pos</p></td>
<td class="parameter_description"><p>start of the selection, in characters</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>end_pos</p></td>
<td class="parameter_description"><p>end of the selection, in characters</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-get-selection"></a><h3>clutter_text_get_selection ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
clutter_text_get_selection (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
<p>Retrieves the currently selected text.</p>
<div class="refsect3">
<a name="clutter-text-get-selection.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-text-get-selection.returns"></a><h4>Returns</h4>
<p> a newly allocated string containing the currently
selected text, or <code class="literal">NULL</code>. Use <code class="function">g_free()</code> to free the returned
string.</p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-set-selection-bound"></a><h3>clutter_text_set_selection_bound ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_text_set_selection_bound (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">gint</span> selection_bound</code></em>);</pre>
<p>Sets the other end of the selection, starting from the current
cursor position.</p>
<p>If <em class="parameter"><code>selection_bound</code></em>
is -1, the selection unset.</p>
<div class="refsect3">
<a name="clutter-text-set-selection-bound.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>selection_bound</p></td>
<td class="parameter_description"><p>the position of the end of the selection, in characters</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-get-selection-bound"></a><h3>clutter_text_get_selection_bound ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>
clutter_text_get_selection_bound (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
<p>Retrieves the other end of the selection of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor,
in characters from the current cursor position.</p>
<div class="refsect3">
<a name="clutter-text-get-selection-bound.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-text-get-selection-bound.returns"></a><h4>Returns</h4>
<p> the position of the other end of the selection</p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-set-single-line-mode"></a><h3>clutter_text_set_single_line_mode ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_text_set_single_line_mode (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> single_line</code></em>);</pre>
<p>Sets whether a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should be in single line mode
or not. Only editable <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>s can be in single line
mode.</p>
<p>A text actor in single line mode will not wrap text and will clip
the visible area to the predefined size. The contents of the
text actor will scroll to display the end of the text if its length
is bigger than the allocated width.</p>
<p>When setting the single line mode the <a class="link" href="ClutterText.html#ClutterText--activatable" title="The “activatable” property"><span class="type">“activatable”</span></a>
property is also set as a side effect. Instead of entering a new
line character, the text actor will emit the <a class="link" href="ClutterText.html#ClutterText-activate" title="The “activate” signal"><span class="type">“activate”</span></a>
signal.</p>
<div class="refsect3">
<a name="clutter-text-set-single-line-mode.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>single_line</p></td>
<td class="parameter_description"><p>whether to enable single line mode</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-get-single-line-mode"></a><h3>clutter_text_get_single_line_mode ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
clutter_text_get_single_line_mode (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
<p>Retrieves whether the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor is in single line mode.</p>
<div class="refsect3">
<a name="clutter-text-get-single-line-mode.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-text-get-single-line-mode.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor is in single line mode</p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-set-use-markup"></a><h3>clutter_text_set_use_markup ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_text_set_use_markup (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> setting</code></em>);</pre>
<p>Sets whether the contents of the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor contains markup
in Pango's text markup language.</p>
<p>Setting <a class="link" href="ClutterText.html#ClutterText--use-markup" title="The “use-markup” property"><span class="type">“use-markup”</span></a> on an editable <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> will
not have any effect except hiding the markup.</p>
<p>See also <a class="link" href="ClutterText.html#ClutterText--use-markup" title="The “use-markup” property"><span class="type">“use-markup”</span></a>.</p>
<div class="refsect3">
<a name="clutter-text-set-use-markup.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>setting</p></td>
<td class="parameter_description"><p><code class="literal">TRUE</code> if the text should be parsed for markup.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-get-use-markup"></a><h3>clutter_text_get_use_markup ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
clutter_text_get_use_markup (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
<p>Retrieves whether the contents of the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should be
parsed for the Pango text markup.</p>
<div class="refsect3">
<a name="clutter-text-get-use-markup.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-text-get-use-markup.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the contents will be parsed for markup</p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-set-editable"></a><h3>clutter_text_set_editable ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_text_set_editable (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> editable</code></em>);</pre>
<p>Sets whether the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should be editable.</p>
<p>An editable <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> with key focus set using
<a class="link" href="ClutterActor.html#clutter-actor-grab-key-focus" title="clutter_actor_grab_key_focus ()"><code class="function">clutter_actor_grab_key_focus()</code></a> or <a class="link" href="ClutterStage.html#clutter-stage-set-key-focus" title="clutter_stage_set_key_focus ()"><code class="function">clutter_stage_set_key_focus()</code></a>
will receive key events and will update its contents accordingly.</p>
<div class="refsect3">
<a name="clutter-text-set-editable.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>editable</p></td>
<td class="parameter_description"><p>whether the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> should be editable</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-get-editable"></a><h3>clutter_text_get_editable ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
clutter_text_get_editable (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
<p>Retrieves whether a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> is editable or not.</p>
<div class="refsect3">
<a name="clutter-text-get-editable.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-text-get-editable.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the actor is editable</p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-insert-text"></a><h3>clutter_text_insert_text ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_text_insert_text (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>,
<em class="parameter"><code><span class="type">gssize</span> position</code></em>);</pre>
<p>Inserts <em class="parameter"><code>text</code></em>
into a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> at the given position.</p>
<p>If <em class="parameter"><code>position</code></em>
is a negative number, the text will be appended
at the end of the current contents of the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>.</p>
<p>The position is expressed in characters, not in bytes.</p>
<div class="refsect3">
<a name="clutter-text-insert-text.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>text</p></td>
<td class="parameter_description"><p>the text to be inserted</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>position</p></td>
<td class="parameter_description"><p>the position of the insertion, or -1</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-insert-unichar"></a><h3>clutter_text_insert_unichar ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_text_insert_unichar (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">gunichar</span> wc</code></em>);</pre>
<p>Inserts <em class="parameter"><code>wc</code></em>
at the current cursor position of a
<a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.</p>
<div class="refsect3">
<a name="clutter-text-insert-unichar.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>wc</p></td>
<td class="parameter_description"><p>a Unicode character</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-delete-chars"></a><h3>clutter_text_delete_chars ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_text_delete_chars (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">guint</span> n_chars</code></em>);</pre>
<p>Deletes <em class="parameter"><code>n_chars</code></em>
inside a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor, starting from the
current cursor position.</p>
<p>Somewhat awkwardly, the cursor position is decremented by the same
number of characters you've deleted.</p>
<div class="refsect3">
<a name="clutter-text-delete-chars.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>n_chars</p></td>
<td class="parameter_description"><p>the number of characters to delete</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-delete-text"></a><h3>clutter_text_delete_text ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_text_delete_text (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">gssize</span> start_pos</code></em>,
<em class="parameter"><code><span class="type">gssize</span> end_pos</code></em>);</pre>
<p>Deletes the text inside a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor between <em class="parameter"><code>start_pos</code></em>
and <em class="parameter"><code>end_pos</code></em>
.</p>
<p>The starting and ending positions are expressed in characters,
not in bytes.</p>
<div class="refsect3">
<a name="clutter-text-delete-text.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>start_pos</p></td>
<td class="parameter_description"><p>starting position</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>end_pos</p></td>
<td class="parameter_description"><p>ending position</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-delete-selection"></a><h3>clutter_text_delete_selection ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
clutter_text_delete_selection (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
<p>Deletes the currently selected text</p>
<p>This function is only useful in subclasses of <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p>
<div class="refsect3">
<a name="clutter-text-delete-selection.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-text-delete-selection.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if text was deleted or if the text actor
is empty, and <code class="literal">FALSE</code> otherwise</p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-get-chars"></a><h3>clutter_text_get_chars ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> *
clutter_text_get_chars (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">gssize</span> start_pos</code></em>,
<em class="parameter"><code><span class="type">gssize</span> end_pos</code></em>);</pre>
<p>Retrieves the contents of the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor between
<em class="parameter"><code>start_pos</code></em>
and <em class="parameter"><code>end_pos</code></em>
, but not including <em class="parameter"><code>end_pos</code></em>
.</p>
<p>The positions are specified in characters, not in bytes.</p>
<div class="refsect3">
<a name="clutter-text-get-chars.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>start_pos</p></td>
<td class="parameter_description"><p>start of text, in characters</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>end_pos</p></td>
<td class="parameter_description"><p>end of text, in characters</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-text-get-chars.returns"></a><h4>Returns</h4>
<p> a newly allocated string with the contents of
the text actor between the specified positions. Use <code class="function">g_free()</code>
to free the resources when done</p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-set-cursor-color"></a><h3>clutter_text_set_cursor_color ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_text_set_cursor_color (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
<em class="parameter"><code>const <a class="link" href="clutter-Colors.html#ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);</pre>
<p>Sets the color of the cursor of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.</p>
<p>If <em class="parameter"><code>color</code></em>
is <code class="literal">NULL</code>, the cursor color will be the same as the
text color.</p>
<div class="refsect3">
<a name="clutter-text-set-cursor-color.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>color</p></td>
<td class="parameter_description"><p> the color of the cursor, or <code class="literal">NULL</code> to unset it. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-get-cursor-color"></a><h3>clutter_text_get_cursor_color ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_text_get_cursor_color (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
<em class="parameter"><code><a class="link" href="clutter-Colors.html#ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);</pre>
<p>Retrieves the color of the cursor of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.</p>
<div class="refsect3">
<a name="clutter-text-get-cursor-color.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>color</p></td>
<td class="parameter_description"><p> return location for a <a class="link" href="clutter-Colors.html#ClutterColor"><span class="type">ClutterColor</span></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-set-selection-color"></a><h3>clutter_text_set_selection_color ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_text_set_selection_color (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
<em class="parameter"><code>const <a class="link" href="clutter-Colors.html#ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);</pre>
<p>Sets the color of the selection of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.</p>
<p>If <em class="parameter"><code>color</code></em>
is <code class="literal">NULL</code>, the selection color will be the same as the
cursor color, or if no cursor color is set either then it will be
the same as the text color.</p>
<div class="refsect3">
<a name="clutter-text-set-selection-color.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>color</p></td>
<td class="parameter_description"><p> the color of the selection, or <code class="literal">NULL</code> to unset it. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-get-selection-color"></a><h3>clutter_text_get_selection_color ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_text_get_selection_color (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
<em class="parameter"><code><a class="link" href="clutter-Colors.html#ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);</pre>
<p>Retrieves the color of the selection of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.</p>
<div class="refsect3">
<a name="clutter-text-get-selection-color.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>color</p></td>
<td class="parameter_description"><p> return location for a <a class="link" href="clutter-Colors.html#ClutterColor"><span class="type">ClutterColor</span></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Out parameter, where caller must allocate storage."><span class="acronym">out caller-allocates</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-set-selected-text-color"></a><h3>clutter_text_set_selected_text_color ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_text_set_selected_text_color (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
<em class="parameter"><code>const <a class="link" href="clutter-Colors.html#ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);</pre>
<p>Sets the selected text color of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.</p>
<p>If <em class="parameter"><code>color</code></em>
is <code class="literal">NULL</code>, the selected text color will be the same as the
selection color, which then falls back to cursor, and then text color.</p>
<div class="refsect3">
<a name="clutter-text-set-selected-text-color.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>color</p></td>
<td class="parameter_description"><p> the selected text color, or <code class="literal">NULL</code> to unset it. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix11.html#api-index-1.8">1.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-get-selected-text-color"></a><h3>clutter_text_get_selected_text_color ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_text_get_selected_text_color (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
<em class="parameter"><code><a class="link" href="clutter-Colors.html#ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);</pre>
<p>Retrieves the color of selected text of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.</p>
<div class="refsect3">
<a name="clutter-text-get-selected-text-color.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>color</p></td>
<td class="parameter_description"><p> return location for a <a class="link" href="clutter-Colors.html#ClutterColor"><span class="type">ClutterColor</span></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Out parameter, where caller must allocate storage."><span class="acronym">out caller-allocates</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix11.html#api-index-1.8">1.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-set-cursor-position"></a><h3>clutter_text_set_cursor_position ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_text_set_cursor_position (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">gint</span> position</code></em>);</pre>
<p>Sets the cursor of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor at <em class="parameter"><code>position</code></em>
.</p>
<p>The position is expressed in characters, not in bytes.</p>
<div class="refsect3">
<a name="clutter-text-set-cursor-position.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>position</p></td>
<td class="parameter_description"><p>the new cursor position, in characters</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-get-cursor-position"></a><h3>clutter_text_get_cursor_position ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>
clutter_text_get_cursor_position (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
<p>Retrieves the cursor position.</p>
<div class="refsect3">
<a name="clutter-text-get-cursor-position.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-text-get-cursor-position.returns"></a><h4>Returns</h4>
<p> the cursor position, in characters</p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-set-cursor-visible"></a><h3>clutter_text_set_cursor_visible ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_text_set_cursor_visible (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> cursor_visible</code></em>);</pre>
<p>Sets whether the cursor of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should be
visible or not.</p>
<p>The color of the cursor will be the same as the text color
unless <a class="link" href="ClutterText.html#clutter-text-set-cursor-color" title="clutter_text_set_cursor_color ()"><code class="function">clutter_text_set_cursor_color()</code></a> has been called.</p>
<p>The size of the cursor can be set using <a class="link" href="ClutterText.html#clutter-text-set-cursor-size" title="clutter_text_set_cursor_size ()"><code class="function">clutter_text_set_cursor_size()</code></a>.</p>
<p>The position of the cursor can be changed programmatically using
<a class="link" href="ClutterText.html#clutter-text-set-cursor-position" title="clutter_text_set_cursor_position ()"><code class="function">clutter_text_set_cursor_position()</code></a>.</p>
<div class="refsect3">
<a name="clutter-text-set-cursor-visible.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cursor_visible</p></td>
<td class="parameter_description"><p>whether the cursor should be visible</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-get-cursor-visible"></a><h3>clutter_text_get_cursor_visible ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
clutter_text_get_cursor_visible (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
<p>Retrieves whether the cursor of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor is visible.</p>
<div class="refsect3">
<a name="clutter-text-get-cursor-visible.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-text-get-cursor-visible.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the cursor is visible</p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-set-cursor-size"></a><h3>clutter_text_set_cursor_size ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_text_set_cursor_size (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">gint</span> size</code></em>);</pre>
<p>Sets the size of the cursor of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>. The cursor
will only be visible if the <a class="link" href="ClutterText.html#ClutterText--cursor-visible" title="The “cursor-visible” property"><span class="type">“cursor-visible”</span></a> property
is set to <code class="literal">TRUE</code>.</p>
<div class="refsect3">
<a name="clutter-text-set-cursor-size.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>size</p></td>
<td class="parameter_description"><p>the size of the cursor, in pixels, or -1 to use the
default value</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-get-cursor-size"></a><h3>clutter_text_get_cursor_size ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
clutter_text_get_cursor_size (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
<p>Retrieves the size of the cursor of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.</p>
<div class="refsect3">
<a name="clutter-text-get-cursor-size.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-text-get-cursor-size.returns"></a><h4>Returns</h4>
<p> the size of the cursor, in pixels</p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-get-cursor-rect"></a><h3>clutter_text_get_cursor_rect ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_text_get_cursor_rect (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
<em class="parameter"><code><a class="link" href="clutter-Base-geometric-types.html#ClutterRect"><span class="type">ClutterRect</span></a> *rect</code></em>);</pre>
<p>Retrieves the rectangle that contains the cursor.</p>
<p>The coordinates of the rectangle's origin are in actor-relative
coordinates.</p>
<div class="refsect3">
<a name="clutter-text-get-cursor-rect.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>rect</p></td>
<td class="parameter_description"><p> return location of a <a class="link" href="clutter-Base-geometric-types.html#ClutterRect"><span class="type">ClutterRect</span></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Out parameter, where caller must allocate storage."><span class="acronym">out caller-allocates</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix15.html#api-index-1.16">1.16</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-activate"></a><h3>clutter_text_activate ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
clutter_text_activate (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
<p>Emits the <a class="link" href="ClutterText.html#ClutterText-activate" title="The “activate” signal"><span class="type">“activate”</span></a> signal, if <em class="parameter"><code>self</code></em>
has been set
as activatable using <a class="link" href="ClutterText.html#clutter-text-set-activatable" title="clutter_text_set_activatable ()"><code class="function">clutter_text_set_activatable()</code></a>.</p>
<p>This function can be used to emit the ::activate signal inside
a <a class="link" href="ClutterActor.html#ClutterActor-captured-event" title="The “captured-event” signal"><span class="type">“captured-event”</span></a> or <a class="link" href="ClutterActor.html#ClutterActor-key-press-event" title="The “key-press-event” signal"><span class="type">“key-press-event”</span></a>
signal handlers before the default signal handler for the
<a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> is invoked.</p>
<div class="refsect3">
<a name="clutter-text-activate.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-text-activate.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the ::activate signal has been emitted,
and <code class="literal">FALSE</code> otherwise</p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-coords-to-position"></a><h3>clutter_text_coords_to_position ()</h3>
<pre class="programlisting"><span class="returnvalue">gint</span>
clutter_text_coords_to_position (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">gfloat</span> x</code></em>,
<em class="parameter"><code><span class="type">gfloat</span> y</code></em>);</pre>
<p>Retrieves the position of the character at the given coordinates.</p>
<p>Return: the position of the character</p>
<div class="refsect3">
<a name="clutter-text-coords-to-position.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>x</p></td>
<td class="parameter_description"><p>the X coordinate, relative to the actor</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>y</p></td>
<td class="parameter_description"><p>the Y coordinate, relative to the actor</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix12.html#api-index-1.10">1.10</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-position-to-coords"></a><h3>clutter_text_position_to_coords ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
clutter_text_position_to_coords (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">gint</span> position</code></em>,
<em class="parameter"><code><span class="type">gfloat</span> *x</code></em>,
<em class="parameter"><code><span class="type">gfloat</span> *y</code></em>,
<em class="parameter"><code><span class="type">gfloat</span> *line_height</code></em>);</pre>
<p>Retrieves the coordinates of the given <em class="parameter"><code>position</code></em>
.</p>
<div class="refsect3">
<a name="clutter-text-position-to-coords.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>position</p></td>
<td class="parameter_description"><p>position in characters</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>x</p></td>
<td class="parameter_description"><p> return location for the X coordinate, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>y</p></td>
<td class="parameter_description"><p> return location for the Y coordinate, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>line_height</p></td>
<td class="parameter_description"><p> return location for the line height, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="clutter-text-position-to-coords.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if the conversion was successful</p>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-set-preedit-string"></a><h3>clutter_text_set_preedit_string ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_text_set_preedit_string (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *preedit_str</code></em>,
<em class="parameter"><code><span class="type">PangoAttrList</span> *preedit_attrs</code></em>,
<em class="parameter"><code><span class="type">guint</span> cursor_pos</code></em>);</pre>
<p>Sets, or unsets, the pre-edit string. This function is useful
for input methods to display a string (with eventual specific
Pango attributes) before it is entered inside the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
buffer.</p>
<p>The preedit string and attributes are ignored if the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
actor is not editable.</p>
<p>This function should not be used by applications</p>
<div class="refsect3">
<a name="clutter-text-set-preedit-string.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>preedit_str</p></td>
<td class="parameter_description"><p> the pre-edit string, or <code class="literal">NULL</code> to unset it. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>preedit_attrs</p></td>
<td class="parameter_description"><p> the pre-edit string attributes. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>cursor_pos</p></td>
<td class="parameter_description"><p>the cursor position for the pre-edit string</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix08.html#api-index-1.2">1.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="clutter-text-get-layout-offsets"></a><h3>clutter_text_get_layout_offsets ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
clutter_text_get_layout_offsets (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">gint</span> *x</code></em>,
<em class="parameter"><code><span class="type">gint</span> *y</code></em>);</pre>
<p>Obtains the coordinates where the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> will draw the <span class="type">PangoLayout</span>
representing the text.</p>
<div class="refsect3">
<a name="clutter-text-get-layout-offsets.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>x</p></td>
<td class="parameter_description"><p> location to store X offset of layout, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>y</p></td>
<td class="parameter_description"><p> location to store Y offset of layout, or <code class="literal">NULL</code>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix11.html#api-index-1.8">1.8</a></p>
</div>
</div>
<div class="refsect1">
<a name="ClutterText.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="ClutterText-struct"></a><h3>struct ClutterText</h3>
<pre class="programlisting">struct ClutterText;</pre>
<p>The <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> struct contains only private data.</p>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterTextClass"></a><h3>struct ClutterTextClass</h3>
<pre class="programlisting">struct ClutterTextClass {
/* signals, not vfuncs */
void (* text_changed) (ClutterText *self);
void (* activate) (ClutterText *self);
void (* cursor_event) (ClutterText *self,
const ClutterGeometry *geometry);
void (* cursor_changed) (ClutterText *self);
};
</pre>
<p>The <a class="link" href="ClutterText.html#ClutterTextClass" title="struct ClutterTextClass"><span class="type">ClutterTextClass</span></a> struct contains only private data.</p>
<div class="refsect3">
<a name="ClutterTextClass.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterTextClass.text-changed"></a>text_changed</code></em> ()</p></td>
<td class="struct_member_description"><p>class handler for the <a class="link" href="ClutterText.html#ClutterText-text-changed" title="The “text-changed” signal"><span class="type">“text-changed”</span></a> signal</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterTextClass.activate"></a>activate</code></em> ()</p></td>
<td class="struct_member_description"><p>class handler for the <a class="link" href="ClutterText.html#ClutterText-activate" title="The “activate” signal"><span class="type">“activate”</span></a> signal</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterTextClass.cursor-event"></a>cursor_event</code></em> ()</p></td>
<td class="struct_member_description"><p>class handler for the <a class="link" href="ClutterText.html#ClutterText-cursor-event" title="The “cursor-event” signal"><span class="type">“cursor-event”</span></a> signal</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterTextClass.cursor-changed"></a>cursor_changed</code></em> ()</p></td>
<td class="struct_member_description"><p>class handler for the <a class="link" href="ClutterText.html#ClutterText-cursor-changed" title="The “cursor-changed” signal"><span class="type">“cursor-changed”</span></a> signal</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
</div>
<div class="refsect1">
<a name="ClutterText.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="ClutterText--activatable"></a><h3>The <code class="literal">“activatable”</code> property</h3>
<pre class="programlisting"> “activatable” <span class="type">gboolean</span></pre>
<p>Toggles whether return invokes the activate signal or not.</p>
<p>Flags: Read / Write</p>
<p>Default value: TRUE</p>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterText--attributes"></a><h3>The <code class="literal">“attributes”</code> property</h3>
<pre class="programlisting"> “attributes” <span class="type">PangoAttrList</span> *</pre>
<p>A list of <span class="type">PangoStyleAttribute</span>s to be applied to the
contents of the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.</p>
<p>Flags: Read / Write</p>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterText--buffer"></a><h3>The <code class="literal">“buffer”</code> property</h3>
<pre class="programlisting"> “buffer” <a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a> *</pre>
<p>The buffer which stores the text for this <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>.</p>
<p>If set to <code class="literal">NULL</code>, a default buffer will be created.</p>
<p>Flags: Read / Write</p>
<p class="since">Since: <a class="link" href="ix11.html#api-index-1.8">1.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterText--color"></a><h3>The <code class="literal">“color”</code> property</h3>
<pre class="programlisting"> “color” <a class="link" href="clutter-Colors.html#ClutterColor"><span class="type">ClutterColor</span></a> *</pre>
<p>The color used to render the text.</p>
<p>Flags: Read / Write</p>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterText--cursor-color"></a><h3>The <code class="literal">“cursor-color”</code> property</h3>
<pre class="programlisting"> “cursor-color” <a class="link" href="clutter-Colors.html#ClutterColor"><span class="type">ClutterColor</span></a> *</pre>
<p>The color of the cursor.</p>
<p>Flags: Read / Write</p>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterText--cursor-color-set"></a><h3>The <code class="literal">“cursor-color-set”</code> property</h3>
<pre class="programlisting"> “cursor-color-set” <span class="type">gboolean</span></pre>
<p>Will be set to <code class="literal">TRUE</code> if <a class="link" href="ClutterText.html#ClutterText--cursor-color" title="The “cursor-color” property"><span class="type">“cursor-color”</span></a> has been set.</p>
<p>Flags: Read</p>
<p>Default value: FALSE</p>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterText--cursor-position"></a><h3>The <code class="literal">“cursor-position”</code> property</h3>
<pre class="programlisting"> “cursor-position” <span class="type">gint</span></pre>
<p>The current input cursor position. -1 is taken to be the end of the text</p>
<p>Flags: Read / Write</p>
<p>Allowed values: >= -1</p>
<p>Default value: -1</p>
<p class="since">Since: <a class="link" href="ix13.html#api-index-1.12">1.12</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterText--cursor-size"></a><h3>The <code class="literal">“cursor-size”</code> property</h3>
<pre class="programlisting"> “cursor-size” <span class="type">gint</span></pre>
<p>The size of the cursor, in pixels. If set to -1 the size used will
be the default cursor size of 2 pixels.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: >= -1</p>
<p>Default value: 2</p>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterText--cursor-visible"></a><h3>The <code class="literal">“cursor-visible”</code> property</h3>
<pre class="programlisting"> “cursor-visible” <span class="type">gboolean</span></pre>
<p>Whether the input cursor is visible or not.</p>
<p>The cursor will only be visible if this property and either
the <a class="link" href="ClutterText.html#ClutterText--editable" title="The “editable” property"><span class="type">“editable”</span></a> or the <a class="link" href="ClutterText.html#ClutterText--selectable" title="The “selectable” property"><span class="type">“selectable”</span></a> properties
are set to <code class="literal">TRUE</code>.</p>
<p>Flags: Read / Write</p>
<p>Default value: TRUE</p>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterText--editable"></a><h3>The <code class="literal">“editable”</code> property</h3>
<pre class="programlisting"> “editable” <span class="type">gboolean</span></pre>
<p>Whether key events delivered to the actor causes editing.</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterText--ellipsize"></a><h3>The <code class="literal">“ellipsize”</code> property</h3>
<pre class="programlisting"> “ellipsize” <span class="type">PangoEllipsizeMode</span></pre>
<p>The preferred place to ellipsize the contents of the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor</p>
<p>Flags: Read / Write</p>
<p>Default value: PANGO_ELLIPSIZE_NONE</p>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterText--font-description"></a><h3>The <code class="literal">“font-description”</code> property</h3>
<pre class="programlisting"> “font-description” <span class="type">PangoFontDescription</span> *</pre>
<p>The <span class="type">PangoFontDescription</span> that should be used by the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p>
<p>If you have a string describing the font then you should look at
<a class="link" href="ClutterText.html#ClutterText--font-name" title="The “font-name” property"><span class="type">“font-name”</span></a> instead</p>
<p>Flags: Read / Write</p>
<p class="since">Since: <a class="link" href="ix08.html#api-index-1.2">1.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterText--font-name"></a><h3>The <code class="literal">“font-name”</code> property</h3>
<pre class="programlisting"> “font-name” <span class="type">gchar</span> *</pre>
<p>The font to be used by the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>, as a string
that can be parsed by <code class="function">pango_font_description_from_string()</code>.</p>
<p>If set to <code class="literal">NULL</code>, the default system font will be used instead.</p>
<p>Flags: Read / Write</p>
<p>Default value: NULL</p>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterText--justify"></a><h3>The <code class="literal">“justify”</code> property</h3>
<pre class="programlisting"> “justify” <span class="type">gboolean</span></pre>
<p>Whether the contents of the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> should be justified
on both margins.</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterText--line-alignment"></a><h3>The <code class="literal">“line-alignment”</code> property</h3>
<pre class="programlisting"> “line-alignment” <span class="type">PangoAlignment</span></pre>
<p>The preferred alignment for the text. This property controls
the alignment of multi-line paragraphs.</p>
<p>Flags: Read / Write</p>
<p>Default value: PANGO_ALIGN_LEFT</p>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterText--line-wrap"></a><h3>The <code class="literal">“line-wrap”</code> property</h3>
<pre class="programlisting"> “line-wrap” <span class="type">gboolean</span></pre>
<p>Whether to wrap the lines of <a class="link" href="ClutterText.html#ClutterText--text" title="The “text” property"><span class="type">“text”</span></a> if the contents
exceed the available allocation. The wrapping strategy is
controlled by the <a class="link" href="ClutterText.html#ClutterText--line-wrap-mode" title="The “line-wrap-mode” property"><span class="type">“line-wrap-mode”</span></a> property.</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterText--line-wrap-mode"></a><h3>The <code class="literal">“line-wrap-mode”</code> property</h3>
<pre class="programlisting"> “line-wrap-mode” <span class="type">PangoWrapMode</span></pre>
<p>If <a class="link" href="ClutterText.html#ClutterText--line-wrap" title="The “line-wrap” property"><span class="type">“line-wrap”</span></a> is set to <code class="literal">TRUE</code>, this property will
control how the text is wrapped.</p>
<p>Flags: Read / Write</p>
<p>Default value: PANGO_WRAP_WORD</p>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterText--max-length"></a><h3>The <code class="literal">“max-length”</code> property</h3>
<pre class="programlisting"> “max-length” <span class="type">gint</span></pre>
<p>The maximum length of the contents of the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.</p>
<p>Flags: Read / Write</p>
<p>Allowed values: >= -1</p>
<p>Default value: 0</p>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterText--password-char"></a><h3>The <code class="literal">“password-char”</code> property</h3>
<pre class="programlisting"> “password-char” <span class="type">guint</span></pre>
<p>If non-zero, the character that should be used in place of
the actual text in a password text actor.</p>
<p>Flags: Read / Write</p>
<p>Default value: 0</p>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterText--position"></a><h3>The <code class="literal">“position”</code> property</h3>
<pre class="programlisting"> “position” <span class="type">gint</span></pre>
<p>The current input cursor position. -1 is taken to be the end of the text</p>
<div class="warning">
<p><code class="literal">ClutterText:position</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
<p>Use ClutterText:cursor-position instead.</p>
</div>
<p>Flags: Read / Write</p>
<p>Allowed values: >= -1</p>
<p>Default value: -1</p>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterText--selectable"></a><h3>The <code class="literal">“selectable”</code> property</h3>
<pre class="programlisting"> “selectable” <span class="type">gboolean</span></pre>
<p>Whether it is possible to select text, either using the pointer
or the keyboard.</p>
<p>This property depends on the <a class="link" href="ClutterActor.html#ClutterActor--reactive" title="The “reactive” property"><span class="type">“reactive”</span></a> property being
set to <code class="literal">TRUE</code>.</p>
<p>Flags: Read / Write</p>
<p>Default value: TRUE</p>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterText--selected-text-color"></a><h3>The <code class="literal">“selected-text-color”</code> property</h3>
<pre class="programlisting"> “selected-text-color” <a class="link" href="clutter-Colors.html#ClutterColor"><span class="type">ClutterColor</span></a> *</pre>
<p>The color of selected text.</p>
<p>Flags: Read / Write</p>
<p class="since">Since: <a class="link" href="ix11.html#api-index-1.8">1.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterText--selected-text-color-set"></a><h3>The <code class="literal">“selected-text-color-set”</code> property</h3>
<pre class="programlisting"> “selected-text-color-set” <span class="type">gboolean</span></pre>
<p>Will be set to <code class="literal">TRUE</code> if <a class="link" href="ClutterText.html#ClutterText--selected-text-color" title="The “selected-text-color” property"><span class="type">“selected-text-color”</span></a> has been set.</p>
<p>Flags: Read</p>
<p>Default value: FALSE</p>
<p class="since">Since: <a class="link" href="ix11.html#api-index-1.8">1.8</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterText--selection-bound"></a><h3>The <code class="literal">“selection-bound”</code> property</h3>
<pre class="programlisting"> “selection-bound” <span class="type">gint</span></pre>
<p>The current input cursor position. -1 is taken to be the end of the text</p>
<p>Flags: Read / Write</p>
<p>Allowed values: >= -1</p>
<p>Default value: -1</p>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterText--selection-color"></a><h3>The <code class="literal">“selection-color”</code> property</h3>
<pre class="programlisting"> “selection-color” <a class="link" href="clutter-Colors.html#ClutterColor"><span class="type">ClutterColor</span></a> *</pre>
<p>The color of the selection.</p>
<p>Flags: Read / Write</p>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterText--selection-color-set"></a><h3>The <code class="literal">“selection-color-set”</code> property</h3>
<pre class="programlisting"> “selection-color-set” <span class="type">gboolean</span></pre>
<p>Will be set to <code class="literal">TRUE</code> if <a class="link" href="ClutterText.html#ClutterText--selection-color" title="The “selection-color” property"><span class="type">“selection-color”</span></a> has been set.</p>
<p>Flags: Read</p>
<p>Default value: FALSE</p>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterText--single-line-mode"></a><h3>The <code class="literal">“single-line-mode”</code> property</h3>
<pre class="programlisting"> “single-line-mode” <span class="type">gboolean</span></pre>
<p>Whether the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should be in single line mode
or not. A single line <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor will only contain a
single line of text, scrolling it in case its length is bigger
than the allocated size.</p>
<p>Setting this property will also set the <a class="link" href="ClutterText.html#ClutterText--activatable" title="The “activatable” property"><span class="type">“activatable”</span></a>
property as a side-effect.</p>
<p>The <a class="link" href="ClutterText.html#ClutterText--single-line-mode" title="The “single-line-mode” property"><span class="type">“single-line-mode”</span></a> property is used only if the
<a class="link" href="ClutterText.html#ClutterText--editable" title="The “editable” property"><span class="type">“editable”</span></a> property is set to <code class="literal">TRUE</code>.</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterText--text"></a><h3>The <code class="literal">“text”</code> property</h3>
<pre class="programlisting"> “text” <span class="type">gchar</span> *</pre>
<p>The text to render inside the actor.</p>
<p>Flags: Read / Write</p>
<p>Default value: ""</p>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterText--use-markup"></a><h3>The <code class="literal">“use-markup”</code> property</h3>
<pre class="programlisting"> “use-markup” <span class="type">gboolean</span></pre>
<p>Whether the text includes Pango markup.</p>
<p>For more informations about the Pango markup format, see
<code class="function">pango_layout_set_markup()</code> in the Pango documentation.</p>
<p>It is not possible to round-trip this property between
<code class="literal">TRUE</code> and <code class="literal">FALSE</code>. Once a string with markup has been set on
a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor with :use-markup set to <code class="literal">TRUE</code>, the markup
is stripped from the string.</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
</div>
<div class="refsect1">
<a name="ClutterText.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="ClutterText-activate"></a><h3>The <code class="literal">“activate”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self,
<span class="type">gpointer</span> user_data)</pre>
<p>The ::activate signal is emitted each time the actor is 'activated'
by the user, normally by pressing the 'Enter' key. The signal is
emitted only if <a class="link" href="ClutterText.html#ClutterText--activatable" title="The “activatable” property"><span class="type">“activatable”</span></a> is set to <code class="literal">TRUE</code>.</p>
<div class="refsect3">
<a name="ClutterText-activate.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> that emitted the signal</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterText-cursor-changed"></a><h3>The <code class="literal">“cursor-changed”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self,
<span class="type">gpointer</span> user_data)</pre>
<p>The ::cursor-changed signal is emitted whenever the cursor
position or size changes.</p>
<div class="refsect3">
<a name="ClutterText-cursor-changed.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> that emitted the signal</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
<p class="since">Since: <a class="link" href="ix15.html#api-index-1.16">1.16</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterText-cursor-event"></a><h3>The <code class="literal">“cursor-event”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self,
<a class="link" href="clutter-Base-geometric-types.html#ClutterGeometry"><span class="type">ClutterGeometry</span></a> *geometry,
<span class="type">gpointer</span> user_data)</pre>
<p>The ::cursor-event signal is emitted whenever the cursor position
changes inside a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor. Inside <em class="parameter"><code>geometry</code></em>
it is stored
the current position and size of the cursor, relative to the actor
itself.</p>
<div class="warning">
<p><code class="literal">ClutterText::cursor-event</code> has been deprecated since version 1.16 and should not be used in newly-written code.</p>
<p>Use the <a class="link" href="ClutterText.html#ClutterText-cursor-changed" title="The “cursor-changed” signal"><span class="type">“cursor-changed”</span></a> signal instead</p>
</div>
<div class="refsect3">
<a name="ClutterText-cursor-event.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> that emitted the signal</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>geometry</p></td>
<td class="parameter_description"><p>the coordinates of the cursor</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterText-delete-text"></a><h3>The <code class="literal">“delete-text”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self,
<span class="type">gint</span> start_pos,
<span class="type">gint</span> end_pos,
<span class="type">gpointer</span> user_data)</pre>
<p>This signal is emitted when text is deleted from the actor by
the user. It is emitted before <em class="parameter"><code>self</code></em>
text changes.</p>
<div class="refsect3">
<a name="ClutterText-delete-text.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> that emitted the signal</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>start_pos</p></td>
<td class="parameter_description"><p>the starting position</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>end_pos</p></td>
<td class="parameter_description"><p>the end position</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Action</p>
<p class="since">Since: <a class="link" href="ix08.html#api-index-1.2">1.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterText-insert-text"></a><h3>The <code class="literal">“insert-text”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self,
<span class="type">gchar</span> *new_text,
<span class="type">gint</span> new_text_length,
<span class="type">gpointer</span> position,
<span class="type">gpointer</span> user_data)</pre>
<p>This signal is emitted when text is inserted into the actor by
the user. It is emitted before <em class="parameter"><code>self</code></em>
text changes.</p>
<div class="refsect3">
<a name="ClutterText-insert-text.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> that emitted the signal</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>new_text</p></td>
<td class="parameter_description"><p>the new text to insert</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>new_text_length</p></td>
<td class="parameter_description"><p>the length of the new text, in bytes, or -1 if
new_text is nul-terminated</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>position</p></td>
<td class="parameter_description"><p>the position, in characters, at which to insert the
new text. this is an in-out parameter. After the signal
emission is finished, it should point after the newly
inserted text.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Action</p>
<p class="since">Since: <a class="link" href="ix08.html#api-index-1.2">1.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ClutterText-text-changed"></a><h3>The <code class="literal">“text-changed”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self,
<span class="type">gpointer</span> user_data)</pre>
<p>The ::text-changed signal is emitted after <em class="parameter"><code>actor</code></em>
's text changes</p>
<div class="refsect3">
<a name="ClutterText-text-changed.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> that emitted the signal</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
<p class="since">Since: <a class="link" href="ix07.html#api-index-1.0">1.0</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25.1</div>
</body>
</html>