~ubuntu-branches/ubuntu/vivid/clutter-1.0/vivid-proposed

« back to all changes in this revision

Viewing changes to doc/reference/clutter/html/ClutterText.html

  • Committer: Package Import Robot
  • Author(s): Emilio Pozuelo Monfort
  • Date: 2014-03-26 11:51:28 UTC
  • mfrom: (1.5.1) (4.1.30 experimental)
  • Revision ID: package-import@ubuntu.com-20140326115128-timmbsde8734o6wz
Tags: 1.18.0-1
* New upstream release.
* debian/control.in:
  + Bump gtk-doc-tools build dependency.
  + Also break libcogl15.
  + Standards-Version is 3.9.5, no changes needed.
* debian/libclutter-1.0-0.symbols:
  + Drop a few symbols that were accidentally exported in the DSO because
    they had a clutter_ prefix but were not in the public headers.
  + Add one new symbol.
  + Drop unnecessary debian revisions from some symbols.
* debian/control.in,
  debian/rules,
  debian/libclutter-1.0-0.symbols:
  + Temporarily disable evdev input support. It was only enabled in 1.17.6-1
    in experimental and there is nothing using it yet, and I would like to
    wait a bit before uploading libinput to unstable as the ABI isn't stable
    yet.
* d/p/0001-wayland-Add-missing-CLUTTER_AVAILABLE-annotations.patch:
  + Add missing annotations so that a few symbols are exported in the DSO.

* Upload to unstable.

Show diffs side-by-side

added added

removed removed

Lines of Context:
2
2
<html>
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
 
<title>ClutterText</title>
 
5
<title>Clutter Reference Manual: ClutterText</title>
6
6
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
7
7
<link rel="home" href="index.html" title="Clutter Reference Manual">
8
8
<link rel="up" href="ch02.html" title="Base actors">
9
9
<link rel="prev" href="ClutterClone.html" title="ClutterClone">
10
10
<link rel="next" href="ClutterScrollActor.html" title="ClutterScrollActor">
11
 
<meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
 
11
<meta name="generator" content="GTK-Doc V1.20.1 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
</head>
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
 
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
16
 
<tr valign="middle">
17
 
<td><a accesskey="p" href="ClutterClone.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
 
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19
 
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20
 
<th width="100%" align="center">Clutter Reference Manual</th>
21
 
<td><a accesskey="n" href="ClutterScrollActor.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22
 
</tr>
23
 
<tr><td colspan="5" class="shortcuts">
24
 
<a href="#ClutterText.synopsis" class="shortcut">Top</a>
25
 
                   | 
26
 
                  <a href="#ClutterText.description" class="shortcut">Description</a>
27
 
                   | 
28
 
                  <a href="#ClutterText.object-hierarchy" class="shortcut">Object Hierarchy</a>
29
 
                   | 
30
 
                  <a href="#ClutterText.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
31
 
                   | 
32
 
                  <a href="#ClutterText.properties" class="shortcut">Properties</a>
33
 
                   | 
34
 
                  <a href="#ClutterText.signals" class="shortcut">Signals</a>
35
 
</td></tr>
36
 
</table>
 
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
 
16
<td width="100%" align="left" class="shortcuts">
 
17
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
 
18
                  <a href="#ClutterText.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
 
19
                  <a href="#ClutterText.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span> 
 
20
                  <a href="#ClutterText.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties">  <span class="dim">|</span> 
 
21
                  <a href="#ClutterText.properties" class="shortcut">Properties</a></span><span id="nav_signals">  <span class="dim">|</span> 
 
22
                  <a href="#ClutterText.signals" class="shortcut">Signals</a></span>
 
23
</td>
 
24
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
 
25
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
 
26
<td><a accesskey="p" href="ClutterClone.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
 
27
<td><a accesskey="n" href="ClutterScrollActor.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
 
28
</tr></table>
37
29
<div class="refentry">
38
30
<a name="ClutterText"></a><div class="titlepage"></div>
39
31
<div class="refnamediv"><table width="100%"><tr>
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>
43
35
</td>
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>);
57
 
 
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>);
121
 
 
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>);
162
 
 
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>);
179
 
</pre>
 
38
<div class="refsect1">
 
39
<a name="ClutterText.functions"></a><h2>Functions</h2>
 
40
<div class="informaltable"><table width="100%" border="0">
 
41
<colgroup>
 
42
<col width="150px" class="functions_return">
 
43
<col class="functions_name">
 
44
</colgroup>
 
45
<tbody>
 
46
<tr>
 
47
<td class="function_type">
 
48
<a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
 
49
</td>
 
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>
 
52
</td>
 
53
</tr>
 
54
<tr>
 
55
<td class="function_type">
 
56
<a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
 
57
</td>
 
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>
 
60
</td>
 
61
</tr>
 
62
<tr>
 
63
<td class="function_type">
 
64
<a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
 
65
</td>
 
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>
 
68
</td>
 
69
</tr>
 
70
<tr>
 
71
<td class="function_type">
 
72
<a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
 
73
</td>
 
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>
 
76
</td>
 
77
</tr>
 
78
<tr>
 
79
<td class="function_type">
 
80
<span class="returnvalue">void</span>
 
81
</td>
 
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>
 
84
</td>
 
85
</tr>
 
86
<tr>
 
87
<td class="function_type">
 
88
<a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="returnvalue">ClutterTextBuffer</span></a> *
 
89
</td>
 
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>
 
92
</td>
 
93
</tr>
 
94
<tr>
 
95
<td class="function_type">
 
96
<span class="returnvalue">void</span>
 
97
</td>
 
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>
 
100
</td>
 
101
</tr>
 
102
<tr>
 
103
<td class="function_type">
 
104
<span class="returnvalue">void</span>
 
105
</td>
 
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>
 
108
</td>
 
109
</tr>
 
110
<tr>
 
111
<td class="function_type">const <span class="returnvalue">gchar</span> *
 
112
</td>
 
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>
 
115
</td>
 
116
</tr>
 
117
<tr>
 
118
<td class="function_type">
 
119
<span class="returnvalue">void</span>
 
120
</td>
 
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>
 
123
</td>
 
124
</tr>
 
125
<tr>
 
126
<td class="function_type">
 
127
<span class="returnvalue">gboolean</span>
 
128
</td>
 
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>
 
131
</td>
 
132
</tr>
 
133
<tr>
 
134
<td class="function_type">
 
135
<span class="returnvalue">void</span>
 
136
</td>
 
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>
 
139
</td>
 
140
</tr>
 
141
<tr>
 
142
<td class="function_type">
 
143
<span class="returnvalue">PangoAttrList</span> *
 
144
</td>
 
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>
 
147
</td>
 
148
</tr>
 
149
<tr>
 
150
<td class="function_type">
 
151
<span class="returnvalue">void</span>
 
152
</td>
 
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>
 
155
</td>
 
156
</tr>
 
157
<tr>
 
158
<td class="function_type">
 
159
<span class="returnvalue">void</span>
 
160
</td>
 
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>
 
163
</td>
 
164
</tr>
 
165
<tr>
 
166
<td class="function_type">
 
167
<span class="returnvalue">void</span>
 
168
</td>
 
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>
 
171
</td>
 
172
</tr>
 
173
<tr>
 
174
<td class="function_type">
 
175
<span class="returnvalue">PangoEllipsizeMode</span>
 
176
</td>
 
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>
 
179
</td>
 
180
</tr>
 
181
<tr>
 
182
<td class="function_type">
 
183
<span class="returnvalue">void</span>
 
184
</td>
 
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>
 
187
</td>
 
188
</tr>
 
189
<tr>
 
190
<td class="function_type">const <span class="returnvalue">gchar</span> *
 
191
</td>
 
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>
 
194
</td>
 
195
</tr>
 
196
<tr>
 
197
<td class="function_type">
 
198
<span class="returnvalue">void</span>
 
199
</td>
 
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>
 
202
</td>
 
203
</tr>
 
204
<tr>
 
205
<td class="function_type">
 
206
<span class="returnvalue">PangoFontDescription</span> *
 
207
</td>
 
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>
 
210
</td>
 
211
</tr>
 
212
<tr>
 
213
<td class="function_type">
 
214
<span class="returnvalue">void</span>
 
215
</td>
 
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>
 
218
</td>
 
219
</tr>
 
220
<tr>
 
221
<td class="function_type">
 
222
<span class="returnvalue">gunichar</span>
 
223
</td>
 
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>
 
226
</td>
 
227
</tr>
 
228
<tr>
 
229
<td class="function_type">
 
230
<span class="returnvalue">void</span>
 
231
</td>
 
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>
 
234
</td>
 
235
</tr>
 
236
<tr>
 
237
<td class="function_type">
 
238
<span class="returnvalue">gboolean</span>
 
239
</td>
 
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>
 
242
</td>
 
243
</tr>
 
244
<tr>
 
245
<td class="function_type">
 
246
<span class="returnvalue">PangoLayout</span> *
 
247
</td>
 
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>
 
250
</td>
 
251
</tr>
 
252
<tr>
 
253
<td class="function_type">
 
254
<span class="returnvalue">void</span>
 
255
</td>
 
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>
 
258
</td>
 
259
</tr>
 
260
<tr>
 
261
<td class="function_type">
 
262
<span class="returnvalue">PangoAlignment</span>
 
263
</td>
 
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>
 
266
</td>
 
267
</tr>
 
268
<tr>
 
269
<td class="function_type">
 
270
<span class="returnvalue">void</span>
 
271
</td>
 
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>
 
274
</td>
 
275
</tr>
 
276
<tr>
 
277
<td class="function_type">
 
278
<span class="returnvalue">gboolean</span>
 
279
</td>
 
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>
 
282
</td>
 
283
</tr>
 
284
<tr>
 
285
<td class="function_type">
 
286
<span class="returnvalue">void</span>
 
287
</td>
 
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>
 
290
</td>
 
291
</tr>
 
292
<tr>
 
293
<td class="function_type">
 
294
<span class="returnvalue">PangoWrapMode</span>
 
295
</td>
 
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>
 
298
</td>
 
299
</tr>
 
300
<tr>
 
301
<td class="function_type">
 
302
<span class="returnvalue">void</span>
 
303
</td>
 
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>
 
306
</td>
 
307
</tr>
 
308
<tr>
 
309
<td class="function_type">
 
310
<span class="returnvalue">gint</span>
 
311
</td>
 
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>
 
314
</td>
 
315
</tr>
 
316
<tr>
 
317
<td class="function_type">
 
318
<span class="returnvalue">void</span>
 
319
</td>
 
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>
 
322
</td>
 
323
</tr>
 
324
<tr>
 
325
<td class="function_type">
 
326
<span class="returnvalue">gboolean</span>
 
327
</td>
 
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>
 
330
</td>
 
331
</tr>
 
332
<tr>
 
333
<td class="function_type">
 
334
<span class="returnvalue">void</span>
 
335
</td>
 
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>
 
338
</td>
 
339
</tr>
 
340
<tr>
 
341
<td class="function_type">
 
342
<span class="returnvalue">gchar</span> *
 
343
</td>
 
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>
 
346
</td>
 
347
</tr>
 
348
<tr>
 
349
<td class="function_type">
 
350
<span class="returnvalue">void</span>
 
351
</td>
 
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>
 
354
</td>
 
355
</tr>
 
356
<tr>
 
357
<td class="function_type">
 
358
<span class="returnvalue">gint</span>
 
359
</td>
 
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>
 
362
</td>
 
363
</tr>
 
364
<tr>
 
365
<td class="function_type">
 
366
<span class="returnvalue">void</span>
 
367
</td>
 
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>
 
370
</td>
 
371
</tr>
 
372
<tr>
 
373
<td class="function_type">
 
374
<span class="returnvalue">gboolean</span>
 
375
</td>
 
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>
 
378
</td>
 
379
</tr>
 
380
<tr>
 
381
<td class="function_type">
 
382
<span class="returnvalue">void</span>
 
383
</td>
 
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>
 
386
</td>
 
387
</tr>
 
388
<tr>
 
389
<td class="function_type">
 
390
<span class="returnvalue">gboolean</span>
 
391
</td>
 
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>
 
394
</td>
 
395
</tr>
 
396
<tr>
 
397
<td class="function_type">
 
398
<span class="returnvalue">void</span>
 
399
</td>
 
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>
 
402
</td>
 
403
</tr>
 
404
<tr>
 
405
<td class="function_type">
 
406
<span class="returnvalue">gboolean</span>
 
407
</td>
 
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>
 
410
</td>
 
411
</tr>
 
412
<tr>
 
413
<td class="function_type">
 
414
<span class="returnvalue">void</span>
 
415
</td>
 
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>
 
418
</td>
 
419
</tr>
 
420
<tr>
 
421
<td class="function_type">
 
422
<span class="returnvalue">void</span>
 
423
</td>
 
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>
 
426
</td>
 
427
</tr>
 
428
<tr>
 
429
<td class="function_type">
 
430
<span class="returnvalue">void</span>
 
431
</td>
 
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>
 
434
</td>
 
435
</tr>
 
436
<tr>
 
437
<td class="function_type">
 
438
<span class="returnvalue">void</span>
 
439
</td>
 
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>
 
442
</td>
 
443
</tr>
 
444
<tr>
 
445
<td class="function_type">
 
446
<span class="returnvalue">gboolean</span>
 
447
</td>
 
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>
 
450
</td>
 
451
</tr>
 
452
<tr>
 
453
<td class="function_type">
 
454
<span class="returnvalue">gchar</span> *
 
455
</td>
 
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>
 
458
</td>
 
459
</tr>
 
460
<tr>
 
461
<td class="function_type">
 
462
<span class="returnvalue">void</span>
 
463
</td>
 
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>
 
466
</td>
 
467
</tr>
 
468
<tr>
 
469
<td class="function_type">
 
470
<span class="returnvalue">void</span>
 
471
</td>
 
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>
 
474
</td>
 
475
</tr>
 
476
<tr>
 
477
<td class="function_type">
 
478
<span class="returnvalue">void</span>
 
479
</td>
 
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>
 
482
</td>
 
483
</tr>
 
484
<tr>
 
485
<td class="function_type">
 
486
<span class="returnvalue">void</span>
 
487
</td>
 
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>
 
490
</td>
 
491
</tr>
 
492
<tr>
 
493
<td class="function_type">
 
494
<span class="returnvalue">void</span>
 
495
</td>
 
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>
 
498
</td>
 
499
</tr>
 
500
<tr>
 
501
<td class="function_type">
 
502
<span class="returnvalue">void</span>
 
503
</td>
 
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>
 
506
</td>
 
507
</tr>
 
508
<tr>
 
509
<td class="function_type">
 
510
<span class="returnvalue">void</span>
 
511
</td>
 
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>
 
514
</td>
 
515
</tr>
 
516
<tr>
 
517
<td class="function_type">
 
518
<span class="returnvalue">gint</span>
 
519
</td>
 
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>
 
522
</td>
 
523
</tr>
 
524
<tr>
 
525
<td class="function_type">
 
526
<span class="returnvalue">void</span>
 
527
</td>
 
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>
 
530
</td>
 
531
</tr>
 
532
<tr>
 
533
<td class="function_type">
 
534
<span class="returnvalue">gboolean</span>
 
535
</td>
 
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>
 
538
</td>
 
539
</tr>
 
540
<tr>
 
541
<td class="function_type">
 
542
<span class="returnvalue">void</span>
 
543
</td>
 
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>
 
546
</td>
 
547
</tr>
 
548
<tr>
 
549
<td class="function_type">
 
550
<span class="returnvalue">guint</span>
 
551
</td>
 
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>
 
554
</td>
 
555
</tr>
 
556
<tr>
 
557
<td class="function_type">
 
558
<span class="returnvalue">void</span>
 
559
</td>
 
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>
 
562
</td>
 
563
</tr>
 
564
<tr>
 
565
<td class="function_type">
 
566
<span class="returnvalue">gboolean</span>
 
567
</td>
 
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>
 
570
</td>
 
571
</tr>
 
572
<tr>
 
573
<td class="function_type">
 
574
<span class="returnvalue">gint</span>
 
575
</td>
 
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>
 
578
</td>
 
579
</tr>
 
580
<tr>
 
581
<td class="function_type">
 
582
<span class="returnvalue">gboolean</span>
 
583
</td>
 
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>
 
586
</td>
 
587
</tr>
 
588
<tr>
 
589
<td class="function_type">
 
590
<span class="returnvalue">void</span>
 
591
</td>
 
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>
 
594
</td>
 
595
</tr>
 
596
<tr>
 
597
<td class="function_type">
 
598
<span class="returnvalue">void</span>
 
599
</td>
 
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>
 
602
</td>
 
603
</tr>
 
604
</tbody>
 
605
</table></div>
 
606
</div>
 
607
<div class="refsect1">
 
608
<a name="ClutterText.properties"></a><h2>Properties</h2>
 
609
<div class="informaltable"><table border="0">
 
610
<colgroup>
 
611
<col width="150px" class="properties_type">
 
612
<col width="300px" class="properties_name">
 
613
<col width="200px" class="properties_flags">
 
614
</colgroup>
 
615
<tbody>
 
616
<tr>
 
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>
 
620
</tr>
 
621
<tr>
 
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>
 
626
</tr>
 
627
<tr>
 
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>
 
632
</tr>
 
633
<tr>
 
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>
 
638
</tr>
 
639
<tr>
 
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>
 
644
</tr>
 
645
<tr>
 
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>
 
649
</tr>
 
650
<tr>
 
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>
 
654
</tr>
 
655
<tr>
 
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>
 
659
</tr>
 
660
<tr>
 
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>
 
664
</tr>
 
665
<tr>
 
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>
 
669
</tr>
 
670
<tr>
 
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>
 
674
</tr>
 
675
<tr>
 
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>
 
680
</tr>
 
681
<tr>
 
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>
 
686
</tr>
 
687
<tr>
 
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>
 
691
</tr>
 
692
<tr>
 
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>
 
696
</tr>
 
697
<tr>
 
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>
 
701
</tr>
 
702
<tr>
 
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>
 
706
</tr>
 
707
<tr>
 
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>
 
711
</tr>
 
712
<tr>
 
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>
 
716
</tr>
 
717
<tr>
 
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>
 
721
</tr>
 
722
<tr>
 
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>
 
726
</tr>
 
727
<tr>
 
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>
 
732
</tr>
 
733
<tr>
 
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>
 
737
</tr>
 
738
<tr>
 
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>
 
742
</tr>
 
743
<tr>
 
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>
 
748
</tr>
 
749
<tr>
 
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>
 
753
</tr>
 
754
<tr>
 
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>
 
758
</tr>
 
759
<tr>
 
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>
 
764
</tr>
 
765
<tr>
 
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>
 
769
</tr>
 
770
</tbody>
 
771
</table></div>
 
772
</div>
 
773
<div class="refsect1">
 
774
<a name="ClutterText.signals"></a><h2>Signals</h2>
 
775
<div class="informaltable"><table border="0">
 
776
<colgroup>
 
777
<col width="150px" class="signals_return">
 
778
<col width="300px" class="signals_name">
 
779
<col width="200px" class="signals_flags">
 
780
</colgroup>
 
781
<tbody>
 
782
<tr>
 
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>
 
786
</tr>
 
787
<tr>
 
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>
 
791
</tr>
 
792
<tr>
 
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>
 
796
</tr>
 
797
<tr>
 
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>
 
801
</tr>
 
802
<tr>
 
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>
 
806
</tr>
 
807
<tr>
 
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>
 
811
</tr>
 
812
</tbody>
 
813
</table></div>
 
814
</div>
 
815
<div class="refsect1">
 
816
<a name="ClutterText.other"></a><h2>Types and Values</h2>
 
817
<div class="informaltable"><table width="100%" border="0">
 
818
<colgroup>
 
819
<col width="150px" class="name">
 
820
<col class="description">
 
821
</colgroup>
 
822
<tbody>
 
823
<tr>
 
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>
 
826
</tr>
 
827
<tr>
 
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>
 
830
</tr>
 
831
</tbody>
 
832
</table></div>
180
833
</div>
181
834
<div class="refsect1">
182
835
<a name="ClutterText.object-hierarchy"></a><h2>Object Hierarchy</h2>
183
 
<pre class="synopsis">
184
 
  GObject
185
 
   +----GInitiallyUnowned
186
 
         +----<a class="link" href="ClutterActor.html" title="ClutterActor">ClutterActor</a>
187
 
               +----ClutterText
 
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
188
840
</pre>
189
841
</div>
190
842
<div class="refsect1">
194
846
 <a class="link" href="ClutterContainer.html" title="ClutterContainer">ClutterContainer</a>,  <a class="link" href="ClutterScriptable.html" title="ClutterScriptable">ClutterScriptable</a>,  <a class="link" href="ClutterAnimatable.html" title="ClutterAnimatable">ClutterAnimatable</a> and  AtkImplementorIface.</p>
195
847
</div>
196
848
<div class="refsect1">
197
 
<a name="ClutterText.properties"></a><h2>Properties</h2>
198
 
<pre class="synopsis">
199
 
  "<a class="link" href="ClutterText.html#ClutterText--activatable" title='The "activatable" property'>activatable</a>"              <span class="type">gboolean</span>              : Read / Write
200
 
  "<a class="link" href="ClutterText.html#ClutterText--attributes" title='The "attributes" property'>attributes</a>"               <span class="type">PangoAttrList</span>*        : Read / Write
201
 
  "<a class="link" href="ClutterText.html#ClutterText--buffer" title='The "buffer" property'>buffer</a>"                   <a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a>*    : Read / Write
202
 
  "<a class="link" href="ClutterText.html#ClutterText--color" title='The "color" property'>color</a>"                    <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a>*         : Read / Write
