41
33
<h2><span class="refentrytitle"><a name="ClutterText.top_of_page"></a>ClutterText</span></h2>
42
34
<p>ClutterText — An actor for displaying and editing text</p>
44
<td valign="top" align="right"></td>
36
<td class="gallery_image" valign="top" align="right"></td>
45
37
</tr></table></div>
46
<div class="refsynopsisdiv">
47
<a name="ClutterText.synopsis"></a><h2>Synopsis</h2>
48
<pre class="synopsis">struct <a class="link" href="ClutterText.html#ClutterText-struct" title="struct ClutterText">ClutterText</a>;
49
struct <a class="link" href="ClutterText.html#ClutterTextClass" title="struct ClutterTextClass">ClutterTextClass</a>;
50
<a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> * <a class="link" href="ClutterText.html#clutter-text-new" title="clutter_text_new ()">clutter_text_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
51
<a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> * <a class="link" href="ClutterText.html#clutter-text-new-full" title="clutter_text_new_full ()">clutter_text_new_full</a> (<em class="parameter"><code>const <span class="type">gchar</span> *font_name</code></em>,
52
<em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>,
53
<em class="parameter"><code>const <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);
54
<a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> * <a class="link" href="ClutterText.html#clutter-text-new-with-text" title="clutter_text_new_with_text ()">clutter_text_new_with_text</a> (<em class="parameter"><code>const <span class="type">gchar</span> *font_name</code></em>,
55
<em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>);
56
<a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> * <a class="link" href="ClutterText.html#clutter-text-new-with-buffer" title="clutter_text_new_with_buffer ()">clutter_text_new_with_buffer</a> (<em class="parameter"><code><a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a> *buffer</code></em>);
58
<span class="returnvalue">void</span> <a class="link" href="ClutterText.html#clutter-text-set-buffer" title="clutter_text_set_buffer ()">clutter_text_set_buffer</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
59
<em class="parameter"><code><a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a> *buffer</code></em>);
60
<a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="returnvalue">ClutterTextBuffer</span></a> * <a class="link" href="ClutterText.html#clutter-text-get-buffer" title="clutter_text_get_buffer ()">clutter_text_get_buffer</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);
61
<span class="returnvalue">void</span> <a class="link" href="ClutterText.html#clutter-text-set-text" title="clutter_text_set_text ()">clutter_text_set_text</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
62
<em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>);
63
<span class="returnvalue">void</span> <a class="link" href="ClutterText.html#clutter-text-set-markup" title="clutter_text_set_markup ()">clutter_text_set_markup</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
64
<em class="parameter"><code>const <span class="type">gchar</span> *markup</code></em>);
65
const <span class="returnvalue">gchar</span> * <a class="link" href="ClutterText.html#clutter-text-get-text" title="clutter_text_get_text ()">clutter_text_get_text</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);
66
<span class="returnvalue">void</span> <a class="link" href="ClutterText.html#clutter-text-set-activatable" title="clutter_text_set_activatable ()">clutter_text_set_activatable</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
67
<em class="parameter"><code><span class="type">gboolean</span> activatable</code></em>);
68
<span class="returnvalue">gboolean</span> <a class="link" href="ClutterText.html#clutter-text-get-activatable" title="clutter_text_get_activatable ()">clutter_text_get_activatable</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);
69
<span class="returnvalue">void</span> <a class="link" href="ClutterText.html#clutter-text-set-attributes" title="clutter_text_set_attributes ()">clutter_text_set_attributes</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
70
<em class="parameter"><code><span class="type">PangoAttrList</span> *attrs</code></em>);
71
<span class="returnvalue">PangoAttrList</span> * <a class="link" href="ClutterText.html#clutter-text-get-attributes" title="clutter_text_get_attributes ()">clutter_text_get_attributes</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);
72
<span class="returnvalue">void</span> <a class="link" href="ClutterText.html#clutter-text-set-color" title="clutter_text_set_color ()">clutter_text_set_color</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
73
<em class="parameter"><code>const <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);
74
<span class="returnvalue">void</span> <a class="link" href="ClutterText.html#clutter-text-get-color" title="clutter_text_get_color ()">clutter_text_get_color</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
75
<em class="parameter"><code><a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);
76
<span class="returnvalue">void</span> <a class="link" href="ClutterText.html#clutter-text-set-ellipsize" title="clutter_text_set_ellipsize ()">clutter_text_set_ellipsize</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
77
<em class="parameter"><code><span class="type">PangoEllipsizeMode</span> mode</code></em>);
78
<span class="returnvalue">PangoEllipsizeMode</span> <a class="link" href="ClutterText.html#clutter-text-get-ellipsize" title="clutter_text_get_ellipsize ()">clutter_text_get_ellipsize</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);
79
<span class="returnvalue">void</span> <a class="link" href="ClutterText.html#clutter-text-set-font-name" title="clutter_text_set_font_name ()">clutter_text_set_font_name</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
80
<em class="parameter"><code>const <span class="type">gchar</span> *font_name</code></em>);
81
const <span class="returnvalue">gchar</span> * <a class="link" href="ClutterText.html#clutter-text-get-font-name" title="clutter_text_get_font_name ()">clutter_text_get_font_name</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);
82
<span class="returnvalue">void</span> <a class="link" href="ClutterText.html#clutter-text-set-font-description" title="clutter_text_set_font_description ()">clutter_text_set_font_description</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
83
<em class="parameter"><code><span class="type">PangoFontDescription</span> *font_desc</code></em>);
84
<span class="returnvalue">PangoFontDescription</span> * <a class="link" href="ClutterText.html#clutter-text-get-font-description" title="clutter_text_get_font_description ()">clutter_text_get_font_description</a>
85
(<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);
86
<span class="returnvalue">void</span> <a class="link" href="ClutterText.html#clutter-text-set-password-char" title="clutter_text_set_password_char ()">clutter_text_set_password_char</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
87
<em class="parameter"><code><span class="type">gunichar</span> wc</code></em>);
88
<span class="returnvalue">gunichar</span> <a class="link" href="ClutterText.html#clutter-text-get-password-char" title="clutter_text_get_password_char ()">clutter_text_get_password_char</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);
89
<span class="returnvalue">void</span> <a class="link" href="ClutterText.html#clutter-text-set-justify" title="clutter_text_set_justify ()">clutter_text_set_justify</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
90
<em class="parameter"><code><span class="type">gboolean</span> justify</code></em>);
91
<span class="returnvalue">gboolean</span> <a class="link" href="ClutterText.html#clutter-text-get-justify" title="clutter_text_get_justify ()">clutter_text_get_justify</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);
92
<span class="returnvalue">PangoLayout</span> * <a class="link" href="ClutterText.html#clutter-text-get-layout" title="clutter_text_get_layout ()">clutter_text_get_layout</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);
93
<span class="returnvalue">void</span> <a class="link" href="ClutterText.html#clutter-text-set-line-alignment" title="clutter_text_set_line_alignment ()">clutter_text_set_line_alignment</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
94
<em class="parameter"><code><span class="type">PangoAlignment</span> alignment</code></em>);
95
<span class="returnvalue">PangoAlignment</span> <a class="link" href="ClutterText.html#clutter-text-get-line-alignment" title="clutter_text_get_line_alignment ()">clutter_text_get_line_alignment</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);
96
<span class="returnvalue">void</span> <a class="link" href="ClutterText.html#clutter-text-set-line-wrap" title="clutter_text_set_line_wrap ()">clutter_text_set_line_wrap</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
97
<em class="parameter"><code><span class="type">gboolean</span> line_wrap</code></em>);
98
<span class="returnvalue">gboolean</span> <a class="link" href="ClutterText.html#clutter-text-get-line-wrap" title="clutter_text_get_line_wrap ()">clutter_text_get_line_wrap</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);
99
<span class="returnvalue">void</span> <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> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
100
<em class="parameter"><code><span class="type">PangoWrapMode</span> wrap_mode</code></em>);
101
<span class="returnvalue">PangoWrapMode</span> <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> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);
102
<span class="returnvalue">void</span> <a class="link" href="ClutterText.html#clutter-text-set-max-length" title="clutter_text_set_max_length ()">clutter_text_set_max_length</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
103
<em class="parameter"><code><span class="type">gint</span> max</code></em>);
104
<span class="returnvalue">gint</span> <a class="link" href="ClutterText.html#clutter-text-get-max-length" title="clutter_text_get_max_length ()">clutter_text_get_max_length</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);
105
<span class="returnvalue">void</span> <a class="link" href="ClutterText.html#clutter-text-set-selectable" title="clutter_text_set_selectable ()">clutter_text_set_selectable</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
106
<em class="parameter"><code><span class="type">gboolean</span> selectable</code></em>);
107
<span class="returnvalue">gboolean</span> <a class="link" href="ClutterText.html#clutter-text-get-selectable" title="clutter_text_get_selectable ()">clutter_text_get_selectable</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);
108
<span class="returnvalue">void</span> <a class="link" href="ClutterText.html#clutter-text-set-selection" title="clutter_text_set_selection ()">clutter_text_set_selection</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
109
<em class="parameter"><code><span class="type">gssize</span> start_pos</code></em>,
110
<em class="parameter"><code><span class="type">gssize</span> end_pos</code></em>);
111
<span class="returnvalue">gchar</span> * <a class="link" href="ClutterText.html#clutter-text-get-selection" title="clutter_text_get_selection ()">clutter_text_get_selection</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);
112
<span class="returnvalue">void</span> <a class="link" href="ClutterText.html#clutter-text-set-selection-bound" title="clutter_text_set_selection_bound ()">clutter_text_set_selection_bound</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
113
<em class="parameter"><code><span class="type">gint</span> selection_bound</code></em>);
114
<span class="returnvalue">gint</span> <a class="link" href="ClutterText.html#clutter-text-get-selection-bound" title="clutter_text_get_selection_bound ()">clutter_text_get_selection_bound</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);
115
<span class="returnvalue">void</span> <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> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
116
<em class="parameter"><code><span class="type">gboolean</span> single_line</code></em>);
117
<span class="returnvalue">gboolean</span> <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> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);
118
<span class="returnvalue">void</span> <a class="link" href="ClutterText.html#clutter-text-set-use-markup" title="clutter_text_set_use_markup ()">clutter_text_set_use_markup</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
119
<em class="parameter"><code><span class="type">gboolean</span> setting</code></em>);
120
<span class="returnvalue">gboolean</span> <a class="link" href="ClutterText.html#clutter-text-get-use-markup" title="clutter_text_get_use_markup ()">clutter_text_get_use_markup</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);
122
<span class="returnvalue">void</span> <a class="link" href="ClutterText.html#clutter-text-set-editable" title="clutter_text_set_editable ()">clutter_text_set_editable</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
123
<em class="parameter"><code><span class="type">gboolean</span> editable</code></em>);
124
<span class="returnvalue">gboolean</span> <a class="link" href="ClutterText.html#clutter-text-get-editable" title="clutter_text_get_editable ()">clutter_text_get_editable</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);
125
<span class="returnvalue">void</span> <a class="link" href="ClutterText.html#clutter-text-insert-text" title="clutter_text_insert_text ()">clutter_text_insert_text</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
126
<em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>,
127
<em class="parameter"><code><span class="type">gssize</span> position</code></em>);
128
<span class="returnvalue">void</span> <a class="link" href="ClutterText.html#clutter-text-insert-unichar" title="clutter_text_insert_unichar ()">clutter_text_insert_unichar</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
129
<em class="parameter"><code><span class="type">gunichar</span> wc</code></em>);
130
<span class="returnvalue">void</span> <a class="link" href="ClutterText.html#clutter-text-delete-chars" title="clutter_text_delete_chars ()">clutter_text_delete_chars</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
131
<em class="parameter"><code><span class="type">guint</span> n_chars</code></em>);
132
<span class="returnvalue">void</span> <a class="link" href="ClutterText.html#clutter-text-delete-text" title="clutter_text_delete_text ()">clutter_text_delete_text</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
133
<em class="parameter"><code><span class="type">gssize</span> start_pos</code></em>,
134
<em class="parameter"><code><span class="type">gssize</span> end_pos</code></em>);
135
<span class="returnvalue">gboolean</span> <a class="link" href="ClutterText.html#clutter-text-delete-selection" title="clutter_text_delete_selection ()">clutter_text_delete_selection</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);
136
<span class="returnvalue">gchar</span> * <a class="link" href="ClutterText.html#clutter-text-get-chars" title="clutter_text_get_chars ()">clutter_text_get_chars</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
137
<em class="parameter"><code><span class="type">gssize</span> start_pos</code></em>,
138
<em class="parameter"><code><span class="type">gssize</span> end_pos</code></em>);
139
<span class="returnvalue">void</span> <a class="link" href="ClutterText.html#clutter-text-set-cursor-color" title="clutter_text_set_cursor_color ()">clutter_text_set_cursor_color</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
140
<em class="parameter"><code>const <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);
141
<span class="returnvalue">void</span> <a class="link" href="ClutterText.html#clutter-text-get-cursor-color" title="clutter_text_get_cursor_color ()">clutter_text_get_cursor_color</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
142
<em class="parameter"><code><a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);
143
<span class="returnvalue">void</span> <a class="link" href="ClutterText.html#clutter-text-set-selection-color" title="clutter_text_set_selection_color ()">clutter_text_set_selection_color</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
144
<em class="parameter"><code>const <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);
145
<span class="returnvalue">void</span> <a class="link" href="ClutterText.html#clutter-text-get-selection-color" title="clutter_text_get_selection_color ()">clutter_text_get_selection_color</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
146
<em class="parameter"><code><a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);
147
<span class="returnvalue">void</span> <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>
148
(<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
149
<em class="parameter"><code>const <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);
150
<span class="returnvalue">void</span> <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>
151
(<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
152
<em class="parameter"><code><a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);
153
<span class="returnvalue">void</span> <a class="link" href="ClutterText.html#clutter-text-set-cursor-position" title="clutter_text_set_cursor_position ()">clutter_text_set_cursor_position</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
154
<em class="parameter"><code><span class="type">gint</span> position</code></em>);
155
<span class="returnvalue">gint</span> <a class="link" href="ClutterText.html#clutter-text-get-cursor-position" title="clutter_text_get_cursor_position ()">clutter_text_get_cursor_position</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);
156
<span class="returnvalue">void</span> <a class="link" href="ClutterText.html#clutter-text-set-cursor-visible" title="clutter_text_set_cursor_visible ()">clutter_text_set_cursor_visible</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
157
<em class="parameter"><code><span class="type">gboolean</span> cursor_visible</code></em>);
158
<span class="returnvalue">gboolean</span> <a class="link" href="ClutterText.html#clutter-text-get-cursor-visible" title="clutter_text_get_cursor_visible ()">clutter_text_get_cursor_visible</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);
159
<span class="returnvalue">void</span> <a class="link" href="ClutterText.html#clutter-text-set-cursor-size" title="clutter_text_set_cursor_size ()">clutter_text_set_cursor_size</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
160
<em class="parameter"><code><span class="type">gint</span> size</code></em>);
161
<span class="returnvalue">guint</span> <a class="link" href="ClutterText.html#clutter-text-get-cursor-size" title="clutter_text_get_cursor_size ()">clutter_text_get_cursor_size</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);
163
<span class="returnvalue">gboolean</span> <a class="link" href="ClutterText.html#clutter-text-activate" title="clutter_text_activate ()">clutter_text_activate</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);
164
<span class="returnvalue">gint</span> <a class="link" href="ClutterText.html#clutter-text-coords-to-position" title="clutter_text_coords_to_position ()">clutter_text_coords_to_position</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
165
<em class="parameter"><code><span class="type">gfloat</span> x</code></em>,
166
<em class="parameter"><code><span class="type">gfloat</span> y</code></em>);
167
<span class="returnvalue">gboolean</span> <a class="link" href="ClutterText.html#clutter-text-position-to-coords" title="clutter_text_position_to_coords ()">clutter_text_position_to_coords</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
168
<em class="parameter"><code><span class="type">gint</span> position</code></em>,
169
<em class="parameter"><code><span class="type">gfloat</span> *x</code></em>,
170
<em class="parameter"><code><span class="type">gfloat</span> *y</code></em>,
171
<em class="parameter"><code><span class="type">gfloat</span> *line_height</code></em>);
172
<span class="returnvalue">void</span> <a class="link" href="ClutterText.html#clutter-text-set-preedit-string" title="clutter_text_set_preedit_string ()">clutter_text_set_preedit_string</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
173
<em class="parameter"><code>const <span class="type">gchar</span> *preedit_str</code></em>,
174
<em class="parameter"><code><span class="type">PangoAttrList</span> *preedit_attrs</code></em>,
175
<em class="parameter"><code><span class="type">guint</span> cursor_pos</code></em>);
176
<span class="returnvalue">void</span> <a class="link" href="ClutterText.html#clutter-text-get-layout-offsets" title="clutter_text_get_layout_offsets ()">clutter_text_get_layout_offsets</a> (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
177
<em class="parameter"><code><span class="type">gint</span> *x</code></em>,
178
<em class="parameter"><code><span class="type">gint</span> *y</code></em>);
38
<div class="refsect1">
39
<a name="ClutterText.functions"></a><h2>Functions</h2>
40
<div class="informaltable"><table width="100%" border="0">
42
<col width="150px" class="functions_return">
43
<col class="functions_name">
47
<td class="function_type">
48
<a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
50
<td class="function_name">
51
<a class="link" href="ClutterText.html#clutter-text-new" title="clutter_text_new ()">clutter_text_new</a> <span class="c_punctuation">()</span>
55
<td class="function_type">
56
<a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
58
<td class="function_name">
59
<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>
63
<td class="function_type">
64
<a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
66
<td class="function_name">
67
<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>
71
<td class="function_type">
72
<a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
74
<td class="function_name">
75
<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>
79
<td class="function_type">
80
<span class="returnvalue">void</span>
82
<td class="function_name">
83
<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>
87
<td class="function_type">
88
<a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="returnvalue">ClutterTextBuffer</span></a> *
90
<td class="function_name">
91
<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>
95
<td class="function_type">
96
<span class="returnvalue">void</span>
98
<td class="function_name">
99
<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>
103
<td class="function_type">
104
<span class="returnvalue">void</span>
106
<td class="function_name">
107
<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>
111
<td class="function_type">const <span class="returnvalue">gchar</span> *
113
<td class="function_name">
114
<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>
118
<td class="function_type">
119
<span class="returnvalue">void</span>
121
<td class="function_name">
122
<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>
126
<td class="function_type">
127
<span class="returnvalue">gboolean</span>
129
<td class="function_name">
130
<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>
134
<td class="function_type">
135
<span class="returnvalue">void</span>
137
<td class="function_name">
138
<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>
142
<td class="function_type">
143
<span class="returnvalue">PangoAttrList</span> *
145
<td class="function_name">
146
<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>
150
<td class="function_type">
151
<span class="returnvalue">void</span>
153
<td class="function_name">
154
<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>
158
<td class="function_type">
159
<span class="returnvalue">void</span>
161
<td class="function_name">
162
<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>
166
<td class="function_type">
167
<span class="returnvalue">void</span>
169
<td class="function_name">
170
<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>
174
<td class="function_type">
175
<span class="returnvalue">PangoEllipsizeMode</span>
177
<td class="function_name">
178
<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>
182
<td class="function_type">
183
<span class="returnvalue">void</span>
185
<td class="function_name">
186
<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>
190
<td class="function_type">const <span class="returnvalue">gchar</span> *
192
<td class="function_name">
193
<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>
197
<td class="function_type">
198
<span class="returnvalue">void</span>
200
<td class="function_name">
201
<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>
205
<td class="function_type">
206
<span class="returnvalue">PangoFontDescription</span> *
208
<td class="function_name">
209
<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>
213
<td class="function_type">
214
<span class="returnvalue">void</span>
216
<td class="function_name">
217
<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>
221
<td class="function_type">
222
<span class="returnvalue">gunichar</span>
224
<td class="function_name">
225
<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>
229
<td class="function_type">
230
<span class="returnvalue">void</span>
232
<td class="function_name">
233
<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>
237
<td class="function_type">
238
<span class="returnvalue">gboolean</span>
240
<td class="function_name">
241
<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>
245
<td class="function_type">
246
<span class="returnvalue">PangoLayout</span> *
248
<td class="function_name">
249
<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>
253
<td class="function_type">
254
<span class="returnvalue">void</span>
256
<td class="function_name">
257
<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>
261
<td class="function_type">
262
<span class="returnvalue">PangoAlignment</span>
264
<td class="function_name">
265
<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>
269
<td class="function_type">
270
<span class="returnvalue">void</span>
272
<td class="function_name">
273
<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>
277
<td class="function_type">
278
<span class="returnvalue">gboolean</span>
280
<td class="function_name">
281
<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>
285
<td class="function_type">
286
<span class="returnvalue">void</span>
288
<td class="function_name">
289
<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>
293
<td class="function_type">
294
<span class="returnvalue">PangoWrapMode</span>
296
<td class="function_name">
297
<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>
301
<td class="function_type">
302
<span class="returnvalue">void</span>
304
<td class="function_name">
305
<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>
309
<td class="function_type">
310
<span class="returnvalue">gint</span>
312
<td class="function_name">
313
<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>
317
<td class="function_type">
318
<span class="returnvalue">void</span>
320
<td class="function_name">
321
<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>
325
<td class="function_type">
326
<span class="returnvalue">gboolean</span>
328
<td class="function_name">
329
<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>
333
<td class="function_type">
334
<span class="returnvalue">void</span>
336
<td class="function_name">
337
<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>
341
<td class="function_type">
342
<span class="returnvalue">gchar</span> *
344
<td class="function_name">
345
<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>
349
<td class="function_type">
350
<span class="returnvalue">void</span>
352
<td class="function_name">
353
<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>
357
<td class="function_type">
358
<span class="returnvalue">gint</span>
360
<td class="function_name">
361
<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>
365
<td class="function_type">
366
<span class="returnvalue">void</span>
368
<td class="function_name">
369
<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>
373
<td class="function_type">
374
<span class="returnvalue">gboolean</span>
376
<td class="function_name">
377
<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>
381
<td class="function_type">
382
<span class="returnvalue">void</span>
384
<td class="function_name">
385
<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>
389
<td class="function_type">
390
<span class="returnvalue">gboolean</span>
392
<td class="function_name">
393
<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>
397
<td class="function_type">
398
<span class="returnvalue">void</span>
400
<td class="function_name">
401
<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>
405
<td class="function_type">
406
<span class="returnvalue">gboolean</span>
408
<td class="function_name">
409
<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>
413
<td class="function_type">
414
<span class="returnvalue">void</span>
416
<td class="function_name">
417
<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>
421
<td class="function_type">
422
<span class="returnvalue">void</span>
424
<td class="function_name">
425
<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>
429
<td class="function_type">
430
<span class="returnvalue">void</span>
432
<td class="function_name">
433
<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>
437
<td class="function_type">
438
<span class="returnvalue">void</span>
440
<td class="function_name">
441
<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>
445
<td class="function_type">
446
<span class="returnvalue">gboolean</span>
448
<td class="function_name">
449
<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>
453
<td class="function_type">
454
<span class="returnvalue">gchar</span> *
456
<td class="function_name">
457
<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>
461
<td class="function_type">
462
<span class="returnvalue">void</span>
464
<td class="function_name">
465
<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>
469
<td class="function_type">
470
<span class="returnvalue">void</span>
472
<td class="function_name">
473
<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>
477
<td class="function_type">
478
<span class="returnvalue">void</span>
480
<td class="function_name">
481
<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>
485
<td class="function_type">
486
<span class="returnvalue">void</span>
488
<td class="function_name">
489
<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>
493
<td class="function_type">
494
<span class="returnvalue">void</span>
496
<td class="function_name">
497
<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>
501
<td class="function_type">
502
<span class="returnvalue">void</span>
504
<td class="function_name">
505
<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>
509
<td class="function_type">
510
<span class="returnvalue">void</span>
512
<td class="function_name">
513
<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>
517
<td class="function_type">
518
<span class="returnvalue">gint</span>
520
<td class="function_name">
521
<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>
525
<td class="function_type">
526
<span class="returnvalue">void</span>
528
<td class="function_name">
529
<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>
533
<td class="function_type">
534
<span class="returnvalue">gboolean</span>
536
<td class="function_name">
537
<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>
541
<td class="function_type">
542
<span class="returnvalue">void</span>
544
<td class="function_name">
545
<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>
549
<td class="function_type">
550
<span class="returnvalue">guint</span>
552
<td class="function_name">
553
<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>
557
<td class="function_type">
558
<span class="returnvalue">void</span>
560
<td class="function_name">
561
<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>
565
<td class="function_type">
566
<span class="returnvalue">gboolean</span>
568
<td class="function_name">
569
<a class="link" href="ClutterText.html#clutter-text-activate" title="clutter_text_activate ()">clutter_text_activate</a> <span class="c_punctuation">()</span>
573
<td class="function_type">
574
<span class="returnvalue">gint</span>
576
<td class="function_name">
577
<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>
581
<td class="function_type">
582
<span class="returnvalue">gboolean</span>
584
<td class="function_name">
585
<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>
589
<td class="function_type">
590
<span class="returnvalue">void</span>
592
<td class="function_name">
593
<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>
597
<td class="function_type">
598
<span class="returnvalue">void</span>
600
<td class="function_name">
601
<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>
607
<div class="refsect1">
608
<a name="ClutterText.properties"></a><h2>Properties</h2>
609
<div class="informaltable"><table border="0">
611
<col width="150px" class="properties_type">
612
<col width="300px" class="properties_name">
613
<col width="200px" class="properties_flags">
617
<td class="property_type"><span class="type">gboolean</span></td>
618
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--activatable" title="The “activatable” property">activatable</a></td>
619
<td class="property_flags">Read / Write</td>
622
<td class="property_type">
623
<span class="type">PangoAttrList</span> *</td>
624
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--attributes" title="The “attributes” property">attributes</a></td>
625
<td class="property_flags">Read / Write</td>
628
<td class="property_type">
629
<a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a> *</td>
630
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--buffer" title="The “buffer” property">buffer</a></td>
631
<td class="property_flags">Read / Write</td>
634
<td class="property_type">
635
<a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *</td>
636
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--color" title="The “color” property">color</a></td>
637
<td class="property_flags">Read / Write</td>
640
<td class="property_type">
641
<a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *</td>
642
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--cursor-color" title="The “cursor-color” property">cursor-color</a></td>
643
<td class="property_flags">Read / Write</td>
646
<td class="property_type"><span class="type">gboolean</span></td>
647
<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>
648
<td class="property_flags">Read</td>
651
<td class="property_type"><span class="type">gint</span></td>
652
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--cursor-position" title="The “cursor-position” property">cursor-position</a></td>
653
<td class="property_flags">Read / Write</td>
656
<td class="property_type"><span class="type">gint</span></td>
657
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--cursor-size" title="The “cursor-size” property">cursor-size</a></td>
658
<td class="property_flags">Read / Write</td>
661
<td class="property_type"><span class="type">gboolean</span></td>
662
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--cursor-visible" title="The “cursor-visible” property">cursor-visible</a></td>
663
<td class="property_flags">Read / Write</td>
666
<td class="property_type"><span class="type">gboolean</span></td>
667
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--editable" title="The “editable” property">editable</a></td>
668
<td class="property_flags">Read / Write</td>
671
<td class="property_type"><span class="type">PangoEllipsizeMode</span></td>
672
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--ellipsize" title="The “ellipsize” property">ellipsize</a></td>
673
<td class="property_flags">Read / Write</td>
676
<td class="property_type">
677
<span class="type">PangoFontDescription</span> *</td>
678
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--font-description" title="The “font-description” property">font-description</a></td>
679
<td class="property_flags">Read / Write</td>
682
<td class="property_type">
683
<span class="type">gchar</span> *</td>
684
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--font-name" title="The “font-name” property">font-name</a></td>
685
<td class="property_flags">Read / Write</td>
688
<td class="property_type"><span class="type">gboolean</span></td>
689
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--justify" title="The “justify” property">justify</a></td>
690
<td class="property_flags">Read / Write</td>
693
<td class="property_type"><span class="type">PangoAlignment</span></td>
694
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--line-alignment" title="The “line-alignment” property">line-alignment</a></td>
695
<td class="property_flags">Read / Write</td>
698
<td class="property_type"><span class="type">gboolean</span></td>
699
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--line-wrap" title="The “line-wrap” property">line-wrap</a></td>
700
<td class="property_flags">Read / Write</td>
703
<td class="property_type"><span class="type">PangoWrapMode</span></td>
704
<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>
705
<td class="property_flags">Read / Write</td>
708
<td class="property_type"><span class="type">gint</span></td>
709
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--max-length" title="The “max-length” property">max-length</a></td>
710
<td class="property_flags">Read / Write</td>
713
<td class="property_type"><span class="type">guint</span></td>
714
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--password-char" title="The “password-char” property">password-char</a></td>
715
<td class="property_flags">Read / Write</td>
718
<td class="property_type"><span class="type">gint</span></td>
719
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--position" title="The “position” property">position</a></td>
720
<td class="property_flags">Read / Write</td>
723
<td class="property_type"><span class="type">gboolean</span></td>
724
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--selectable" title="The “selectable” property">selectable</a></td>
725
<td class="property_flags">Read / Write</td>
728
<td class="property_type">
729
<a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *</td>
730
<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>
731
<td class="property_flags">Read / Write</td>
734
<td class="property_type"><span class="type">gboolean</span></td>
735
<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>
736
<td class="property_flags">Read</td>
739
<td class="property_type"><span class="type">gint</span></td>
740
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--selection-bound" title="The “selection-bound” property">selection-bound</a></td>
741
<td class="property_flags">Read / Write</td>
744
<td class="property_type">
745
<a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *</td>
746
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--selection-color" title="The “selection-color” property">selection-color</a></td>
747
<td class="property_flags">Read / Write</td>
750
<td class="property_type"><span class="type">gboolean</span></td>
751
<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>
752
<td class="property_flags">Read</td>
755
<td class="property_type"><span class="type">gboolean</span></td>
756
<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>
757
<td class="property_flags">Read / Write</td>
760
<td class="property_type">
761
<span class="type">gchar</span> *</td>
762
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--text" title="The “text” property">text</a></td>
763
<td class="property_flags">Read / Write</td>
766
<td class="property_type"><span class="type">gboolean</span></td>
767
<td class="property_name"><a class="link" href="ClutterText.html#ClutterText--use-markup" title="The “use-markup” property">use-markup</a></td>
768
<td class="property_flags">Read / Write</td>
773
<div class="refsect1">
774
<a name="ClutterText.signals"></a><h2>Signals</h2>
775
<div class="informaltable"><table border="0">
777
<col width="150px" class="signals_return">
778
<col width="300px" class="signals_name">
779
<col width="200px" class="signals_flags">
783
<td class="signal_type"><span class="returnvalue">void</span></td>
784
<td class="signal_name"><a class="link" href="ClutterText.html#ClutterText-activate" title="The “activate” signal">activate</a></td>
785
<td class="signal_flags">Run Last</td>
788
<td class="signal_type"><span class="returnvalue">void</span></td>
789
<td class="signal_name"><a class="link" href="ClutterText.html#ClutterText-cursor-changed" title="The “cursor-changed” signal">cursor-changed</a></td>
790
<td class="signal_flags">Run Last</td>
793
<td class="signal_type"><span class="returnvalue">void</span></td>
794
<td class="signal_name"><a class="link" href="ClutterText.html#ClutterText-cursor-event" title="The “cursor-event” signal">cursor-event</a></td>
795
<td class="signal_flags">Run Last</td>
798
<td class="signal_type"><span class="returnvalue">void</span></td>
799
<td class="signal_name"><a class="link" href="ClutterText.html#ClutterText-delete-text" title="The “delete-text” signal">delete-text</a></td>
800
<td class="signal_flags">Action</td>
803
<td class="signal_type"><span class="returnvalue">void</span></td>
804
<td class="signal_name"><a class="link" href="ClutterText.html#ClutterText-insert-text" title="The “insert-text” signal">insert-text</a></td>
805
<td class="signal_flags">Action</td>
808
<td class="signal_type"><span class="returnvalue">void</span></td>
809
<td class="signal_name"><a class="link" href="ClutterText.html#ClutterText-text-changed" title="The “text-changed” signal">text-changed</a></td>
810
<td class="signal_flags">Run Last</td>
815
<div class="refsect1">
816
<a name="ClutterText.other"></a><h2>Types and Values</h2>
817
<div class="informaltable"><table width="100%" border="0">
819
<col width="150px" class="name">
820
<col class="description">
824
<td class="datatype_keyword">struct</td>
825
<td class="function_name"><a class="link" href="ClutterText.html#ClutterText-struct" title="struct ClutterText">ClutterText</a></td>
828
<td class="datatype_keyword">struct</td>
829
<td class="function_name"><a class="link" href="ClutterText.html#ClutterTextClass" title="struct ClutterTextClass">ClutterTextClass</a></td>
181
834
<div class="refsect1">
182
835
<a name="ClutterText.object-hierarchy"></a><h2>Object Hierarchy</h2>
183
<pre class="synopsis">
185
+----GInitiallyUnowned
186
+----<a class="link" href="ClutterActor.html" title="ClutterActor">ClutterActor</a>
836
<pre class="screen"> GObject
837
<span class="lineart">╰──</span> GInitiallyUnowned
838
<span class="lineart">╰──</span> <a class="link" href="ClutterActor.html" title="ClutterActor">ClutterActor</a>
839
<span class="lineart">╰──</span> ClutterText
190
842
<div class="refsect1">
904
<div class="variablelist"><table border="0" class="variablelist">
1475
<div class="refsect3">
1476
<a name="id-1.5.3.4.10.19.7"></a><h4>Parameters</h4>
1477
<div class="informaltable"><table width="100%" border="0">
906
<col align="left" valign="top">
1479
<col width="150px" class="parameters_name">
1480
<col class="parameters_description">
1481
<col width="200px" class="parameters_annotations">
911
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
912
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1485
<td class="parameter_name"><p>self</p></td>
1486
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
1487
<td class="parameter_annotations"> </td>
916
<td><p><span class="term"><em class="parameter"><code>font_name</code></em> :</span></p></td>
917
<td>a font name, or <code class="literal">NULL</code> to set the default font name. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
1490
<td class="parameter_name"><p>font_name</p></td>
1491
<td class="parameter_description"><p> a font name, or <code class="literal">NULL</code> to set the default font name. </p></td>
1492
<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>
922
1497
<p class="since">Since 1.0</p>
925
1500
<div class="refsect2">
926
<a name="clutter-text-get-font-name"></a><h3>clutter_text_get_font_name ()</h3>
927
<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>
929
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>.
931
<div class="variablelist"><table border="0" class="variablelist">
1501
<a name="clutter-text-get-font-name"></a><h3>clutter_text_get_font_name ()</h3>
1502
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
1503
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>
1504
<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>
1505
<div class="refsect3">
1506
<a name="id-1.5.3.4.10.20.5"></a><h4>Parameters</h4>
1507
<div class="informaltable"><table width="100%" border="0">
933
<col align="left" valign="top">
1509
<col width="150px" class="parameters_name">
1510
<col class="parameters_description">
1511
<col width="200px" class="parameters_annotations">
938
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
939
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
943
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
944
<td>a string containing the font name. The returned
1514
<td class="parameter_name"><p>self</p></td>
1515
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
1516
<td class="parameter_annotations"> </td>
1520
<div class="refsect3">
1521
<a name="id-1.5.3.4.10.20.6"></a><h4>Returns</h4>
1522
<p> a string containing the font name. The returned
945
1523
string is owned by the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor and should not be
946
modified or freed</td>
1524
modified or freed</p>
950
1527
<p class="since">Since 1.0</p>
953
1530
<div class="refsect2">
954
<a name="clutter-text-set-font-description"></a><h3>clutter_text_set_font_description ()</h3>
955
<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>,
956
<em class="parameter"><code><span class="type">PangoFontDescription</span> *font_desc</code></em>);</pre>
958
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>
961
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
1531
<a name="clutter-text-set-font-description"></a><h3>clutter_text_set_font_description ()</h3>
1532
<pre class="programlisting"><span class="returnvalue">void</span>
1533
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>,
1534
<em class="parameter"><code><span class="type">PangoFontDescription</span> *font_desc</code></em>);</pre>
1535
<p>Sets <em class="parameter"><code>font_desc</code></em>
1536
as the font description for a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p>
1537
<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
962
1538
so you can safely call <code class="function">pango_font_description_free()</code> on it after
963
calling this function.
965
<div class="variablelist"><table border="0" class="variablelist">
967
<col align="left" valign="top">
972
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
973
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
977
<td><p><span class="term"><em class="parameter"><code>font_desc</code></em> :</span></p></td>
978
<td>a <span class="type">PangoFontDescription</span>
983
<p class="since">Since 1.2</p>
986
<div class="refsect2">
987
<a name="clutter-text-get-font-description"></a><h3>clutter_text_get_font_description ()</h3>
988
<pre class="programlisting"><span class="returnvalue">PangoFontDescription</span> * clutter_text_get_font_description
989
(<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
991
Retrieves the <span class="type">PangoFontDescription</span> used by <em class="parameter"><code>self</code></em>
993
<div class="variablelist"><table border="0" class="variablelist">
995
<col align="left" valign="top">
1000
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1001
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1005
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1006
<td>a <span class="type">PangoFontDescription</span>. The returned value is owned
1007
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</td>
1011
<p class="since">Since 1.2</p>
1014
<div class="refsect2">
1015
<a name="clutter-text-set-password-char"></a><h3>clutter_text_set_password_char ()</h3>
1016
<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>,
1017
<em class="parameter"><code><span class="type">gunichar</span> wc</code></em>);</pre>
1019
Sets the character to use in place of the actual text in a
1020
password text actor.
1023
If <em class="parameter"><code>wc</code></em> is 0 the text will be displayed as it is entered in the
1024
<a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.
1026
<div class="variablelist"><table border="0" class="variablelist">
1028
<col align="left" valign="top">
1033
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1034
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1038
<td><p><span class="term"><em class="parameter"><code>wc</code></em> :</span></p></td>
1039
<td>a Unicode character, or 0 to unset the password character</td>
1043
<p class="since">Since 1.0</p>
1046
<div class="refsect2">
1047
<a name="clutter-text-get-password-char"></a><h3>clutter_text_get_password_char ()</h3>
1048
<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>
1050
Retrieves the character to use in place of the actual text
1051
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>.
1053
<div class="variablelist"><table border="0" class="variablelist">
1055
<col align="left" valign="top">
1060
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1061
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1065
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1066
<td>a Unicode character or 0 if the password
1067
character is not set</td>
1071
<p class="since">Since 1.0</p>
1074
<div class="refsect2">
1075
<a name="clutter-text-set-justify"></a><h3>clutter_text_set_justify ()</h3>
1076
<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>,
1077
<em class="parameter"><code><span class="type">gboolean</span> justify</code></em>);</pre>
1079
Sets whether the text of the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should be justified
1539
calling this function.</p>
1540
<div class="refsect3">
1541
<a name="id-1.5.3.4.10.21.6"></a><h4>Parameters</h4>
1542
<div class="informaltable"><table width="100%" border="0">
1544
<col width="150px" class="parameters_name">
1545
<col class="parameters_description">
1546
<col width="200px" class="parameters_annotations">
1550
<td class="parameter_name"><p>self</p></td>
1551
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
1552
<td class="parameter_annotations"> </td>
1555
<td class="parameter_name"><p>font_desc</p></td>
1556
<td class="parameter_description"><p>a <span class="type">PangoFontDescription</span></p></td>
1557
<td class="parameter_annotations"> </td>
1562
<p class="since">Since 1.2</p>
1565
<div class="refsect2">
1566
<a name="clutter-text-get-font-description"></a><h3>clutter_text_get_font_description ()</h3>
1567
<pre class="programlisting"><span class="returnvalue">PangoFontDescription</span> *
1568
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>
1569
<p>Retrieves the <span class="type">PangoFontDescription</span> used by <em class="parameter"><code>self</code></em>
1571
<div class="refsect3">
1572
<a name="id-1.5.3.4.10.22.5"></a><h4>Parameters</h4>
1573
<div class="informaltable"><table width="100%" border="0">
1575
<col width="150px" class="parameters_name">
1576
<col class="parameters_description">
1577
<col width="200px" class="parameters_annotations">
1580
<td class="parameter_name"><p>self</p></td>
1581
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
1582
<td class="parameter_annotations"> </td>
1586
<div class="refsect3">
1587
<a name="id-1.5.3.4.10.22.6"></a><h4>Returns</h4>
1588
<p> a <span class="type">PangoFontDescription</span>. The returned value is owned
1589
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>
1592
<p class="since">Since 1.2</p>
1595
<div class="refsect2">
1596
<a name="clutter-text-set-password-char"></a><h3>clutter_text_set_password_char ()</h3>
1597
<pre class="programlisting"><span class="returnvalue">void</span>
1598
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>,
1599
<em class="parameter"><code><span class="type">gunichar</span> wc</code></em>);</pre>
1600
<p>Sets the character to use in place of the actual text in a
1601
password text actor.</p>
1602
<p>If <em class="parameter"><code>wc</code></em>
1603
is 0 the text will be displayed as it is entered in the
1604
<a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.</p>
1605
<div class="refsect3">
1606
<a name="id-1.5.3.4.10.23.6"></a><h4>Parameters</h4>
1607
<div class="informaltable"><table width="100%" border="0">
1609
<col width="150px" class="parameters_name">
1610
<col class="parameters_description">
1611
<col width="200px" class="parameters_annotations">
1615
<td class="parameter_name"><p>self</p></td>
1616
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
1617
<td class="parameter_annotations"> </td>
1620
<td class="parameter_name"><p>wc</p></td>
1621
<td class="parameter_description"><p>a Unicode character, or 0 to unset the password character</p></td>
1622
<td class="parameter_annotations"> </td>
1627
<p class="since">Since 1.0</p>
1630
<div class="refsect2">
1631
<a name="clutter-text-get-password-char"></a><h3>clutter_text_get_password_char ()</h3>
1632
<pre class="programlisting"><span class="returnvalue">gunichar</span>
1633
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>
1634
<p>Retrieves the character to use in place of the actual text
1635
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>
1636
<div class="refsect3">
1637
<a name="id-1.5.3.4.10.24.5"></a><h4>Parameters</h4>
1638
<div class="informaltable"><table width="100%" border="0">
1640
<col width="150px" class="parameters_name">
1641
<col class="parameters_description">
1642
<col width="200px" class="parameters_annotations">
1645
<td class="parameter_name"><p>self</p></td>
1646
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
1647
<td class="parameter_annotations"> </td>
1651
<div class="refsect3">
1652
<a name="id-1.5.3.4.10.24.6"></a><h4>Returns</h4>
1653
<p> a Unicode character or 0 if the password
1654
character is not set</p>
1657
<p class="since">Since 1.0</p>
1660
<div class="refsect2">
1661
<a name="clutter-text-set-justify"></a><h3>clutter_text_set_justify ()</h3>
1662
<pre class="programlisting"><span class="returnvalue">void</span>
1663
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>,
1664
<em class="parameter"><code><span class="type">gboolean</span> justify</code></em>);</pre>
1665
<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
1080
1666
on both margins. This setting is ignored if Clutter is compiled
1081
against Pango < 1.18.
1083
<div class="variablelist"><table border="0" class="variablelist">
1667
against Pango &lt; 1.18.</p>
1668
<div class="refsect3">
1669
<a name="id-1.5.3.4.10.25.5"></a><h4>Parameters</h4>
1670
<div class="informaltable"><table width="100%" border="0">
1085
<col align="left" valign="top">
1672
<col width="150px" class="parameters_name">
1673
<col class="parameters_description">
1674
<col width="200px" class="parameters_annotations">
1090
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1091
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1678
<td class="parameter_name"><p>self</p></td>
1679
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
1680
<td class="parameter_annotations"> </td>
1095
<td><p><span class="term"><em class="parameter"><code>justify</code></em> :</span></p></td>
1096
<td>whether the text should be justified</td>
1683
<td class="parameter_name"><p>justify</p></td>
1684
<td class="parameter_description"><p>whether the text should be justified</p></td>
1685
<td class="parameter_annotations"> </td>
1100
1690
<p class="since">Since 1.0</p>
1103
1693
<div class="refsect2">
1104
<a name="clutter-text-get-justify"></a><h3>clutter_text_get_justify ()</h3>
1105
<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>
1107
Retrieves whether the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should justify its contents
1110
<div class="variablelist"><table border="0" class="variablelist">
1694
<a name="clutter-text-get-justify"></a><h3>clutter_text_get_justify ()</h3>
1695
<pre class="programlisting"><span class="returnvalue">gboolean</span>
1696
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>
1697
<p>Retrieves whether the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should justify its contents
1698
on both margins.</p>
1699
<div class="refsect3">
1700
<a name="id-1.5.3.4.10.26.5"></a><h4>Parameters</h4>
1701
<div class="informaltable"><table width="100%" border="0">
1112
<col align="left" valign="top">
1703
<col width="150px" class="parameters_name">
1704
<col class="parameters_description">
1705
<col width="200px" class="parameters_annotations">
1117
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1118
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1122
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1124
<code class="literal">TRUE</code> if the text should be justified</td>
1708
<td class="parameter_name"><p>self</p></td>
1709
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
1710
<td class="parameter_annotations"> </td>
1714
<div class="refsect3">
1715
<a name="id-1.5.3.4.10.26.6"></a><h4>Returns</h4>
1716
<p> <code class="literal">TRUE</code> if the text should be justified</p>
1128
1719
<p class="since">Since 0.6</p>
1131
1722
<div class="refsect2">
1132
<a name="clutter-text-get-layout"></a><h3>clutter_text_get_layout ()</h3>
1133
<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>
1135
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.
1137
<div class="variablelist"><table border="0" class="variablelist">
1723
<a name="clutter-text-get-layout"></a><h3>clutter_text_get_layout ()</h3>
1724
<pre class="programlisting"><span class="returnvalue">PangoLayout</span> *
1725
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>
1726
<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>
1727
<div class="refsect3">
1728
<a name="id-1.5.3.4.10.27.5"></a><h4>Parameters</h4>
1729
<div class="informaltable"><table width="100%" border="0">
1139
<col align="left" valign="top">
1731
<col width="150px" class="parameters_name">
1732
<col class="parameters_description">
1733
<col width="200px" class="parameters_annotations">
1144
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1145
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1149
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1150
<td>a <span class="type">PangoLayout</span>. The returned object is owned by
1151
the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor and should not be modified or freed. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
1736
<td class="parameter_name"><p>self</p></td>
1737
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
1738
<td class="parameter_annotations"> </td>
1742
<div class="refsect3">
1743
<a name="id-1.5.3.4.10.27.6"></a><h4>Returns</h4>
1744
<p> a <span class="type">PangoLayout</span>. The returned object is owned by
1745
the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor and should not be modified or freed. </p>
1746
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
1156
1748
<p class="since">Since 1.0</p>
1159
1751
<div class="refsect2">
1160
<a name="clutter-text-set-line-alignment"></a><h3>clutter_text_set_line_alignment ()</h3>
1161
<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>,
1162
<em class="parameter"><code><span class="type">PangoAlignment</span> alignment</code></em>);</pre>
1164
Sets the way that the lines of a wrapped label are aligned with
1752
<a name="clutter-text-set-line-alignment"></a><h3>clutter_text_set_line_alignment ()</h3>
1753
<pre class="programlisting"><span class="returnvalue">void</span>
1754
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>,
1755
<em class="parameter"><code><span class="type">PangoAlignment</span> alignment</code></em>);</pre>
1756
<p>Sets the way that the lines of a wrapped label are aligned with
1165
1757
respect to each other. This does not affect the overall alignment
1166
of the label within its allocated or specified width.
1169
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
1170
that supports alignment, or use the anchor point.
1172
<div class="variablelist"><table border="0" class="variablelist">
1174
<col align="left" valign="top">
1179
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1180
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1184
<td><p><span class="term"><em class="parameter"><code>alignment</code></em> :</span></p></td>
1185
<td>A <span class="type">PangoAlignment</span>
1190
<p class="since">Since 1.0</p>
1193
<div class="refsect2">
1194
<a name="clutter-text-get-line-alignment"></a><h3>clutter_text_get_line_alignment ()</h3>
1195
<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>
1197
Retrieves the alignment of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>, as set by
1198
<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>.
1200
<div class="variablelist"><table border="0" class="variablelist">
1202
<col align="left" valign="top">
1207
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1208
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1212
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1213
<td>a <span class="type">PangoAlignment</span>
1218
<p class="since">Since 1.0</p>
1221
<div class="refsect2">
1222
<a name="clutter-text-set-line-wrap"></a><h3>clutter_text_set_line_wrap ()</h3>
1223
<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>,
1224
<em class="parameter"><code><span class="type">gboolean</span> line_wrap</code></em>);</pre>
1226
Sets whether the contents of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should wrap,
1227
if they don't fit the size assigned to the actor.
1229
<div class="variablelist"><table border="0" class="variablelist">
1231
<col align="left" valign="top">
1236
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1237
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1241
<td><p><span class="term"><em class="parameter"><code>line_wrap</code></em> :</span></p></td>
1242
<td>whether the contents should wrap</td>
1246
<p class="since">Since 1.0</p>
1249
<div class="refsect2">
1250
<a name="clutter-text-get-line-wrap"></a><h3>clutter_text_get_line_wrap ()</h3>
1251
<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>
1253
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>.
1255
<div class="variablelist"><table border="0" class="variablelist">
1257
<col align="left" valign="top">
1262
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1263
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1267
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1269
<code class="literal">TRUE</code> if the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should wrap
1274
<p class="since">Since 1.0</p>
1277
<div class="refsect2">
1278
<a name="clutter-text-set-line-wrap-mode"></a><h3>clutter_text_set_line_wrap_mode ()</h3>
1279
<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>,
1280
<em class="parameter"><code><span class="type">PangoWrapMode</span> wrap_mode</code></em>);</pre>
1282
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
1758
of the label within its allocated or specified width.</p>
1759
<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
1760
that supports alignment, or use the anchor point.</p>
1761
<div class="refsect3">
1762
<a name="id-1.5.3.4.10.28.6"></a><h4>Parameters</h4>
1763
<div class="informaltable"><table width="100%" border="0">
1765
<col width="150px" class="parameters_name">
1766
<col class="parameters_description">
1767
<col width="200px" class="parameters_annotations">
1771
<td class="parameter_name"><p>self</p></td>
1772
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
1773
<td class="parameter_annotations"> </td>
1776
<td class="parameter_name"><p>alignment</p></td>
1777
<td class="parameter_description"><p>A <span class="type">PangoAlignment</span></p></td>
1778
<td class="parameter_annotations"> </td>
1783
<p class="since">Since 1.0</p>
1786
<div class="refsect2">
1787
<a name="clutter-text-get-line-alignment"></a><h3>clutter_text_get_line_alignment ()</h3>
1788
<pre class="programlisting"><span class="returnvalue">PangoAlignment</span>
1789
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>
1790
<p>Retrieves the alignment of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>, as set by
1791
<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>
1792
<div class="refsect3">
1793
<a name="id-1.5.3.4.10.29.5"></a><h4>Parameters</h4>
1794
<div class="informaltable"><table width="100%" border="0">
1796
<col width="150px" class="parameters_name">
1797
<col class="parameters_description">
1798
<col width="200px" class="parameters_annotations">
1801
<td class="parameter_name"><p>self</p></td>
1802
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
1803
<td class="parameter_annotations"> </td>
1807
<div class="refsect3">
1808
<a name="id-1.5.3.4.10.29.6"></a><h4>Returns</h4>
1809
<p> a <span class="type">PangoAlignment</span></p>
1812
<p class="since">Since 1.0</p>
1815
<div class="refsect2">
1816
<a name="clutter-text-set-line-wrap"></a><h3>clutter_text_set_line_wrap ()</h3>
1817
<pre class="programlisting"><span class="returnvalue">void</span>
1818
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>,
1819
<em class="parameter"><code><span class="type">gboolean</span> line_wrap</code></em>);</pre>
1820
<p>Sets whether the contents of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should wrap,
1821
if they don't fit the size assigned to the actor.</p>
1822
<div class="refsect3">
1823
<a name="id-1.5.3.4.10.30.5"></a><h4>Parameters</h4>
1824
<div class="informaltable"><table width="100%" border="0">
1826
<col width="150px" class="parameters_name">
1827
<col class="parameters_description">
1828
<col width="200px" class="parameters_annotations">
1832
<td class="parameter_name"><p>self</p></td>
1833
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
1834
<td class="parameter_annotations"> </td>
1837
<td class="parameter_name"><p>line_wrap</p></td>
1838
<td class="parameter_description"><p>whether the contents should wrap</p></td>
1839
<td class="parameter_annotations"> </td>
1844
<p class="since">Since 1.0</p>
1847
<div class="refsect2">
1848
<a name="clutter-text-get-line-wrap"></a><h3>clutter_text_get_line_wrap ()</h3>
1849
<pre class="programlisting"><span class="returnvalue">gboolean</span>
1850
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>
1851
<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>
1852
<div class="refsect3">
1853
<a name="id-1.5.3.4.10.31.5"></a><h4>Parameters</h4>
1854
<div class="informaltable"><table width="100%" border="0">
1856
<col width="150px" class="parameters_name">
1857
<col class="parameters_description">
1858
<col width="200px" class="parameters_annotations">
1861
<td class="parameter_name"><p>self</p></td>
1862
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
1863
<td class="parameter_annotations"> </td>
1867
<div class="refsect3">
1868
<a name="id-1.5.3.4.10.31.6"></a><h4>Returns</h4>
1869
<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
1873
<p class="since">Since 1.0</p>
1876
<div class="refsect2">
1877
<a name="clutter-text-set-line-wrap-mode"></a><h3>clutter_text_set_line_wrap_mode ()</h3>
1878
<pre class="programlisting"><span class="returnvalue">void</span>
1879
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>,
1880
<em class="parameter"><code><span class="type">PangoWrapMode</span> wrap_mode</code></em>);</pre>
1881
<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
1283
1882
function controls how the line wrapping is performed. The default is
1284
<code class="literal">PANGO_WRAP_WORD</code> which means wrap on word boundaries.
1286
<div class="variablelist"><table border="0" class="variablelist">
1288
<col align="left" valign="top">
1293
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1294
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1298
<td><p><span class="term"><em class="parameter"><code>wrap_mode</code></em> :</span></p></td>
1299
<td>the line wrapping mode</td>
1303
<p class="since">Since 1.0</p>
1306
<div class="refsect2">
1307
<a name="clutter-text-get-line-wrap-mode"></a><h3>clutter_text_get_line_wrap_mode ()</h3>
1308
<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>
1310
Retrieves the line wrap mode used by the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.
1313
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>.
1315
<div class="variablelist"><table border="0" class="variablelist">
1317
<col align="left" valign="top">
1322
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1323
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1327
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1328
<td>the wrap mode used by the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1333
<p class="since">Since 1.0</p>
1336
<div class="refsect2">
1337
<a name="clutter-text-set-max-length"></a><h3>clutter_text_set_max_length ()</h3>
1338
<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>,
1339
<em class="parameter"><code><span class="type">gint</span> max</code></em>);</pre>
1341
Sets the maximum allowed length of the contents of the actor. If the
1883
<code class="literal">PANGO_WRAP_WORD</code> which means wrap on word boundaries.</p>
1884
<div class="refsect3">
1885
<a name="id-1.5.3.4.10.32.5"></a><h4>Parameters</h4>
1886
<div class="informaltable"><table width="100%" border="0">
1888
<col width="150px" class="parameters_name">
1889
<col class="parameters_description">
1890
<col width="200px" class="parameters_annotations">
1894
<td class="parameter_name"><p>self</p></td>
1895
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
1896
<td class="parameter_annotations"> </td>
1899
<td class="parameter_name"><p>wrap_mode</p></td>
1900
<td class="parameter_description"><p>the line wrapping mode</p></td>
1901
<td class="parameter_annotations"> </td>
1906
<p class="since">Since 1.0</p>
1909
<div class="refsect2">
1910
<a name="clutter-text-get-line-wrap-mode"></a><h3>clutter_text_get_line_wrap_mode ()</h3>
1911
<pre class="programlisting"><span class="returnvalue">PangoWrapMode</span>
1912
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>
1913
<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>
1914
<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>
1915
<div class="refsect3">
1916
<a name="id-1.5.3.4.10.33.6"></a><h4>Parameters</h4>
1917
<div class="informaltable"><table width="100%" border="0">
1919
<col width="150px" class="parameters_name">
1920
<col class="parameters_description">
1921
<col width="200px" class="parameters_annotations">
1924
<td class="parameter_name"><p>self</p></td>
1925
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
1926
<td class="parameter_annotations"> </td>
1930
<div class="refsect3">
1931
<a name="id-1.5.3.4.10.33.7"></a><h4>Returns</h4>
1932
<p> the wrap mode used by the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p>
1935
<p class="since">Since 1.0</p>
1938
<div class="refsect2">
1939
<a name="clutter-text-set-max-length"></a><h3>clutter_text_set_max_length ()</h3>
1940
<pre class="programlisting"><span class="returnvalue">void</span>
1941
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>,
1942
<em class="parameter"><code><span class="type">gint</span> max</code></em>);</pre>
1943
<p>Sets the maximum allowed length of the contents of the actor. If the
1342
1944
current contents are longer than the given length, then they will be
1345
<div class="variablelist"><table border="0" class="variablelist">
1347
<col align="left" valign="top">
1352
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1353
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1357
<td><p><span class="term"><em class="parameter"><code>max</code></em> :</span></p></td>
1358
<td>the maximum number of characters allowed in the text actor; 0
1359
to disable or -1 to set the length of the current string</td>
1363
<p class="since">Since 1.0</p>
1366
<div class="refsect2">
1367
<a name="clutter-text-get-max-length"></a><h3>clutter_text_get_max_length ()</h3>
1368
<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>
1370
Gets the maximum length of text that can be set into a text actor.
1373
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>.
1375
<div class="variablelist"><table border="0" class="variablelist">
1377
<col align="left" valign="top">
1382
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1383
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1387
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1388
<td>the maximum number of characters.</td>
1392
<p class="since">Since 1.0</p>
1395
<div class="refsect2">
1396
<a name="clutter-text-set-selectable"></a><h3>clutter_text_set_selectable ()</h3>
1397
<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>,
1398
<em class="parameter"><code><span class="type">gboolean</span> selectable</code></em>);</pre>
1400
Sets whether a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should be selectable.
1403
A selectable <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> will allow selecting its contents using
1404
the pointer or the keyboard.
1406
<div class="variablelist"><table border="0" class="variablelist">
1408
<col align="left" valign="top">
1413
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1414
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1418
<td><p><span class="term"><em class="parameter"><code>selectable</code></em> :</span></p></td>
1419
<td>whether the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should be selectable</td>
1423
<p class="since">Since 1.0</p>
1426
<div class="refsect2">
1427
<a name="clutter-text-get-selectable"></a><h3>clutter_text_get_selectable ()</h3>
1428
<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>
1430
Retrieves whether a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> is selectable or not.
1432
<div class="variablelist"><table border="0" class="variablelist">
1434
<col align="left" valign="top">
1439
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1440
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1444
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1446
<code class="literal">TRUE</code> if the actor is selectable</td>
1450
<p class="since">Since 1.0</p>
1453
<div class="refsect2">
1454
<a name="clutter-text-set-selection"></a><h3>clutter_text_set_selection ()</h3>
1455
<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>,
1456
<em class="parameter"><code><span class="type">gssize</span> start_pos</code></em>,
1457
<em class="parameter"><code><span class="type">gssize</span> end_pos</code></em>);</pre>
1459
Selects the region of text between <em class="parameter"><code>start_pos</code></em> and <em class="parameter"><code>end_pos</code></em>.
1462
This function changes the position of the cursor to match
1463
<em class="parameter"><code>start_pos</code></em> and the selection bound to match <em class="parameter"><code>end_pos</code></em>.
1465
<div class="variablelist"><table border="0" class="variablelist">
1467
<col align="left" valign="top">
1472
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1473
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1477
<td><p><span class="term"><em class="parameter"><code>start_pos</code></em> :</span></p></td>
1478
<td>start of the selection, in characters</td>
1481
<td><p><span class="term"><em class="parameter"><code>end_pos</code></em> :</span></p></td>
1482
<td>end of the selection, in characters</td>
1486
<p class="since">Since 1.0</p>
1489
<div class="refsect2">
1490
<a name="clutter-text-get-selection"></a><h3>clutter_text_get_selection ()</h3>
1491
<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>
1493
Retrieves the currently selected text.
1495
<div class="variablelist"><table border="0" class="variablelist">
1497
<col align="left" valign="top">
1502
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1503
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1507
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1508
<td>a newly allocated string containing the currently
1945
truncated to fit.</p>
1946
<div class="refsect3">
1947
<a name="id-1.5.3.4.10.34.5"></a><h4>Parameters</h4>
1948
<div class="informaltable"><table width="100%" border="0">
1950
<col width="150px" class="parameters_name">
1951
<col class="parameters_description">
1952
<col width="200px" class="parameters_annotations">
1956
<td class="parameter_name"><p>self</p></td>
1957
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
1958
<td class="parameter_annotations"> </td>
1961
<td class="parameter_name"><p>max</p></td>
1962
<td class="parameter_description"><p>the maximum number of characters allowed in the text actor; 0
1963
to disable or -1 to set the length of the current string</p></td>
1964
<td class="parameter_annotations"> </td>
1969
<p class="since">Since 1.0</p>
1972
<div class="refsect2">
1973
<a name="clutter-text-get-max-length"></a><h3>clutter_text_get_max_length ()</h3>
1974
<pre class="programlisting"><span class="returnvalue">gint</span>
1975
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>
1976
<p>Gets the maximum length of text that can be set into a text actor.</p>
1977
<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>
1978
<div class="refsect3">
1979
<a name="id-1.5.3.4.10.35.6"></a><h4>Parameters</h4>
1980
<div class="informaltable"><table width="100%" border="0">
1982
<col width="150px" class="parameters_name">
1983
<col class="parameters_description">
1984
<col width="200px" class="parameters_annotations">
1987
<td class="parameter_name"><p>self</p></td>
1988
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
1989
<td class="parameter_annotations"> </td>
1993
<div class="refsect3">
1994
<a name="id-1.5.3.4.10.35.7"></a><h4>Returns</h4>
1995
<p> the maximum number of characters.</p>
1998
<p class="since">Since 1.0</p>
2001
<div class="refsect2">
2002
<a name="clutter-text-set-selectable"></a><h3>clutter_text_set_selectable ()</h3>
2003
<pre class="programlisting"><span class="returnvalue">void</span>
2004
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>,
2005
<em class="parameter"><code><span class="type">gboolean</span> selectable</code></em>);</pre>
2006
<p>Sets whether a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should be selectable.</p>
2007
<p>A selectable <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> will allow selecting its contents using
2008
the pointer or the keyboard.</p>
2009
<div class="refsect3">
2010
<a name="id-1.5.3.4.10.36.6"></a><h4>Parameters</h4>
2011
<div class="informaltable"><table width="100%" border="0">
2013
<col width="150px" class="parameters_name">
2014
<col class="parameters_description">
2015
<col width="200px" class="parameters_annotations">
2019
<td class="parameter_name"><p>self</p></td>
2020
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
2021
<td class="parameter_annotations"> </td>
2024
<td class="parameter_name"><p>selectable</p></td>
2025
<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>
2026
<td class="parameter_annotations"> </td>
2031
<p class="since">Since 1.0</p>
2034
<div class="refsect2">
2035
<a name="clutter-text-get-selectable"></a><h3>clutter_text_get_selectable ()</h3>
2036
<pre class="programlisting"><span class="returnvalue">gboolean</span>
2037
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>
2038
<p>Retrieves whether a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> is selectable or not.</p>
2039
<div class="refsect3">
2040
<a name="id-1.5.3.4.10.37.5"></a><h4>Parameters</h4>
2041
<div class="informaltable"><table width="100%" border="0">
2043
<col width="150px" class="parameters_name">
2044
<col class="parameters_description">
2045
<col width="200px" class="parameters_annotations">
2048
<td class="parameter_name"><p>self</p></td>
2049
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
2050
<td class="parameter_annotations"> </td>
2054
<div class="refsect3">
2055
<a name="id-1.5.3.4.10.37.6"></a><h4>Returns</h4>
2056
<p> <code class="literal">TRUE</code> if the actor is selectable</p>
2059
<p class="since">Since 1.0</p>
2062
<div class="refsect2">
2063
<a name="clutter-text-set-selection"></a><h3>clutter_text_set_selection ()</h3>
2064
<pre class="programlisting"><span class="returnvalue">void</span>
2065
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>,
2066
<em class="parameter"><code><span class="type">gssize</span> start_pos</code></em>,
2067
<em class="parameter"><code><span class="type">gssize</span> end_pos</code></em>);</pre>
2068
<p>Selects the region of text between <em class="parameter"><code>start_pos</code></em>
2069
and <em class="parameter"><code>end_pos</code></em>
2071
<p>This function changes the position of the cursor to match
2072
<em class="parameter"><code>start_pos</code></em>
2073
and the selection bound to match <em class="parameter"><code>end_pos</code></em>
2075
<div class="refsect3">
2076
<a name="id-1.5.3.4.10.38.6"></a><h4>Parameters</h4>
2077
<div class="informaltable"><table width="100%" border="0">
2079
<col width="150px" class="parameters_name">
2080
<col class="parameters_description">
2081
<col width="200px" class="parameters_annotations">
2085
<td class="parameter_name"><p>self</p></td>
2086
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
2087
<td class="parameter_annotations"> </td>
2090
<td class="parameter_name"><p>start_pos</p></td>
2091
<td class="parameter_description"><p>start of the selection, in characters</p></td>
2092
<td class="parameter_annotations"> </td>
2095
<td class="parameter_name"><p>end_pos</p></td>
2096
<td class="parameter_description"><p>end of the selection, in characters</p></td>
2097
<td class="parameter_annotations"> </td>
2102
<p class="since">Since 1.0</p>
2105
<div class="refsect2">
2106
<a name="clutter-text-get-selection"></a><h3>clutter_text_get_selection ()</h3>
2107
<pre class="programlisting"><span class="returnvalue">gchar</span> *
2108
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>
2109
<p>Retrieves the currently selected text.</p>
2110
<div class="refsect3">
2111
<a name="id-1.5.3.4.10.39.5"></a><h4>Parameters</h4>
2112
<div class="informaltable"><table width="100%" border="0">
2114
<col width="150px" class="parameters_name">
2115
<col class="parameters_description">
2116
<col width="200px" class="parameters_annotations">
2119
<td class="parameter_name"><p>self</p></td>
2120
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
2121
<td class="parameter_annotations"> </td>
2125
<div class="refsect3">
2126
<a name="id-1.5.3.4.10.39.6"></a><h4>Returns</h4>
2127
<p> a newly allocated string containing the currently
1509
2128
selected text, or <code class="literal">NULL</code>. Use <code class="function">g_free()</code> to free the returned
1514
<p class="since">Since 1.0</p>
1517
<div class="refsect2">
1518
<a name="clutter-text-set-selection-bound"></a><h3>clutter_text_set_selection_bound ()</h3>
1519
<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>,
1520
<em class="parameter"><code><span class="type">gint</span> selection_bound</code></em>);</pre>
1522
Sets the other end of the selection, starting from the current
1526
If <em class="parameter"><code>selection_bound</code></em> is -1, the selection unset.
1528
<div class="variablelist"><table border="0" class="variablelist">
1530
<col align="left" valign="top">
1535
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1536
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1540
<td><p><span class="term"><em class="parameter"><code>selection_bound</code></em> :</span></p></td>
1541
<td>the position of the end of the selection, in characters</td>
1545
<p class="since">Since 1.0</p>
1548
<div class="refsect2">
1549
<a name="clutter-text-get-selection-bound"></a><h3>clutter_text_get_selection_bound ()</h3>
1550
<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>
1552
Retrieves the other end of the selection of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor,
1553
in characters from the current cursor position.
1555
<div class="variablelist"><table border="0" class="variablelist">
1557
<col align="left" valign="top">
1562
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1563
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1567
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1568
<td>the position of the other end of the selection</td>
1572
<p class="since">Since 1.0</p>
1575
<div class="refsect2">
1576
<a name="clutter-text-set-single-line-mode"></a><h3>clutter_text_set_single_line_mode ()</h3>
1577
<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>,
1578
<em class="parameter"><code><span class="type">gboolean</span> single_line</code></em>);</pre>
1580
Sets whether a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should be in single line mode
1581
or not. Only editable <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>s can be in single line
1585
A text actor in single line mode will not wrap text and will clip
2132
<p class="since">Since 1.0</p>
2135
<div class="refsect2">
2136
<a name="clutter-text-set-selection-bound"></a><h3>clutter_text_set_selection_bound ()</h3>
2137
<pre class="programlisting"><span class="returnvalue">void</span>
2138
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>,
2139
<em class="parameter"><code><span class="type">gint</span> selection_bound</code></em>);</pre>
2140
<p>Sets the other end of the selection, starting from the current
2141
cursor position.</p>
2142
<p>If <em class="parameter"><code>selection_bound</code></em>
2143
is -1, the selection unset.</p>
2144
<div class="refsect3">
2145
<a name="id-1.5.3.4.10.40.6"></a><h4>Parameters</h4>
2146
<div class="informaltable"><table width="100%" border="0">
2148
<col width="150px" class="parameters_name">
2149
<col class="parameters_description">
2150
<col width="200px" class="parameters_annotations">
2154
<td class="parameter_name"><p>self</p></td>
2155
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
2156
<td class="parameter_annotations"> </td>
2159
<td class="parameter_name"><p>selection_bound</p></td>
2160
<td class="parameter_description"><p>the position of the end of the selection, in characters</p></td>
2161
<td class="parameter_annotations"> </td>
2166
<p class="since">Since 1.0</p>
2169
<div class="refsect2">
2170
<a name="clutter-text-get-selection-bound"></a><h3>clutter_text_get_selection_bound ()</h3>
2171
<pre class="programlisting"><span class="returnvalue">gint</span>
2172
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>
2173
<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,
2174
in characters from the current cursor position.</p>
2175
<div class="refsect3">
2176
<a name="id-1.5.3.4.10.41.5"></a><h4>Parameters</h4>
2177
<div class="informaltable"><table width="100%" border="0">
2179
<col width="150px" class="parameters_name">
2180
<col class="parameters_description">
2181
<col width="200px" class="parameters_annotations">
2184
<td class="parameter_name"><p>self</p></td>
2185
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
2186
<td class="parameter_annotations"> </td>
2190
<div class="refsect3">
2191
<a name="id-1.5.3.4.10.41.6"></a><h4>Returns</h4>
2192
<p> the position of the other end of the selection</p>
2195
<p class="since">Since 1.0</p>
2198
<div class="refsect2">
2199
<a name="clutter-text-set-single-line-mode"></a><h3>clutter_text_set_single_line_mode ()</h3>
2200
<pre class="programlisting"><span class="returnvalue">void</span>
2201
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>,
2202
<em class="parameter"><code><span class="type">gboolean</span> single_line</code></em>);</pre>
2203
<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
2204
or not. Only editable <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a><!-- -->s can be in single line
2206
<p>A text actor in single line mode will not wrap text and will clip
1586
2207
the visible area to the predefined size. The contents of the
1587
2208
text actor will scroll to display the end of the text if its length
1588
is bigger than the allocated width.
1591
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>
2209
is bigger than the allocated width.</p>
2210
<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>
1592
2211
property is also set as a side effect. Instead of entering a new
1593
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>
1596
<div class="variablelist"><table border="0" class="variablelist">
1598
<col align="left" valign="top">
1603
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1604
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1608
<td><p><span class="term"><em class="parameter"><code>single_line</code></em> :</span></p></td>
1609
<td>whether to enable single line mode</td>
1613
<p class="since">Since 1.0</p>
1616
<div class="refsect2">
1617
<a name="clutter-text-get-single-line-mode"></a><h3>clutter_text_get_single_line_mode ()</h3>
1618
<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>
1620
Retrieves whether the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor is in single line mode.
1622
<div class="variablelist"><table border="0" class="variablelist">
1624
<col align="left" valign="top">
1629
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1630
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1634
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1636
<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</td>
1640
<p class="since">Since 1.0</p>
1643
<div class="refsect2">
1644
<a name="clutter-text-set-use-markup"></a><h3>clutter_text_set_use_markup ()</h3>
1645
<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>,
1646
<em class="parameter"><code><span class="type">gboolean</span> setting</code></em>);</pre>
1648
Sets whether the contents of the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor contains markup
1649
in Pango's text markup language.
1652
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
1653
not have any effect except hiding the markup.
1656
See also <a class="link" href="ClutterText.html#ClutterText--use-markup" title='The "use-markup" property'><span class="type">"use-markup"</span></a>.
1658
<div class="variablelist"><table border="0" class="variablelist">
1660
<col align="left" valign="top">
1665
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1666
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1670
<td><p><span class="term"><em class="parameter"><code>setting</code></em> :</span></p></td>
1672
<code class="literal">TRUE</code> if the text should be parsed for markup.</td>
1676
<p class="since">Since 1.0</p>
1679
<div class="refsect2">
1680
<a name="clutter-text-get-use-markup"></a><h3>clutter_text_get_use_markup ()</h3>
1681
<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>
1683
Retrieves whether the contents of the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should be
1684
parsed for the Pango text markup.
1686
<div class="variablelist"><table border="0" class="variablelist">
1688
<col align="left" valign="top">
1693
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1694
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1698
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1700
<code class="literal">TRUE</code> if the contents will be parsed for markup</td>
1704
<p class="since">Since 1.0</p>
1707
<div class="refsect2">
1708
<a name="clutter-text-set-editable"></a><h3>clutter_text_set_editable ()</h3>
1709
<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>,
1710
<em class="parameter"><code><span class="type">gboolean</span> editable</code></em>);</pre>
1712
Sets whether the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should be editable.
1715
An editable <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> with key focus set using
1716
<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>
1717
will receive key events and will update its contents accordingly.
1719
<div class="variablelist"><table border="0" class="variablelist">
1721
<col align="left" valign="top">
1726
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1727
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1731
<td><p><span class="term"><em class="parameter"><code>editable</code></em> :</span></p></td>
1732
<td>whether the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> should be editable</td>
1736
<p class="since">Since 1.0</p>
1739
<div class="refsect2">
1740
<a name="clutter-text-get-editable"></a><h3>clutter_text_get_editable ()</h3>
1741
<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>
1743
Retrieves whether a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> is editable or not.
1745
<div class="variablelist"><table border="0" class="variablelist">
1747
<col align="left" valign="top">
1752
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1753
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1757
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1759
<code class="literal">TRUE</code> if the actor is editable</td>
1763
<p class="since">Since 1.0</p>
1766
<div class="refsect2">
1767
<a name="clutter-text-insert-text"></a><h3>clutter_text_insert_text ()</h3>
1768
<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>,
1769
<em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>,
1770
<em class="parameter"><code><span class="type">gssize</span> position</code></em>);</pre>
1772
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.
1775
If <em class="parameter"><code>position</code></em> is a negative number, the text will be appended
1776
at the end of the current contents of the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>.
1779
The position is expressed in characters, not in bytes.
1781
<div class="variablelist"><table border="0" class="variablelist">
1783
<col align="left" valign="top">
1788
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1789
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1793
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
1794
<td>the text to be inserted</td>
1797
<td><p><span class="term"><em class="parameter"><code>position</code></em> :</span></p></td>
1798
<td>the position of the insertion, or -1</td>
1802
<p class="since">Since 1.0</p>
1805
<div class="refsect2">
1806
<a name="clutter-text-insert-unichar"></a><h3>clutter_text_insert_unichar ()</h3>
1807
<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>,
1808
<em class="parameter"><code><span class="type">gunichar</span> wc</code></em>);</pre>
1810
Inserts <em class="parameter"><code>wc</code></em> at the current cursor position of a
1811
<a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.
1813
<div class="variablelist"><table border="0" class="variablelist">
1815
<col align="left" valign="top">
1820
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1821
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1825
<td><p><span class="term"><em class="parameter"><code>wc</code></em> :</span></p></td>
1826
<td>a Unicode character</td>
1830
<p class="since">Since 1.0</p>
1833
<div class="refsect2">
1834
<a name="clutter-text-delete-chars"></a><h3>clutter_text_delete_chars ()</h3>
1835
<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>,
1836
<em class="parameter"><code><span class="type">guint</span> n_chars</code></em>);</pre>
1838
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
1839
current cursor position.
1842
Somewhat awkwardly, the cursor position is decremented by the same
1843
number of characters you've deleted.
1845
<div class="variablelist"><table border="0" class="variablelist">
1847
<col align="left" valign="top">
1852
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1853
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1857
<td><p><span class="term"><em class="parameter"><code>n_chars</code></em> :</span></p></td>
1858
<td>the number of characters to delete</td>
1862
<p class="since">Since 1.0</p>
1865
<div class="refsect2">
1866
<a name="clutter-text-delete-text"></a><h3>clutter_text_delete_text ()</h3>
1867
<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>,
1868
<em class="parameter"><code><span class="type">gssize</span> start_pos</code></em>,
1869
<em class="parameter"><code><span class="type">gssize</span> end_pos</code></em>);</pre>
1871
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>
1872
and <em class="parameter"><code>end_pos</code></em>.
1875
The starting and ending positions are expressed in characters,
1878
<div class="variablelist"><table border="0" class="variablelist">
1880
<col align="left" valign="top">
1885
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1886
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1890
<td><p><span class="term"><em class="parameter"><code>start_pos</code></em> :</span></p></td>
1891
<td>starting position</td>
1894
<td><p><span class="term"><em class="parameter"><code>end_pos</code></em> :</span></p></td>
1895
<td>ending position</td>
1899
<p class="since">Since 1.0</p>
1902
<div class="refsect2">
1903
<a name="clutter-text-delete-selection"></a><h3>clutter_text_delete_selection ()</h3>
1904
<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>
1906
Deletes the currently selected text
1909
This function is only useful in subclasses of <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1911
<div class="variablelist"><table border="0" class="variablelist">
1913
<col align="left" valign="top">
1918
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1919
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1923
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1925
<code class="literal">TRUE</code> if text was deleted or if the text actor
1926
is empty, and <code class="literal">FALSE</code> otherwise</td>
1930
<p class="since">Since 1.0</p>
1933
<div class="refsect2">
1934
<a name="clutter-text-get-chars"></a><h3>clutter_text_get_chars ()</h3>
1935
<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>,
1936
<em class="parameter"><code><span class="type">gssize</span> start_pos</code></em>,
1937
<em class="parameter"><code><span class="type">gssize</span> end_pos</code></em>);</pre>
1939
Retrieves the contents of the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor between
1940
<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>.
1943
The positions are specified in characters, not in bytes.
1945
<div class="variablelist"><table border="0" class="variablelist">
1947
<col align="left" valign="top">
1952
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1953
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1957
<td><p><span class="term"><em class="parameter"><code>start_pos</code></em> :</span></p></td>
1958
<td>start of text, in characters</td>
1961
<td><p><span class="term"><em class="parameter"><code>end_pos</code></em> :</span></p></td>
1962
<td>end of text, in characters</td>
1965
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1966
<td>a newly allocated string with the contents of
2212
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>
2214
<div class="refsect3">
2215
<a name="id-1.5.3.4.10.42.7"></a><h4>Parameters</h4>
2216
<div class="informaltable"><table width="100%" border="0">
2218
<col width="150px" class="parameters_name">
2219
<col class="parameters_description">
2220
<col width="200px" class="parameters_annotations">
2224
<td class="parameter_name"><p>self</p></td>
2225
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
2226
<td class="parameter_annotations"> </td>
2229
<td class="parameter_name"><p>single_line</p></td>
2230
<td class="parameter_description"><p>whether to enable single line mode</p></td>
2231
<td class="parameter_annotations"> </td>
2236
<p class="since">Since 1.0</p>
2239
<div class="refsect2">
2240
<a name="clutter-text-get-single-line-mode"></a><h3>clutter_text_get_single_line_mode ()</h3>
2241
<pre class="programlisting"><span class="returnvalue">gboolean</span>
2242
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>
2243
<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>
2244
<div class="refsect3">
2245
<a name="id-1.5.3.4.10.43.5"></a><h4>Parameters</h4>
2246
<div class="informaltable"><table width="100%" border="0">
2248
<col width="150px" class="parameters_name">
2249
<col class="parameters_description">
2250
<col width="200px" class="parameters_annotations">
2253
<td class="parameter_name"><p>self</p></td>
2254
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
2255
<td class="parameter_annotations"> </td>
2259
<div class="refsect3">
2260
<a name="id-1.5.3.4.10.43.6"></a><h4>Returns</h4>
2261
<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>
2264
<p class="since">Since 1.0</p>
2267
<div class="refsect2">
2268
<a name="clutter-text-set-use-markup"></a><h3>clutter_text_set_use_markup ()</h3>
2269
<pre class="programlisting"><span class="returnvalue">void</span>
2270
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>,
2271
<em class="parameter"><code><span class="type">gboolean</span> setting</code></em>);</pre>
2272
<p>Sets whether the contents of the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor contains markup
2273
in <link linkend="PangoMarkupFormat">Pango's text markup language</link>.</p>
2274
<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
2275
not have any effect except hiding the markup.</p>
2276
<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>
2277
<div class="refsect3">
2278
<a name="id-1.5.3.4.10.44.7"></a><h4>Parameters</h4>
2279
<div class="informaltable"><table width="100%" border="0">
2281
<col width="150px" class="parameters_name">
2282
<col class="parameters_description">
2283
<col width="200px" class="parameters_annotations">
2287
<td class="parameter_name"><p>self</p></td>
2288
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
2289
<td class="parameter_annotations"> </td>
2292
<td class="parameter_name"><p>setting</p></td>
2293
<td class="parameter_description"><p><code class="literal">TRUE</code> if the text should be parsed for markup.</p></td>
2294
<td class="parameter_annotations"> </td>
2299
<p class="since">Since 1.0</p>
2302
<div class="refsect2">
2303
<a name="clutter-text-get-use-markup"></a><h3>clutter_text_get_use_markup ()</h3>
2304
<pre class="programlisting"><span class="returnvalue">gboolean</span>
2305
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>
2306
<p>Retrieves whether the contents of the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should be
2307
parsed for the Pango text markup.</p>
2308
<div class="refsect3">
2309
<a name="id-1.5.3.4.10.45.5"></a><h4>Parameters</h4>
2310
<div class="informaltable"><table width="100%" border="0">
2312
<col width="150px" class="parameters_name">
2313
<col class="parameters_description">
2314
<col width="200px" class="parameters_annotations">
2317
<td class="parameter_name"><p>self</p></td>
2318
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
2319
<td class="parameter_annotations"> </td>
2323
<div class="refsect3">
2324
<a name="id-1.5.3.4.10.45.6"></a><h4>Returns</h4>
2325
<p> <code class="literal">TRUE</code> if the contents will be parsed for markup</p>
2328
<p class="since">Since 1.0</p>
2331
<div class="refsect2">
2332
<a name="clutter-text-set-editable"></a><h3>clutter_text_set_editable ()</h3>
2333
<pre class="programlisting"><span class="returnvalue">void</span>
2334
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>,
2335
<em class="parameter"><code><span class="type">gboolean</span> editable</code></em>);</pre>
2336
<p>Sets whether the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should be editable.</p>
2337
<p>An editable <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> with key focus set using
2338
<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>
2339
will receive key events and will update its contents accordingly.</p>
2340
<div class="refsect3">
2341
<a name="id-1.5.3.4.10.46.6"></a><h4>Parameters</h4>
2342
<div class="informaltable"><table width="100%" border="0">
2344
<col width="150px" class="parameters_name">
2345
<col class="parameters_description">
2346
<col width="200px" class="parameters_annotations">
2350
<td class="parameter_name"><p>self</p></td>
2351
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
2352
<td class="parameter_annotations"> </td>
2355
<td class="parameter_name"><p>editable</p></td>
2356
<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>
2357
<td class="parameter_annotations"> </td>
2362
<p class="since">Since 1.0</p>
2365
<div class="refsect2">
2366
<a name="clutter-text-get-editable"></a><h3>clutter_text_get_editable ()</h3>
2367
<pre class="programlisting"><span class="returnvalue">gboolean</span>
2368
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>
2369
<p>Retrieves whether a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> is editable or not.</p>
2370
<div class="refsect3">
2371
<a name="id-1.5.3.4.10.47.5"></a><h4>Parameters</h4>
2372
<div class="informaltable"><table width="100%" border="0">
2374
<col width="150px" class="parameters_name">
2375
<col class="parameters_description">
2376
<col width="200px" class="parameters_annotations">
2379
<td class="parameter_name"><p>self</p></td>
2380
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
2381
<td class="parameter_annotations"> </td>
2385
<div class="refsect3">
2386
<a name="id-1.5.3.4.10.47.6"></a><h4>Returns</h4>
2387
<p> <code class="literal">TRUE</code> if the actor is editable</p>
2390
<p class="since">Since 1.0</p>
2393
<div class="refsect2">
2394
<a name="clutter-text-insert-text"></a><h3>clutter_text_insert_text ()</h3>
2395
<pre class="programlisting"><span class="returnvalue">void</span>
2396
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>,
2397
<em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>,
2398
<em class="parameter"><code><span class="type">gssize</span> position</code></em>);</pre>
2399
<p>Inserts <em class="parameter"><code>text</code></em>
2400
into a <a class="link" href="ClutterActor.html" title="ClutterActor"><span class="type">ClutterActor</span></a> at the given position.</p>
2401
<p>If <em class="parameter"><code>position</code></em>
2402
is a negative number, the text will be appended
2403
at the end of the current contents of the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>.</p>
2404
<p>The position is expressed in characters, not in bytes.</p>
2405
<div class="refsect3">
2406
<a name="id-1.5.3.4.10.48.7"></a><h4>Parameters</h4>
2407
<div class="informaltable"><table width="100%" border="0">
2409
<col width="150px" class="parameters_name">
2410
<col class="parameters_description">
2411
<col width="200px" class="parameters_annotations">
2415
<td class="parameter_name"><p>self</p></td>
2416
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
2417
<td class="parameter_annotations"> </td>
2420
<td class="parameter_name"><p>text</p></td>
2421
<td class="parameter_description"><p>the text to be inserted</p></td>
2422
<td class="parameter_annotations"> </td>
2425
<td class="parameter_name"><p>position</p></td>
2426
<td class="parameter_description"><p>the position of the insertion, or -1</p></td>
2427
<td class="parameter_annotations"> </td>
2432
<p class="since">Since 1.0</p>
2435
<div class="refsect2">
2436
<a name="clutter-text-insert-unichar"></a><h3>clutter_text_insert_unichar ()</h3>
2437
<pre class="programlisting"><span class="returnvalue">void</span>
2438
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>,
2439
<em class="parameter"><code><span class="type">gunichar</span> wc</code></em>);</pre>
2440
<p>Inserts <em class="parameter"><code>wc</code></em>
2441
at the current cursor position of a
2442
<a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.</p>
2443
<div class="refsect3">
2444
<a name="id-1.5.3.4.10.49.5"></a><h4>Parameters</h4>
2445
<div class="informaltable"><table width="100%" border="0">
2447
<col width="150px" class="parameters_name">
2448
<col class="parameters_description">
2449
<col width="200px" class="parameters_annotations">
2453
<td class="parameter_name"><p>self</p></td>
2454
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
2455
<td class="parameter_annotations"> </td>
2458
<td class="parameter_name"><p>wc</p></td>
2459
<td class="parameter_description"><p>a Unicode character</p></td>
2460
<td class="parameter_annotations"> </td>
2465
<p class="since">Since 1.0</p>
2468
<div class="refsect2">
2469
<a name="clutter-text-delete-chars"></a><h3>clutter_text_delete_chars ()</h3>
2470
<pre class="programlisting"><span class="returnvalue">void</span>
2471
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>,
2472
<em class="parameter"><code><span class="type">guint</span> n_chars</code></em>);</pre>
2473
<p>Deletes <em class="parameter"><code>n_chars</code></em>
2474
inside a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor, starting from the
2475
current cursor position.</p>
2476
<p>Somewhat awkwardly, the cursor position is decremented by the same
2477
number of characters you've deleted.</p>
2478
<div class="refsect3">
2479
<a name="id-1.5.3.4.10.50.6"></a><h4>Parameters</h4>
2480
<div class="informaltable"><table width="100%" border="0">
2482
<col width="150px" class="parameters_name">
2483
<col class="parameters_description">
2484
<col width="200px" class="parameters_annotations">
2488
<td class="parameter_name"><p>self</p></td>
2489
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
2490
<td class="parameter_annotations"> </td>
2493
<td class="parameter_name"><p>n_chars</p></td>
2494
<td class="parameter_description"><p>the number of characters to delete</p></td>
2495
<td class="parameter_annotations"> </td>
2500
<p class="since">Since 1.0</p>
2503
<div class="refsect2">
2504
<a name="clutter-text-delete-text"></a><h3>clutter_text_delete_text ()</h3>
2505
<pre class="programlisting"><span class="returnvalue">void</span>
2506
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>,
2507
<em class="parameter"><code><span class="type">gssize</span> start_pos</code></em>,
2508
<em class="parameter"><code><span class="type">gssize</span> end_pos</code></em>);</pre>
2509
<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>
2511
and <em class="parameter"><code>end_pos</code></em>
2513
<p>The starting and ending positions are expressed in characters,
2515
<div class="refsect3">
2516
<a name="id-1.5.3.4.10.51.6"></a><h4>Parameters</h4>
2517
<div class="informaltable"><table width="100%" border="0">
2519
<col width="150px" class="parameters_name">
2520
<col class="parameters_description">
2521
<col width="200px" class="parameters_annotations">
2525
<td class="parameter_name"><p>self</p></td>
2526
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
2527
<td class="parameter_annotations"> </td>
2530
<td class="parameter_name"><p>start_pos</p></td>
2531
<td class="parameter_description"><p>starting position</p></td>
2532
<td class="parameter_annotations"> </td>
2535
<td class="parameter_name"><p>end_pos</p></td>
2536
<td class="parameter_description"><p>ending position</p></td>
2537
<td class="parameter_annotations"> </td>
2542
<p class="since">Since 1.0</p>
2545
<div class="refsect2">
2546
<a name="clutter-text-delete-selection"></a><h3>clutter_text_delete_selection ()</h3>
2547
<pre class="programlisting"><span class="returnvalue">gboolean</span>
2548
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>
2549
<p>Deletes the currently selected text</p>
2550
<p>This function is only useful in subclasses of <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p>
2551
<div class="refsect3">
2552
<a name="id-1.5.3.4.10.52.6"></a><h4>Parameters</h4>
2553
<div class="informaltable"><table width="100%" border="0">
2555
<col width="150px" class="parameters_name">
2556
<col class="parameters_description">
2557
<col width="200px" class="parameters_annotations">
2560
<td class="parameter_name"><p>self</p></td>
2561
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
2562
<td class="parameter_annotations"> </td>
2566
<div class="refsect3">
2567
<a name="id-1.5.3.4.10.52.7"></a><h4>Returns</h4>
2568
<p> <code class="literal">TRUE</code> if text was deleted or if the text actor
2569
is empty, and <code class="literal">FALSE</code> otherwise</p>
2572
<p class="since">Since 1.0</p>
2575
<div class="refsect2">
2576
<a name="clutter-text-get-chars"></a><h3>clutter_text_get_chars ()</h3>
2577
<pre class="programlisting"><span class="returnvalue">gchar</span> *
2578
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>,
2579
<em class="parameter"><code><span class="type">gssize</span> start_pos</code></em>,
2580
<em class="parameter"><code><span class="type">gssize</span> end_pos</code></em>);</pre>
2581
<p>Retrieves the contents of the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor between
2582
<em class="parameter"><code>start_pos</code></em>
2583
and <em class="parameter"><code>end_pos</code></em>
2584
, but not including <em class="parameter"><code>end_pos</code></em>
2586
<p>The positions are specified in characters, not in bytes.</p>
2587
<div class="refsect3">
2588
<a name="id-1.5.3.4.10.53.6"></a><h4>Parameters</h4>
2589
<div class="informaltable"><table width="100%" border="0">
2591
<col width="150px" class="parameters_name">
2592
<col class="parameters_description">
2593
<col width="200px" class="parameters_annotations">
2597
<td class="parameter_name"><p>self</p></td>
2598
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
2599
<td class="parameter_annotations"> </td>
2602
<td class="parameter_name"><p>start_pos</p></td>
2603
<td class="parameter_description"><p>start of text, in characters</p></td>
2604
<td class="parameter_annotations"> </td>
2607
<td class="parameter_name"><p>end_pos</p></td>
2608
<td class="parameter_description"><p>end of text, in characters</p></td>
2609
<td class="parameter_annotations"> </td>
2614
<div class="refsect3">
2615
<a name="id-1.5.3.4.10.53.7"></a><h4>Returns</h4>
2616
<p> a newly allocated string with the contents of
1967
2617
the text actor between the specified positions. Use <code class="function">g_free()</code>
1968
to free the resources when done</td>
1972
<p class="since">Since 1.0</p>
1975
<div class="refsect2">
1976
<a name="clutter-text-set-cursor-color"></a><h3>clutter_text_set_cursor_color ()</h3>
1977
<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>,
1978
<em class="parameter"><code>const <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);</pre>
1980
Sets the color of the cursor of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.
1983
If <em class="parameter"><code>color</code></em> is <code class="literal">NULL</code>, the cursor color will be the same as the
1986
<div class="variablelist"><table border="0" class="variablelist">
1988
<col align="left" valign="top">
1993
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
1994
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1998
<td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
1999
<td>the color of the cursor, or <code class="literal">NULL</code> to unset it. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
2004
<p class="since">Since 1.0</p>
2007
<div class="refsect2">
2008
<a name="clutter-text-get-cursor-color"></a><h3>clutter_text_get_cursor_color ()</h3>
2009
<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>,
2010
<em class="parameter"><code><a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);</pre>
2012
Retrieves the color of the cursor of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.
2014
<div class="variablelist"><table border="0" class="variablelist">
2016
<col align="left" valign="top">
2021
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
2022
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
2026
<td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
2027
<td>return location for a <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
2032
<p class="since">Since 1.0</p>
2035
<div class="refsect2">
2036
<a name="clutter-text-set-selection-color"></a><h3>clutter_text_set_selection_color ()</h3>
2037
<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>,
2038
<em class="parameter"><code>const <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);</pre>
2040
Sets the color of the selection of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.
2043
If <em class="parameter"><code>color</code></em> is <code class="literal">NULL</code>, the selection color will be the same as the
2618
to free the resources when done</p>
2621
<p class="since">Since 1.0</p>
2624
<div class="refsect2">
2625
<a name="clutter-text-set-cursor-color"></a><h3>clutter_text_set_cursor_color ()</h3>
2626
<pre class="programlisting"><span class="returnvalue">void</span>
2627
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>,
2628
<em class="parameter"><code>const <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);</pre>
2629
<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>
2630
<p>If <em class="parameter"><code>color</code></em>
2631
is <code class="literal">NULL</code>, the cursor color will be the same as the
2633
<div class="refsect3">
2634
<a name="id-1.5.3.4.10.54.6"></a><h4>Parameters</h4>
2635
<div class="informaltable"><table width="100%" border="0">
2637
<col width="150px" class="parameters_name">
2638
<col class="parameters_description">
2639
<col width="200px" class="parameters_annotations">
2643
<td class="parameter_name"><p>self</p></td>
2644
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
2645
<td class="parameter_annotations"> </td>
2648
<td class="parameter_name"><p>color</p></td>
2649
<td class="parameter_description"><p> the color of the cursor, or <code class="literal">NULL</code> to unset it. </p></td>
2650
<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>
2655
<p class="since">Since 1.0</p>
2658
<div class="refsect2">
2659
<a name="clutter-text-get-cursor-color"></a><h3>clutter_text_get_cursor_color ()</h3>
2660
<pre class="programlisting"><span class="returnvalue">void</span>
2661
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>,
2662
<em class="parameter"><code><a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);</pre>
2663
<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>
2664
<div class="refsect3">
2665
<a name="id-1.5.3.4.10.55.5"></a><h4>Parameters</h4>
2666
<div class="informaltable"><table width="100%" border="0">
2668
<col width="150px" class="parameters_name">
2669
<col class="parameters_description">
2670
<col width="200px" class="parameters_annotations">
2674
<td class="parameter_name"><p>self</p></td>
2675
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
2676
<td class="parameter_annotations"> </td>
2679
<td class="parameter_name"><p>color</p></td>
2680
<td class="parameter_description"><p> return location for a <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a>. </p></td>
2681
<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>
2686
<p class="since">Since 1.0</p>
2689
<div class="refsect2">
2690
<a name="clutter-text-set-selection-color"></a><h3>clutter_text_set_selection_color ()</h3>
2691
<pre class="programlisting"><span class="returnvalue">void</span>
2692
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>,
2693
<em class="parameter"><code>const <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);</pre>
2694
<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>
2695
<p>If <em class="parameter"><code>color</code></em>
2696
is <code class="literal">NULL</code>, the selection color will be the same as the
2044
2697
cursor color, or if no cursor color is set either then it will be
2045
the same as the text color.
2047
<div class="variablelist"><table border="0" class="variablelist">
2049
<col align="left" valign="top">
2054
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
2055
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
2059
<td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
2060
<td>the color of the selection, or <code class="literal">NULL</code> to unset it. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
2065
<p class="since">Since 1.0</p>
2068
<div class="refsect2">
2069
<a name="clutter-text-get-selection-color"></a><h3>clutter_text_get_selection_color ()</h3>
2070
<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>,
2071
<em class="parameter"><code><a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);</pre>
2073
Retrieves the color of the selection of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.
2075
<div class="variablelist"><table border="0" class="variablelist">
2077
<col align="left" valign="top">
2082
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
2083
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
2087
<td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
2088
<td>return location for a <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a>. <span class="annotation">[<acronym title="Out parameter, where caller must allocate storage."><span class="acronym">out caller-allocates</span></acronym>]</span>
2093
<p class="since">Since 1.0</p>
2096
<div class="refsect2">
2097
<a name="clutter-text-set-selected-text-color"></a><h3>clutter_text_set_selected_text_color ()</h3>
2098
<pre class="programlisting"><span class="returnvalue">void</span> clutter_text_set_selected_text_color
2099
(<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
2100
<em class="parameter"><code>const <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);</pre>
2102
Sets the selected text color of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.
2105
If <em class="parameter"><code>color</code></em> is <code class="literal">NULL</code>, the selected text color will be the same as the
2106
selection color, which then falls back to cursor, and then text color.
2108
<div class="variablelist"><table border="0" class="variablelist">
2110
<col align="left" valign="top">
2115
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
2116
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
2120
<td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
2121
<td>the selected text color, or <code class="literal">NULL</code> to unset it. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
2126
<p class="since">Since 1.8</p>
2129
<div class="refsect2">
2130
<a name="clutter-text-get-selected-text-color"></a><h3>clutter_text_get_selected_text_color ()</h3>
2131
<pre class="programlisting"><span class="returnvalue">void</span> clutter_text_get_selected_text_color
2132
(<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
2133
<em class="parameter"><code><a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);</pre>
2135
Retrieves the color of selected text of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.
2137
<div class="variablelist"><table border="0" class="variablelist">
2139
<col align="left" valign="top">
2144
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
2145
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
2149
<td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
2150
<td>return location for a <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a>. <span class="annotation">[<acronym title="Out parameter, where caller must allocate storage."><span class="acronym">out caller-allocates</span></acronym>]</span>
2155
<p class="since">Since 1.8</p>
2158
<div class="refsect2">
2159
<a name="clutter-text-set-cursor-position"></a><h3>clutter_text_set_cursor_position ()</h3>
2160
<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>,
2161
<em class="parameter"><code><span class="type">gint</span> position</code></em>);</pre>
2163
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>.
2166
The position is expressed in characters, not in bytes.
2168
<div class="variablelist"><table border="0" class="variablelist">
2170
<col align="left" valign="top">
2175
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
2176
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
2180
<td><p><span class="term"><em class="parameter"><code>position</code></em> :</span></p></td>
2181
<td>the new cursor position, in characters</td>
2185
<p class="since">Since 1.0</p>
2188
<div class="refsect2">
2189
<a name="clutter-text-get-cursor-position"></a><h3>clutter_text_get_cursor_position ()</h3>
2190
<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>
2192
Retrieves the cursor position.
2194
<div class="variablelist"><table border="0" class="variablelist">
2196
<col align="left" valign="top">
2201
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
2202
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
2206
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
2207
<td>the cursor position, in characters</td>
2211
<p class="since">Since 1.0</p>
2214
<div class="refsect2">
2215
<a name="clutter-text-set-cursor-visible"></a><h3>clutter_text_set_cursor_visible ()</h3>
2216
<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>,
2217
<em class="parameter"><code><span class="type">gboolean</span> cursor_visible</code></em>);</pre>
2219
Sets whether the cursor of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should be
2223
The color of the cursor will be the same as the text color
2224
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.
2227
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>.
2230
The position of the cursor can be changed programmatically using
2231
<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>.
2233
<div class="variablelist"><table border="0" class="variablelist">
2235
<col align="left" valign="top">
2240
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
2241
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
2245
<td><p><span class="term"><em class="parameter"><code>cursor_visible</code></em> :</span></p></td>
2246
<td>whether the cursor should be visible</td>
2250
<p class="since">Since 1.0</p>
2253
<div class="refsect2">
2254
<a name="clutter-text-get-cursor-visible"></a><h3>clutter_text_get_cursor_visible ()</h3>
2255
<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>
2257
Retrieves whether the cursor of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor is visible.
2259
<div class="variablelist"><table border="0" class="variablelist">
2261
<col align="left" valign="top">
2266
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
2267
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
2271
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
2273
<code class="literal">TRUE</code> if the cursor is visible</td>
2277
<p class="since">Since 1.0</p>
2280
<div class="refsect2">
2281
<a name="clutter-text-set-cursor-size"></a><h3>clutter_text_set_cursor_size ()</h3>
2282
<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>,
2283
<em class="parameter"><code><span class="type">gint</span> size</code></em>);</pre>
2285
Sets the size of the cursor of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>. The cursor
2286
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
2287
is set to <code class="literal">TRUE</code>.
2289
<div class="variablelist"><table border="0" class="variablelist">
2291
<col align="left" valign="top">
2296
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
2297
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
2301
<td><p><span class="term"><em class="parameter"><code>size</code></em> :</span></p></td>
2302
<td>the size of the cursor, in pixels, or -1 to use the
2307
<p class="since">Since 1.0</p>
2310
<div class="refsect2">
2311
<a name="clutter-text-get-cursor-size"></a><h3>clutter_text_get_cursor_size ()</h3>
2312
<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>
2314
Retrieves the size of the cursor of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.
2316
<div class="variablelist"><table border="0" class="variablelist">
2318
<col align="left" valign="top">
2323
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
2324
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
2328
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
2329
<td>the size of the cursor, in pixels</td>
2333
<p class="since">Since 1.0</p>
2336
<div class="refsect2">
2337
<a name="clutter-text-activate"></a><h3>clutter_text_activate ()</h3>
2338
<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>
2340
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
2341
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>.
2344
This function can be used to emit the ::activate signal inside
2345
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>
2698
the same as the text color.</p>
2699
<div class="refsect3">
2700
<a name="id-1.5.3.4.10.56.6"></a><h4>Parameters</h4>
2701
<div class="informaltable"><table width="100%" border="0">
2703
<col width="150px" class="parameters_name">
2704
<col class="parameters_description">
2705
<col width="200px" class="parameters_annotations">
2709
<td class="parameter_name"><p>self</p></td>
2710
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
2711
<td class="parameter_annotations"> </td>
2714
<td class="parameter_name"><p>color</p></td>
2715
<td class="parameter_description"><p> the color of the selection, or <code class="literal">NULL</code> to unset it. </p></td>
2716
<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>
2721
<p class="since">Since 1.0</p>
2724
<div class="refsect2">
2725
<a name="clutter-text-get-selection-color"></a><h3>clutter_text_get_selection_color ()</h3>
2726
<pre class="programlisting"><span class="returnvalue">void</span>
2727
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>,
2728
<em class="parameter"><code><a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);</pre>
2729
<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>
2730
<div class="refsect3">
2731
<a name="id-1.5.3.4.10.57.5"></a><h4>Parameters</h4>
2732
<div class="informaltable"><table width="100%" border="0">
2734
<col width="150px" class="parameters_name">
2735
<col class="parameters_description">
2736
<col width="200px" class="parameters_annotations">
2740
<td class="parameter_name"><p>self</p></td>
2741
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
2742
<td class="parameter_annotations"> </td>
2745
<td class="parameter_name"><p>color</p></td>
2746
<td class="parameter_description"><p> return location for a <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a>. </p></td>
2747
<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>
2752
<p class="since">Since 1.0</p>
2755
<div class="refsect2">
2756
<a name="clutter-text-set-selected-text-color"></a><h3>clutter_text_set_selected_text_color ()</h3>
2757
<pre class="programlisting"><span class="returnvalue">void</span>
2758
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>,
2759
<em class="parameter"><code>const <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);</pre>
2760
<p>Sets the selected text color of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.</p>
2761
<p>If <em class="parameter"><code>color</code></em>
2762
is <code class="literal">NULL</code>, the selected text color will be the same as the
2763
selection color, which then falls back to cursor, and then text color.</p>
2764
<div class="refsect3">
2765
<a name="id-1.5.3.4.10.58.6"></a><h4>Parameters</h4>
2766
<div class="informaltable"><table width="100%" border="0">
2768
<col width="150px" class="parameters_name">
2769
<col class="parameters_description">
2770
<col width="200px" class="parameters_annotations">
2774
<td class="parameter_name"><p>self</p></td>
2775
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
2776
<td class="parameter_annotations"> </td>
2779
<td class="parameter_name"><p>color</p></td>
2780
<td class="parameter_description"><p> the selected text color, or <code class="literal">NULL</code> to unset it. </p></td>
2781
<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>
2786
<p class="since">Since 1.8</p>
2789
<div class="refsect2">
2790
<a name="clutter-text-get-selected-text-color"></a><h3>clutter_text_get_selected_text_color ()</h3>
2791
<pre class="programlisting"><span class="returnvalue">void</span>
2792
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>,
2793
<em class="parameter"><code><a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);</pre>
2794
<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>
2795
<div class="refsect3">
2796
<a name="id-1.5.3.4.10.59.5"></a><h4>Parameters</h4>
2797
<div class="informaltable"><table width="100%" border="0">
2799
<col width="150px" class="parameters_name">
2800
<col class="parameters_description">
2801
<col width="200px" class="parameters_annotations">
2805
<td class="parameter_name"><p>self</p></td>
2806
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
2807
<td class="parameter_annotations"> </td>
2810
<td class="parameter_name"><p>color</p></td>
2811
<td class="parameter_description"><p> return location for a <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a>. </p></td>
2812
<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>
2817
<p class="since">Since 1.8</p>
2820
<div class="refsect2">
2821
<a name="clutter-text-set-cursor-position"></a><h3>clutter_text_set_cursor_position ()</h3>
2822
<pre class="programlisting"><span class="returnvalue">void</span>
2823
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>,
2824
<em class="parameter"><code><span class="type">gint</span> position</code></em>);</pre>
2825
<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>
2827
<p>The position is expressed in characters, not in bytes.</p>
2828
<div class="refsect3">
2829
<a name="id-1.5.3.4.10.60.6"></a><h4>Parameters</h4>
2830
<div class="informaltable"><table width="100%" border="0">
2832
<col width="150px" class="parameters_name">
2833
<col class="parameters_description">
2834
<col width="200px" class="parameters_annotations">
2838
<td class="parameter_name"><p>self</p></td>
2839
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
2840
<td class="parameter_annotations"> </td>
2843
<td class="parameter_name"><p>position</p></td>
2844
<td class="parameter_description"><p>the new cursor position, in characters</p></td>
2845
<td class="parameter_annotations"> </td>
2850
<p class="since">Since 1.0</p>
2853
<div class="refsect2">
2854
<a name="clutter-text-get-cursor-position"></a><h3>clutter_text_get_cursor_position ()</h3>
2855
<pre class="programlisting"><span class="returnvalue">gint</span>
2856
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>
2857
<p>Retrieves the cursor position.</p>
2858
<div class="refsect3">
2859
<a name="id-1.5.3.4.10.61.5"></a><h4>Parameters</h4>
2860
<div class="informaltable"><table width="100%" border="0">
2862
<col width="150px" class="parameters_name">
2863
<col class="parameters_description">
2864
<col width="200px" class="parameters_annotations">
2867
<td class="parameter_name"><p>self</p></td>
2868
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
2869
<td class="parameter_annotations"> </td>
2873
<div class="refsect3">
2874
<a name="id-1.5.3.4.10.61.6"></a><h4>Returns</h4>
2875
<p> the cursor position, in characters</p>
2878
<p class="since">Since 1.0</p>
2881
<div class="refsect2">
2882
<a name="clutter-text-set-cursor-visible"></a><h3>clutter_text_set_cursor_visible ()</h3>
2883
<pre class="programlisting"><span class="returnvalue">void</span>
2884
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>,
2885
<em class="parameter"><code><span class="type">gboolean</span> cursor_visible</code></em>);</pre>
2886
<p>Sets whether the cursor of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should be
2888
<p>The color of the cursor will be the same as the text color
2889
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>
2890
<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>
2891
<p>The position of the cursor can be changed programmatically using
2892
<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>
2893
<div class="refsect3">
2894
<a name="id-1.5.3.4.10.62.8"></a><h4>Parameters</h4>
2895
<div class="informaltable"><table width="100%" border="0">
2897
<col width="150px" class="parameters_name">
2898
<col class="parameters_description">
2899
<col width="200px" class="parameters_annotations">
2903
<td class="parameter_name"><p>self</p></td>
2904
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
2905
<td class="parameter_annotations"> </td>
2908
<td class="parameter_name"><p>cursor_visible</p></td>
2909
<td class="parameter_description"><p>whether the cursor should be visible</p></td>
2910
<td class="parameter_annotations"> </td>
2915
<p class="since">Since 1.0</p>
2918
<div class="refsect2">
2919
<a name="clutter-text-get-cursor-visible"></a><h3>clutter_text_get_cursor_visible ()</h3>
2920
<pre class="programlisting"><span class="returnvalue">gboolean</span>
2921
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>
2922
<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>
2923
<div class="refsect3">
2924
<a name="id-1.5.3.4.10.63.5"></a><h4>Parameters</h4>
2925
<div class="informaltable"><table width="100%" border="0">
2927
<col width="150px" class="parameters_name">
2928
<col class="parameters_description">
2929
<col width="200px" class="parameters_annotations">
2932
<td class="parameter_name"><p>self</p></td>
2933
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
2934
<td class="parameter_annotations"> </td>
2938
<div class="refsect3">
2939
<a name="id-1.5.3.4.10.63.6"></a><h4>Returns</h4>
2940
<p> <code class="literal">TRUE</code> if the cursor is visible</p>
2943
<p class="since">Since 1.0</p>
2946
<div class="refsect2">
2947
<a name="clutter-text-set-cursor-size"></a><h3>clutter_text_set_cursor_size ()</h3>
2948
<pre class="programlisting"><span class="returnvalue">void</span>
2949
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>,
2950
<em class="parameter"><code><span class="type">gint</span> size</code></em>);</pre>
2951
<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
2952
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
2953
is set to <code class="literal">TRUE</code>.</p>
2954
<div class="refsect3">
2955
<a name="id-1.5.3.4.10.64.5"></a><h4>Parameters</h4>
2956
<div class="informaltable"><table width="100%" border="0">
2958
<col width="150px" class="parameters_name">
2959
<col class="parameters_description">
2960
<col width="200px" class="parameters_annotations">
2964
<td class="parameter_name"><p>self</p></td>
2965
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
2966
<td class="parameter_annotations"> </td>
2969
<td class="parameter_name"><p>size</p></td>
2970
<td class="parameter_description"><p>the size of the cursor, in pixels, or -1 to use the
2971
default value</p></td>
2972
<td class="parameter_annotations"> </td>
2977
<p class="since">Since 1.0</p>
2980
<div class="refsect2">
2981
<a name="clutter-text-get-cursor-size"></a><h3>clutter_text_get_cursor_size ()</h3>
2982
<pre class="programlisting"><span class="returnvalue">guint</span>
2983
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>
2984
<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>
2985
<div class="refsect3">
2986
<a name="id-1.5.3.4.10.65.5"></a><h4>Parameters</h4>
2987
<div class="informaltable"><table width="100%" border="0">
2989
<col width="150px" class="parameters_name">
2990
<col class="parameters_description">
2991
<col width="200px" class="parameters_annotations">
2994
<td class="parameter_name"><p>self</p></td>
2995
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
2996
<td class="parameter_annotations"> </td>
3000
<div class="refsect3">
3001
<a name="id-1.5.3.4.10.65.6"></a><h4>Returns</h4>
3002
<p> the size of the cursor, in pixels</p>
3005
<p class="since">Since 1.0</p>
3008
<div class="refsect2">
3009
<a name="clutter-text-get-cursor-rect"></a><h3>clutter_text_get_cursor_rect ()</h3>
3010
<pre class="programlisting"><span class="returnvalue">void</span>
3011
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>,
3012
<em class="parameter"><code><a class="link" href="clutter-Base-geometric-types.html#ClutterRect" title="struct ClutterRect"><span class="type">ClutterRect</span></a> *rect</code></em>);</pre>
3013
<p>Retrieves the rectangle that contains the cursor.</p>
3014
<p>The coordinates of the rectangle's origin are in actor-relative
3016
<div class="refsect3">
3017
<a name="id-1.5.3.4.10.66.6"></a><h4>Parameters</h4>
3018
<div class="informaltable"><table width="100%" border="0">
3020
<col width="150px" class="parameters_name">
3021
<col class="parameters_description">
3022
<col width="200px" class="parameters_annotations">
3026
<td class="parameter_name"><p>self</p></td>
3027
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
3028
<td class="parameter_annotations"> </td>
3031
<td class="parameter_name"><p>rect</p></td>
3032
<td class="parameter_description"><p> return location of a <a class="link" href="clutter-Base-geometric-types.html#ClutterRect" title="struct ClutterRect"><span class="type">ClutterRect</span></a>. </p></td>
3033
<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>
3038
<p class="since">Since 1.16</p>
3041
<div class="refsect2">
3042
<a name="clutter-text-activate"></a><h3>clutter_text_activate ()</h3>
3043
<pre class="programlisting"><span class="returnvalue">gboolean</span>
3044
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>
3045
<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>
3047
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>
3048
<p>This function can be used to emit the ::activate signal inside
3049
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>
2346
3050
signal handlers before the default signal handler for the
2347
<a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> is invoked.
2349
<div class="variablelist"><table border="0" class="variablelist">
3051
<a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> is invoked.</p>
3052
<div class="refsect3">
3053
<a name="id-1.5.3.4.10.67.6"></a><h4>Parameters</h4>
3054
<div class="informaltable"><table width="100%" border="0">
2351
<col align="left" valign="top">
3056
<col width="150px" class="parameters_name">
3057
<col class="parameters_description">
3058
<col width="200px" class="parameters_annotations">
2356
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
2357
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
2361
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
2363
<code class="literal">TRUE</code> if the ::activate signal has been emitted,
2364
and <code class="literal">FALSE</code> otherwise</td>
3061
<td class="parameter_name"><p>self</p></td>
3062
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
3063
<td class="parameter_annotations"> </td>
3067
<div class="refsect3">
3068
<a name="id-1.5.3.4.10.67.7"></a><h4>Returns</h4>
3069
<p> <code class="literal">TRUE</code> if the ::activate signal has been emitted,
3070
and <code class="literal">FALSE</code> otherwise</p>
2368
3073
<p class="since">Since 1.0</p>
2371
3076
<div class="refsect2">
2372
<a name="clutter-text-coords-to-position"></a><h3>clutter_text_coords_to_position ()</h3>
2373
<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>,
2374
<em class="parameter"><code><span class="type">gfloat</span> x</code></em>,
2375
<em class="parameter"><code><span class="type">gfloat</span> y</code></em>);</pre>
2377
Retrieves the position of the character at the given coordinates.
2380
Return: the position of the character
2382
<div class="variablelist"><table border="0" class="variablelist">
3077
<a name="clutter-text-coords-to-position"></a><h3>clutter_text_coords_to_position ()</h3>
3078
<pre class="programlisting"><span class="returnvalue">gint</span>
3079
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>,
3080
<em class="parameter"><code><span class="type">gfloat</span> x</code></em>,
3081
<em class="parameter"><code><span class="type">gfloat</span> y</code></em>);</pre>
3082
<p>Retrieves the position of the character at the given coordinates.</p>
3083
<p>Return: the position of the character</p>
3084
<div class="refsect3">
3085
<a name="id-1.5.3.4.10.68.6"></a><h4>Parameters</h4>
3086
<div class="informaltable"><table width="100%" border="0">
2384
<col align="left" valign="top">
3088
<col width="150px" class="parameters_name">
3089
<col class="parameters_description">
3090
<col width="200px" class="parameters_annotations">
2389
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
2390
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
2394
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
2395
<td>the X coordinate, relative to the actor</td>
2398
<td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
2399
<td>the Y coordinate, relative to the actor</td>
3094
<td class="parameter_name"><p>self</p></td>
3095
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
3096
<td class="parameter_annotations"> </td>
3099
<td class="parameter_name"><p>x</p></td>
3100
<td class="parameter_description"><p>the X coordinate, relative to the actor</p></td>
3101
<td class="parameter_annotations"> </td>
3104
<td class="parameter_name"><p>y</p></td>
3105
<td class="parameter_description"><p>the Y coordinate, relative to the actor</p></td>
3106
<td class="parameter_annotations"> </td>
2403
3111
<p class="since">Since 1.10</p>
2406
3114
<div class="refsect2">
2407
<a name="clutter-text-position-to-coords"></a><h3>clutter_text_position_to_coords ()</h3>
2408
<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>,
2409
<em class="parameter"><code><span class="type">gint</span> position</code></em>,
2410
<em class="parameter"><code><span class="type">gfloat</span> *x</code></em>,
2411
<em class="parameter"><code><span class="type">gfloat</span> *y</code></em>,
2412
<em class="parameter"><code><span class="type">gfloat</span> *line_height</code></em>);</pre>
2414
Retrieves the coordinates of the given <em class="parameter"><code>position</code></em>.
2416
<div class="variablelist"><table border="0" class="variablelist">
3115
<a name="clutter-text-position-to-coords"></a><h3>clutter_text_position_to_coords ()</h3>
3116
<pre class="programlisting"><span class="returnvalue">gboolean</span>
3117
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>,
3118
<em class="parameter"><code><span class="type">gint</span> position</code></em>,
3119
<em class="parameter"><code><span class="type">gfloat</span> *x</code></em>,
3120
<em class="parameter"><code><span class="type">gfloat</span> *y</code></em>,
3121
<em class="parameter"><code><span class="type">gfloat</span> *line_height</code></em>);</pre>
3122
<p>Retrieves the coordinates of the given <em class="parameter"><code>position</code></em>
3124
<div class="refsect3">
3125
<a name="id-1.5.3.4.10.69.5"></a><h4>Parameters</h4>
3126
<div class="informaltable"><table width="100%" border="0">
2418
<col align="left" valign="top">
3128
<col width="150px" class="parameters_name">
3129
<col class="parameters_description">
3130
<col width="200px" class="parameters_annotations">
2423
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
2424
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
2428
<td><p><span class="term"><em class="parameter"><code>position</code></em> :</span></p></td>
2429
<td>position in characters</td>
2432
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
2433
<td>return location for the X coordinate, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
2437
<td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
2438
<td>return location for the Y coordinate, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
2442
<td><p><span class="term"><em class="parameter"><code>line_height</code></em> :</span></p></td>
2443
<td>return location for the line height, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
2447
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
2449
<code class="literal">TRUE</code> if the conversion was successful</td>
3134
<td class="parameter_name"><p>self</p></td>
3135
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
3136
<td class="parameter_annotations"> </td>
3139
<td class="parameter_name"><p>position</p></td>
3140
<td class="parameter_description"><p>position in characters</p></td>
3141
<td class="parameter_annotations"> </td>
3144
<td class="parameter_name"><p>x</p></td>
3145
<td class="parameter_description"><p> return location for the X coordinate, or <code class="literal">NULL</code>. </p></td>
3146
<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>
3149
<td class="parameter_name"><p>y</p></td>
3150
<td class="parameter_description"><p> return location for the Y coordinate, or <code class="literal">NULL</code>. </p></td>
3151
<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>
3154
<td class="parameter_name"><p>line_height</p></td>
3155
<td class="parameter_description"><p> return location for the line height, or <code class="literal">NULL</code>. </p></td>
3156
<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>
3161
<div class="refsect3">
3162
<a name="id-1.5.3.4.10.69.6"></a><h4>Returns</h4>
3163
<p> <code class="literal">TRUE</code> if the conversion was successful</p>
2453
3166
<p class="since">Since 1.0</p>
2456
3169
<div class="refsect2">
2457
<a name="clutter-text-set-preedit-string"></a><h3>clutter_text_set_preedit_string ()</h3>
2458
<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>,
2459
<em class="parameter"><code>const <span class="type">gchar</span> *preedit_str</code></em>,
2460
<em class="parameter"><code><span class="type">PangoAttrList</span> *preedit_attrs</code></em>,
2461
<em class="parameter"><code><span class="type">guint</span> cursor_pos</code></em>);</pre>
2463
Sets, or unsets, the pre-edit string. This function is useful
3170
<a name="clutter-text-set-preedit-string"></a><h3>clutter_text_set_preedit_string ()</h3>
3171
<pre class="programlisting"><span class="returnvalue">void</span>
3172
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>,
3173
<em class="parameter"><code>const <span class="type">gchar</span> *preedit_str</code></em>,
3174
<em class="parameter"><code><span class="type">PangoAttrList</span> *preedit_attrs</code></em>,
3175
<em class="parameter"><code><span class="type">guint</span> cursor_pos</code></em>);</pre>
3176
<p>Sets, or unsets, the pre-edit string. This function is useful
2464
3177
for input methods to display a string (with eventual specific
2465
3178
Pango attributes) before it is entered inside the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
2469
The preedit string and attributes are ignored if the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
2470
actor is not editable.
2473
This function should not be used by applications
2475
<div class="variablelist"><table border="0" class="variablelist">
3180
<p>The preedit string and attributes are ignored if the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
3181
actor is not editable.</p>
3182
<p>This function should not be used by applications</p>
3183
<div class="refsect3">
3184
<a name="id-1.5.3.4.10.70.7"></a><h4>Parameters</h4>
3185
<div class="informaltable"><table width="100%" border="0">
2477
<col align="left" valign="top">
3187
<col width="150px" class="parameters_name">
3188
<col class="parameters_description">
3189
<col width="200px" class="parameters_annotations">
2482
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
2483
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
2487
<td><p><span class="term"><em class="parameter"><code>preedit_str</code></em> :</span></p></td>
2488
<td>the pre-edit string, or <code class="literal">NULL</code> to unset it. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
2492
<td><p><span class="term"><em class="parameter"><code>preedit_attrs</code></em> :</span></p></td>
2493
<td>the pre-edit string attributes. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
2497
<td><p><span class="term"><em class="parameter"><code>cursor_pos</code></em> :</span></p></td>
2498
<td>the cursor position for the pre-edit string</td>
3193
<td class="parameter_name"><p>self</p></td>
3194
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
3195
<td class="parameter_annotations"> </td>
3198
<td class="parameter_name"><p>preedit_str</p></td>
3199
<td class="parameter_description"><p> the pre-edit string, or <code class="literal">NULL</code> to unset it. </p></td>
3200
<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>
3203
<td class="parameter_name"><p>preedit_attrs</p></td>
3204
<td class="parameter_description"><p> the pre-edit string attributes. </p></td>
3205
<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>
3208
<td class="parameter_name"><p>cursor_pos</p></td>
3209
<td class="parameter_description"><p>the cursor position for the pre-edit string</p></td>
3210
<td class="parameter_annotations"> </td>
2502
3215
<p class="since">Since 1.2</p>
2505
3218
<div class="refsect2">
2506
<a name="clutter-text-get-layout-offsets"></a><h3>clutter_text_get_layout_offsets ()</h3>
2507
<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>,
2508
<em class="parameter"><code><span class="type">gint</span> *x</code></em>,
2509
<em class="parameter"><code><span class="type">gint</span> *y</code></em>);</pre>
2511
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>
2512
representing the text.
2514
<div class="variablelist"><table border="0" class="variablelist">
3219
<a name="clutter-text-get-layout-offsets"></a><h3>clutter_text_get_layout_offsets ()</h3>
3220
<pre class="programlisting"><span class="returnvalue">void</span>
3221
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>,
3222
<em class="parameter"><code><span class="type">gint</span> *x</code></em>,
3223
<em class="parameter"><code><span class="type">gint</span> *y</code></em>);</pre>
3224
<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>
3225
representing the text.</p>
3226
<div class="refsect3">
3227
<a name="id-1.5.3.4.10.71.5"></a><h4>Parameters</h4>
3228
<div class="informaltable"><table width="100%" border="0">
2516
<col align="left" valign="top">
3230
<col width="150px" class="parameters_name">
3231
<col class="parameters_description">
3232
<col width="200px" class="parameters_annotations">
2521
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
2522
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
2526
<td><p><span class="term"><em class="parameter"><code>x</code></em> :</span></p></td>
2527
<td>location to store X offset of layout, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
2531
<td><p><span class="term"><em class="parameter"><code>y</code></em> :</span></p></td>
2532
<td>location to store Y offset of layout, or <code class="literal">NULL</code>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
3236
<td class="parameter_name"><p>self</p></td>
3237
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
3238
<td class="parameter_annotations"> </td>
3241
<td class="parameter_name"><p>x</p></td>
3242
<td class="parameter_description"><p> location to store X offset of layout, or <code class="literal">NULL</code>. </p></td>
3243
<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>
3246
<td class="parameter_name"><p>y</p></td>
3247
<td class="parameter_description"><p> location to store Y offset of layout, or <code class="literal">NULL</code>. </p></td>
3248
<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>
2537
3253
<p class="since">Since 1.8</p>
2540
3256
<div class="refsect1">
3257
<a name="ClutterText.other_details"></a><h2>Types and Values</h2>
3258
<div class="refsect2">
3259
<a name="ClutterText-struct"></a><h3>struct ClutterText</h3>
3260
<pre class="programlisting">struct ClutterText;</pre>
3261
<p>The <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> struct contains only private data.</p>
3262
<p class="since">Since 1.0</p>
3265
<div class="refsect2">
3266
<a name="ClutterTextClass"></a><h3>struct ClutterTextClass</h3>
3267
<pre class="programlisting">struct ClutterTextClass {
3268
/* signals, not vfuncs */
3269
void (* text_changed) (ClutterText *self);
3270
void (* activate) (ClutterText *self);
3271
void (* cursor_event) (ClutterText *self,
3272
const ClutterGeometry *geometry);
3273
void (* cursor_changed) (ClutterText *self);
3276
<p>The <a class="link" href="ClutterText.html#ClutterTextClass" title="struct ClutterTextClass"><span class="type">ClutterTextClass</span></a> struct contains only private data.</p>
3277
<div class="refsect3">
3278
<a name="id-1.5.3.4.11.3.5"></a><h4>Members</h4>
3279
<div class="informaltable"><table width="100%" border="0">
3281
<col width="300px" class="struct_members_name">
3282
<col class="struct_members_description">
3283
<col width="200px" class="struct_members_annotations">
3287
<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterTextClass.text-changed"></a>text_changed</code></em> ()</p></td>
3288
<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>
3289
<td class="struct_member_annotations"> </td>
3292
<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterTextClass.activate"></a>activate</code></em> ()</p></td>
3293
<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>
3294
<td class="struct_member_annotations"> </td>
3297
<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterTextClass.cursor-event"></a>cursor_event</code></em> ()</p></td>
3298
<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>
3299
<td class="struct_member_annotations"> </td>
3302
<td class="struct_member_name"><p><em class="structfield"><code><a name="ClutterTextClass.cursor-changed"></a>cursor_changed</code></em> ()</p></td>
3303
<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>
3304
<td class="struct_member_annotations"> </td>
3309
<p class="since">Since 1.0</p>
3312
<div class="refsect1">
2541
3313
<a name="ClutterText.property-details"></a><h2>Property Details</h2>
2542
3314
<div class="refsect2">
2543
<a name="ClutterText--activatable"></a><h3>The <code class="literal">"activatable"</code> property</h3>
2544
<pre class="programlisting"> "activatable" <span class="type">gboolean</span> : Read / Write</pre>
2546
Toggles whether return invokes the activate signal or not.
3315
<a name="ClutterText--activatable"></a><h3>The <code class="literal">“activatable”</code> property</h3>
3316
<pre class="programlisting"> “activatable” <span class="type">gboolean</span></pre>
3317
<p>Toggles whether return invokes the activate signal or not.</p>
3318
<p>Flags: Read / Write</p>
2548
3319
<p>Default value: TRUE</p>
2549
3320
<p class="since">Since 1.0</p>
2552
3323
<div class="refsect2">
2553
<a name="ClutterText--attributes"></a><h3>The <code class="literal">"attributes"</code> property</h3>
2554
<pre class="programlisting"> "attributes" <span class="type">PangoAttrList</span>* : Read / Write</pre>
2556
A list of <span class="type">PangoStyleAttribute</span>s to be applied to the
2557
contents of the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.
3324
<a name="ClutterText--attributes"></a><h3>The <code class="literal">“attributes”</code> property</h3>
3325
<pre class="programlisting"> “attributes” <span class="type">PangoAttrList</span> *</pre>
3326
<p>A list of <span class="type">PangoStyleAttribute</span><!-- -->s to be applied to the
3327
contents of the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.</p>
3328
<p>Flags: Read / Write</p>
2559
3329
<p class="since">Since 1.0</p>
2562
3332
<div class="refsect2">
2563
<a name="ClutterText--buffer"></a><h3>The <code class="literal">"buffer"</code> property</h3>
2564
<pre class="programlisting"> "buffer" <a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a>* : Read / Write</pre>
2566
The buffer which stores the text for this <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>.
2569
If set to <code class="literal">NULL</code>, a default buffer will be created.
3333
<a name="ClutterText--buffer"></a><h3>The <code class="literal">“buffer”</code> property</h3>
3334
<pre class="programlisting"> “buffer” <a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a> *</pre>
3335
<p>The buffer which stores the text for this <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>.</p>
3336
<p>If set to <code class="literal">NULL</code>, a default buffer will be created.</p>
3337
<p>Flags: Read / Write</p>
2571
3338
<p class="since">Since 1.8</p>
2574
3341
<div class="refsect2">
2575
<a name="ClutterText--color"></a><h3>The <code class="literal">"color"</code> property</h3>
2576
<pre class="programlisting"> "color" <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a>* : Read / Write</pre>
2578
The color used to render the text.
2580
<p class="since">Since 1.0</p>
2583
<div class="refsect2">
2584
<a name="ClutterText--cursor-color"></a><h3>The <code class="literal">"cursor-color"</code> property</h3>
2585
<pre class="programlisting"> "cursor-color" <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a>* : Read / Write</pre>
2587
The color of the cursor.
2589
<p class="since">Since 1.0</p>
2592
<div class="refsect2">
2593
<a name="ClutterText--cursor-color-set"></a><h3>The <code class="literal">"cursor-color-set"</code> property</h3>
2594
<pre class="programlisting"> "cursor-color-set" <span class="type">gboolean</span> : Read</pre>
2596
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.
3342
<a name="ClutterText--color"></a><h3>The <code class="literal">“color”</code> property</h3>
3343
<pre class="programlisting"> “color” <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *</pre>
3344
<p>The color used to render the text.</p>
3345
<p>Flags: Read / Write</p>
3346
<p class="since">Since 1.0</p>
3349
<div class="refsect2">
3350
<a name="ClutterText--cursor-color"></a><h3>The <code class="literal">“cursor-color”</code> property</h3>
3351
<pre class="programlisting"> “cursor-color” <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *</pre>
3352
<p>The color of the cursor.</p>
3353
<p>Flags: Read / Write</p>
3354
<p class="since">Since 1.0</p>
3357
<div class="refsect2">
3358
<a name="ClutterText--cursor-color-set"></a><h3>The <code class="literal">“cursor-color-set”</code> property</h3>
3359
<pre class="programlisting"> “cursor-color-set” <span class="type">gboolean</span></pre>
3360
<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>
2598
3362
<p>Default value: FALSE</p>
2599
3363
<p class="since">Since 1.0</p>
2602
3366
<div class="refsect2">
2603
<a name="ClutterText--cursor-position"></a><h3>The <code class="literal">"cursor-position"</code> property</h3>
2604
<pre class="programlisting"> "cursor-position" <span class="type">gint</span> : Read / Write</pre>
2606
The current input cursor position. -1 is taken to be the end of the text
2608
<p>Allowed values: >= G_MAXULONG</p>
3367
<a name="ClutterText--cursor-position"></a><h3>The <code class="literal">“cursor-position”</code> property</h3>
3368
<pre class="programlisting"> “cursor-position” <span class="type">gint</span></pre>
3369
<p>The current input cursor position. -1 is taken to be the end of the text</p>
3370
<p>Flags: Read / Write</p>
3371
<p>Allowed values: >= -1</p>
2609
3372
<p>Default value: -1</p>
2610
3373
<p class="since">Since 1.12</p>
2613
3376
<div class="refsect2">
2614
<a name="ClutterText--cursor-size"></a><h3>The <code class="literal">"cursor-size"</code> property</h3>
2615
<pre class="programlisting"> "cursor-size" <span class="type">gint</span> : Read / Write</pre>
2617
The size of the cursor, in pixels. If set to -1 the size used will
2618
be the default cursor size of 2 pixels.
2620
<p>Allowed values: >= G_MAXULONG</p>
3377
<a name="ClutterText--cursor-size"></a><h3>The <code class="literal">“cursor-size”</code> property</h3>
3378
<pre class="programlisting"> “cursor-size” <span class="type">gint</span></pre>
3379
<p>The size of the cursor, in pixels. If set to -1 the size used will
3380
be the default cursor size of 2 pixels.</p>
3381
<p>Flags: Read / Write</p>
3382
<p>Allowed values: >= -1</p>
2621
3383
<p>Default value: 2</p>
2622
3384
<p class="since">Since 1.0</p>
2625
3387
<div class="refsect2">
2626
<a name="ClutterText--cursor-visible"></a><h3>The <code class="literal">"cursor-visible"</code> property</h3>
2627
<pre class="programlisting"> "cursor-visible" <span class="type">gboolean</span> : Read / Write</pre>
2629
Whether the input cursor is visible or not, it will only be visible
2630
if both <a class="link" href="ClutterText.html#ClutterText--cursor-visible" title='The "cursor-visible" property'><span class="type">"cursor-visible"</span></a> and <a class="link" href="ClutterText.html#ClutterText--editable" title='The "editable" property'><span class="type">"editable"</span></a> are
2631
set to <code class="literal">TRUE</code>.
3388
<a name="ClutterText--cursor-visible"></a><h3>The <code class="literal">“cursor-visible”</code> property</h3>
3389
<pre class="programlisting"> “cursor-visible” <span class="type">gboolean</span></pre>
3390
<p>Whether the input cursor is visible or not, it will only be visible
3391
if both <a class="link" href="ClutterText.html#ClutterText--cursor-visible" title="The “cursor-visible” property"><span class="type">“cursor-visible”</span></a> and <a class="link" href="ClutterText.html#ClutterText--editable" title="The “editable” property"><span class="type">“editable”</span></a> are
3392
set to <code class="literal">TRUE</code>.</p>
3393
<p>Flags: Read / Write</p>
2633
3394
<p>Default value: TRUE</p>
2634
3395
<p class="since">Since 1.0</p>
2637
3398
<div class="refsect2">
2638
<a name="ClutterText--editable"></a><h3>The <code class="literal">"editable"</code> property</h3>
2639
<pre class="programlisting"> "editable" <span class="type">gboolean</span> : Read / Write</pre>
2641
Whether key events delivered to the actor causes editing.
3399
<a name="ClutterText--editable"></a><h3>The <code class="literal">“editable”</code> property</h3>
3400
<pre class="programlisting"> “editable” <span class="type">gboolean</span></pre>
3401
<p>Whether key events delivered to the actor causes editing.</p>
3402
<p>Flags: Read / Write</p>
2643
3403
<p>Default value: FALSE</p>
2644
3404
<p class="since">Since 1.0</p>
2647
3407
<div class="refsect2">
2648
<a name="ClutterText--ellipsize"></a><h3>The <code class="literal">"ellipsize"</code> property</h3>
2649
<pre class="programlisting"> "ellipsize" <span class="type">PangoEllipsizeMode</span> : Read / Write</pre>
2651
The preferred place to ellipsize the contents of the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor
3408
<a name="ClutterText--ellipsize"></a><h3>The <code class="literal">“ellipsize”</code> property</h3>
3409
<pre class="programlisting"> “ellipsize” <span class="type">PangoEllipsizeMode</span></pre>
3410
<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>
3411
<p>Flags: Read / Write</p>
2653
3412
<p>Default value: PANGO_ELLIPSIZE_NONE</p>
2654
3413
<p class="since">Since 1.0</p>
2657
3416
<div class="refsect2">
2658
<a name="ClutterText--font-description"></a><h3>The <code class="literal">"font-description"</code> property</h3>
2659
<pre class="programlisting"> "font-description" <span class="type">PangoFontDescription</span>* : Read / Write</pre>
2661
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>
2664
If you have a string describing the font then you should look at
2665
<a class="link" href="ClutterText.html#ClutterText--font-name" title='The "font-name" property'><span class="type">"font-name"</span></a> instead
3417
<a name="ClutterText--font-description"></a><h3>The <code class="literal">“font-description”</code> property</h3>
3418
<pre class="programlisting"> “font-description” <span class="type">PangoFontDescription</span> *</pre>
3419
<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>
3420
<p>If you have a string describing the font then you should look at
3421
<a class="link" href="ClutterText.html#ClutterText--font-name" title="The “font-name” property"><span class="type">“font-name”</span></a> instead</p>
3422
<p>Flags: Read / Write</p>
2667
3423
<p class="since">Since 1.2</p>
2670
3426
<div class="refsect2">
2671
<a name="ClutterText--font-name"></a><h3>The <code class="literal">"font-name"</code> property</h3>
2672
<pre class="programlisting"> "font-name" <span class="type">gchar</span>* : Read / Write</pre>
2674
The font to be used by the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>, as a string
2675
that can be parsed by <code class="function">pango_font_description_from_string()</code>.
2678
If set to <code class="literal">NULL</code>, the default system font will be used instead.
3427
<a name="ClutterText--font-name"></a><h3>The <code class="literal">“font-name”</code> property</h3>
3428
<pre class="programlisting"> “font-name” <span class="type">gchar</span> *</pre>
3429
<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
3430
that can be parsed by <code class="function">pango_font_description_from_string()</code>.</p>
3431
<p>If set to <code class="literal">NULL</code>, the default system font will be used instead.</p>
3432
<p>Flags: Read / Write</p>
2680
3433
<p>Default value: NULL</p>
2681
3434
<p class="since">Since 1.0</p>
2684
3437
<div class="refsect2">
2685
<a name="ClutterText--justify"></a><h3>The <code class="literal">"justify"</code> property</h3>
2686
<pre class="programlisting"> "justify" <span class="type">gboolean</span> : Read / Write</pre>
2688
Whether the contents of the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> should be justified
3438
<a name="ClutterText--justify"></a><h3>The <code class="literal">“justify”</code> property</h3>
3439
<pre class="programlisting"> “justify” <span class="type">gboolean</span></pre>
3440
<p>Whether the contents of the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> should be justified
3441
on both margins.</p>
3442
<p>Flags: Read / Write</p>
2691
3443
<p>Default value: FALSE</p>
2692
3444
<p class="since">Since 1.0</p>
2695
3447
<div class="refsect2">
2696
<a name="ClutterText--line-alignment"></a><h3>The <code class="literal">"line-alignment"</code> property</h3>
2697
<pre class="programlisting"> "line-alignment" <span class="type">PangoAlignment</span> : Read / Write</pre>
2699
The preferred alignment for the text. This property controls
2700
the alignment of multi-line paragraphs.
3448
<a name="ClutterText--line-alignment"></a><h3>The <code class="literal">“line-alignment”</code> property</h3>
3449
<pre class="programlisting"> “line-alignment” <span class="type">PangoAlignment</span></pre>
3450
<p>The preferred alignment for the text. This property controls
3451
the alignment of multi-line paragraphs.</p>
3452
<p>Flags: Read / Write</p>
2702
3453
<p>Default value: PANGO_ALIGN_LEFT</p>
2703
3454
<p class="since">Since 1.0</p>
2706
3457
<div class="refsect2">
2707
<a name="ClutterText--line-wrap"></a><h3>The <code class="literal">"line-wrap"</code> property</h3>
2708
<pre class="programlisting"> "line-wrap" <span class="type">gboolean</span> : Read / Write</pre>
2710
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
3458
<a name="ClutterText--line-wrap"></a><h3>The <code class="literal">“line-wrap”</code> property</h3>
3459
<pre class="programlisting"> “line-wrap” <span class="type">gboolean</span></pre>
3460
<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
2711
3461
exceed the available allocation. The wrapping strategy is
2712
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.
3462
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>
3463
<p>Flags: Read / Write</p>
2714
3464
<p>Default value: FALSE</p>
2715
3465
<p class="since">Since 1.0</p>
2718
3468
<div class="refsect2">
2719
<a name="ClutterText--line-wrap-mode"></a><h3>The <code class="literal">"line-wrap-mode"</code> property</h3>
2720
<pre class="programlisting"> "line-wrap-mode" <span class="type">PangoWrapMode</span> : Read / Write</pre>
2722
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
2723
control how the text is wrapped.
3469
<a name="ClutterText--line-wrap-mode"></a><h3>The <code class="literal">“line-wrap-mode”</code> property</h3>
3470
<pre class="programlisting"> “line-wrap-mode” <span class="type">PangoWrapMode</span></pre>
3471
<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
3472
control how the text is wrapped.</p>
3473
<p>Flags: Read / Write</p>
2725
3474
<p>Default value: PANGO_WRAP_WORD</p>
2726
3475
<p class="since">Since 1.0</p>
2729
3478
<div class="refsect2">
2730
<a name="ClutterText--max-length"></a><h3>The <code class="literal">"max-length"</code> property</h3>
2731
<pre class="programlisting"> "max-length" <span class="type">gint</span> : Read / Write</pre>
2733
The maximum length of the contents of the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.
2735
<p>Allowed values: >= G_MAXULONG</p>
2736
<p>Default value: 0</p>
2737
<p class="since">Since 1.0</p>
2740
<div class="refsect2">
2741
<a name="ClutterText--password-char"></a><h3>The <code class="literal">"password-char"</code> property</h3>
2742
<pre class="programlisting"> "password-char" <span class="type">guint</span> : Read / Write</pre>
2744
If non-zero, the character that should be used in place of
2745
the actual text in a password text actor.
2747
<p>Default value: 0</p>
2748
<p class="since">Since 1.0</p>
2751
<div class="refsect2">
2752
<a name="ClutterText--position"></a><h3>The <code class="literal">"position"</code> property</h3>
2753
<pre class="programlisting"> "position" <span class="type">gint</span> : Read / Write</pre>
2754
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
2755
<h3 class="title">Warning</h3>
2756
<p><code class="literal">ClutterText:position</code> has been deprecated since version 1.12 and should not be used in newly-written code. Use ClutterText:cursor-position instead.</p>
2759
The current input cursor position. -1 is taken to be the end of the text
2761
<p>Allowed values: >= G_MAXULONG</p>
3479
<a name="ClutterText--max-length"></a><h3>The <code class="literal">“max-length”</code> property</h3>
3480
<pre class="programlisting"> “max-length” <span class="type">gint</span></pre>
3481
<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>
3482
<p>Flags: Read / Write</p>
3483
<p>Allowed values: >= -1</p>
3484
<p>Default value: 0</p>
3485
<p class="since">Since 1.0</p>
3488
<div class="refsect2">
3489
<a name="ClutterText--password-char"></a><h3>The <code class="literal">“password-char”</code> property</h3>
3490
<pre class="programlisting"> “password-char” <span class="type">guint</span></pre>
3491
<p>If non-zero, the character that should be used in place of
3492
the actual text in a password text actor.</p>
3493
<p>Flags: Read / Write</p>
3494
<p>Default value: 0</p>
3495
<p class="since">Since 1.0</p>
3498
<div class="refsect2">
3499
<a name="ClutterText--position"></a><h3>The <code class="literal">“position”</code> property</h3>
3500
<pre class="programlisting"> “position” <span class="type">gint</span></pre>
3501
<p>The current input cursor position. -1 is taken to be the end of the text</p>
3502
<div class="warning">
3503
<p><code class="literal">ClutterText:position</code> has been deprecated since version 1.12 and should not be used in newly-written code.</p>
3504
<p>Use ClutterText:cursor-position instead.</p>
3506
<p>Flags: Read / Write</p>
3507
<p>Allowed values: >= -1</p>
2762
3508
<p>Default value: -1</p>
2763
3509
<p class="since">Since 1.0</p>
2766
3512
<div class="refsect2">
2767
<a name="ClutterText--selectable"></a><h3>The <code class="literal">"selectable"</code> property</h3>
2768
<pre class="programlisting"> "selectable" <span class="type">gboolean</span> : Read / Write</pre>
2770
Whether it is possible to select text, either using the pointer
3513
<a name="ClutterText--selectable"></a><h3>The <code class="literal">“selectable”</code> property</h3>
3514
<pre class="programlisting"> “selectable” <span class="type">gboolean</span></pre>
3515
<p>Whether it is possible to select text, either using the pointer
3516
or the keyboard.</p>
3517
<p>Flags: Read / Write</p>
2773
3518
<p>Default value: TRUE</p>
2774
3519
<p class="since">Since 1.0</p>
2777
3522
<div class="refsect2">
2778
<a name="ClutterText--selected-text-color"></a><h3>The <code class="literal">"selected-text-color"</code> property</h3>
2779
<pre class="programlisting"> "selected-text-color" <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a>* : Read / Write</pre>
2781
The color of selected text.
3523
<a name="ClutterText--selected-text-color"></a><h3>The <code class="literal">“selected-text-color”</code> property</h3>
3524
<pre class="programlisting"> “selected-text-color” <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *</pre>
3525
<p>The color of selected text.</p>
3526
<p>Flags: Read / Write</p>
2783
3527
<p class="since">Since 1.8</p>
2786
3530
<div class="refsect2">
2787
<a name="ClutterText--selected-text-color-set"></a><h3>The <code class="literal">"selected-text-color-set"</code> property</h3>
2788
<pre class="programlisting"> "selected-text-color-set" <span class="type">gboolean</span> : Read</pre>
2790
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.
3531
<a name="ClutterText--selected-text-color-set"></a><h3>The <code class="literal">“selected-text-color-set”</code> property</h3>
3532
<pre class="programlisting"> “selected-text-color-set” <span class="type">gboolean</span></pre>
3533
<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>
2792
3535
<p>Default value: FALSE</p>
2793
3536
<p class="since">Since 1.8</p>
2796
3539
<div class="refsect2">
2797
<a name="ClutterText--selection-bound"></a><h3>The <code class="literal">"selection-bound"</code> property</h3>
2798
<pre class="programlisting"> "selection-bound" <span class="type">gint</span> : Read / Write</pre>
2800
The current input cursor position. -1 is taken to be the end of the text
2802
<p>Allowed values: >= G_MAXULONG</p>
3540
<a name="ClutterText--selection-bound"></a><h3>The <code class="literal">“selection-bound”</code> property</h3>
3541
<pre class="programlisting"> “selection-bound” <span class="type">gint</span></pre>
3542
<p>The current input cursor position. -1 is taken to be the end of the text</p>
3543
<p>Flags: Read / Write</p>
3544
<p>Allowed values: >= -1</p>
2803
3545
<p>Default value: -1</p>
2804
3546
<p class="since">Since 1.0</p>
2807
3549
<div class="refsect2">
2808
<a name="ClutterText--selection-color"></a><h3>The <code class="literal">"selection-color"</code> property</h3>
2809
<pre class="programlisting"> "selection-color" <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a>* : Read / Write</pre>
2811
The color of the selection.
3550
<a name="ClutterText--selection-color"></a><h3>The <code class="literal">“selection-color”</code> property</h3>
3551
<pre class="programlisting"> “selection-color” <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *</pre>
3552
<p>The color of the selection.</p>
3553
<p>Flags: Read / Write</p>
2813
3554
<p class="since">Since 1.0</p>
2816
3557
<div class="refsect2">
2817
<a name="ClutterText--selection-color-set"></a><h3>The <code class="literal">"selection-color-set"</code> property</h3>
2818
<pre class="programlisting"> "selection-color-set" <span class="type">gboolean</span> : Read</pre>
2820
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.
3558
<a name="ClutterText--selection-color-set"></a><h3>The <code class="literal">“selection-color-set”</code> property</h3>
3559
<pre class="programlisting"> “selection-color-set” <span class="type">gboolean</span></pre>
3560
<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>
2822
3562
<p>Default value: FALSE</p>
2823
3563
<p class="since">Since 1.0</p>
2826
3566
<div class="refsect2">
2827
<a name="ClutterText--single-line-mode"></a><h3>The <code class="literal">"single-line-mode"</code> property</h3>
2828
<pre class="programlisting"> "single-line-mode" <span class="type">gboolean</span> : Read / Write</pre>
2830
Whether the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should be in single line mode
3567
<a name="ClutterText--single-line-mode"></a><h3>The <code class="literal">“single-line-mode”</code> property</h3>
3568
<pre class="programlisting"> “single-line-mode” <span class="type">gboolean</span></pre>
3569
<p>Whether the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should be in single line mode
2831
3570
or not. A single line <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor will only contain a
2832
3571
single line of text, scrolling it in case its length is bigger
2833
than the allocated size.
2836
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>
2837
property as a side-effect.
2840
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
2841
<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>.
3572
than the allocated size.</p>
3573
<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>
3574
property as a side-effect.</p>
3575
<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
3576
<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>
3577
<p>Flags: Read / Write</p>
2843
3578
<p>Default value: FALSE</p>
2844
3579
<p class="since">Since 1.0</p>
2847
3582
<div class="refsect2">
2848
<a name="ClutterText--text"></a><h3>The <code class="literal">"text"</code> property</h3>
2849
<pre class="programlisting"> "text" <span class="type">gchar</span>* : Read / Write</pre>
2851
The text to render inside the actor.
3583
<a name="ClutterText--text"></a><h3>The <code class="literal">“text”</code> property</h3>
3584
<pre class="programlisting"> “text” <span class="type">gchar</span> *</pre>
3585
<p>The text to render inside the actor.</p>
3586
<p>Flags: Read / Write</p>
2853
3587
<p>Default value: ""</p>
2854
3588
<p class="since">Since 1.0</p>
2857
3591
<div class="refsect2">
2858
<a name="ClutterText--use-markup"></a><h3>The <code class="literal">"use-markup"</code> property</h3>
2859
<pre class="programlisting"> "use-markup" <span class="type">gboolean</span> : Read / Write</pre>
2861
Whether the text includes Pango markup.
2864
For more informations about the Pango markup format, see
2865
<code class="function">pango_layout_set_markup()</code> in the Pango documentation.
2869
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
2870
<h3 class="title">Note</h3>It is not possible to round-trip this property between
3592
<a name="ClutterText--use-markup"></a><h3>The <code class="literal">“use-markup”</code> property</h3>
3593
<pre class="programlisting"> “use-markup” <span class="type">gboolean</span></pre>
3594
<p>Whether the text includes Pango markup.</p>
3595
<p>For more informations about the Pango markup format, see
3596
<code class="function">pango_layout_set_markup()</code> in the Pango documentation.</p>
3597
<p>It is not possible to round-trip this property between
2871
3598
<code class="literal">TRUE</code> and <code class="literal">FALSE</code>. Once a string with markup has been set on
2872
3599
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
2873
is stripped from the string.</div>
3600
is stripped from the string.</p>
3601
<p>Flags: Read / Write</p>
2876
3602
<p>Default value: FALSE</p>
2877
3603
<p class="since">Since 1.0</p>