203
 
  "<a class="link" href="ClutterText.html#ClutterText--cursor-color" title='The "cursor-color" property'>cursor-color</a>"             <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a>*         : Read / Write
204
 
  "<a class="link" href="ClutterText.html#ClutterText--cursor-color-set" title='The "cursor-color-set" property'>cursor-color-set</a>"         <span class="type">gboolean</span>              : Read
205
 
  "<a class="link" href="ClutterText.html#ClutterText--cursor-position" title='The "cursor-position" property'>cursor-position</a>"          <span class="type">gint</span>                  : Read / Write
206
 
  "<a class="link" href="ClutterText.html#ClutterText--cursor-size" title='The "cursor-size" property'>cursor-size</a>"              <span class="type">gint</span>                  : Read / Write
207
 
  "<a class="link" href="ClutterText.html#ClutterText--cursor-visible" title='The "cursor-visible" property'>cursor-visible</a>"           <span class="type">gboolean</span>              : Read / Write
208
 
  "<a class="link" href="ClutterText.html#ClutterText--editable" title='The "editable" property'>editable</a>"                 <span class="type">gboolean</span>              : Read / Write
209
 
  "<a class="link" href="ClutterText.html#ClutterText--ellipsize" title='The "ellipsize" property'>ellipsize</a>"                <span class="type">PangoEllipsizeMode</span>    : Read / Write
210
 
  "<a class="link" href="ClutterText.html#ClutterText--font-description" title='The "font-description" property'>font-description</a>"         <span class="type">PangoFontDescription</span>*  : Read / Write
211
 
  "<a class="link" href="ClutterText.html#ClutterText--font-name" title='The "font-name" property'>font-name</a>"                <span class="type">gchar</span>*                : Read / Write
212
 
  "<a class="link" href="ClutterText.html#ClutterText--justify" title='The "justify" property'>justify</a>"                  <span class="type">gboolean</span>              : Read / Write
213
 
  "<a class="link" href="ClutterText.html#ClutterText--line-alignment" title='The "line-alignment" property'>line-alignment</a>"           <span class="type">PangoAlignment</span>        : Read / Write
214
 
  "<a class="link" href="ClutterText.html#ClutterText--line-wrap" title='The "line-wrap" property'>line-wrap</a>"                <span class="type">gboolean</span>              : Read / Write
215
 
  "<a class="link" href="ClutterText.html#ClutterText--line-wrap-mode" title='The "line-wrap-mode" property'>line-wrap-mode</a>"           <span class="type">PangoWrapMode</span>         : Read / Write
216
 
  "<a class="link" href="ClutterText.html#ClutterText--max-length" title='The "max-length" property'>max-length</a>"               <span class="type">gint</span>                  : Read / Write
217
 
  "<a class="link" href="ClutterText.html#ClutterText--password-char" title='The "password-char" property'>password-char</a>"            <span class="type">guint</span>                 : Read / Write
218
 
  "<a class="link" href="ClutterText.html#ClutterText--position" title='The "position" property'>position</a>"                 <span class="type">gint</span>                  : Read / Write
219
 
  "<a class="link" href="ClutterText.html#ClutterText--selectable" title='The "selectable" property'>selectable</a>"               <span class="type">gboolean</span>              : Read / Write
220
 
  "<a class="link" href="ClutterText.html#ClutterText--selected-text-color" title='The "selected-text-color" property'>selected-text-color</a>"      <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a>*         : Read / Write
221
 
  "<a class="link" href="ClutterText.html#ClutterText--selected-text-color-set" title='The "selected-text-color-set" property'>selected-text-color-set</a>"  <span class="type">gboolean</span>              : Read
222
 
  "<a class="link" href="ClutterText.html#ClutterText--selection-bound" title='The "selection-bound" property'>selection-bound</a>"          <span class="type">gint</span>                  : Read / Write
223
 
  "<a class="link" href="ClutterText.html#ClutterText--selection-color" title='The "selection-color" property'>selection-color</a>"          <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a>*         : Read / Write
224
 
  "<a class="link" href="ClutterText.html#ClutterText--selection-color-set" title='The "selection-color-set" property'>selection-color-set</a>"      <span class="type">gboolean</span>              : Read
225
 
  "<a class="link" href="ClutterText.html#ClutterText--single-line-mode" title='The "single-line-mode" property'>single-line-mode</a>"         <span class="type">gboolean</span>              : Read / Write
226
 
  "<a class="link" href="ClutterText.html#ClutterText--text" title='The "text" property'>text</a>"                     <span class="type">gchar</span>*                : Read / Write
227
 
  "<a class="link" href="ClutterText.html#ClutterText--use-markup" title='The "use-markup" property'>use-markup</a>"               <span class="type">gboolean</span>              : Read / Write
228
 
</pre>
229
 
</div>
230
 
<div class="refsect1">
231
 
<a name="ClutterText.signals"></a><h2>Signals</h2>
232
 
<pre class="synopsis">
233
 
  "<a class="link" href="ClutterText.html#ClutterText-activate" title='The "activate" signal'>activate</a>"                                       : <code class="literal">Run Last</code>
234
 
  "<a class="link" href="ClutterText.html#ClutterText-cursor-event" title='The "cursor-event" signal'>cursor-event</a>"                                   : <code class="literal">Run Last</code>
235
 
  "<a class="link" href="ClutterText.html#ClutterText-delete-text" title='The "delete-text" signal'>delete-text</a>"                                    : <code class="literal">Action</code>
236
 
  "<a class="link" href="ClutterText.html#ClutterText-insert-text" title='The "insert-text" signal'>insert-text</a>"                                    : <code class="literal">Action</code>
237
 
  "<a class="link" href="ClutterText.html#ClutterText-text-changed" title='The "text-changed" signal'>text-changed</a>"                                   : <code class="literal">Run Last</code>
238
 
</pre>
239
 
</div>
240
 
<div class="refsect1">
241
849
<a name="ClutterText.description"></a><h2>Description</h2>
242
 
<p>
243
 
<a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> is an actor that displays custom text using Pango
244
 
as the text rendering engine.
245
 
</p>
246
 
<p>
247
 
<a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> also allows inline editing of the text if the
248
 
actor is set editable using <a class="link" href="ClutterText.html#clutter-text-set-editable" title="clutter_text_set_editable ()"><code class="function">clutter_text_set_editable()</code></a>.
249
 
</p>
250
 
<p>
251
 
Selection using keyboard or pointers can be enabled using
252
 
<a class="link" href="ClutterText.html#clutter-text-set-selectable" title="clutter_text_set_selectable ()"><code class="function">clutter_text_set_selectable()</code></a>.
253
 
</p>
254
 
<p>
255
 
<a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> is available since Clutter 1.0
256
 
</p>
 
850
<p><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> is an actor that displays custom text using Pango
 
851
as the text rendering engine.</p>
 
852
<p><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> also allows inline editing of the text if the
 
853
actor is set editable using <a class="link" href="ClutterText.html#clutter-text-set-editable" title="clutter_text_set_editable ()"><code class="function">clutter_text_set_editable()</code></a>.</p>
 
854
<p>Selection using keyboard or pointers can be enabled using
 
855
<a class="link" href="ClutterText.html#clutter-text-set-selectable" title="clutter_text_set_selectable ()"><code class="function">clutter_text_set_selectable()</code></a>.</p>
 
856
<p><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> is available since Clutter 1.0</p>
257
857
</div>
258
858
<div class="refsect1">
259
 
<a name="ClutterText.details"></a><h2>Details</h2>
260
 
<div class="refsect2">
261
 
<a name="ClutterText-struct"></a><h3>struct ClutterText</h3>
262
 
<pre class="programlisting">struct ClutterText;</pre>
263
 
<p>
264
 
The <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> struct contains only private data.
265
 
</p>
266
 
<p class="since">Since 1.0</p>
267
 
</div>
268
 
<hr>
269
 
<div class="refsect2">
270
 
<a name="ClutterTextClass"></a><h3>struct ClutterTextClass</h3>
271
 
<pre class="programlisting">struct ClutterTextClass {
272
 
  /* signals, not vfuncs */
273
 
  void (* text_changed) (ClutterText           *self);
274
 
  void (* activate)     (ClutterText           *self);
275
 
  void (* cursor_event) (ClutterText           *self,
276
 
                         const ClutterGeometry *geometry);
277
 
};
278
 
</pre>
279
 
<p>
280
 
The <a class="link" href="ClutterText.html#ClutterTextClass" title="struct ClutterTextClass"><span class="type">ClutterTextClass</span></a> struct contains only private data.
281
 
</p>
282
 
<div class="variablelist"><table border="0" class="variablelist">
283
 
<colgroup>
284
 
<col align="left" valign="top">
285
 
<col>
286
 
</colgroup>
287
 
<tbody>
288
 
<tr>
289
 
<td><p><span class="term"><em class="structfield"><code><a name="ClutterTextClass.text-changed"></a>text_changed</code></em> ()</span></p></td>
290
 
<td>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</td>
291
 
</tr>
292
 
<tr>
293
 
<td><p><span class="term"><em class="structfield"><code><a name="ClutterTextClass.activate"></a>activate</code></em> ()</span></p></td>
294
 
<td>class handler for the <a class="link" href="ClutterText.html#ClutterText-activate" title='The "activate" signal'><span class="type">"activate"</span></a> signal</td>
295
 
</tr>
296
 
<tr>
297
 
<td><p><span class="term"><em class="structfield"><code><a name="ClutterTextClass.cursor-event"></a>cursor_event</code></em> ()</span></p></td>
298
 
<td>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</td>
299
 
</tr>
300
 
</tbody>
301
 
</table></div>
302
 
<p class="since">Since 1.0</p>
303
 
</div>
304
 
<hr>
305
 
<div class="refsect2">
306
 
<a name="clutter-text-new"></a><h3>clutter_text_new ()</h3>
307
 
<pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      clutter_text_new                    (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
308
 
<p>
309
 
Creates a new <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor. This actor can be used to
310
 
display and edit text.
311
 
</p>
312
 
<div class="variablelist"><table border="0" class="variablelist">
313
 
<colgroup>
314
 
<col align="left" valign="top">
315
 
<col>
316
 
</colgroup>
317
 
<tbody><tr>
318
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
319
 
<td>the newly created <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor</td>
320
 
</tr></tbody>
321
 
</table></div>
322
 
<p class="since">Since 1.0</p>
323
 
</div>
324
 
<hr>
325
 
<div class="refsect2">
326
 
<a name="clutter-text-new-full"></a><h3>clutter_text_new_full ()</h3>
327
 
<pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      clutter_text_new_full               (<em class="parameter"><code>const <span class="type">gchar</span> *font_name</code></em>,
328
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>,
329
 
                                                         <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>
330
 
<p>
331
 
Creates a new <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor, using <em class="parameter"><code>font_name</code></em> as the font
332
 
description; <em class="parameter"><code>text</code></em> will be used to set the contents of the actor;
333
 
and <em class="parameter"><code>color</code></em> will be used as the color to render <em class="parameter"><code>text</code></em>.
334
 
</p>
335
 
<p>
336
 
This function is equivalent to calling <a class="link" href="ClutterText.html#clutter-text-new" title="clutter_text_new ()"><code class="function">clutter_text_new()</code></a>,
337
 
<a class="link" href="ClutterText.html#clutter-text-set-font-name" title="clutter_text_set_font_name ()"><code class="function">clutter_text_set_font_name()</code></a>, <a class="link" href="ClutterText.html#clutter-text-set-text" title="clutter_text_set_text ()"><code class="function">clutter_text_set_text()</code></a> and
338
 
<a class="link" href="ClutterText.html#clutter-text-set-color" title="clutter_text_set_color ()"><code class="function">clutter_text_set_color()</code></a>.
339
 
</p>
340
 
<div class="variablelist"><table border="0" class="variablelist">
341
 
<colgroup>
342
 
<col align="left" valign="top">
343
 
<col>
344
 
</colgroup>
345
 
<tbody>
346
 
<tr>
347
 
<td><p><span class="term"><em class="parameter"><code>font_name</code></em> :</span></p></td>
348
 
<td>a string with a font description</td>
349
 
</tr>
350
 
<tr>
351
 
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
352
 
<td>the contents of the actor</td>
353
 
</tr>
354
 
<tr>
355
 
<td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
356
 
<td>the color to be used to render <em class="parameter"><code>text</code></em>
357
 
</td>
358
 
</tr>
359
 
<tr>
360
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
361
 
<td>the newly created <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor</td>
362
 
</tr>
363
 
</tbody>
364
 
</table></div>
365
 
<p class="since">Since 1.0</p>
366
 
</div>
367
 
<hr>
368
 
<div class="refsect2">
369
 
<a name="clutter-text-new-with-text"></a><h3>clutter_text_new_with_text ()</h3>
370
 
<pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      clutter_text_new_with_text          (<em class="parameter"><code>const <span class="type">gchar</span> *font_name</code></em>,
371
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>);</pre>
372
 
<p>
373
 
Creates a new <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor, using <em class="parameter"><code>font_name</code></em> as the font
374
 
description; <em class="parameter"><code>text</code></em> will be used to set the contents of the actor.
375
 
</p>
376
 
<p>
377
 
This function is equivalent to calling <a class="link" href="ClutterText.html#clutter-text-new" title="clutter_text_new ()"><code class="function">clutter_text_new()</code></a>,
378
 
<a class="link" href="ClutterText.html#clutter-text-set-font-name" title="clutter_text_set_font_name ()"><code class="function">clutter_text_set_font_name()</code></a>, and <a class="link" href="ClutterText.html#clutter-text-set-text" title="clutter_text_set_text ()"><code class="function">clutter_text_set_text()</code></a>.
379
 
</p>
380
 
<div class="variablelist"><table border="0" class="variablelist">
381
 
<colgroup>
382
 
<col align="left" valign="top">
383
 
<col>
384
 
</colgroup>
385
 
<tbody>
386
 
<tr>
387
 
<td><p><span class="term"><em class="parameter"><code>font_name</code></em> :</span></p></td>
388
 
<td>a string with a font description. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
389
 
</td>
390
 
</tr>
391
 
<tr>
392
 
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
393
 
<td>the contents of the actor</td>
394
 
</tr>
395
 
<tr>
396
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
397
 
<td>the newly created <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor</td>
398
 
</tr>
399
 
</tbody>
400
 
</table></div>
401
 
<p class="since">Since 1.0</p>
402
 
</div>
403
 
<hr>
404
 
<div class="refsect2">
405
 
<a name="clutter-text-new-with-buffer"></a><h3>clutter_text_new_with_buffer ()</h3>
406
 
<pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *      clutter_text_new_with_buffer        (<em class="parameter"><code><a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a> *buffer</code></em>);</pre>
407
 
<p>
408
 
Creates a new entry with the specified text buffer.
409
 
</p>
410
 
<div class="variablelist"><table border="0" class="variablelist">
411
 
<colgroup>
412
 
<col align="left" valign="top">
413
 
<col>
414
 
</colgroup>
415
 
<tbody>
416
 
<tr>
417
 
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
418
 
<td>The buffer to use for the new <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>.</td>
419
 
</tr>
420
 
<tr>
421
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
422
 
<td>a new <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
423
 
</td>
424
 
</tr>
425
 
</tbody>
426
 
</table></div>
427
 
<p class="since">Since 1.10</p>
428
 
</div>
429
 
<hr>
430
 
<div class="refsect2">
431
 
<a name="clutter-text-set-buffer"></a><h3>clutter_text_set_buffer ()</h3>
432
 
<pre class="programlisting"><span class="returnvalue">void</span>                clutter_text_set_buffer             (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
433
 
                                                         <em class="parameter"><code><a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a> *buffer</code></em>);</pre>
434
 
<p>
435
 
Set the <a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a> object which holds the text for
436
 
this widget.
437
 
</p>
438
 
<div class="variablelist"><table border="0" class="variablelist">
439
 
<colgroup>
440
 
<col align="left" valign="top">
441
 
<col>
442
 
</colgroup>
443
 
<tbody>
444
 
<tr>
445
 
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
446
 
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
447
 
</td>
448
 
</tr>
449
 
<tr>
450
 
<td><p><span class="term"><em class="parameter"><code>buffer</code></em> :</span></p></td>
451
 
<td>a <a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a>
452
 
</td>
453
 
</tr>
454
 
</tbody>
455
 
</table></div>
456
 
<p class="since">Since 1.10</p>
457
 
</div>
458
 
<hr>
459
 
<div class="refsect2">
460
 
<a name="clutter-text-get-buffer"></a><h3>clutter_text_get_buffer ()</h3>
461
 
<pre class="programlisting"><a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="returnvalue">ClutterTextBuffer</span></a> * clutter_text_get_buffer             (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
462
 
<p>
463
 
Get the <a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a> object which holds the text for
464
 
this widget.
465
 
</p>
466
 
<div class="variablelist"><table border="0" class="variablelist">
467
 
<colgroup>
468
 
<col align="left" valign="top">
469
 
<col>
470
 
</colgroup>
471
 
<tbody>
472
 
<tr>
473
 
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
474
 
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
475
 
</td>
476
 
</tr>
477
 
<tr>
478
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
479
 
<td>A <span class="type">GtkEntryBuffer</span> object. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
480
 
</td>
481
 
</tr>
482
 
</tbody>
483
 
</table></div>
484
 
<p class="since">Since 1.10</p>
485
 
</div>
486
 
<hr>
487
 
<div class="refsect2">
488
 
<a name="clutter-text-set-text"></a><h3>clutter_text_set_text ()</h3>
489
 
<pre class="programlisting"><span class="returnvalue">void</span>                clutter_text_set_text               (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
490
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>);</pre>
491
 
<p>
492
 
Sets the contents of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.
493
 
</p>
494
 
<p>
495
 
If the <a class="link" href="ClutterText.html#ClutterText--use-markup" title='The "use-markup" property'><span class="type">"use-markup"</span></a> property was set to <code class="literal">TRUE</code> it
 
859
<a name="ClutterText.functions_details"></a><h2>Functions</h2>
 
860
<div class="refsect2">
 
861
<a name="clutter-text-new"></a><h3>clutter_text_new ()</h3>
 
862
<pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
 
863
clutter_text_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
864
<p>Creates a new <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor. This actor can be used to
 
865
display and edit text.</p>
 
866
<div class="refsect3">
 
867
<a name="id-1.5.3.4.10.2.5"></a><h4>Returns</h4>
 
868
<p> the newly created <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor</p>
 
869
<p></p>
 
870
</div>
 
871
<p class="since">Since 1.0</p>
 
872
</div>
 
873
<hr>
 
874
<div class="refsect2">
 
875
<a name="clutter-text-new-full"></a><h3>clutter_text_new_full ()</h3>
 
876
<pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
 
877
clutter_text_new_full (<em class="parameter"><code>const <span class="type">gchar</span> *font_name</code></em>,
 
878
                       <em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>,
 
879
                       <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>
 
880
<p>Creates a new <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor, using <em class="parameter"><code>font_name</code></em>
 
881
 as the font
 
882
description; <em class="parameter"><code>text</code></em>
 
883
 will be used to set the contents of the actor;
 
884
and <em class="parameter"><code>color</code></em>
 
885
 will be used as the color to render <em class="parameter"><code>text</code></em>
 
886
.</p>
 
887
<p>This function is equivalent to calling <a class="link" href="ClutterText.html#clutter-text-new" title="clutter_text_new ()"><code class="function">clutter_text_new()</code></a>,
 
888
<a class="link" href="ClutterText.html#clutter-text-set-font-name" title="clutter_text_set_font_name ()"><code class="function">clutter_text_set_font_name()</code></a>, <a class="link" href="ClutterText.html#clutter-text-set-text" title="clutter_text_set_text ()"><code class="function">clutter_text_set_text()</code></a> and
 
889
<a class="link" href="ClutterText.html#clutter-text-set-color" title="clutter_text_set_color ()"><code class="function">clutter_text_set_color()</code></a>.</p>
 
890
<div class="refsect3">
 
891
<a name="id-1.5.3.4.10.3.6"></a><h4>Parameters</h4>
 
892
<div class="informaltable"><table width="100%" border="0">
 
893
<colgroup>
 
894
<col width="150px" class="parameters_name">
 
895
<col class="parameters_description">
 
896
<col width="200px" class="parameters_annotations">
 
897
</colgroup>
 
898
<tbody>
 
899
<tr>
 
900
<td class="parameter_name"><p>font_name</p></td>
 
901
<td class="parameter_description"><p>a string with a font description</p></td>
 
902
<td class="parameter_annotations"> </td>
 
903
</tr>
 
904
<tr>
 
905
<td class="parameter_name"><p>text</p></td>
 
906
<td class="parameter_description"><p>the contents of the actor</p></td>
 
907
<td class="parameter_annotations"> </td>
 
908
</tr>
 
909
<tr>
 
910
<td class="parameter_name"><p>color</p></td>
 
911
<td class="parameter_description"><p>the color to be used to render <em class="parameter"><code>text</code></em>
 
912
</p></td>
 
913
<td class="parameter_annotations"> </td>
 
914
</tr>
 
915
</tbody>
 
916
</table></div>
 
917
</div>
 
918
<div class="refsect3">
 
919
<a name="id-1.5.3.4.10.3.7"></a><h4>Returns</h4>
 
920
<p> the newly created <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor</p>
 
921
<p></p>
 
922
</div>
 
923
<p class="since">Since 1.0</p>
 
924
</div>
 
925
<hr>
 
926
<div class="refsect2">
 
927
<a name="clutter-text-new-with-text"></a><h3>clutter_text_new_with_text ()</h3>
 
928
<pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
 
929
clutter_text_new_with_text (<em class="parameter"><code>const <span class="type">gchar</span> *font_name</code></em>,
 
930
                            <em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>);</pre>
 
931
<p>Creates a new <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor, using <em class="parameter"><code>font_name</code></em>
 
932
 as the font
 
933
description; <em class="parameter"><code>text</code></em>
 
934
 will be used to set the contents of the actor.</p>
 
935
<p>This function is equivalent to calling <a class="link" href="ClutterText.html#clutter-text-new" title="clutter_text_new ()"><code class="function">clutter_text_new()</code></a>,
 
936
<a class="link" href="ClutterText.html#clutter-text-set-font-name" title="clutter_text_set_font_name ()"><code class="function">clutter_text_set_font_name()</code></a>, and <a class="link" href="ClutterText.html#clutter-text-set-text" title="clutter_text_set_text ()"><code class="function">clutter_text_set_text()</code></a>.</p>
 
937
<div class="refsect3">
 
938
<a name="id-1.5.3.4.10.4.6"></a><h4>Parameters</h4>
 
939
<div class="informaltable"><table width="100%" border="0">
 
940
<colgroup>
 
941
<col width="150px" class="parameters_name">
 
942
<col class="parameters_description">
 
943
<col width="200px" class="parameters_annotations">
 
944
</colgroup>
 
945
<tbody>
 
946
<tr>
 
947
<td class="parameter_name"><p>font_name</p></td>
 
948
<td class="parameter_description"><p> a string with a font description. </p></td>
 
949
<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>
 
950
</tr>
 
951
<tr>
 
952
<td class="parameter_name"><p>text</p></td>
 
953
<td class="parameter_description"><p>the contents of the actor</p></td>
 
954
<td class="parameter_annotations"> </td>
 
955
</tr>
 
956
</tbody>
 
957
</table></div>
 
958
</div>
 
959
<div class="refsect3">
 
960
<a name="id-1.5.3.4.10.4.7"></a><h4>Returns</h4>
 
961
<p> the newly created <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor</p>
 
962
<p></p>
 
963
</div>
 
964
<p class="since">Since 1.0</p>
 
965
</div>
 
966
<hr>
 
967
<div class="refsect2">
 
968
<a name="clutter-text-new-with-buffer"></a><h3>clutter_text_new_with_buffer ()</h3>
 
969
<pre class="programlisting"><a class="link" href="ClutterActor.html" title="ClutterActor"><span class="returnvalue">ClutterActor</span></a> *
 
970
clutter_text_new_with_buffer (<em class="parameter"><code><a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a> *buffer</code></em>);</pre>
 
971
<p>Creates a new entry with the specified text buffer.</p>
 
972
<div class="refsect3">
 
973
<a name="id-1.5.3.4.10.5.5"></a><h4>Parameters</h4>
 
974
<div class="informaltable"><table width="100%" border="0">
 
975
<colgroup>
 
976
<col width="150px" class="parameters_name">
 
977
<col class="parameters_description">
 
978
<col width="200px" class="parameters_annotations">
 
979
</colgroup>
 
980
<tbody><tr>
 
981
<td class="parameter_name"><p>buffer</p></td>
 
982
<td class="parameter_description"><p>The buffer to use for the new <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>.</p></td>
 
983
<td class="parameter_annotations"> </td>
 
984
</tr></tbody>
 
985
</table></div>
 
986
</div>
 
987
<div class="refsect3">
 
988
<a name="id-1.5.3.4.10.5.6"></a><h4>Returns</h4>
 
989
<p> a new <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p>
 
990
<p></p>
 
991
</div>
 
992
<p class="since">Since 1.10</p>
 
993
</div>
 
994
<hr>
 
995
<div class="refsect2">
 
996
<a name="clutter-text-set-buffer"></a><h3>clutter_text_set_buffer ()</h3>
 
997
<pre class="programlisting"><span class="returnvalue">void</span>
 
998
clutter_text_set_buffer (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
 
999
                         <em class="parameter"><code><a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a> *buffer</code></em>);</pre>
 
1000
<p>Set the <a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a> object which holds the text for
 
1001
this widget.</p>
 
1002
<div class="refsect3">
 
1003
<a name="id-1.5.3.4.10.6.5"></a><h4>Parameters</h4>
 
1004
<div class="informaltable"><table width="100%" border="0">
 
1005
<colgroup>
 
1006
<col width="150px" class="parameters_name">
 
1007
<col class="parameters_description">
 
1008
<col width="200px" class="parameters_annotations">
 
1009
</colgroup>
 
1010
<tbody>
 
1011
<tr>
 
1012
<td class="parameter_name"><p>self</p></td>
 
1013
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
 
1014
<td class="parameter_annotations"> </td>
 
1015
</tr>
 
1016
<tr>
 
1017
<td class="parameter_name"><p>buffer</p></td>
 
1018
<td class="parameter_description"><p>a <a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a></p></td>
 
1019
<td class="parameter_annotations"> </td>
 
1020
</tr>
 
1021
</tbody>
 
1022
</table></div>
 
1023
</div>
 
1024
<p class="since">Since 1.10</p>
 
1025
</div>
 
1026
<hr>
 
1027
<div class="refsect2">
 
1028
<a name="clutter-text-get-buffer"></a><h3>clutter_text_get_buffer ()</h3>
 
1029
<pre class="programlisting"><a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="returnvalue">ClutterTextBuffer</span></a> *
 
1030
clutter_text_get_buffer (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
 
1031
<p>Get the <a class="link" href="ClutterTextBuffer.html" title="ClutterTextBuffer"><span class="type">ClutterTextBuffer</span></a> object which holds the text for
 
1032
this widget.</p>
 
1033
<div class="refsect3">
 
1034
<a name="id-1.5.3.4.10.7.5"></a><h4>Parameters</h4>
 
1035
<div class="informaltable"><table width="100%" border="0">
 
1036
<colgroup>
 
1037
<col width="150px" class="parameters_name">
 
1038
<col class="parameters_description">
 
1039
<col width="200px" class="parameters_annotations">
 
1040
</colgroup>
 
1041
<tbody><tr>
 
1042
<td class="parameter_name"><p>self</p></td>
 
1043
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
 
1044
<td class="parameter_annotations"> </td>
 
1045
</tr></tbody>
 
1046
</table></div>
 
1047
</div>
 
1048
<div class="refsect3">
 
1049
<a name="id-1.5.3.4.10.7.6"></a><h4>Returns</h4>
 
1050
<p> A <span class="type">GtkEntryBuffer</span> object. </p>
 
1051
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 
1052
</div>
 
1053
<p class="since">Since 1.10</p>
 
1054
</div>
 
1055
<hr>
 
1056
<div class="refsect2">
 
1057
<a name="clutter-text-set-text"></a><h3>clutter_text_set_text ()</h3>
 
1058
<pre class="programlisting"><span class="returnvalue">void</span>
 
1059
clutter_text_set_text (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
 
1060
                       <em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>);</pre>
 
1061
<p>Sets the contents of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.</p>
 
1062
<p>If the <a class="link" href="ClutterText.html#ClutterText--use-markup" title="The “use-markup” property"><span class="type">“use-markup”</span></a> property was set to <code class="literal">TRUE</code> it
496
1063
will be reset to <code class="literal">FALSE</code> as a side effect. If you want to
497
 
maintain the <a class="link" href="ClutterText.html#ClutterText--use-markup" title='The "use-markup" property'><span class="type">"use-markup"</span></a> you should use the
498
 
<a class="link" href="ClutterText.html#clutter-text-set-markup" title="clutter_text_set_markup ()"><code class="function">clutter_text_set_markup()</code></a> function instead
499
 
</p>
500
 
<div class="variablelist"><table border="0" class="variablelist">
 
1064
maintain the <a class="link" href="ClutterText.html#ClutterText--use-markup" title="The “use-markup” property"><span class="type">“use-markup”</span></a> you should use the
 
1065
<a class="link" href="ClutterText.html#clutter-text-set-markup" title="clutter_text_set_markup ()"><code class="function">clutter_text_set_markup()</code></a> function instead</p>
 
1066
<div class="refsect3">
 
1067
<a name="id-1.5.3.4.10.8.6"></a><h4>Parameters</h4>
 
1068
<div class="informaltable"><table width="100%" border="0">
501
1069
<colgroup>
502
 
<col align="left" valign="top">
503
 
<col>
 
1070
<col width="150px" class="parameters_name">
 
1071
<col class="parameters_description">
 
1072
<col width="200px" class="parameters_annotations">
504
1073
</colgroup>
505
1074
<tbody>
506
1075
<tr>
507
 
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
508
 
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
509
 
</td>
 
1076
<td class="parameter_name"><p>self</p></td>
 
1077
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
 
1078
<td class="parameter_annotations"> </td>
510
1079
</tr>
511
1080
<tr>
512
 
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
513
 
<td>the text to set. Passing <code class="literal">NULL</code> is the same
514
 
as passing "" (the empty string). <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
515
 
</td>
 
1081
<td class="parameter_name"><p>text</p></td>
 
1082
<td class="parameter_description"><p> the text to set. Passing <code class="literal">NULL</code> is the same
 
1083
as passing "" (the empty string). </p></td>
 
1084
<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>
516
1085
</tr>
517
1086
</tbody>
518
1087
</table></div>
 
1088
</div>
519
1089
<p class="since">Since 1.0</p>
520
1090
</div>
521
1091
<hr>
522
1092
<div class="refsect2">
523
 
<a name="clutter-text-set-markup"></a><h3>clutter_text_set_markup ()</h3>
524
 
<pre class="programlisting"><span class="returnvalue">void</span>                clutter_text_set_markup             (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
525
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *markup</code></em>);</pre>
526
 
<p>
527
 
Sets <em class="parameter"><code>markup</code></em> as the contents of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>.
528
 
</p>
529
 
<p>
530
 
This is a convenience function for setting a string containing
531
 
Pango markup, and it is logically equivalent to:
532
 
</p>
533
 
<p>
534
 
</p>
 
1093
<a name="clutter-text-set-markup"></a><h3>clutter_text_set_markup ()</h3>
 
1094
<pre class="programlisting"><span class="returnvalue">void</span>
 
1095
clutter_text_set_markup (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
 
1096
                         <em class="parameter"><code>const <span class="type">gchar</span> *markup</code></em>);</pre>
 
1097
<p>Sets <em class="parameter"><code>markup</code></em>
 
1098
 as the contents of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>.</p>
 
1099
<p>This is a convenience function for setting a string containing
 
1100
Pango markup, and it is logically equivalent to:</p>
535
1101
<div class="informalexample">
536
1102
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
537
1103
    <tbody>
539
1105
        <td class="listing_lines" align="right"><pre>1
540
1106
2
541
1107
3</pre></td>
542
 
        <td class="listing_code"><pre class="programlisting"><span class="comment">/* the order is important */</span>
 
1108
        <td class="listing_code"><pre class="programlisting"><span class="symbol">/&amp;</span><span class="normal">ast</span><span class="symbol">;</span><span class="normal"> the order </span><span class="usertype">is</span><span class="normal"> </span><span class="usertype">important</span><span class="normal"> </span><span class="symbol">&amp;</span><span class="normal">ast</span><span class="symbol">;/</span>
543
1109
<span class="function"><a href="ClutterText.html#clutter-text-set-text">clutter_text_set_text</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">CLUTTER_TEXT</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">actor</span><span class="symbol">),</span><span class="normal"> markup</span><span class="symbol">);</span>
544
1110
<span class="function"><a href="ClutterText.html#clutter-text-set-use-markup">clutter_text_set_use_markup</a></span><span class="normal"> </span><span class="symbol">(</span><span class="function">CLUTTER_TEXT</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">actor</span><span class="symbol">),</span><span class="normal"> TRUE</span><span class="symbol">);</span></pre></td>
545
1111
      </tr>
547
1113
  </table>
548
1114
</div>
549
1115
 
550
 
<p>
551
 
</p>
552
 
<div class="variablelist"><table border="0" class="variablelist">
 
1116
<p></p>
 
1117
<div class="refsect3">
 
1118
<a name="id-1.5.3.4.10.9.8"></a><h4>Parameters</h4>
 
1119
<div class="informaltable"><table width="100%" border="0">
553
1120
<colgroup>
554
 
<col align="left" valign="top">
555
 
<col>
 
1121
<col width="150px" class="parameters_name">
 
1122
<col class="parameters_description">
 
1123
<col width="200px" class="parameters_annotations">
556
1124
</colgroup>
557
1125
<tbody>
558
1126
<tr>
559
 
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
560
 
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
561
 
</td>
 
1127
<td class="parameter_name"><p>self</p></td>
 
1128
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
 
1129
<td class="parameter_annotations"> </td>
562
1130
</tr>
563
1131
<tr>
564
 
<td><p><span class="term"><em class="parameter"><code>markup</code></em> :</span></p></td>
565
 
<td>a string containing Pango markup.
566
 
Passing <code class="literal">NULL</code> is the same as passing "" (the empty string). <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
567
 
</td>
 
1132
<td class="parameter_name"><p>markup</p></td>
 
1133
<td class="parameter_description"><p> a string containing Pango markup.
 
1134
Passing <code class="literal">NULL</code> is the same as passing "" (the empty string). </p></td>
 
1135
<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>
568
1136
</tr>
569
1137
</tbody>
570
1138
</table></div>
 
1139
</div>
571
1140
<p class="since">Since 1.0</p>
572
1141
</div>
573
1142
<hr>
574
1143
<div class="refsect2">
575
 
<a name="clutter-text-get-text"></a><h3>clutter_text_get_text ()</h3>
576
 
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       clutter_text_get_text               (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
577
 
<p>
578
 
Retrieves a pointer to the current contents of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
579
 
actor.
580
 
</p>
581
 
<p>
582
 
If you need a copy of the contents for manipulating, either
583
 
use <code class="function">g_strdup()</code> on the returned string, or use:
584
 
</p>
585
 
<p>
586
 
</p>
 
1144
<a name="clutter-text-get-text"></a><h3>clutter_text_get_text ()</h3>
 
1145
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
 
1146
clutter_text_get_text (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
 
1147
<p>Retrieves a pointer to the current contents of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
 
1148
actor.</p>
 
1149
<p>If you need a copy of the contents for manipulating, either
 
1150
use <code class="function">g_strdup()</code> on the returned string, or use:</p>
587
1151
<div class="informalexample">
588
1152
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
589
1153
    <tbody>
595
1159
  </table>
596
1160
</div>
597
1161
 
598
 
<p>
599
 
</p>
600
 
<p>
601
 
Which will return a newly allocated string.
602
 
</p>
603
 
<p>
604
 
If the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor is empty, this function will return
605
 
an empty string, and not <code class="literal">NULL</code>.
606
 
</p>
607
 
<div class="variablelist"><table border="0" class="variablelist">
 
1162
<p></p>
 
1163
<p>Which will return a newly allocated string.</p>
 
1164
<p>If the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor is empty, this function will return
 
1165
an empty string, and not <code class="literal">NULL</code>.</p>
 
1166
<div class="refsect3">
 
1167
<a name="id-1.5.3.4.10.10.10"></a><h4>Parameters</h4>
 
1168
<div class="informaltable"><table width="100%" border="0">
608
1169
<colgroup>
609
 
<col align="left" valign="top">
610
 
<col>
 
1170
<col width="150px" class="parameters_name">
 
1171
<col class="parameters_description">
 
1172
<col width="200px" class="parameters_annotations">
611
1173
</colgroup>
612
 
<tbody>
613
 
<tr>
614
 
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
615
 
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
616
 
</td>
617
 
</tr>
618
 
<tr>
619
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
620
 
<td>the contents of the actor. The returned
 
1174
<tbody><tr>
 
1175
<td class="parameter_name"><p>self</p></td>
 
1176
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
 
1177
<td class="parameter_annotations"> </td>
 
1178
</tr></tbody>
 
1179
</table></div>
 
1180
</div>
 
1181
<div class="refsect3">
 
1182
<a name="id-1.5.3.4.10.10.11"></a><h4>Returns</h4>
 
1183
<p> the contents of the actor. The returned
621
1184
string is owned by the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor and should never be modified
622
 
or freed. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
623
 
</td>
624
 
</tr>
625
 
</tbody>
626
 
</table></div>
 
1185
or freed. </p>
 
1186
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 
1187
</div>
627
1188
<p class="since">Since 1.0</p>
628
1189
</div>
629
1190
<hr>
630
1191
<div class="refsect2">
631
 
<a name="clutter-text-set-activatable"></a><h3>clutter_text_set_activatable ()</h3>
632
 
<pre class="programlisting"><span class="returnvalue">void</span>                clutter_text_set_activatable        (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
633
 
                                                         <em class="parameter"><code><span class="type">gboolean</span> activatable</code></em>);</pre>
634
 
<p>
635
 
Sets whether a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should be activatable.
636
 
</p>
637
 
<p>
638
 
An activatable <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor will emit the <a class="link" href="ClutterText.html#ClutterText-activate" title='The "activate" signal'><span class="type">"activate"</span></a>
 
1192
<a name="clutter-text-set-activatable"></a><h3>clutter_text_set_activatable ()</h3>
 
1193
<pre class="programlisting"><span class="returnvalue">void</span>
 
1194
clutter_text_set_activatable (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
 
1195
                              <em class="parameter"><code><span class="type">gboolean</span> activatable</code></em>);</pre>
 
1196
<p>Sets whether a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should be activatable.</p>
 
1197
<p>An activatable <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor will emit the <a class="link" href="ClutterText.html#ClutterText-activate" title="The “activate” signal"><span class="type">“activate”</span></a>
639
1198
signal whenever the 'Enter' (or 'Return') key is pressed; if it is not
640
 
activatable, a new line will be appended to the current content.
641
 
</p>
642
 
<p>
643
 
An activatable <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> must also be set as editable using
644
 
<a class="link" href="ClutterText.html#clutter-text-set-editable" title="clutter_text_set_editable ()"><code class="function">clutter_text_set_editable()</code></a>.
645
 
</p>
646
 
<div class="variablelist"><table border="0" class="variablelist">
647
 
<colgroup>
648
 
<col align="left" valign="top">
649
 
<col>
650
 
</colgroup>
651
 
<tbody>
652
 
<tr>
653
 
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
654
 
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
655
 
</td>
656
 
</tr>
657
 
<tr>
658
 
<td><p><span class="term"><em class="parameter"><code>activatable</code></em> :</span></p></td>
659
 
<td>whether the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should be activatable</td>
660
 
</tr>
661
 
</tbody>
662
 
</table></div>
663
 
<p class="since">Since 1.0</p>
664
 
</div>
665
 
<hr>
666
 
<div class="refsect2">
667
 
<a name="clutter-text-get-activatable"></a><h3>clutter_text_get_activatable ()</h3>
668
 
<pre class="programlisting"><span class="returnvalue">gboolean</span>            clutter_text_get_activatable        (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
669
 
<p>
670
 
Retrieves whether a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> is activatable or not.
671
 
</p>
672
 
<div class="variablelist"><table border="0" class="variablelist">
673
 
<colgroup>
674
 
<col align="left" valign="top">
675
 
<col>
676
 
</colgroup>
677
 
<tbody>
678
 
<tr>
679
 
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
680
 
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
681
 
</td>
682
 
</tr>
683
 
<tr>
684
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
685
 
<td>
686
 
<code class="literal">TRUE</code> if the actor is activatable</td>
687
 
</tr>
688
 
</tbody>
689
 
</table></div>
690
 
<p class="since">Since 1.0</p>
691
 
</div>
692
 
<hr>
693
 
<div class="refsect2">
694
 
<a name="clutter-text-set-attributes"></a><h3>clutter_text_set_attributes ()</h3>
695
 
<pre class="programlisting"><span class="returnvalue">void</span>                clutter_text_set_attributes         (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
696
 
                                                         <em class="parameter"><code><span class="type">PangoAttrList</span> *attrs</code></em>);</pre>
697
 
<p>
698
 
Sets the attributes list that are going to be applied to the
699
 
<a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> contents.
700
 
</p>
701
 
<p>
702
 
The <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor will take a reference on the <span class="type">PangoAttrList</span>
703
 
passed to this function.
704
 
</p>
705
 
<div class="variablelist"><table border="0" class="variablelist">
706
 
<colgroup>
707
 
<col align="left" valign="top">
708
 
<col>
709
 
</colgroup>
710
 
<tbody>
711
 
<tr>
712
 
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
713
 
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
714
 
</td>
715
 
</tr>
716
 
<tr>
717
 
<td><p><span class="term"><em class="parameter"><code>attrs</code></em> :</span></p></td>
718
 
<td>a <span class="type">PangoAttrList</span> or <code class="literal">NULL</code> to unset the attributes. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
719
 
</td>
720
 
</tr>
721
 
</tbody>
722
 
</table></div>
723
 
<p class="since">Since 1.0</p>
724
 
</div>
725
 
<hr>
726
 
<div class="refsect2">
727
 
<a name="clutter-text-get-attributes"></a><h3>clutter_text_get_attributes ()</h3>
728
 
<pre class="programlisting"><span class="returnvalue">PangoAttrList</span> *     clutter_text_get_attributes         (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
729
 
<p>
730
 
Gets the attribute list that was set on the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor
731
 
<a class="link" href="ClutterText.html#clutter-text-set-attributes" title="clutter_text_set_attributes ()"><code class="function">clutter_text_set_attributes()</code></a>, if any.
732
 
</p>
733
 
<div class="variablelist"><table border="0" class="variablelist">
734
 
<colgroup>
735
 
<col align="left" valign="top">
736
 
<col>
737
 
</colgroup>
738
 
<tbody>
739
 
<tr>
740
 
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
741
 
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
742
 
</td>
743
 
</tr>
744
 
<tr>
745
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
746
 
<td>the attribute list, or <code class="literal">NULL</code> if none was set. The
747
 
returned value is owned by the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> and should not be unreferenced. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
748
 
</td>
749
 
</tr>
750
 
</tbody>
751
 
</table></div>
752
 
<p class="since">Since 1.0</p>
753
 
</div>
754
 
<hr>
755
 
<div class="refsect2">
756
 
<a name="clutter-text-set-color"></a><h3>clutter_text_set_color ()</h3>
757
 
<pre class="programlisting"><span class="returnvalue">void</span>                clutter_text_set_color              (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
758
 
                                                         <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>
759
 
<p>
760
 
Sets the color of the contents of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.
761
 
</p>
762
 
<p>
763
 
The overall opacity of the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor will be the
764
 
result of the alpha value of <em class="parameter"><code>color</code></em> and the composited
 
1199
activatable, a new line will be appended to the current content.</p>
 
1200
<p>An activatable <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> must also be set as editable using
 
1201
<a class="link" href="ClutterText.html#clutter-text-set-editable" title="clutter_text_set_editable ()"><code class="function">clutter_text_set_editable()</code></a>.</p>
 
1202
<div class="refsect3">
 
1203
<a name="id-1.5.3.4.10.11.7"></a><h4>Parameters</h4>
 
1204
<div class="informaltable"><table width="100%" border="0">
 
1205
<colgroup>
 
1206
<col width="150px" class="parameters_name">
 
1207
<col class="parameters_description">
 
1208
<col width="200px" class="parameters_annotations">
 
1209
</colgroup>
 
1210
<tbody>
 
1211
<tr>
 
1212
<td class="parameter_name"><p>self</p></td>
 
1213
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
 
1214
<td class="parameter_annotations"> </td>
 
1215
</tr>
 
1216
<tr>
 
1217
<td class="parameter_name"><p>activatable</p></td>
 
1218
<td class="parameter_description"><p>whether the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should be activatable</p></td>
 
1219
<td class="parameter_annotations"> </td>
 
1220
</tr>
 
1221
</tbody>
 
1222
</table></div>
 
1223
</div>
 
1224
<p class="since">Since 1.0</p>
 
1225
</div>
 
1226
<hr>
 
1227
<div class="refsect2">
 
1228
<a name="clutter-text-get-activatable"></a><h3>clutter_text_get_activatable ()</h3>
 
1229
<pre class="programlisting"><span class="returnvalue">gboolean</span>
 
1230
clutter_text_get_activatable (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
 
1231
<p>Retrieves whether a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> is activatable or not.</p>
 
1232
<div class="refsect3">
 
1233
<a name="id-1.5.3.4.10.12.5"></a><h4>Parameters</h4>
 
1234
<div class="informaltable"><table width="100%" border="0">
 
1235
<colgroup>
 
1236
<col width="150px" class="parameters_name">
 
1237
<col class="parameters_description">
 
1238
<col width="200px" class="parameters_annotations">
 
1239
</colgroup>
 
1240
<tbody><tr>
 
1241
<td class="parameter_name"><p>self</p></td>
 
1242
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
 
1243
<td class="parameter_annotations"> </td>
 
1244
</tr></tbody>
 
1245
</table></div>
 
1246
</div>
 
1247
<div class="refsect3">
 
1248
<a name="id-1.5.3.4.10.12.6"></a><h4>Returns</h4>
 
1249
<p> <code class="literal">TRUE</code> if the actor is activatable</p>
 
1250
<p></p>
 
1251
</div>
 
1252
<p class="since">Since 1.0</p>
 
1253
</div>
 
1254
<hr>
 
1255
<div class="refsect2">
 
1256
<a name="clutter-text-set-attributes"></a><h3>clutter_text_set_attributes ()</h3>
 
1257
<pre class="programlisting"><span class="returnvalue">void</span>
 
1258
clutter_text_set_attributes (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
 
1259
                             <em class="parameter"><code><span class="type">PangoAttrList</span> *attrs</code></em>);</pre>
 
1260
<p>Sets the attributes list that are going to be applied to the
 
1261
<a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> contents.</p>
 
1262
<p>The <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor will take a reference on the <span class="type">PangoAttrList</span>
 
1263
passed to this function.</p>
 
1264
<div class="refsect3">
 
1265
<a name="id-1.5.3.4.10.13.6"></a><h4>Parameters</h4>
 
1266
<div class="informaltable"><table width="100%" border="0">
 
1267
<colgroup>
 
1268
<col width="150px" class="parameters_name">
 
1269
<col class="parameters_description">
 
1270
<col width="200px" class="parameters_annotations">
 
1271
</colgroup>
 
1272
<tbody>
 
1273
<tr>
 
1274
<td class="parameter_name"><p>self</p></td>
 
1275
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
 
1276
<td class="parameter_annotations"> </td>
 
1277
</tr>
 
1278
<tr>
 
1279
<td class="parameter_name"><p>attrs</p></td>
 
1280
<td class="parameter_description"><p> a <span class="type">PangoAttrList</span> or <code class="literal">NULL</code> to unset the attributes. </p></td>
 
1281
<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>
 
1282
</tr>
 
1283
</tbody>
 
1284
</table></div>
 
1285
</div>
 
1286
<p class="since">Since 1.0</p>
 
1287
</div>
 
1288
<hr>
 
1289
<div class="refsect2">
 
1290
<a name="clutter-text-get-attributes"></a><h3>clutter_text_get_attributes ()</h3>
 
1291
<pre class="programlisting"><span class="returnvalue">PangoAttrList</span> *
 
1292
clutter_text_get_attributes (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
 
1293
<p>Gets the attribute list that was set on the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor
 
1294
<a class="link" href="ClutterText.html#clutter-text-set-attributes" title="clutter_text_set_attributes ()"><code class="function">clutter_text_set_attributes()</code></a>, if any.</p>
 
1295
<div class="refsect3">
 
1296
<a name="id-1.5.3.4.10.14.5"></a><h4>Parameters</h4>
 
1297
<div class="informaltable"><table width="100%" border="0">
 
1298
<colgroup>
 
1299
<col width="150px" class="parameters_name">
 
1300
<col class="parameters_description">
 
1301
<col width="200px" class="parameters_annotations">
 
1302
</colgroup>
 
1303
<tbody><tr>
 
1304
<td class="parameter_name"><p>self</p></td>
 
1305
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
 
1306
<td class="parameter_annotations"> </td>
 
1307
</tr></tbody>
 
1308
</table></div>
 
1309
</div>
 
1310
<div class="refsect3">
 
1311
<a name="id-1.5.3.4.10.14.6"></a><h4>Returns</h4>
 
1312
<p> the attribute list, or <code class="literal">NULL</code> if none was set. The
 
1313
returned value is owned by the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> and should not be unreferenced. </p>
 
1314
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 
1315
</div>
 
1316
<p class="since">Since 1.0</p>
 
1317
</div>
 
1318
<hr>
 
1319
<div class="refsect2">
 
1320
<a name="clutter-text-set-color"></a><h3>clutter_text_set_color ()</h3>
 
1321
<pre class="programlisting"><span class="returnvalue">void</span>
 
1322
clutter_text_set_color (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
 
1323
                        <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>
 
1324
<p>Sets the color of the contents of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.</p>
 
1325
<p>The overall opacity of the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor will be the
 
1326
result of the alpha value of <em class="parameter"><code>color</code></em>
 
1327
 and the composited
765
1328
opacity of the actor itself on the scenegraph, as returned
766
 
by <a class="link" href="ClutterActor.html#clutter-actor-get-paint-opacity" title="clutter_actor_get_paint_opacity ()"><code class="function">clutter_actor_get_paint_opacity()</code></a>.
767
 
</p>
768
 
<div class="variablelist"><table border="0" class="variablelist">
769
 
<colgroup>
770
 
<col align="left" valign="top">
771
 
<col>
772
 
</colgroup>
773
 
<tbody>
774
 
<tr>
775
 
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
776
 
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
777
 
</td>
778
 
</tr>
779
 
<tr>
780
 
<td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
781
 
<td>a <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a>
782
 
</td>
783
 
</tr>
784
 
</tbody>
785
 
</table></div>
786
 
<p class="since">Since 1.0</p>
787
 
</div>
788
 
<hr>
789
 
<div class="refsect2">
790
 
<a name="clutter-text-get-color"></a><h3>clutter_text_get_color ()</h3>
791
 
<pre class="programlisting"><span class="returnvalue">void</span>                clutter_text_get_color              (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
792
 
                                                         <em class="parameter"><code><a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);</pre>
793
 
<p>
794
 
Retrieves the text color as set by <a class="link" href="ClutterText.html#clutter-text-set-color" title="clutter_text_set_color ()"><code class="function">clutter_text_set_color()</code></a>.
795
 
</p>
796
 
<div class="variablelist"><table border="0" class="variablelist">
797
 
<colgroup>
798
 
<col align="left" valign="top">
799
 
<col>
800
 
</colgroup>
801
 
<tbody>
802
 
<tr>
803
 
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
804
 
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
805
 
</td>
806
 
</tr>
807
 
<tr>
808
 
<td><p><span class="term"><em class="parameter"><code>color</code></em> :</span></p></td>
809
 
<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>
810
 
</td>
811
 
</tr>
812
 
</tbody>
813
 
</table></div>
814
 
<p class="since">Since 1.0</p>
815
 
</div>
816
 
<hr>
817
 
<div class="refsect2">
818
 
<a name="clutter-text-set-ellipsize"></a><h3>clutter_text_set_ellipsize ()</h3>
819
 
<pre class="programlisting"><span class="returnvalue">void</span>                clutter_text_set_ellipsize          (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
820
 
                                                         <em class="parameter"><code><span class="type">PangoEllipsizeMode</span> mode</code></em>);</pre>
821
 
<p>
822
 
Sets the mode used to ellipsize (add an ellipsis: "...") to the
 
1329
by <a class="link" href="ClutterActor.html#clutter-actor-get-paint-opacity" title="clutter_actor_get_paint_opacity ()"><code class="function">clutter_actor_get_paint_opacity()</code></a>.</p>
 
1330
<div class="refsect3">
 
1331
<a name="id-1.5.3.4.10.15.6"></a><h4>Parameters</h4>
 
1332
<div class="informaltable"><table width="100%" border="0">
 
1333
<colgroup>
 
1334
<col width="150px" class="parameters_name">
 
1335
<col class="parameters_description">
 
1336
<col width="200px" class="parameters_annotations">
 
1337
</colgroup>
 
1338
<tbody>
 
1339
<tr>
 
1340
<td class="parameter_name"><p>self</p></td>
 
1341
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
 
1342
<td class="parameter_annotations"> </td>
 
1343
</tr>
 
1344
<tr>
 
1345
<td class="parameter_name"><p>color</p></td>
 
1346
<td class="parameter_description"><p>a <a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a></p></td>
 
1347
<td class="parameter_annotations"> </td>
 
1348
</tr>
 
1349
</tbody>
 
1350
</table></div>
 
1351
</div>
 
1352
<p class="since">Since 1.0</p>
 
1353
</div>
 
1354
<hr>
 
1355
<div class="refsect2">
 
1356
<a name="clutter-text-get-color"></a><h3>clutter_text_get_color ()</h3>
 
1357
<pre class="programlisting"><span class="returnvalue">void</span>
 
1358
clutter_text_get_color (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
 
1359
                        <em class="parameter"><code><a class="link" href="clutter-Colors.html#ClutterColor" title="ClutterColor"><span class="type">ClutterColor</span></a> *color</code></em>);</pre>
 
1360
<p>Retrieves the text color as set by <a class="link" href="ClutterText.html#clutter-text-set-color" title="clutter_text_set_color ()"><code class="function">clutter_text_set_color()</code></a>.</p>
 
1361
<div class="refsect3">
 
1362
<a name="id-1.5.3.4.10.16.5"></a><h4>Parameters</h4>
 
1363
<div class="informaltable"><table width="100%" border="0">
 
1364
<colgroup>
 
1365
<col width="150px" class="parameters_name">
 
1366
<col class="parameters_description">
 
1367
<col width="200px" class="parameters_annotations">
 
1368
</colgroup>
 
1369
<tbody>
 
1370
<tr>
 
1371
<td class="parameter_name"><p>self</p></td>
 
1372
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
 
1373
<td class="parameter_annotations"> </td>
 
1374
</tr>
 
1375
<tr>
 
1376
<td class="parameter_name"><p>color</p></td>
 
1377
<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>
 
1378
<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>
 
1379
</tr>
 
1380
</tbody>
 
1381
</table></div>
 
1382
</div>
 
1383
<p class="since">Since 1.0</p>
 
1384
</div>
 
1385
<hr>
 
1386
<div class="refsect2">
 
1387
<a name="clutter-text-set-ellipsize"></a><h3>clutter_text_set_ellipsize ()</h3>
 
1388
<pre class="programlisting"><span class="returnvalue">void</span>
 
1389
clutter_text_set_ellipsize (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
 
1390
                            <em class="parameter"><code><span class="type">PangoEllipsizeMode</span> mode</code></em>);</pre>
 
1391
<p>Sets the mode used to ellipsize (add an ellipsis: "...") to the
823
1392
text if there is not enough space to render the entire contents
824
 
of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor
825
 
</p>
826
 
<div class="variablelist"><table border="0" class="variablelist">
827
 
<colgroup>
828
 
<col align="left" valign="top">
829
 
<col>
830
 
</colgroup>
831
 
<tbody>
832
 
<tr>
833
 
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
834
 
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
835
 
</td>
836
 
</tr>
837
 
<tr>
838
 
<td><p><span class="term"><em class="parameter"><code>mode</code></em> :</span></p></td>
839
 
<td>a <span class="type">PangoEllipsizeMode</span>
840
 
</td>
841
 
</tr>
842
 
</tbody>
843
 
</table></div>
844
 
<p class="since">Since 1.0</p>
845
 
</div>
846
 
<hr>
847
 
<div class="refsect2">
848
 
<a name="clutter-text-get-ellipsize"></a><h3>clutter_text_get_ellipsize ()</h3>
849
 
<pre class="programlisting"><span class="returnvalue">PangoEllipsizeMode</span>  clutter_text_get_ellipsize          (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
850
 
<p>
851
 
Returns the ellipsizing position of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor, as
852
 
set by <a class="link" href="ClutterText.html#clutter-text-set-ellipsize" title="clutter_text_set_ellipsize ()"><code class="function">clutter_text_set_ellipsize()</code></a>.
853
 
</p>
854
 
<div class="variablelist"><table border="0" class="variablelist">
855
 
<colgroup>
856
 
<col align="left" valign="top">
857
 
<col>
858
 
</colgroup>
859
 
<tbody>
860
 
<tr>
861
 
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
862
 
<td>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
863
 
</td>
864
 
</tr>
865
 
<tr>
866
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
867
 
<td><span class="type">PangoEllipsizeMode</span></td>
868
 
</tr>
869
 
</tbody>
870
 
</table></div>
871
 
<p class="since">Since 1.0</p>
872
 
</div>
873
 
<hr>
874
 
<div class="refsect2">
875
 
<a name="clutter-text-set-font-name"></a><h3>clutter_text_set_font_name ()</h3>
876
 
<pre class="programlisting"><span class="returnvalue">void</span>                clutter_text_set_font_name          (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
877
 
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *font_name</code></em>);</pre>
878
 
<p>
879
 
Sets the font used by a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>. The <em class="parameter"><code>font_name</code></em> string
 
1393
of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor</p>
 
1394
<div class="refsect3">
 
1395
<a name="id-1.5.3.4.10.17.5"></a><h4>Parameters</h4>
 
1396
<div class="informaltable"><table width="100%" border="0">
 
1397
<colgroup>
 
1398
<col width="150px" class="parameters_name">
 
1399
<col class="parameters_description">
 
1400
<col width="200px" class="parameters_annotations">
 
1401
</colgroup>
 
1402
<tbody>
 
1403
<tr>
 
1404
<td class="parameter_name"><p>self</p></td>
 
1405
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
 
1406
<td class="parameter_annotations"> </td>
 
1407
</tr>
 
1408
<tr>
 
1409
<td class="parameter_name"><p>mode</p></td>
 
1410
<td class="parameter_description"><p>a <span class="type">PangoEllipsizeMode</span></p></td>
 
1411
<td class="parameter_annotations"> </td>
 
1412
</tr>
 
1413
</tbody>
 
1414
</table></div>
 
1415
</div>
 
1416
<p class="since">Since 1.0</p>
 
1417
</div>
 
1418
<hr>
 
1419
<div class="refsect2">
 
1420
<a name="clutter-text-get-ellipsize"></a><h3>clutter_text_get_ellipsize ()</h3>
 
1421
<pre class="programlisting"><span class="returnvalue">PangoEllipsizeMode</span>
 
1422
clutter_text_get_ellipsize (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>);</pre>
 
1423
<p>Returns the ellipsizing position of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor, as
 
1424
set by <a class="link" href="ClutterText.html#clutter-text-set-ellipsize" title="clutter_text_set_ellipsize ()"><code class="function">clutter_text_set_ellipsize()</code></a>.</p>
 
1425
<div class="refsect3">
 
1426
<a name="id-1.5.3.4.10.18.5"></a><h4>Parameters</h4>
 
1427
<div class="informaltable"><table width="100%" border="0">
 
1428
<colgroup>
 
1429
<col width="150px" class="parameters_name">
 
1430
<col class="parameters_description">
 
1431
<col width="200px" class="parameters_annotations">
 
1432
</colgroup>
 
1433
<tbody><tr>
 
1434
<td class="parameter_name"><p>self</p></td>
 
1435
<td class="parameter_description"><p>a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a></p></td>
 
1436
<td class="parameter_annotations"> </td>
 
1437
</tr></tbody>
 
1438
</table></div>
 
1439
</div>
 
1440
<div class="refsect3">
 
1441
<a name="id-1.5.3.4.10.18.6"></a><h4>Returns</h4>
 
1442
<p> <span class="type">PangoEllipsizeMode</span></p>
 
1443
<p></p>
 
1444
</div>
 
1445
<p class="since">Since 1.0</p>
 
1446
</div>
 
1447
<hr>
 
1448
<div class="refsect2">
 
1449
<a name="clutter-text-set-font-name"></a><h3>clutter_text_set_font_name ()</h3>
 
1450
<pre class="programlisting"><span class="returnvalue">void</span>
 
1451
clutter_text_set_font_name (<em class="parameter"><code><a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self</code></em>,
 
1452
                            <em class="parameter"><code>const <span class="type">gchar</span> *font_name</code></em>);</pre>
 
1453
<p>Sets the font used by a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>. The <em class="parameter"><code>font_name</code></em>
 
1454
 string
880
1455
must either be <code class="literal">NULL</code>, which means that the font name from the
881
1456
default <a class="link" href="ClutterBackend.html" title="ClutterBackend"><span class="type">ClutterBackend</span></a> will be used; or be something that can
882
1457
be parsed by the <code class="function">pango_font_description_from_string()</code> function,
883
 
like:
884
 
</p>
885
 
<p>
886
 
</p>
 
1458
like:</p>
887
1459
<div class="informalexample">
888
1460
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
889
1461
    <tbody>
899
1471
  </table>
900
1472
</div>
901
1473
 
902
 
<p>
903
 
</p>
904
 
<div class="variablelist"><table border="0" class="variablelist">
 
1474
<p></p>
 
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">
905
1478
<colgroup>
906
 
<col align="left" valign="top">
907
 
<col>
 
1479
<col width="150px" class="parameters_name">
 
1480
<col class="parameters_description">
 
1481
<col width="200px" class="parameters_annotations">
908
1482
</colgroup>
909
1483
<tbody>
910
1484
<tr>
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>
913
 
</td>
 
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>
914
1488
</tr>
915
1489
<tr>
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>
918
 
</td>
 
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>
919
1493
</tr>
920
1494
</tbody>
921
1495
</table></div>
 
1496
</div>
922
1497
<p class="since">Since 1.0</p>
923
1498
</div>
924
1499
<hr>
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>
928
 
<p>
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>.
930
 
</p>
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">
932
1508
<colgroup>
933
 
<col align="left" valign="top">
934
 
<col>
 
1509
<col width="150px" class="parameters_name">
 
1510
<col class="parameters_description">
 
1511
<col width="200px" class="parameters_annotations">
935
1512
</colgroup>
936
 
<tbody>
937
 
<tr>
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>
940
 
</td>
941
 
</tr>
942
 
<tr>
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
 
1513
<tbody><tr>
 
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>
 
1517
</tr></tbody>
 
1518
</table></div>
 
1519
</div>
 
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>
947
 
</tr>
948
 
</tbody>
949
 
</table></div>
 
1524
modified or freed</p>
 
1525
<p></p>
 
1526
</div>
950
1527
<p class="since">Since 1.0</p>
951
1528
</div>
952
1529
<hr>
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>
957
 
<p>
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>
959
 
</p>
960
 
<p>
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.
964
 
</p>
965
 
<div class="variablelist"><table border="0" class="variablelist">
966
 
<colgroup>
967
 
<col align="left" valign="top">
968
 
<col>
969
 
</colgroup>
970
 
<tbody>
971
 
<tr>
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>
974
 
</td>
975
 
</tr>
976
 
<tr>
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>
979
 
</td>
980
 
</tr>
981
 
</tbody>
982
 
</table></div>
983
 
<p class="since">Since 1.2</p>
984
 
</div>
985
 
<hr>
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>
990
 
<p>
991
 
Retrieves the <span class="type">PangoFontDescription</span> used by <em class="parameter"><code>self</code></em>
992
 
</p>
993
 
<div class="variablelist"><table border="0" class="variablelist">
994
 
<colgroup>
995
 
<col align="left" valign="top">
996
 
<col>
997
 
</colgroup>
998
 
<tbody>
999
 
<tr>
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>
1002
 
</td>
1003
 
</tr>
1004
 
<tr>
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>
1008
 
</tr>
1009
 
</tbody>
1010
 
</table></div>
1011
 
<p class="since">Since 1.2</p>
1012
 
</div>
1013
 
<hr>
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>
1018
 
<p>
1019
 
Sets the character to use in place of the actual text in a
1020
 
password text actor.
1021
 
</p>
1022
 
<p>
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.
1025
 
</p>
1026
 
<div class="variablelist"><table border="0" class="variablelist">
1027
 
<colgroup>
1028
 
<col align="left" valign="top">
1029
 
<col>
1030
 
</colgroup>
1031
 
<tbody>
1032
 
<tr>
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>
1035
 
</td>
1036
 
</tr>
1037
 
<tr>
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>
1040
 
</tr>
1041
 
</tbody>
1042
 
</table></div>
1043
 
<p class="since">Since 1.0</p>
1044
 
</div>
1045
 
<hr>
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>
1049
 
<p>
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>.
1052
 
</p>
1053
 
<div class="variablelist"><table border="0" class="variablelist">
1054
 
<colgroup>
1055
 
<col align="left" valign="top">
1056
 
<col>
1057
 
</colgroup>
1058
 
<tbody>
1059
 
<tr>
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>
1062
 
</td>
1063
 
</tr>
1064
 
<tr>
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>
1068
 
</tr>
1069
 
</tbody>
1070
 
</table></div>
1071
 
<p class="since">Since 1.0</p>
1072
 
</div>
1073
 
<hr>
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>
1078
 
<p>
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">
 
1543
<colgroup>
 
1544
<col width="150px" class="parameters_name">
 
1545
<col class="parameters_description">
 
1546
<col width="200px" class="parameters_annotations">
 
1547
</colgroup>
 
1548
<tbody>
 
1549
<tr>
 
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>
 
1553
</tr>
 
1554
<tr>
 
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>
 
1558
</tr>
 
1559
</tbody>
 
1560
</table></div>
 
1561
</div>
 
1562
<p class="since">Since 1.2</p>
 
1563
</div>
 
1564
<hr>
 
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>
 
1570
</p>
 
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">
 
1574
<colgroup>
 
1575
<col width="150px" class="parameters_name">
 
1576
<col class="parameters_description">
 
1577
<col width="200px" class="parameters_annotations">
 
1578
</colgroup>
 
1579
<tbody><tr>
 
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>
 
1583
</tr></tbody>
 
1584
</table></div>
 
1585
</div>
 
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>
 
1590
<p></p>
 
1591
</div>
 
1592
<p class="since">Since 1.2</p>
 
1593
</div>
 
1594
<hr>
 
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">
 
1608
<colgroup>
 
1609
<col width="150px" class="parameters_name">
 
1610
<col class="parameters_description">
 
1611
<col width="200px" class="parameters_annotations">
 
1612
</colgroup>
 
1613
<tbody>
 
1614
<tr>
 
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>
 
1618
</tr>
 
1619
<tr>
 
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>
 
1623
</tr>
 
1624
</tbody>
 
1625
</table></div>
 
1626
</div>
 
1627
<p class="since">Since 1.0</p>
 
1628
</div>
 
1629
<hr>
 
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">
 
1639
<colgroup>
 
1640
<col width="150px" class="parameters_name">
 
1641
<col class="parameters_description">
 
1642
<col width="200px" class="parameters_annotations">
 
1643
</colgroup>
 
1644
<tbody><tr>
 
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>
 
1648
</tr></tbody>
 
1649
</table></div>
 
1650
</div>
 
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>
 
1655
<p></p>
 
1656
</div>
 
1657
<p class="since">Since 1.0</p>
 
1658
</div>
 
1659
<hr>
 
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 &lt; 1.18.
1082
 
</p>
1083
 
<div class="variablelist"><table border="0" class="variablelist">
 
1667
against Pango &amp;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">
1084
1671
<colgroup>
1085
 
<col align="left" valign="top">
1086
 
<col>
 
1672
<col width="150px" class="parameters_name">
 
1673
<col class="parameters_description">
 
1674
<col width="200px" class="parameters_annotations">
1087
1675
</colgroup>
1088
1676
<tbody>
1089
1677
<tr>
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>
1092
 
</td>
 
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>
1093
1681
</tr>
1094
1682
<tr>
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>
1097
1686
</tr>
1098
1687
</tbody>
1099
1688
</table></div>
 
1689
</div>
1100
1690
<p class="since">Since 1.0</p>
1101
1691
</div>
1102
1692
<hr>
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>
1106
 
<p>
1107
 
Retrieves whether the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should justify its contents
1108
 
on both margins.
1109
 
</p>
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">
1111
1702
<colgroup>
1112
 
<col align="left" valign="top">
1113
 
<col>
 
1703
<col width="150px" class="parameters_name">
 
1704
<col class="parameters_description">
 
1705
<col width="200px" class="parameters_annotations">
1114
1706
</colgroup>
1115
 
<tbody>
1116
 
<tr>
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>
1119
 
</td>
1120
 
</tr>
1121
 
<tr>
1122
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1123
 
<td>
1124
 
<code class="literal">TRUE</code> if the text should be justified</td>
1125
 
</tr>
1126
 
</tbody>
 
1707
<tbody><tr>
 
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>
 
1711
</tr></tbody>
1127
1712
</table></div>
 
1713
</div>
 
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>
 
1717
<p></p>
 
1718
</div>
1128
1719
<p class="since">Since 0.6</p>
1129
1720
</div>
1130
1721
<hr>
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>
1134
 
<p>
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.
1136
 
</p>
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">
1138
1730
<colgroup>
1139
 
<col align="left" valign="top">
1140
 
<col>
 
1731
<col width="150px" class="parameters_name">
 
1732
<col class="parameters_description">
 
1733
<col width="200px" class="parameters_annotations">
1141
1734
</colgroup>
1142
 
<tbody>
1143
 
<tr>
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>
1146
 
</td>
1147
 
</tr>
1148
 
<tr>
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>
1152
 
</td>
1153
 
</tr>
1154
 
</tbody>
 
1735
<tbody><tr>
 
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>
 
1739
</tr></tbody>
1155
1740
</table></div>
 
1741
</div>
 
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>
 
1747
</div>
1156
1748
<p class="since">Since 1.0</p>
1157
1749
</div>
1158
1750
<hr>
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>
1163
 
<p>
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.
1167
 
</p>
1168
 
<p>
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.
1171
 
</p>
1172
 
<div class="variablelist"><table border="0" class="variablelist">
1173
 
<colgroup>
1174
 
<col align="left" valign="top">
1175
 
<col>
1176
 
</colgroup>
1177
 
<tbody>
1178
 
<tr>
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>
1181
 
</td>
1182
 
</tr>
1183
 
<tr>
1184
 
<td><p><span class="term"><em class="parameter"><code>alignment</code></em> :</span></p></td>
1185
 
<td>A <span class="type">PangoAlignment</span>
1186
 
</td>
1187
 
</tr>
1188
 
</tbody>
1189
 
</table></div>
1190
 
<p class="since">Since 1.0</p>
1191
 
</div>
1192
 
<hr>
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>
1196
 
<p>
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>.
1199
 
</p>
1200
 
<div class="variablelist"><table border="0" class="variablelist">
1201
 
<colgroup>
1202
 
<col align="left" valign="top">
1203
 
<col>
1204
 
</colgroup>
1205
 
<tbody>
1206
 
<tr>
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>
1209
 
</td>
1210
 
</tr>
1211
 
<tr>
1212
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1213
 
<td>a <span class="type">PangoAlignment</span>
1214
 
</td>
1215
 
</tr>
1216
 
</tbody>
1217
 
</table></div>
1218
 
<p class="since">Since 1.0</p>
1219
 
</div>
1220
 
<hr>
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>
1225
 
<p>
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.
1228
 
</p>
1229
 
<div class="variablelist"><table border="0" class="variablelist">
1230
 
<colgroup>
1231
 
<col align="left" valign="top">
1232
 
<col>
1233
 
</colgroup>
1234
 
<tbody>
1235
 
<tr>
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>
1238
 
</td>
1239
 
</tr>
1240
 
<tr>
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>
1243
 
</tr>
1244
 
</tbody>
1245
 
</table></div>
1246
 
<p class="since">Since 1.0</p>
1247
 
</div>
1248
 
<hr>
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>
1252
 
<p>
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>.
1254
 
</p>
1255
 
<div class="variablelist"><table border="0" class="variablelist">
1256
 
<colgroup>
1257
 
<col align="left" valign="top">
1258
 
<col>
1259
 
</colgroup>
1260
 
<tbody>
1261
 
<tr>
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>
1264
 
</td>
1265
 
</tr>
1266
 
<tr>
1267
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1268
 
<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
1270
 
its contents</td>
1271
 
</tr>
1272
 
</tbody>
1273
 
</table></div>
1274
 
<p class="since">Since 1.0</p>
1275
 
</div>
1276
 
<hr>
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>
1281
 
<p>
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">
 
1764
<colgroup>
 
1765
<col width="150px" class="parameters_name">
 
1766
<col class="parameters_description">
 
1767
<col width="200px" class="parameters_annotations">
 
1768
</colgroup>
 
1769
<tbody>
 
1770
<tr>
 
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>
 
1774
</tr>
 
1775
<tr>
 
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>
 
1779
</tr>
 
1780
</tbody>
 
1781
</table></div>
 
1782
</div>
 
1783
<p class="since">Since 1.0</p>
 
1784
</div>
 
1785
<hr>
 
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">
 
1795
<colgroup>
 
1796
<col width="150px" class="parameters_name">
 
1797
<col class="parameters_description">
 
1798
<col width="200px" class="parameters_annotations">
 
1799
</colgroup>
 
1800
<tbody><tr>
 
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>
 
1804
</tr></tbody>
 
1805
</table></div>
 
1806
</div>
 
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>
 
1810
<p></p>
 
1811
</div>
 
1812
<p class="since">Since 1.0</p>
 
1813
</div>
 
1814
<hr>
 
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">
 
1825
<colgroup>
 
1826
<col width="150px" class="parameters_name">
 
1827
<col class="parameters_description">
 
1828
<col width="200px" class="parameters_annotations">
 
1829
</colgroup>
 
1830
<tbody>
 
1831
<tr>
 
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>
 
1835
</tr>
 
1836
<tr>
 
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>
 
1840
</tr>
 
1841
</tbody>
 
1842
</table></div>
 
1843
</div>
 
1844
<p class="since">Since 1.0</p>
 
1845
</div>
 
1846
<hr>
 
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">
 
1855
<colgroup>
 
1856
<col width="150px" class="parameters_name">
 
1857
<col class="parameters_description">
 
1858
<col width="200px" class="parameters_annotations">
 
1859
</colgroup>
 
1860
<tbody><tr>
 
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>
 
1864
</tr></tbody>
 
1865
</table></div>
 
1866
</div>
 
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
 
1870
its contents</p>
 
1871
<p></p>
 
1872
</div>
 
1873
<p class="since">Since 1.0</p>
 
1874
</div>
 
1875
<hr>
 
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.
1285
 
</p>
1286
 
<div class="variablelist"><table border="0" class="variablelist">
1287
 
<colgroup>
1288
 
<col align="left" valign="top">
1289
 
<col>
1290
 
</colgroup>
1291
 
<tbody>
1292
 
<tr>
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>
1295
 
</td>
1296
 
</tr>
1297
 
<tr>
1298
 
<td><p><span class="term"><em class="parameter"><code>wrap_mode</code></em> :</span></p></td>
1299
 
<td>the line wrapping mode</td>
1300
 
</tr>
1301
 
</tbody>
1302
 
</table></div>
1303
 
<p class="since">Since 1.0</p>
1304
 
</div>
1305
 
<hr>
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>
1309
 
<p>
1310
 
Retrieves the line wrap mode used by the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.
1311
 
</p>
1312
 
<p>
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>.
1314
 
</p>
1315
 
<div class="variablelist"><table border="0" class="variablelist">
1316
 
<colgroup>
1317
 
<col align="left" valign="top">
1318
 
<col>
1319
 
</colgroup>
1320
 
<tbody>
1321
 
<tr>
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>
1324
 
</td>
1325
 
</tr>
1326
 
<tr>
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>
1329
 
</td>
1330
 
</tr>
1331
 
</tbody>
1332
 
</table></div>
1333
 
<p class="since">Since 1.0</p>
1334
 
</div>
1335
 
<hr>
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>
1340
 
<p>
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">
 
1887
<colgroup>
 
1888
<col width="150px" class="parameters_name">
 
1889
<col class="parameters_description">
 
1890
<col width="200px" class="parameters_annotations">
 
1891
</colgroup>
 
1892
<tbody>
 
1893
<tr>
 
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>
 
1897
</tr>
 
1898
<tr>
 
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>
 
1902
</tr>
 
1903
</tbody>
 
1904
</table></div>
 
1905
</div>
 
1906
<p class="since">Since 1.0</p>
 
1907
</div>
 
1908
<hr>
 
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">
 
1918
<colgroup>
 
1919
<col width="150px" class="parameters_name">
 
1920
<col class="parameters_description">
 
1921
<col width="200px" class="parameters_annotations">
 
1922
</colgroup>
 
1923
<tbody><tr>
 
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>
 
1927
</tr></tbody>
 
1928
</table></div>
 
1929
</div>
 
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>
 
1933
<p></p>
 
1934
</div>
 
1935
<p class="since">Since 1.0</p>
 
1936
</div>
 
1937
<hr>
 
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
1343
 
truncated to fit.
1344
 
</p>
1345
 
<div class="variablelist"><table border="0" class="variablelist">
1346
 
<colgroup>
1347
 
<col align="left" valign="top">
1348
 
<col>
1349
 
</colgroup>
1350
 
<tbody>
1351
 
<tr>
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>
1354
 
</td>
1355
 
</tr>
1356
 
<tr>
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>
1360
 
</tr>
1361
 
</tbody>
1362
 
</table></div>
1363
 
<p class="since">Since 1.0</p>
1364
 
</div>
1365
 
<hr>
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>
1369
 
<p>
1370
 
Gets the maximum length of text that can be set into a text actor.
1371
 
</p>
1372
 
<p>
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>.
1374
 
</p>
1375
 
<div class="variablelist"><table border="0" class="variablelist">
1376
 
<colgroup>
1377
 
<col align="left" valign="top">
1378
 
<col>
1379
 
</colgroup>
1380
 
<tbody>
1381
 
<tr>
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>
1384
 
</td>
1385
 
</tr>
1386
 
<tr>
1387
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1388
 
<td>the maximum number of characters.</td>
1389
 
</tr>
1390
 
</tbody>
1391
 
</table></div>
1392
 
<p class="since">Since 1.0</p>
1393
 
</div>
1394
 
<hr>
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>
1399
 
<p>
1400
 
Sets whether a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should be selectable.
1401
 
</p>
1402
 
<p>
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.
1405
 
</p>
1406
 
<div class="variablelist"><table border="0" class="variablelist">
1407
 
<colgroup>
1408
 
<col align="left" valign="top">
1409
 
<col>
1410
 
</colgroup>
1411
 
<tbody>
1412
 
<tr>
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>
1415
 
</td>
1416
 
</tr>
1417
 
<tr>
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>
1420
 
</tr>
1421
 
</tbody>
1422
 
</table></div>
1423
 
<p class="since">Since 1.0</p>
1424
 
</div>
1425
 
<hr>
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>
1429
 
<p>
1430
 
Retrieves whether a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> is selectable or not.
1431
 
</p>
1432
 
<div class="variablelist"><table border="0" class="variablelist">
1433
 
<colgroup>
1434
 
<col align="left" valign="top">
1435
 
<col>
1436
 
</colgroup>
1437
 
<tbody>
1438
 
<tr>
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>
1441
 
</td>
1442
 
</tr>
1443
 
<tr>
1444
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1445
 
<td>
1446
 
<code class="literal">TRUE</code> if the actor is selectable</td>
1447
 
</tr>
1448
 
</tbody>
1449
 
</table></div>
1450
 
<p class="since">Since 1.0</p>
1451
 
</div>
1452
 
<hr>
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>
1458
 
<p>
1459
 
Selects the region of text between <em class="parameter"><code>start_pos</code></em> and <em class="parameter"><code>end_pos</code></em>.
1460
 
</p>
1461
 
<p>
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>.
1464
 
</p>
1465
 
<div class="variablelist"><table border="0" class="variablelist">
1466
 
<colgroup>
1467
 
<col align="left" valign="top">
1468
 
<col>
1469
 
</colgroup>
1470
 
<tbody>
1471
 
<tr>
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>
1474
 
</td>
1475
 
</tr>
1476
 
<tr>
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>
1479
 
</tr>
1480
 
<tr>
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>
1483
 
</tr>
1484
 
</tbody>
1485
 
</table></div>
1486
 
<p class="since">Since 1.0</p>
1487
 
</div>
1488
 
<hr>
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>
1492
 
<p>
1493
 
Retrieves the currently selected text.
1494
 
</p>
1495
 
<div class="variablelist"><table border="0" class="variablelist">
1496
 
<colgroup>
1497
 
<col align="left" valign="top">
1498
 
<col>
1499
 
</colgroup>
1500
 
<tbody>
1501
 
<tr>
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>
1504
 
</td>
1505
 
</tr>
1506
 
<tr>
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">
 
1949
<colgroup>
 
1950
<col width="150px" class="parameters_name">
 
1951
<col class="parameters_description">
 
1952
<col width="200px" class="parameters_annotations">
 
1953
</colgroup>
 
1954
<tbody>
 
1955
<tr>
 
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>
 
1959
</tr>
 
1960
<tr>
 
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>
 
1965
</tr>
 
1966
</tbody>
 
1967
</table></div>
 
1968
</div>
 
1969
<p class="since">Since 1.0</p>
 
1970
</div>
 
1971
<hr>
 
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">
 
1981
<colgroup>
 
1982
<col width="150px" class="parameters_name">
 
1983
<col class="parameters_description">
 
1984
<col width="200px" class="parameters_annotations">
 
1985
</colgroup>
 
1986
<tbody><tr>
 
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>
 
1990
</tr></tbody>
 
1991
</table></div>
 
1992
</div>
 
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>
 
1996
<p></p>
 
1997
</div>
 
1998
<p class="since">Since 1.0</p>
 
1999
</div>
 
2000
<hr>
 
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">
 
2012
<colgroup>
 
2013
<col width="150px" class="parameters_name">
 
2014
<col class="parameters_description">
 
2015
<col width="200px" class="parameters_annotations">
 
2016
</colgroup>
 
2017
<tbody>
 
2018
<tr>
 
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>
 
2022
</tr>
 
2023
<tr>
 
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>
 
2027
</tr>
 
2028
</tbody>
 
2029
</table></div>
 
2030
</div>
 
2031
<p class="since">Since 1.0</p>
 
2032
</div>
 
2033
<hr>
 
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">
 
2042
<colgroup>
 
2043
<col width="150px" class="parameters_name">
 
2044
<col class="parameters_description">
 
2045
<col width="200px" class="parameters_annotations">
 
2046
</colgroup>
 
2047
<tbody><tr>
 
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>
 
2051
</tr></tbody>
 
2052
</table></div>
 
2053
</div>
 
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>
 
2057
<p></p>
 
2058
</div>
 
2059
<p class="since">Since 1.0</p>
 
2060
</div>
 
2061
<hr>
 
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>
 
2070
.</p>
 
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>
 
2074
.</p>
 
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">
 
2078
<colgroup>
 
2079
<col width="150px" class="parameters_name">
 
2080
<col class="parameters_description">
 
2081
<col width="200px" class="parameters_annotations">
 
2082
</colgroup>
 
2083
<tbody>
 
2084
<tr>
 
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>
 
2088
</tr>
 
2089
<tr>
 
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>
 
2093
</tr>
 
2094
<tr>
 
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>
 
2098
</tr>
 
2099
</tbody>
 
2100
</table></div>
 
2101
</div>
 
2102
<p class="since">Since 1.0</p>
 
2103
</div>
 
2104
<hr>
 
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">
 
2113
<colgroup>
 
2114
<col width="150px" class="parameters_name">
 
2115
<col class="parameters_description">
 
2116
<col width="200px" class="parameters_annotations">
 
2117
</colgroup>
 
2118
<tbody><tr>
 
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>
 
2122
</tr></tbody>
 
2123
</table></div>
 
2124
</div>
 
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
1510
 
string.</td>
1511
 
</tr>
1512
 
</tbody>
1513
 
</table></div>
1514
 
<p class="since">Since 1.0</p>
1515
 
</div>
1516
 
<hr>
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>
1521
 
<p>
1522
 
Sets the other end of the selection, starting from the current
1523
 
cursor position.
1524
 
</p>
1525
 
<p>
1526
 
If <em class="parameter"><code>selection_bound</code></em> is -1, the selection unset.
1527
 
</p>
1528
 
<div class="variablelist"><table border="0" class="variablelist">
1529
 
<colgroup>
1530
 
<col align="left" valign="top">
1531
 
<col>
1532
 
</colgroup>
1533
 
<tbody>
1534
 
<tr>
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>
1537
 
</td>
1538
 
</tr>
1539
 
<tr>
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>
1542
 
</tr>
1543
 
</tbody>
1544
 
</table></div>
1545
 
<p class="since">Since 1.0</p>
1546
 
</div>
1547
 
<hr>
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>
1551
 
<p>
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.
1554
 
</p>
1555
 
<div class="variablelist"><table border="0" class="variablelist">
1556
 
<colgroup>
1557
 
<col align="left" valign="top">
1558
 
<col>
1559
 
</colgroup>
1560
 
<tbody>
1561
 
<tr>
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>
1564
 
</td>
1565
 
</tr>
1566
 
<tr>
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>
1569
 
</tr>
1570
 
</tbody>
1571
 
</table></div>
1572
 
<p class="since">Since 1.0</p>
1573
 
</div>
1574
 
<hr>
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>
1579
 
<p>
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
1582
 
mode.
1583
 
</p>
1584
 
<p>
1585
 
A text actor in single line mode will not wrap text and will clip
 
2129
string.</p>
 
2130
<p></p>
 
2131
</div>
 
2132
<p class="since">Since 1.0</p>
 
2133
</div>
 
2134
<hr>
 
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">
 
2147
<colgroup>
 
2148
<col width="150px" class="parameters_name">
 
2149
<col class="parameters_description">
 
2150
<col width="200px" class="parameters_annotations">
 
2151
</colgroup>
 
2152
<tbody>
 
2153
<tr>
 
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>
 
2157
</tr>
 
2158
<tr>
 
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>
 
2162
</tr>
 
2163
</tbody>
 
2164
</table></div>
 
2165
</div>
 
2166
<p class="since">Since 1.0</p>
 
2167
</div>
 
2168
<hr>
 
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">
 
2178
<colgroup>
 
2179
<col width="150px" class="parameters_name">
 
2180
<col class="parameters_description">
 
2181
<col width="200px" class="parameters_annotations">
 
2182
</colgroup>
 
2183
<tbody><tr>
 
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>
 
2187
</tr></tbody>
 
2188
</table></div>
 
2189
</div>
 
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>
 
2193
<p></p>
 
2194
</div>
 
2195
<p class="since">Since 1.0</p>
 
2196
</div>
 
2197
<hr>
 
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>&lt;!-- --&gt;s can be in single line
 
2205
mode.</p>
 
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.
1589
 
</p>
1590
 
<p>
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>
1594
 
signal.
1595
 
</p>
1596
 
<div class="variablelist"><table border="0" class="variablelist">
1597
 
<colgroup>
1598
 
<col align="left" valign="top">
1599
 
<col>
1600
 
</colgroup>
1601
 
<tbody>
1602
 
<tr>
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>
1605
 
</td>
1606
 
</tr>
1607
 
<tr>
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>
1610
 
</tr>
1611
 
</tbody>
1612
 
</table></div>
1613
 
<p class="since">Since 1.0</p>
1614
 
</div>
1615
 
<hr>
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>
1619
 
<p>
1620
 
Retrieves whether the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor is in single line mode.
1621
 
</p>
1622
 
<div class="variablelist"><table border="0" class="variablelist">
1623
 
<colgroup>
1624
 
<col align="left" valign="top">
1625
 
<col>
1626
 
</colgroup>
1627
 
<tbody>
1628
 
<tr>
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>
1631
 
</td>
1632
 
</tr>
1633
 
<tr>
1634
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1635
 
<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>
1637
 
</tr>
1638
 
</tbody>
1639
 
</table></div>
1640
 
<p class="since">Since 1.0</p>
1641
 
</div>
1642
 
<hr>
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>
1647
 
<p>
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.
1650
 
</p>
1651
 
<p>
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.
1654
 
</p>
1655
 
<p>
1656
 
See also <a class="link" href="ClutterText.html#ClutterText--use-markup" title='The "use-markup" property'><span class="type">"use-markup"</span></a>.
1657
 
</p>
1658
 
<div class="variablelist"><table border="0" class="variablelist">
1659
 
<colgroup>
1660
 
<col align="left" valign="top">
1661
 
<col>
1662
 
</colgroup>
1663
 
<tbody>
1664
 
<tr>
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>
1667
 
</td>
1668
 
</tr>
1669
 
<tr>
1670
 
<td><p><span class="term"><em class="parameter"><code>setting</code></em> :</span></p></td>
1671
 
<td>
1672
 
<code class="literal">TRUE</code> if the text should be parsed for markup.</td>
1673
 
</tr>
1674
 
</tbody>
1675
 
</table></div>
1676
 
<p class="since">Since 1.0</p>
1677
 
</div>
1678
 
<hr>
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>
1682
 
<p>
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.
1685
 
</p>
1686
 
<div class="variablelist"><table border="0" class="variablelist">
1687
 
<colgroup>
1688
 
<col align="left" valign="top">
1689
 
<col>
1690
 
</colgroup>
1691
 
<tbody>
1692
 
<tr>
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>
1695
 
</td>
1696
 
</tr>
1697
 
<tr>
1698
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1699
 
<td>
1700
 
<code class="literal">TRUE</code> if the contents will be parsed for markup</td>
1701
 
</tr>
1702
 
</tbody>
1703
 
</table></div>
1704
 
<p class="since">Since 1.0</p>
1705
 
</div>
1706
 
<hr>
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>
1711
 
<p>
1712
 
Sets whether the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should be editable.
1713
 
</p>
1714
 
<p>
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.
1718
 
</p>
1719
 
<div class="variablelist"><table border="0" class="variablelist">
1720
 
<colgroup>
1721
 
<col align="left" valign="top">
1722
 
<col>
1723
 
</colgroup>
1724
 
<tbody>
1725
 
<tr>
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>
1728
 
</td>
1729
 
</tr>
1730
 
<tr>
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>
1733
 
</tr>
1734
 
</tbody>
1735
 
</table></div>
1736
 
<p class="since">Since 1.0</p>
1737
 
</div>
1738
 
<hr>
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>
1742
 
<p>
1743
 
Retrieves whether a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> is editable or not.
1744
 
</p>
1745
 
<div class="variablelist"><table border="0" class="variablelist">
1746
 
<colgroup>
1747
 
<col align="left" valign="top">
1748
 
<col>
1749
 
</colgroup>
1750
 
<tbody>
1751
 
<tr>
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>
1754
 
</td>
1755
 
</tr>
1756
 
<tr>
1757
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1758
 
<td>
1759
 
<code class="literal">TRUE</code> if the actor is editable</td>
1760
 
</tr>
1761
 
</tbody>
1762
 
</table></div>
1763
 
<p class="since">Since 1.0</p>
1764
 
</div>
1765
 
<hr>
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>
1771
 
<p>
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.
1773
 
</p>
1774
 
<p>
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>.
1777
 
</p>
1778
 
<p>
1779
 
The position is expressed in characters, not in bytes.
1780
 
</p>
1781
 
<div class="variablelist"><table border="0" class="variablelist">
1782
 
<colgroup>
1783
 
<col align="left" valign="top">
1784
 
<col>
1785
 
</colgroup>
1786
 
<tbody>
1787
 
<tr>
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>
1790
 
</td>
1791
 
</tr>
1792
 
<tr>
1793
 
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
1794
 
<td>the text to be inserted</td>
1795
 
</tr>
1796
 
<tr>
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>
1799
 
</tr>
1800
 
</tbody>
1801
 
</table></div>
1802
 
<p class="since">Since 1.0</p>
1803
 
</div>
1804
 
<hr>
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>
1809
 
<p>
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.
1812
 
</p>
1813
 
<div class="variablelist"><table border="0" class="variablelist">
1814
 
<colgroup>
1815
 
<col align="left" valign="top">
1816
 
<col>
1817
 
</colgroup>
1818
 
<tbody>
1819
 
<tr>
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>
1822
 
</td>
1823
 
</tr>
1824
 
<tr>
1825
 
<td><p><span class="term"><em class="parameter"><code>wc</code></em> :</span></p></td>
1826
 
<td>a Unicode character</td>
1827
 
</tr>
1828
 
</tbody>
1829
 
</table></div>
1830
 
<p class="since">Since 1.0</p>
1831
 
</div>
1832
 
<hr>
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>
1837
 
<p>
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.
1840
 
</p>
1841
 
<p>
1842
 
Somewhat awkwardly, the cursor position is decremented by the same
1843
 
number of characters you've deleted.
1844
 
</p>
1845
 
<div class="variablelist"><table border="0" class="variablelist">
1846
 
<colgroup>
1847
 
<col align="left" valign="top">
1848
 
<col>
1849
 
</colgroup>
1850
 
<tbody>
1851
 
<tr>
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>
1854
 
</td>
1855
 
</tr>
1856
 
<tr>
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>
1859
 
</tr>
1860
 
</tbody>
1861
 
</table></div>
1862
 
<p class="since">Since 1.0</p>
1863
 
</div>
1864
 
<hr>
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>
1870
 
<p>
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>.
1873
 
</p>
1874
 
<p>
1875
 
The starting and ending positions are expressed in characters,
1876
 
not in bytes.
1877
 
</p>
1878
 
<div class="variablelist"><table border="0" class="variablelist">
1879
 
<colgroup>
1880
 
<col align="left" valign="top">
1881
 
<col>
1882
 
</colgroup>
1883
 
<tbody>
1884
 
<tr>
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>
1887
 
</td>
1888
 
</tr>
1889
 
<tr>
1890
 
<td><p><span class="term"><em class="parameter"><code>start_pos</code></em> :</span></p></td>
1891
 
<td>starting position</td>
1892
 
</tr>
1893
 
<tr>
1894
 
<td><p><span class="term"><em class="parameter"><code>end_pos</code></em> :</span></p></td>
1895
 
<td>ending position</td>
1896
 
</tr>
1897
 
</tbody>
1898
 
</table></div>
1899
 
<p class="since">Since 1.0</p>
1900
 
</div>
1901
 
<hr>
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>
1905
 
<p>
1906
 
Deletes the currently selected text
1907
 
</p>
1908
 
<p>
1909
 
This function is only useful in subclasses of <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>
1910
 
</p>
1911
 
<div class="variablelist"><table border="0" class="variablelist">
1912
 
<colgroup>
1913
 
<col align="left" valign="top">
1914
 
<col>
1915
 
</colgroup>
1916
 
<tbody>
1917
 
<tr>
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>
1920
 
</td>
1921
 
</tr>
1922
 
<tr>
1923
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1924
 
<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>
1927
 
</tr>
1928
 
</tbody>
1929
 
</table></div>
1930
 
<p class="since">Since 1.0</p>
1931
 
</div>
1932
 
<hr>
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>
1938
 
<p>
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>.
1941
 
</p>
1942
 
<p>
1943
 
The positions are specified in characters, not in bytes.
1944
 
</p>
1945
 
<div class="variablelist"><table border="0" class="variablelist">
1946
 
<colgroup>
1947
 
<col align="left" valign="top">
1948
 
<col>
1949
 
</colgroup>
1950
 
<tbody>
1951
 
<tr>
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>
1954
 
</td>
1955
 
</tr>
1956
 
<tr>
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>
1959
 
</tr>
1960
 
<tr>
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>
1963
 
</tr>
1964
 
<tr>
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>
 
2213
signal.</p>
 
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">
 
2217
<colgroup>
 
2218
<col width="150px" class="parameters_name">
 
2219
<col class="parameters_description">
 
2220
<col width="200px" class="parameters_annotations">
 
2221
</colgroup>
 
2222
<tbody>
 
2223
<tr>
 
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>
 
2227
</tr>
 
2228
<tr>
 
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>
 
2232
</tr>
 
2233
</tbody>
 
2234
</table></div>
 
2235
</div>
 
2236
<p class="since">Since 1.0</p>
 
2237
</div>
 
2238
<hr>
 
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">
 
2247
<colgroup>
 
2248
<col width="150px" class="parameters_name">
 
2249
<col class="parameters_description">
 
2250
<col width="200px" class="parameters_annotations">
 
2251
</colgroup>
 
2252
<tbody><tr>
 
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>
 
2256
</tr></tbody>
 
2257
</table></div>
 
2258
</div>
 
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>
 
2262
<p></p>
 
2263
</div>
 
2264
<p class="since">Since 1.0</p>
 
2265
</div>
 
2266
<hr>
 
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 &lt;link linkend="PangoMarkupFormat"&gt;Pango's text markup language&lt;/link&gt;.</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">
 
2280
<colgroup>
 
2281
<col width="150px" class="parameters_name">
 
2282
<col class="parameters_description">
 
2283
<col width="200px" class="parameters_annotations">
 
2284
</colgroup>
 
2285
<tbody>
 
2286
<tr>
 
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>
 
2290
</tr>
 
2291
<tr>
 
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>
 
2295
</tr>
 
2296
</tbody>
 
2297
</table></div>
 
2298
</div>
 
2299
<p class="since">Since 1.0</p>
 
2300
</div>
 
2301
<hr>
 
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">
 
2311
<colgroup>
 
2312
<col width="150px" class="parameters_name">
 
2313
<col class="parameters_description">
 
2314
<col width="200px" class="parameters_annotations">
 
2315
</colgroup>
 
2316
<tbody><tr>
 
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>
 
2320
</tr></tbody>
 
2321
</table></div>
 
2322
</div>
 
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>
 
2326
<p></p>
 
2327
</div>
 
2328
<p class="since">Since 1.0</p>
 
2329
</div>
 
2330
<hr>
 
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">
 
2343
<colgroup>
 
2344
<col width="150px" class="parameters_name">
 
2345
<col class="parameters_description">
 
2346
<col width="200px" class="parameters_annotations">
 
2347
</colgroup>
 
2348
<tbody>
 
2349
<tr>
 
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>
 
2353
</tr>
 
2354
<tr>
 
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>
 
2358
</tr>
 
2359
</tbody>
 
2360
</table></div>
 
2361
</div>
 
2362
<p class="since">Since 1.0</p>
 
2363
</div>
 
2364
<hr>
 
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">
 
2373
<colgroup>
 
2374
<col width="150px" class="parameters_name">
 
2375
<col class="parameters_description">
 
2376
<col width="200px" class="parameters_annotations">
 
2377
</colgroup>
 
2378
<tbody><tr>
 
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>
 
2382
</tr></tbody>
 
2383
</table></div>
 
2384
</div>
 
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>
 
2388
<p></p>
 
2389
</div>
 
2390
<p class="since">Since 1.0</p>
 
2391
</div>
 
2392
<hr>
 
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">
 
2408
<colgroup>
 
2409
<col width="150px" class="parameters_name">
 
2410
<col class="parameters_description">
 
2411
<col width="200px" class="parameters_annotations">
 
2412
</colgroup>
 
2413
<tbody>
 
2414
<tr>
 
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>
 
2418
</tr>
 
2419
<tr>
 
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>
 
2423
</tr>
 
2424
<tr>
 
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>
 
2428
</tr>
 
2429
</tbody>
 
2430
</table></div>
 
2431
</div>
 
2432
<p class="since">Since 1.0</p>
 
2433
</div>
 
2434
<hr>
 
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">
 
2446
<colgroup>
 
2447
<col width="150px" class="parameters_name">
 
2448
<col class="parameters_description">
 
2449
<col width="200px" class="parameters_annotations">
 
2450
</colgroup>
 
2451
<tbody>
 
2452
<tr>
 
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>
 
2456
</tr>
 
2457
<tr>
 
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>
 
2461
</tr>
 
2462
</tbody>
 
2463
</table></div>
 
2464
</div>
 
2465
<p class="since">Since 1.0</p>
 
2466
</div>
 
2467
<hr>
 
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">
 
2481
<colgroup>
 
2482
<col width="150px" class="parameters_name">
 
2483
<col class="parameters_description">
 
2484
<col width="200px" class="parameters_annotations">
 
2485
</colgroup>
 
2486
<tbody>
 
2487
<tr>
 
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>
 
2491
</tr>
 
2492
<tr>
 
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>
 
2496
</tr>
 
2497
</tbody>
 
2498
</table></div>
 
2499
</div>
 
2500
<p class="since">Since 1.0</p>
 
2501
</div>
 
2502
<hr>
 
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>
 
2510
 
 
2511
and <em class="parameter"><code>end_pos</code></em>
 
2512
.</p>
 
2513
<p>The starting and ending positions are expressed in characters,
 
2514
not in bytes.</p>
 
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">
 
2518
<colgroup>
 
2519
<col width="150px" class="parameters_name">
 
2520
<col class="parameters_description">
 
2521
<col width="200px" class="parameters_annotations">
 
2522
</colgroup>
 
2523
<tbody>
 
2524
<tr>
 
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>
 
2528
</tr>
 
2529
<tr>
 
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>
 
2533
</tr>
 
2534
<tr>
 
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>
 
2538
</tr>
 
2539
</tbody>
 
2540
</table></div>
 
2541
</div>
 
2542
<p class="since">Since 1.0</p>
 
2543
</div>
 
2544
<hr>
 
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">
 
2554
<colgroup>
 
2555
<col width="150px" class="parameters_name">
 
2556
<col class="parameters_description">
 
2557
<col width="200px" class="parameters_annotations">
 
2558
</colgroup>
 
2559
<tbody><tr>
 
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>
 
2563
</tr></tbody>
 
2564
</table></div>
 
2565
</div>
 
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>
 
2570
<p></p>
 
2571
</div>
 
2572
<p class="since">Since 1.0</p>
 
2573
</div>
 
2574
<hr>
 
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>
 
2585
.</p>
 
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">
 
2590
<colgroup>
 
2591
<col width="150px" class="parameters_name">
 
2592
<col class="parameters_description">
 
2593
<col width="200px" class="parameters_annotations">
 
2594
</colgroup>
 
2595
<tbody>
 
2596
<tr>
 
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>
 
2600
</tr>
 
2601
<tr>
 
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>
 
2605
</tr>
 
2606
<tr>
 
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>
 
2610
</tr>
 
2611
</tbody>
 
2612
</table></div>
 
2613
</div>
 
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>
1969
 
</tr>
1970
 
</tbody>
1971
 
</table></div>
1972
 
<p class="since">Since 1.0</p>
1973
 
</div>
1974
 
<hr>
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>
1979
 
<p>
1980
 
Sets the color of the cursor of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.
1981
 
</p>
1982
 
<p>
1983
 
If <em class="parameter"><code>color</code></em> is <code class="literal">NULL</code>, the cursor color will be the same as the
1984
 
text color.
1985
 
</p>
1986
 
<div class="variablelist"><table border="0" class="variablelist">
1987
 
<colgroup>
1988
 
<col align="left" valign="top">
1989
 
<col>
1990
 
</colgroup>
1991
 
<tbody>
1992
 
<tr>
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>
1995
 
</td>
1996
 
</tr>
1997
 
<tr>
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>
2000
 
</td>
2001
 
</tr>
2002
 
</tbody>
2003
 
</table></div>
2004
 
<p class="since">Since 1.0</p>
2005
 
</div>
2006
 
<hr>
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>
2011
 
<p>
2012
 
Retrieves the color of the cursor of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.
2013
 
</p>
2014
 
<div class="variablelist"><table border="0" class="variablelist">
2015
 
<colgroup>
2016
 
<col align="left" valign="top">
2017
 
<col>
2018
 
</colgroup>
2019
 
<tbody>
2020
 
<tr>
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>
2023
 
</td>
2024
 
</tr>
2025
 
<tr>
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>
2028
 
</td>
2029
 
</tr>
2030
 
</tbody>
2031
 
</table></div>
2032
 
<p class="since">Since 1.0</p>
2033
 
</div>
2034
 
<hr>
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>
2039
 
<p>
2040
 
Sets the color of the selection of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.
2041
 
</p>
2042
 
<p>
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>
 
2619
<p></p>
 
2620
</div>
 
2621
<p class="since">Since 1.0</p>
 
2622
</div>
 
2623
<hr>
 
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
 
2632
text color.</p>
 
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">
 
2636
<colgroup>
 
2637
<col width="150px" class="parameters_name">
 
2638
<col class="parameters_description">
 
2639
<col width="200px" class="parameters_annotations">
 
2640
</colgroup>
 
2641
<tbody>
 
2642
<tr>
 
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>
 
2646
</tr>
 
2647
<tr>
 
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>
 
2651
</tr>
 
2652
</tbody>
 
2653
</table></div>
 
2654
</div>
 
2655
<p class="since">Since 1.0</p>
 
2656
</div>
 
2657
<hr>
 
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">
 
2667
<colgroup>
 
2668
<col width="150px" class="parameters_name">
 
2669
<col class="parameters_description">
 
2670
<col width="200px" class="parameters_annotations">
 
2671
</colgroup>
 
2672
<tbody>
 
2673
<tr>
 
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>
 
2677
</tr>
 
2678
<tr>
 
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>
 
2682
</tr>
 
2683
</tbody>
 
2684
</table></div>
 
2685
</div>
 
2686
<p class="since">Since 1.0</p>
 
2687
</div>
 
2688
<hr>
 
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.
2046
 
</p>
2047
 
<div class="variablelist"><table border="0" class="variablelist">
2048
 
<colgroup>
2049
 
<col align="left" valign="top">
2050
 
<col>
2051
 
</colgroup>
2052
 
<tbody>
2053
 
<tr>
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>
2056
 
</td>
2057
 
</tr>
2058
 
<tr>
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>
2061
 
</td>
2062
 
</tr>
2063
 
</tbody>
2064
 
</table></div>
2065
 
<p class="since">Since 1.0</p>
2066
 
</div>
2067
 
<hr>
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>
2072
 
<p>
2073
 
Retrieves the color of the selection of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.
2074
 
</p>
2075
 
<div class="variablelist"><table border="0" class="variablelist">
2076
 
<colgroup>
2077
 
<col align="left" valign="top">
2078
 
<col>
2079
 
</colgroup>
2080
 
<tbody>
2081
 
<tr>
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>
2084
 
</td>
2085
 
</tr>
2086
 
<tr>
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>
2089
 
</td>
2090
 
</tr>
2091
 
</tbody>
2092
 
</table></div>
2093
 
<p class="since">Since 1.0</p>
2094
 
</div>
2095
 
<hr>
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>
2101
 
<p>
2102
 
Sets the selected text color of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.
2103
 
</p>
2104
 
<p>
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.
2107
 
</p>
2108
 
<div class="variablelist"><table border="0" class="variablelist">
2109
 
<colgroup>
2110
 
<col align="left" valign="top">
2111
 
<col>
2112
 
</colgroup>
2113
 
<tbody>
2114
 
<tr>
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>
2117
 
</td>
2118
 
</tr>
2119
 
<tr>
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>
2122
 
</td>
2123
 
</tr>
2124
 
</tbody>
2125
 
</table></div>
2126
 
<p class="since">Since 1.8</p>
2127
 
</div>
2128
 
<hr>
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>
2134
 
<p>
2135
 
Retrieves the color of selected text of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.
2136
 
</p>
2137
 
<div class="variablelist"><table border="0" class="variablelist">
2138
 
<colgroup>
2139
 
<col align="left" valign="top">
2140
 
<col>
2141
 
</colgroup>
2142
 
<tbody>
2143
 
<tr>
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>
2146
 
</td>
2147
 
</tr>
2148
 
<tr>
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>
2151
 
</td>
2152
 
</tr>
2153
 
</tbody>
2154
 
</table></div>
2155
 
<p class="since">Since 1.8</p>
2156
 
</div>
2157
 
<hr>
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>
2162
 
<p>
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>.
2164
 
</p>
2165
 
<p>
2166
 
The position is expressed in characters, not in bytes.
2167
 
</p>
2168
 
<div class="variablelist"><table border="0" class="variablelist">
2169
 
<colgroup>
2170
 
<col align="left" valign="top">
2171
 
<col>
2172
 
</colgroup>
2173
 
<tbody>
2174
 
<tr>
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>
2177
 
</td>
2178
 
</tr>
2179
 
<tr>
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>
2182
 
</tr>
2183
 
</tbody>
2184
 
</table></div>
2185
 
<p class="since">Since 1.0</p>
2186
 
</div>
2187
 
<hr>
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>
2191
 
<p>
2192
 
Retrieves the cursor position.
2193
 
</p>
2194
 
<div class="variablelist"><table border="0" class="variablelist">
2195
 
<colgroup>
2196
 
<col align="left" valign="top">
2197
 
<col>
2198
 
</colgroup>
2199
 
<tbody>
2200
 
<tr>
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>
2203
 
</td>
2204
 
</tr>
2205
 
<tr>
2206
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
2207
 
<td>the cursor position, in characters</td>
2208
 
</tr>
2209
 
</tbody>
2210
 
</table></div>
2211
 
<p class="since">Since 1.0</p>
2212
 
</div>
2213
 
<hr>
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>
2218
 
<p>
2219
 
Sets whether the cursor of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor should be
2220
 
visible or not.
2221
 
</p>
2222
 
<p>
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.
2225
 
</p>
2226
 
<p>
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>.
2228
 
</p>
2229
 
<p>
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>.
2232
 
</p>
2233
 
<div class="variablelist"><table border="0" class="variablelist">
2234
 
<colgroup>
2235
 
<col align="left" valign="top">
2236
 
<col>
2237
 
</colgroup>
2238
 
<tbody>
2239
 
<tr>
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>
2242
 
</td>
2243
 
</tr>
2244
 
<tr>
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>
2247
 
</tr>
2248
 
</tbody>
2249
 
</table></div>
2250
 
<p class="since">Since 1.0</p>
2251
 
</div>
2252
 
<hr>
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>
2256
 
<p>
2257
 
Retrieves whether the cursor of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor is visible.
2258
 
</p>
2259
 
<div class="variablelist"><table border="0" class="variablelist">
2260
 
<colgroup>
2261
 
<col align="left" valign="top">
2262
 
<col>
2263
 
</colgroup>
2264
 
<tbody>
2265
 
<tr>
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>
2268
 
</td>
2269
 
</tr>
2270
 
<tr>
2271
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
2272
 
<td>
2273
 
<code class="literal">TRUE</code> if the cursor is visible</td>
2274
 
</tr>
2275
 
</tbody>
2276
 
</table></div>
2277
 
<p class="since">Since 1.0</p>
2278
 
</div>
2279
 
<hr>
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>
2284
 
<p>
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>.
2288
 
</p>
2289
 
<div class="variablelist"><table border="0" class="variablelist">
2290
 
<colgroup>
2291
 
<col align="left" valign="top">
2292
 
<col>
2293
 
</colgroup>
2294
 
<tbody>
2295
 
<tr>
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>
2298
 
</td>
2299
 
</tr>
2300
 
<tr>
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
2303
 
default value</td>
2304
 
</tr>
2305
 
</tbody>
2306
 
</table></div>
2307
 
<p class="since">Since 1.0</p>
2308
 
</div>
2309
 
<hr>
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>
2313
 
<p>
2314
 
Retrieves the size of the cursor of a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.
2315
 
</p>
2316
 
<div class="variablelist"><table border="0" class="variablelist">
2317
 
<colgroup>
2318
 
<col align="left" valign="top">
2319
 
<col>
2320
 
</colgroup>
2321
 
<tbody>
2322
 
<tr>
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>
2325
 
</td>
2326
 
</tr>
2327
 
<tr>
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>
2330
 
</tr>
2331
 
</tbody>
2332
 
</table></div>
2333
 
<p class="since">Since 1.0</p>
2334
 
</div>
2335
 
<hr>
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>
2339
 
<p>
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>.
2342
 
</p>
2343
 
<p>
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">
 
2702
<colgroup>
 
2703
<col width="150px" class="parameters_name">
 
2704
<col class="parameters_description">
 
2705
<col width="200px" class="parameters_annotations">
 
2706
</colgroup>
 
2707
<tbody>
 
2708
<tr>
 
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>
 
2712
</tr>
 
2713
<tr>
 
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>
 
2717
</tr>
 
2718
</tbody>
 
2719
</table></div>
 
2720
</div>
 
2721
<p class="since">Since 1.0</p>
 
2722
</div>
 
2723
<hr>
 
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">
 
2733
<colgroup>
 
2734
<col width="150px" class="parameters_name">
 
2735
<col class="parameters_description">
 
2736
<col width="200px" class="parameters_annotations">
 
2737
</colgroup>
 
2738
<tbody>
 
2739
<tr>
 
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>
 
2743
</tr>
 
2744
<tr>
 
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>
 
2748
</tr>
 
2749
</tbody>
 
2750
</table></div>
 
2751
</div>
 
2752
<p class="since">Since 1.0</p>
 
2753
</div>
 
2754
<hr>
 
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">
 
2767
<colgroup>
 
2768
<col width="150px" class="parameters_name">
 
2769
<col class="parameters_description">
 
2770
<col width="200px" class="parameters_annotations">
 
2771
</colgroup>
 
2772
<tbody>
 
2773
<tr>
 
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>
 
2777
</tr>
 
2778
<tr>
 
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>
 
2782
</tr>
 
2783
</tbody>
 
2784
</table></div>
 
2785
</div>
 
2786
<p class="since">Since 1.8</p>
 
2787
</div>
 
2788
<hr>
 
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">
 
2798
<colgroup>
 
2799
<col width="150px" class="parameters_name">
 
2800
<col class="parameters_description">
 
2801
<col width="200px" class="parameters_annotations">
 
2802
</colgroup>
 
2803
<tbody>
 
2804
<tr>
 
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>
 
2808
</tr>
 
2809
<tr>
 
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>
 
2813
</tr>
 
2814
</tbody>
 
2815
</table></div>
 
2816
</div>
 
2817
<p class="since">Since 1.8</p>
 
2818
</div>
 
2819
<hr>
 
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>
 
2826
.</p>
 
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">
 
2831
<colgroup>
 
2832
<col width="150px" class="parameters_name">
 
2833
<col class="parameters_description">
 
2834
<col width="200px" class="parameters_annotations">
 
2835
</colgroup>
 
2836
<tbody>
 
2837
<tr>
 
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>
 
2841
</tr>
 
2842
<tr>
 
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>
 
2846
</tr>
 
2847
</tbody>
 
2848
</table></div>
 
2849
</div>
 
2850
<p class="since">Since 1.0</p>
 
2851
</div>
 
2852
<hr>
 
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">
 
2861
<colgroup>
 
2862
<col width="150px" class="parameters_name">
 
2863
<col class="parameters_description">
 
2864
<col width="200px" class="parameters_annotations">
 
2865
</colgroup>
 
2866
<tbody><tr>
 
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>
 
2870
</tr></tbody>
 
2871
</table></div>
 
2872
</div>
 
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>
 
2876
<p></p>
 
2877
</div>
 
2878
<p class="since">Since 1.0</p>
 
2879
</div>
 
2880
<hr>
 
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
 
2887
visible or not.</p>
 
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">
 
2896
<colgroup>
 
2897
<col width="150px" class="parameters_name">
 
2898
<col class="parameters_description">
 
2899
<col width="200px" class="parameters_annotations">
 
2900
</colgroup>
 
2901
<tbody>
 
2902
<tr>
 
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>
 
2906
</tr>
 
2907
<tr>
 
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>
 
2911
</tr>
 
2912
</tbody>
 
2913
</table></div>
 
2914
</div>
 
2915
<p class="since">Since 1.0</p>
 
2916
</div>
 
2917
<hr>
 
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">
 
2926
<colgroup>
 
2927
<col width="150px" class="parameters_name">
 
2928
<col class="parameters_description">
 
2929
<col width="200px" class="parameters_annotations">
 
2930
</colgroup>
 
2931
<tbody><tr>
 
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>
 
2935
</tr></tbody>
 
2936
</table></div>
 
2937
</div>
 
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>
 
2941
<p></p>
 
2942
</div>
 
2943
<p class="since">Since 1.0</p>
 
2944
</div>
 
2945
<hr>
 
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">
 
2957
<colgroup>
 
2958
<col width="150px" class="parameters_name">
 
2959
<col class="parameters_description">
 
2960
<col width="200px" class="parameters_annotations">
 
2961
</colgroup>
 
2962
<tbody>
 
2963
<tr>
 
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>
 
2967
</tr>
 
2968
<tr>
 
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>
 
2973
</tr>
 
2974
</tbody>
 
2975
</table></div>
 
2976
</div>
 
2977
<p class="since">Since 1.0</p>
 
2978
</div>
 
2979
<hr>
 
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">
 
2988
<colgroup>
 
2989
<col width="150px" class="parameters_name">
 
2990
<col class="parameters_description">
 
2991
<col width="200px" class="parameters_annotations">
 
2992
</colgroup>
 
2993
<tbody><tr>
 
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>
 
2997
</tr></tbody>
 
2998
</table></div>
 
2999
</div>
 
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>
 
3003
<p></p>
 
3004
</div>
 
3005
<p class="since">Since 1.0</p>
 
3006
</div>
 
3007
<hr>
 
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
 
3015
coordinates.</p>
 
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">
 
3019
<colgroup>
 
3020
<col width="150px" class="parameters_name">
 
3021
<col class="parameters_description">
 
3022
<col width="200px" class="parameters_annotations">
 
3023
</colgroup>
 
3024
<tbody>
 
3025
<tr>
 
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>
 
3029
</tr>
 
3030
<tr>
 
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>
 
3034
</tr>
 
3035
</tbody>
 
3036
</table></div>
 
3037
</div>
 
3038
<p class="since">Since 1.16</p>
 
3039
</div>
 
3040
<hr>
 
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>
 
3046
 has been set
 
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.
2348
 
</p>
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">
2350
3055
<colgroup>
2351
 
<col align="left" valign="top">
2352
 
<col>
 
3056
<col width="150px" class="parameters_name">
 
3057
<col class="parameters_description">
 
3058
<col width="200px" class="parameters_annotations">
2353
3059
</colgroup>
2354
 
<tbody>
2355
 
<tr>
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>
2358
 
</td>
2359
 
</tr>
2360
 
<tr>
2361
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
2362
 
<td>
2363
 
<code class="literal">TRUE</code> if the ::activate signal has been emitted,
2364
 
and <code class="literal">FALSE</code> otherwise</td>
2365
 
</tr>
2366
 
</tbody>
 
3060
<tbody><tr>
 
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>
 
3064
</tr></tbody>
2367
3065
</table></div>
 
3066
</div>
 
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>
 
3071
<p></p>
 
3072
</div>
2368
3073
<p class="since">Since 1.0</p>
2369
3074
</div>
2370
3075
<hr>
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>
2376
 
<p>
2377
 
Retrieves the position of the character at the given coordinates.
2378
 
</p>
2379
 
<p>
2380
 
Return: the position of the character
2381
 
</p>
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">
2383
3087
<colgroup>
2384
 
<col align="left" valign="top">
2385
 
<col>
 
3088
<col width="150px" class="parameters_name">
 
3089
<col class="parameters_description">
 
3090
<col width="200px" class="parameters_annotations">
2386
3091
</colgroup>
2387
3092
<tbody>
2388
3093
<tr>
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>
2391
 
</td>
2392
 
</tr>
2393
 
<tr>
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>
2396
 
</tr>
2397
 
<tr>
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>
 
3097
</tr>
 
3098
<tr>
 
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>
 
3102
</tr>
 
3103
<tr>
 
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>
2400
3107
</tr>
2401
3108
</tbody>
2402
3109
</table></div>
 
3110
</div>
2403
3111
<p class="since">Since 1.10</p>
2404
3112
</div>
2405
3113
<hr>
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>
2413
 
<p>
2414
 
Retrieves the coordinates of the given <em class="parameter"><code>position</code></em>.
2415
 
</p>
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>
 
3123
.</p>
 
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">
2417
3127
<colgroup>
2418
 
<col align="left" valign="top">
2419
 
<col>
 
3128
<col width="150px" class="parameters_name">
 
3129
<col class="parameters_description">
 
3130
<col width="200px" class="parameters_annotations">
2420
3131
</colgroup>
2421
3132
<tbody>
2422
3133
<tr>
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>
2425
 
</td>
2426
 
</tr>
2427
 
<tr>
2428
 
<td><p><span class="term"><em class="parameter"><code>position</code></em> :</span></p></td>
2429
 
<td>position in characters</td>
2430
 
</tr>
2431
 
<tr>
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>
2434
 
</td>
2435
 
</tr>
2436
 
<tr>
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>
2439
 
</td>
2440
 
</tr>
2441
 
<tr>
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>
2444
 
</td>
2445
 
</tr>
2446
 
<tr>
2447
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
2448
 
<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>
 
3137
</tr>
 
3138
<tr>
 
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>
 
3142
</tr>
 
3143
<tr>
 
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>
 
3147
</tr>
 
3148
<tr>
 
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>
 
3152
</tr>
 
3153
<tr>
 
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>
2450
3157
</tr>
2451
3158
</tbody>
2452
3159
</table></div>
 
3160
</div>
 
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>
 
3164
<p></p>
 
3165
</div>
2453
3166
<p class="since">Since 1.0</p>
2454
3167
</div>
2455
3168
<hr>
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>
2462
 
<p>
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>
2466
 
buffer.
2467
 
</p>
2468
 
<p>
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.
2471
 
</p>
2472
 
<p>
2473
 
This function should not be used by applications
2474
 
</p>
2475
 
<div class="variablelist"><table border="0" class="variablelist">
 
3179
buffer.</p>
 
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">
2476
3186
<colgroup>
2477
 
<col align="left" valign="top">
2478
 
<col>
 
3187
<col width="150px" class="parameters_name">
 
3188
<col class="parameters_description">
 
3189
<col width="200px" class="parameters_annotations">
2479
3190
</colgroup>
2480
3191
<tbody>
2481
3192
<tr>
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>
2484
 
</td>
2485
 
</tr>
2486
 
<tr>
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>
2489
 
</td>
2490
 
</tr>
2491
 
<tr>
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>
2494
 
</td>
2495
 
</tr>
2496
 
<tr>
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>
 
3196
</tr>
 
3197
<tr>
 
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>
 
3201
</tr>
 
3202
<tr>
 
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>
 
3206
</tr>
 
3207
<tr>
 
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>
2499
3211
</tr>
2500
3212
</tbody>
2501
3213
</table></div>
 
3214
</div>
2502
3215
<p class="since">Since 1.2</p>
2503
3216
</div>
2504
3217
<hr>
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>
2510
 
<p>
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.
2513
 
</p>
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">
2515
3229
<colgroup>
2516
 
<col align="left" valign="top">
2517
 
<col>
 
3230
<col width="150px" class="parameters_name">
 
3231
<col class="parameters_description">
 
3232
<col width="200px" class="parameters_annotations">
2518
3233
</colgroup>
2519
3234
<tbody>
2520
3235
<tr>
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>
2523
 
</td>
2524
 
</tr>
2525
 
<tr>
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>
2528
 
</td>
2529
 
</tr>
2530
 
<tr>
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>
2533
 
</td>
 
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>
 
3239
</tr>
 
3240
<tr>
 
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>
 
3244
</tr>
 
3245
<tr>
 
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>
2534
3249
</tr>
2535
3250
</tbody>
2536
3251
</table></div>
 
3252
</div>
2537
3253
<p class="since">Since 1.8</p>
2538
3254
</div>
2539
3255
</div>
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>
 
3263
</div>
 
3264
<hr>
 
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);
 
3274
};
 
3275
</pre>
 
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">
 
3280
<colgroup>
 
3281
<col width="300px" class="struct_members_name">
 
3282
<col class="struct_members_description">
 
3283
<col width="200px" class="struct_members_annotations">
 
3284
</colgroup>
 
3285
<tbody>
 
3286
<tr>
 
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>
 
3290
</tr>
 
3291
<tr>
 
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>
 
3295
</tr>
 
3296
<tr>
 
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>
 
3300
</tr>
 
3301
<tr>
 
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>
 
3305
</tr>
 
3306
</tbody>
 
3307
</table></div>
 
3308
</div>
 
3309
<p class="since">Since 1.0</p>
 
3310
</div>
 
3311
</div>
 
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>
2545
 
<p>
2546
 
Toggles whether return invokes the activate signal or not.
2547
 
</p>
 
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>
2550
3321
</div>
2551
3322
<hr>
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>
2555
 
<p>
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.
2558
 
</p>
 
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>&lt;!-- --&gt;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>
2560
3330
</div>
2561
3331
<hr>
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>
2565
 
<p>
2566
 
The buffer which stores the text for this <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>.
2567
 
</p>
2568
 
<p>
2569
 
If set to <code class="literal">NULL</code>, a default buffer will be created.
2570
 
</p>
 
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>
2572
3339
</div>
2573
3340
<hr>
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>
2577
 
<p>
2578
 
The color used to render the text.
2579
 
</p>
2580
 
<p class="since">Since 1.0</p>
2581
 
</div>
2582
 
<hr>
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>
2586
 
<p>
2587
 
The color of the cursor.
2588
 
</p>
2589
 
<p class="since">Since 1.0</p>
2590
 
</div>
2591
 
<hr>
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>
2595
 
<p>
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.
2597
 
</p>
 
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>
 
3347
</div>
 
3348
<hr>
 
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>
 
3355
</div>
 
3356
<hr>
 
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>
 
3361
<p>Flags: Read</p>
2598
3362
<p>Default value: FALSE</p>
2599
3363
<p class="since">Since 1.0</p>
2600
3364
</div>
2601
3365
<hr>
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>
2605
 
<p>
2606
 
The current input cursor position. -1 is taken to be the end of the text
2607
 
</p>
2608
 
<p>Allowed values: &gt;= 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: &gt;= -1</p>
2609
3372
<p>Default value: -1</p>
2610
3373
<p class="since">Since 1.12</p>
2611
3374
</div>
2612
3375
<hr>
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>
2616
 
<p>
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.
2619
 
</p>
2620
 
<p>Allowed values: &gt;= 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: &gt;= -1</p>
2621
3383
<p>Default value: 2</p>
2622
3384
<p class="since">Since 1.0</p>
2623
3385
</div>
2624
3386
<hr>
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>
2628
 
<p>
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>.
2632
 
</p>
 
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>
2635
3396
</div>
2636
3397
<hr>
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>
2640
 
<p>
2641
 
Whether key events delivered to the actor causes editing.
2642
 
</p>
 
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>
2645
3405
</div>
2646
3406
<hr>
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>
2650
 
<p>
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
2652
 
</p>
 
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>
2655
3414
</div>
2656
3415
<hr>
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>
2660
 
<p>
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>
2662
 
</p>
2663
 
<p>
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
2666
 
</p>
 
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>
2668
3424
</div>
2669
3425
<hr>
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>
2673
 
<p>
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>.
2676
 
</p>
2677
 
<p>
2678
 
If set to <code class="literal">NULL</code>, the default system font will be used instead.
2679
 
</p>
 
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>
2682
3435
</div>
2683
3436
<hr>
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>
2687
 
<p>
2688
 
Whether the contents of the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> should be justified
2689
 
on both margins.
2690
 
</p>
 
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>
2693
3445
</div>
2694
3446
<hr>
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>
2698
 
<p>
2699
 
The preferred alignment for the text. This property controls
2700
 
the alignment of multi-line paragraphs.
2701
 
</p>
 
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>
2704
3455
</div>
2705
3456
<hr>
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>
2709
 
<p>
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.
2713
 
</p>
 
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>
2716
3466
</div>
2717
3467
<hr>
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>
2721
 
<p>
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.
2724
 
</p>
 
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>
2727
3476
</div>
2728
3477
<hr>
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>
2732
 
<p>
2733
 
The maximum length of the contents of the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor.
2734
 
</p>
2735
 
<p>Allowed values: &gt;= G_MAXULONG</p>
2736
 
<p>Default value: 0</p>
2737
 
<p class="since">Since 1.0</p>
2738
 
</div>
2739
 
<hr>
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>
2743
 
<p>
2744
 
If non-zero, the character that should be used in place of
2745
 
the actual text in a password text actor.
2746
 
</p>
2747
 
<p>Default value: 0</p>
2748
 
<p class="since">Since 1.0</p>
2749
 
</div>
2750
 
<hr>
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>
2757
 
</div>
2758
 
<p>
2759
 
The current input cursor position. -1 is taken to be the end of the text
2760
 
</p>
2761
 
<p>Allowed values: &gt;= 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: &gt;= -1</p>
 
3484
<p>Default value: 0</p>
 
3485
<p class="since">Since 1.0</p>
 
3486
</div>
 
3487
<hr>
 
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>
 
3496
</div>
 
3497
<hr>
 
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>
 
3505
</div>
 
3506
<p>Flags: Read / Write</p>
 
3507
<p>Allowed values: &gt;= -1</p>
2762
3508
<p>Default value: -1</p>
2763
3509
<p class="since">Since 1.0</p>
2764
3510
</div>
2765
3511
<hr>
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>
2769
 
<p>
2770
 
Whether it is possible to select text, either using the pointer
2771
 
or the keyboard.
2772
 
</p>
 
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>
2775
3520
</div>
2776
3521
<hr>
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>
2780
 
<p>
2781
 
The color of selected text.
2782
 
</p>
 
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>
2784
3528
</div>
2785
3529
<hr>
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>
2789
 
<p>
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.
2791
 
</p>
 
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>
 
3534
<p>Flags: Read</p>
2792
3535
<p>Default value: FALSE</p>
2793
3536
<p class="since">Since 1.8</p>
2794
3537
</div>
2795
3538
<hr>
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>
2799
 
<p>
2800
 
The current input cursor position. -1 is taken to be the end of the text
2801
 
</p>
2802
 
<p>Allowed values: &gt;= 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: &gt;= -1</p>
2803
3545
<p>Default value: -1</p>
2804
3546
<p class="since">Since 1.0</p>
2805
3547
</div>
2806
3548
<hr>
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>
2810
 
<p>
2811
 
The color of the selection.
2812
 
</p>
 
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>
2814
3555
</div>
2815
3556
<hr>
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>
2819
 
<p>
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.
2821
 
</p>
 
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>
 
3561
<p>Flags: Read</p>
2822
3562
<p>Default value: FALSE</p>
2823
3563
<p class="since">Since 1.0</p>
2824
3564
</div>
2825
3565
<hr>
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>
2829
 
<p>
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.
2834
 
</p>
2835
 
<p>
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.
2838
 
</p>
2839
 
<p>
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>.
2842
 
</p>
 
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>
2845
3580
</div>
2846
3581
<hr>
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>
2850
 
<p>
2851
 
The text to render inside the actor.
2852
 
</p>
 
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>
2855
3589
</div>
2856
3590
<hr>
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>
2860
 
<p>
2861
 
Whether the text includes Pango markup.
2862
 
</p>
2863
 
<p>
2864
 
For more informations about the Pango markup format, see
2865
 
<code class="function">pango_layout_set_markup()</code> in the Pango documentation.
2866
 
</p>
2867
 
<p>
2868
 
</p>
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>
2874
 
<p>
2875
 
</p>
 
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>
2878
3604
</div>
2880
3606
<div class="refsect1">
2881
3607
<a name="ClutterText.signal-details"></a><h2>Signal Details</h2>
2882
3608
<div class="refsect2">
2883
 
<a name="ClutterText-activate"></a><h3>The <code class="literal">"activate"</code> signal</h3>
2884
 
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self,
2885
 
                                                        <span class="type">gpointer</span>     user_data)      : <code class="literal">Run Last</code></pre>
2886
 
<p>
2887
 
The ::activate signal is emitted each time the actor is 'activated'
 
3609
<a name="ClutterText-activate"></a><h3>The <code class="literal">“activate”</code> signal</h3>
 
3610
<pre class="programlisting"><span class="returnvalue">void</span>
 
3611
user_function (<a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self,
 
3612
               <span class="type">gpointer</span>     user_data)</pre>
 
3613
<p>The ::activate signal is emitted each time the actor is 'activated'
2888
3614
by the user, normally by pressing the 'Enter' key. The signal is
2889
 
emitted only if <a class="link" href="ClutterText.html#ClutterText--activatable" title='The "activatable" property'><span class="type">"activatable"</span></a> is set to <code class="literal">TRUE</code>.
2890
 
</p>
2891
 
<div class="variablelist"><table border="0" class="variablelist">
 
3615
emitted only if <a class="link" href="ClutterText.html#ClutterText--activatable" title="The “activatable” property"><span class="type">“activatable”</span></a> is set to <code class="literal">TRUE</code>.</p>
 
3616
<div class="refsect3">
 
3617
<a name="id-1.5.3.4.13.2.5"></a><h4>Parameters</h4>
 
3618
<div class="informaltable"><table width="100%" border="0">
2892
3619
<colgroup>
2893
 
<col align="left" valign="top">
2894
 
<col>
 
3620
<col width="150px" class="parameters_name">
 
3621
<col class="parameters_description">
 
3622
<col width="200px" class="parameters_annotations">
2895
3623
</colgroup>
2896
3624
<tbody>
2897
3625
<tr>
2898
 
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
2899
 
<td>the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> that emitted the signal</td>
 
3626
<td class="parameter_name"><p>self</p></td>
 
3627
<td class="parameter_description"><p>the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> that emitted the signal</p></td>
 
3628
<td class="parameter_annotations"> </td>
2900
3629
</tr>
2901
3630
<tr>
2902
 
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
2903
 
<td>user data set when the signal handler was connected.</td>
 
3631
<td class="parameter_name"><p>user_data</p></td>
 
3632
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
 
3633
<td class="parameter_annotations"> </td>
2904
3634
</tr>
2905
3635
</tbody>
2906
3636
</table></div>
 
3637
</div>
 
3638
<p>Flags: Run Last</p>
2907
3639
<p class="since">Since 1.0</p>
2908
3640
</div>
2909
3641
<hr>
2910
3642
<div class="refsect2">
2911
 
<a name="ClutterText-cursor-event"></a><h3>The <code class="literal">"cursor-event"</code> signal</h3>
2912
 
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>     *self,
2913
 
                                                        <a class="link" href="clutter-Base-geometric-types.html#ClutterGeometry" title="struct ClutterGeometry"><span class="type">ClutterGeometry</span></a> *geometry,
2914
 
                                                        <span class="type">gpointer</span>         user_data)      : <code class="literal">Run Last</code></pre>
2915
 
<p>
2916
 
The ::cursor-event signal is emitted whenever the cursor position
2917
 
changes inside a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor. Inside <em class="parameter"><code>geometry</code></em> it is stored
 
3643
<a name="ClutterText-cursor-changed"></a><h3>The <code class="literal">“cursor-changed”</code> signal</h3>
 
3644
<pre class="programlisting"><span class="returnvalue">void</span>
 
3645
user_function (<a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self,
 
3646
               <span class="type">gpointer</span>     user_data)</pre>
 
3647
<p>The ::cursor-changed signal is emitted whenever the cursor
 
3648
position or size changes.</p>
 
3649
<div class="refsect3">
 
3650
<a name="id-1.5.3.4.13.3.5"></a><h4>Parameters</h4>
 
3651
<div class="informaltable"><table width="100%" border="0">
 
3652
<colgroup>
 
3653
<col width="150px" class="parameters_name">
 
3654
<col class="parameters_description">
 
3655
<col width="200px" class="parameters_annotations">
 
3656
</colgroup>
 
3657
<tbody>
 
3658
<tr>
 
3659
<td class="parameter_name"><p>self</p></td>
 
3660
<td class="parameter_description"><p>the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> that emitted the signal</p></td>
 
3661
<td class="parameter_annotations"> </td>
 
3662
</tr>
 
3663
<tr>
 
3664
<td class="parameter_name"><p>user_data</p></td>
 
3665
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
 
3666
<td class="parameter_annotations"> </td>
 
3667
</tr>
 
3668
</tbody>
 
3669
</table></div>
 
3670
</div>
 
3671
<p>Flags: Run Last</p>
 
3672
<p class="since">Since 1.16</p>
 
3673
</div>
 
3674
<hr>
 
3675
<div class="refsect2">
 
3676
<a name="ClutterText-cursor-event"></a><h3>The <code class="literal">“cursor-event”</code> signal</h3>
 
3677
<pre class="programlisting"><span class="returnvalue">void</span>
 
3678
user_function (<a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a>     *self,
 
3679
               <a class="link" href="clutter-Base-geometric-types.html#ClutterGeometry" title="struct ClutterGeometry"><span class="type">ClutterGeometry</span></a> *geometry,
 
3680
               <span class="type">gpointer</span>         user_data)</pre>
 
3681
<p>The ::cursor-event signal is emitted whenever the cursor position
 
3682
changes inside a <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> actor. Inside <em class="parameter"><code>geometry</code></em>
 
3683
 it is stored
2918
3684
the current position and size of the cursor, relative to the actor
2919
 
itself.
2920
 
</p>
2921
 
<div class="variablelist"><table border="0" class="variablelist">
 
3685
itself.</p>
 
3686
<div class="warning">
 
3687
<p><code class="literal">ClutterText::cursor-event</code> has been deprecated since version 1.16 and should not be used in newly-written code.</p>
 
3688
<p>Use the <a class="link" href="ClutterText.html#ClutterText-cursor-changed" title="The “cursor-changed” signal"><span class="type">“cursor-changed”</span></a> signal instead</p>
 
3689
</div>
 
3690
<div class="refsect3">
 
3691
<a name="id-1.5.3.4.13.4.7"></a><h4>Parameters</h4>
 
3692
<div class="informaltable"><table width="100%" border="0">
2922
3693
<colgroup>
2923
 
<col align="left" valign="top">
2924
 
<col>
 
3694
<col width="150px" class="parameters_name">
 
3695
<col class="parameters_description">
 
3696
<col width="200px" class="parameters_annotations">
2925
3697
</colgroup>
2926
3698
<tbody>
2927
3699
<tr>
2928
 
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
2929
 
<td>the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> that emitted the signal</td>
2930
 
</tr>
2931
 
<tr>
2932
 
<td><p><span class="term"><em class="parameter"><code>geometry</code></em> :</span></p></td>
2933
 
<td>the coordinates of the cursor</td>
2934
 
</tr>
2935
 
<tr>
2936
 
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
2937
 
<td>user data set when the signal handler was connected.</td>
 
3700
<td class="parameter_name"><p>self</p></td>
 
3701
<td class="parameter_description"><p>the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> that emitted the signal</p></td>
 
3702
<td class="parameter_annotations"> </td>
 
3703
</tr>
 
3704
<tr>
 
3705
<td class="parameter_name"><p>geometry</p></td>
 
3706
<td class="parameter_description"><p>the coordinates of the cursor</p></td>
 
3707
<td class="parameter_annotations"> </td>
 
3708
</tr>
 
3709
<tr>
 
3710
<td class="parameter_name"><p>user_data</p></td>
 
3711
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
 
3712
<td class="parameter_annotations"> </td>
2938
3713
</tr>
2939
3714
</tbody>
2940
3715
</table></div>
 
3716
</div>
 
3717
<p>Flags: Run Last</p>
2941
3718
<p class="since">Since 1.0</p>
2942
3719
</div>
2943
3720
<hr>
2944
3721
<div class="refsect2">
2945
 
<a name="ClutterText-delete-text"></a><h3>The <code class="literal">"delete-text"</code> signal</h3>
2946
 
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self,
2947
 
                                                        <span class="type">gint</span>         start_pos,
2948
 
                                                        <span class="type">gint</span>         end_pos,
2949
 
                                                        <span class="type">gpointer</span>     user_data)      : <code class="literal">Action</code></pre>
2950
 
<p>
2951
 
This signal is emitted when text is deleted from the actor by
2952
 
the user. It is emitted before <em class="parameter"><code>self</code></em> text changes.
2953
 
</p>
2954
 
<div class="variablelist"><table border="0" class="variablelist">
 
3722
<a name="ClutterText-delete-text"></a><h3>The <code class="literal">“delete-text”</code> signal</h3>
 
3723
<pre class="programlisting"><span class="returnvalue">void</span>
 
3724
user_function (<a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self,
 
3725
               <span class="type">gint</span>         start_pos,
 
3726
               <span class="type">gint</span>         end_pos,
 
3727
               <span class="type">gpointer</span>     user_data)</pre>
 
3728
<p>This signal is emitted when text is deleted from the actor by
 
3729
the user. It is emitted before <em class="parameter"><code>self</code></em>
 
3730
 text changes.</p>
 
3731
<div class="refsect3">
 
3732
<a name="id-1.5.3.4.13.5.5"></a><h4>Parameters</h4>
 
3733
<div class="informaltable"><table width="100%" border="0">
2955
3734
<colgroup>
2956
 
<col align="left" valign="top">
2957
 
<col>
 
3735
<col width="150px" class="parameters_name">
 
3736
<col class="parameters_description">
 
3737
<col width="200px" class="parameters_annotations">
2958
3738
</colgroup>
2959
3739
<tbody>
2960
3740
<tr>
2961
 
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
2962
 
<td>the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> that emitted the signal</td>
2963
 
</tr>
2964
 
<tr>
2965
 
<td><p><span class="term"><em class="parameter"><code>start_pos</code></em> :</span></p></td>
2966
 
<td>the starting position</td>
2967
 
</tr>
2968
 
<tr>
2969
 
<td><p><span class="term"><em class="parameter"><code>end_pos</code></em> :</span></p></td>
2970
 
<td>the end position</td>
2971
 
</tr>
2972
 
<tr>
2973
 
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
2974
 
<td>user data set when the signal handler was connected.</td>
 
3741
<td class="parameter_name"><p>self</p></td>
 
3742
<td class="parameter_description"><p>the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> that emitted the signal</p></td>
 
3743
<td class="parameter_annotations"> </td>
 
3744
</tr>
 
3745
<tr>
 
3746
<td class="parameter_name"><p>start_pos</p></td>
 
3747
<td class="parameter_description"><p>the starting position</p></td>
 
3748
<td class="parameter_annotations"> </td>
 
3749
</tr>
 
3750
<tr>
 
3751
<td class="parameter_name"><p>end_pos</p></td>
 
3752
<td class="parameter_description"><p>the end position</p></td>
 
3753
<td class="parameter_annotations"> </td>
 
3754
</tr>
 
3755
<tr>
 
3756
<td class="parameter_name"><p>user_data</p></td>
 
3757
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
 
3758
<td class="parameter_annotations"> </td>
2975
3759
</tr>
2976
3760
</tbody>
2977
3761
</table></div>
 
3762
</div>
 
3763
<p>Flags: Action</p>
2978
3764
<p class="since">Since 1.2</p>
2979
3765
</div>
2980
3766
<hr>
2981
3767
<div class="refsect2">
2982
 
<a name="ClutterText-insert-text"></a><h3>The <code class="literal">"insert-text"</code> signal</h3>
2983
 
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self,
2984
 
                                                        <span class="type">gchar</span>       *new_text,
2985
 
                                                        <span class="type">gint</span>         new_text_length,
2986
 
                                                        <span class="type">gpointer</span>     position,
2987
 
                                                        <span class="type">gpointer</span>     user_data)            : <code class="literal">Action</code></pre>
2988
 
<p>
2989
 
This signal is emitted when text is inserted into the actor by
2990
 
the user. It is emitted before <em class="parameter"><code>self</code></em> text changes.
2991
 
</p>
2992
 
<div class="variablelist"><table border="0" class="variablelist">
 
3768
<a name="ClutterText-insert-text"></a><h3>The <code class="literal">“insert-text”</code> signal</h3>
 
3769
<pre class="programlisting"><span class="returnvalue">void</span>
 
3770
user_function (<a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self,
 
3771
               <span class="type">gchar</span>       *new_text,
 
3772
               <span class="type">gint</span>         new_text_length,
 
3773
               <span class="type">gpointer</span>     position,
 
3774
               <span class="type">gpointer</span>     user_data)</pre>
 
3775
<p>This signal is emitted when text is inserted into the actor by
 
3776
the user. It is emitted before <em class="parameter"><code>self</code></em>
 
3777
 text changes.</p>
 
3778
<div class="refsect3">
 
3779
<a name="id-1.5.3.4.13.6.5"></a><h4>Parameters</h4>
 
3780
<div class="informaltable"><table width="100%" border="0">
2993
3781
<colgroup>
2994
 
<col align="left" valign="top">
2995
 
<col>
 
3782
<col width="150px" class="parameters_name">
 
3783
<col class="parameters_description">
 
3784
<col width="200px" class="parameters_annotations">
2996
3785
</colgroup>
2997
3786
<tbody>
2998
3787
<tr>
2999
 
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
3000
 
<td>the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> that emitted the signal</td>
3001
 
</tr>
3002
 
<tr>
3003
 
<td><p><span class="term"><em class="parameter"><code>new_text</code></em> :</span></p></td>
3004
 
<td>the new text to insert</td>
3005
 
</tr>
3006
 
<tr>
3007
 
<td><p><span class="term"><em class="parameter"><code>new_text_length</code></em> :</span></p></td>
3008
 
<td>the length of the new text, in bytes, or -1 if
3009
 
new_text is nul-terminated</td>
3010
 
</tr>
3011
 
<tr>
3012
 
<td><p><span class="term"><em class="parameter"><code>position</code></em> :</span></p></td>
3013
 
<td>the position, in characters, at which to insert the
 
3788
<td class="parameter_name"><p>self</p></td>
 
3789
<td class="parameter_description"><p>the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> that emitted the signal</p></td>
 
3790
<td class="parameter_annotations"> </td>
 
3791
</tr>
 
3792
<tr>
 
3793
<td class="parameter_name"><p>new_text</p></td>
 
3794
<td class="parameter_description"><p>the new text to insert</p></td>
 
3795
<td class="parameter_annotations"> </td>
 
3796
</tr>
 
3797
<tr>
 
3798
<td class="parameter_name"><p>new_text_length</p></td>
 
3799
<td class="parameter_description"><p>the length of the new text, in bytes, or -1 if
 
3800
new_text is nul-terminated</p></td>
 
3801
<td class="parameter_annotations"> </td>
 
3802
</tr>
 
3803
<tr>
 
3804
<td class="parameter_name"><p>position</p></td>
 
3805
<td class="parameter_description"><p>the position, in characters, at which to insert the
3014
3806
new text. this is an in-out parameter.  After the signal
3015
3807
emission is finished, it should point after the newly
3016
 
inserted text.</td>
 
3808
inserted text.</p></td>
 
3809
<td class="parameter_annotations"> </td>
3017
3810
</tr>
3018
3811
<tr>
3019
 
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
3020
 
<td>user data set when the signal handler was connected.</td>
 
3812
<td class="parameter_name"><p>user_data</p></td>
 
3813
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
 
3814
<td class="parameter_annotations"> </td>
3021
3815
</tr>
3022
3816
</tbody>
3023
3817
</table></div>
 
3818
</div>
 
3819
<p>Flags: Action</p>
3024
3820
<p class="since">Since 1.2</p>
3025
3821
</div>
3026
3822
<hr>
3027
3823
<div class="refsect2">
3028
 
<a name="ClutterText-text-changed"></a><h3>The <code class="literal">"text-changed"</code> signal</h3>
3029
 
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self,
3030
 
                                                        <span class="type">gpointer</span>     user_data)      : <code class="literal">Run Last</code></pre>
3031
 
<p>
3032
 
The ::text-changed signal is emitted after <em class="parameter"><code>actor</code></em>'s text changes
3033
 
</p>
3034
 
<div class="variablelist"><table border="0" class="variablelist">
 
3824
<a name="ClutterText-text-changed"></a><h3>The <code class="literal">“text-changed”</code> signal</h3>
 
3825
<pre class="programlisting"><span class="returnvalue">void</span>
 
3826
user_function (<a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> *self,
 
3827
               <span class="type">gpointer</span>     user_data)</pre>
 
3828
<p>The ::text-changed signal is emitted after <em class="parameter"><code>actor</code></em>
 
3829
's text changes</p>
 
3830
<div class="refsect3">
 
3831
<a name="id-1.5.3.4.13.7.5"></a><h4>Parameters</h4>
 
3832
<div class="informaltable"><table width="100%" border="0">
3035
3833
<colgroup>
3036
 
<col align="left" valign="top">
3037
 
<col>
 
3834
<col width="150px" class="parameters_name">
 
3835
<col class="parameters_description">
 
3836
<col width="200px" class="parameters_annotations">
3038
3837
</colgroup>
3039
3838
<tbody>
3040
3839
<tr>
3041
 
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
3042
 
<td>the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> that emitted the signal</td>
 
3840
<td class="parameter_name"><p>self</p></td>
 
3841
<td class="parameter_description"><p>the <a class="link" href="ClutterText.html" title="ClutterText"><span class="type">ClutterText</span></a> that emitted the signal</p></td>
 
3842
<td class="parameter_annotations"> </td>
3043
3843
</tr>
3044
3844
<tr>
3045
 
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
3046
 
<td>user data set when the signal handler was connected.</td>
 
3845
<td class="parameter_name"><p>user_data</p></td>
 
3846
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
 
3847
<td class="parameter_annotations"> </td>
3047
3848
</tr>
3048
3849
</tbody>
3049
3850
</table></div>
 
3851
</div>
 
3852
<p>Flags: Run Last</p>
3050
3853
<p class="since">Since 1.0</p>
3051
3854
</div>
3052
3855
</div>
3053
3856
</div>
3054
3857
<div class="footer">
3055
3858
<hr>
3056
 
          Generated by GTK-Doc V1.18.1</div>
 
3859
          Generated by GTK-Doc V1.20.1</div>
3057
3860
</body>
3058
3861
</html>
 
 
b'\\ No newline at end of file'