8
8
<link rel="up" href="widgets.html" title="Widgets">
9
9
<link rel="prev" href="StDrawingArea.html" title="StDrawingArea">
10
10
<link rel="next" href="StIcon.html" title="StIcon">
11
<meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
11
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
47
47
<a name="StEntry.synopsis"></a><h2>Synopsis</h2>
48
48
<pre class="synopsis">struct <a class="link" href="StEntry.html#StEntry-struct" title="struct StEntry">StEntry</a>;
49
49
struct <a class="link" href="StEntry.html#StEntryClass" title="struct StEntryClass">StEntryClass</a>;
50
<a class="link" href="StWidget.html" title="StWidget"><span class="returnvalue">StWidget</span></a> * <a class="link" href="StEntry.html#st-entry-new" title="st_entry_new ()">st_entry_new</a> (<em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>);
51
const <span class="returnvalue">gchar</span> * <a class="link" href="StEntry.html#st-entry-get-text" title="st_entry_get_text ()">st_entry_get_text</a> (<em class="parameter"><code><a class="link" href="StEntry.html" title="StEntry"><span class="type">StEntry</span></a> *entry</code></em>);
50
<a class="link" href="StWidget.html" title="StWidget"><span class="returnvalue">StWidget</span></a> * <a class="link" href="StEntry.html#st-entry-new" title="st_entry_new ()">st_entry_new</a> (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *text</code></em>);
51
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="StEntry.html#st-entry-get-text" title="st_entry_get_text ()">st_entry_get_text</a> (<em class="parameter"><code><a class="link" href="StEntry.html" title="StEntry"><span class="type">StEntry</span></a> *entry</code></em>);
52
52
<span class="returnvalue">void</span> <a class="link" href="StEntry.html#st-entry-set-text" title="st_entry_set_text ()">st_entry_set_text</a> (<em class="parameter"><code><a class="link" href="StEntry.html" title="StEntry"><span class="type">StEntry</span></a> *entry</code></em>,
53
<em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>);
54
<span class="returnvalue">ClutterActor</span> * <a class="link" href="StEntry.html#st-entry-get-clutter-text" title="st_entry_get_clutter_text ()">st_entry_get_clutter_text</a> (<em class="parameter"><code><a class="link" href="StEntry.html" title="StEntry"><span class="type">StEntry</span></a> *entry</code></em>);
53
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *text</code></em>);
54
<a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html"><span class="returnvalue">ClutterActor</span></a> * <a class="link" href="StEntry.html#st-entry-get-clutter-text" title="st_entry_get_clutter_text ()">st_entry_get_clutter_text</a> (<em class="parameter"><code><a class="link" href="StEntry.html" title="StEntry"><span class="type">StEntry</span></a> *entry</code></em>);
55
55
<span class="returnvalue">void</span> <a class="link" href="StEntry.html#st-entry-set-hint-text" title="st_entry_set_hint_text ()">st_entry_set_hint_text</a> (<em class="parameter"><code><a class="link" href="StEntry.html" title="StEntry"><span class="type">StEntry</span></a> *entry</code></em>,
56
<em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>);
57
const <span class="returnvalue">gchar</span> * <a class="link" href="StEntry.html#st-entry-get-hint-text" title="st_entry_get_hint_text ()">st_entry_get_hint_text</a> (<em class="parameter"><code><a class="link" href="StEntry.html" title="StEntry"><span class="type">StEntry</span></a> *entry</code></em>);
56
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *text</code></em>);
57
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="StEntry.html#st-entry-get-hint-text" title="st_entry_get_hint_text ()">st_entry_get_hint_text</a> (<em class="parameter"><code><a class="link" href="StEntry.html" title="StEntry"><span class="type">StEntry</span></a> *entry</code></em>);
58
58
<span class="returnvalue">void</span> <a class="link" href="StEntry.html#st-entry-set-input-purpose" title="st_entry_set_input_purpose ()">st_entry_set_input_purpose</a> (<em class="parameter"><code><a class="link" href="StEntry.html" title="StEntry"><span class="type">StEntry</span></a> *entry</code></em>,
59
59
<em class="parameter"><code><span class="type">GtkInputPurpose</span> purpose</code></em>);
60
60
<span class="returnvalue">GtkInputPurpose</span> <a class="link" href="StEntry.html#st-entry-get-input-purpose" title="st_entry_get_input_purpose ()">st_entry_get_input_purpose</a> (<em class="parameter"><code><a class="link" href="StEntry.html" title="StEntry"><span class="type">StEntry</span></a> *entry</code></em>);
62
62
<em class="parameter"><code><span class="type">GtkInputHints</span> hints</code></em>);
63
63
<span class="returnvalue">GtkInputHints</span> <a class="link" href="StEntry.html#st-entry-get-input-hints" title="st_entry_get_input_hints ()">st_entry_get_input_hints</a> (<em class="parameter"><code><a class="link" href="StEntry.html" title="StEntry"><span class="type">StEntry</span></a> *entry</code></em>);
64
64
<span class="returnvalue">void</span> <a class="link" href="StEntry.html#st-entry-set-primary-icon" title="st_entry_set_primary_icon ()">st_entry_set_primary_icon</a> (<em class="parameter"><code><a class="link" href="StEntry.html" title="StEntry"><span class="type">StEntry</span></a> *entry</code></em>,
65
<em class="parameter"><code><span class="type">ClutterActor</span> *icon</code></em>);
65
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html"><span class="type">ClutterActor</span></a> *icon</code></em>);
66
66
<span class="returnvalue">void</span> <a class="link" href="StEntry.html#st-entry-set-secondary-icon" title="st_entry_set_secondary_icon ()">st_entry_set_secondary_icon</a> (<em class="parameter"><code><a class="link" href="StEntry.html" title="StEntry"><span class="type">StEntry</span></a> *entry</code></em>,
67
<em class="parameter"><code><span class="type">ClutterActor</span> *icon</code></em>);
67
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html"><span class="type">ClutterActor</span></a> *icon</code></em>);
70
70
<div class="refsect1">
71
71
<a name="StEntry.object-hierarchy"></a><h2>Object Hierarchy</h2>
72
72
<pre class="synopsis">
74
+----GInitiallyUnowned
73
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
74
+----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
75
+----<a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html">ClutterActor</a>
76
76
+----<a class="link" href="StWidget.html" title="StWidget">StWidget</a>
81
81
<a name="StEntry.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
84
ClutterContainer, ClutterScriptable, ClutterAnimatable and AtkImplementorIface.</p>
84
<a href="/usr/share/gtk-doc/html/clutter/ClutterContainer.html">ClutterContainer</a>, <a href="/usr/share/gtk-doc/html/clutter/ClutterScriptable.html">ClutterScriptable</a>, <a href="/usr/share/gtk-doc/html/clutter/ClutterAnimatable.html">ClutterAnimatable</a> and AtkImplementorIface.</p>
86
86
<div class="refsect1">
87
87
<a name="StEntry.properties"></a><h2>Properties</h2>
88
88
<pre class="synopsis">
89
"<a class="link" href="StEntry.html#StEntry--clutter-text" title='The "clutter-text" property'>clutter-text</a>" <span class="type">ClutterText</span>* : Read
90
"<a class="link" href="StEntry.html#StEntry--hint-text" title='The "hint-text" property'>hint-text</a>" <span class="type">gchar</span>* : Read / Write
89
"<a class="link" href="StEntry.html#StEntry--clutter-text" title='The "clutter-text" property'>clutter-text</a>" <a href="/usr/share/gtk-doc/html/clutter/ClutterText.html"><span class="type">ClutterText</span></a>* : Read
90
"<a class="link" href="StEntry.html#StEntry--hint-text" title='The "hint-text" property'>hint-text</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write
91
91
"<a class="link" href="StEntry.html#StEntry--input-hints" title='The "input-hints" property'>input-hints</a>" <span class="type">GtkInputHints</span> : Read / Write
92
92
"<a class="link" href="StEntry.html#StEntry--input-purpose" title='The "input-purpose" property'>input-purpose</a>" <span class="type">GtkInputPurpose</span> : Read / Write
93
"<a class="link" href="StEntry.html#StEntry--text" title='The "text" property'>text</a>" <span class="type">gchar</span>* : Read / Write
93
"<a class="link" href="StEntry.html#StEntry--text" title='The "text" property'>text</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write
96
96
<div class="refsect1">
97
97
<a name="StEntry.signals"></a><h2>Signals</h2>
98
98
<pre class="synopsis">
99
"<a class="link" href="StEntry.html#StEntry-primary-icon-clicked" title='The "primary-icon-clicked" signal'>primary-icon-clicked</a>" : <code class="literal">Run Last</code>
100
"<a class="link" href="StEntry.html#StEntry-secondary-icon-clicked" title='The "secondary-icon-clicked" signal'>secondary-icon-clicked</a>" : <code class="literal">Run Last</code>
99
"<a class="link" href="StEntry.html#StEntry-primary-icon-clicked" title='The "primary-icon-clicked" signal'>primary-icon-clicked</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
100
"<a class="link" href="StEntry.html#StEntry-secondary-icon-clicked" title='The "secondary-icon-clicked" signal'>secondary-icon-clicked</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
103
103
<div class="refsect1">
106
106
<a class="link" href="StEntry.html" title="StEntry"><span class="type">StEntry</span></a> is a simple widget for displaying text. It derives from
107
107
<a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> to add extra style and placement functionality over
108
<span class="type">ClutterText</span>. The internal <span class="type">ClutterText</span> is publicly accessibly to allow
108
<a href="/usr/share/gtk-doc/html/clutter/ClutterText.html"><span class="type">ClutterText</span></a>. The internal <a href="/usr/share/gtk-doc/html/clutter/ClutterText.html"><span class="type">ClutterText</span></a> is publicly accessibly to allow
109
109
applications to set further properties.
146
146
<div class="refsect2">
147
147
<a name="st-entry-new"></a><h3>st_entry_new ()</h3>
148
<pre class="programlisting"><a class="link" href="StWidget.html" title="StWidget"><span class="returnvalue">StWidget</span></a> * st_entry_new (<em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>);</pre>
148
<pre class="programlisting"><a class="link" href="StWidget.html" title="StWidget"><span class="returnvalue">StWidget</span></a> * st_entry_new (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *text</code></em>);</pre>
150
150
Create a new <a class="link" href="StEntry.html" title="StEntry"><span class="type">StEntry</span></a> with the specified entry
171
171
<div class="refsect2">
172
172
<a name="st-entry-get-text"></a><h3>st_entry_get_text ()</h3>
173
<pre class="programlisting">const <span class="returnvalue">gchar</span> * st_entry_get_text (<em class="parameter"><code><a class="link" href="StEntry.html" title="StEntry"><span class="type">StEntry</span></a> *entry</code></em>);</pre>
173
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * st_entry_get_text (<em class="parameter"><code><a class="link" href="StEntry.html" title="StEntry"><span class="type">StEntry</span></a> *entry</code></em>);</pre>
175
175
Get the text displayed on the entry
196
196
<div class="refsect2">
197
197
<a name="st-entry-set-text"></a><h3>st_entry_set_text ()</h3>
198
198
<pre class="programlisting"><span class="returnvalue">void</span> st_entry_set_text (<em class="parameter"><code><a class="link" href="StEntry.html" title="StEntry"><span class="type">StEntry</span></a> *entry</code></em>,
199
<em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>);</pre>
199
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *text</code></em>);</pre>
201
201
Sets the text displayed on the entry
223
223
<div class="refsect2">
224
224
<a name="st-entry-get-clutter-text"></a><h3>st_entry_get_clutter_text ()</h3>
225
<pre class="programlisting"><span class="returnvalue">ClutterActor</span> * st_entry_get_clutter_text (<em class="parameter"><code><a class="link" href="StEntry.html" title="StEntry"><span class="type">StEntry</span></a> *entry</code></em>);</pre>
225
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html"><span class="returnvalue">ClutterActor</span></a> * st_entry_get_clutter_text (<em class="parameter"><code><a class="link" href="StEntry.html" title="StEntry"><span class="type">StEntry</span></a> *entry</code></em>);</pre>
227
Retrieve the internal <span class="type">ClutterText</span> so that extra parameters can be set
227
Retrieve the internal <a href="/usr/share/gtk-doc/html/clutter/ClutterText.html"><span class="type">ClutterText</span></a> so that extra parameters can be set
229
229
<div class="variablelist"><table border="0" class="variablelist">
241
241
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
242
<td>the <span class="type">ClutterText</span> used by <a class="link" href="StEntry.html" title="StEntry"><span class="type">StEntry</span></a>. The entry is
242
<td>the <a href="/usr/share/gtk-doc/html/clutter/ClutterText.html"><span class="type">ClutterText</span></a> used by <a class="link" href="StEntry.html" title="StEntry"><span class="type">StEntry</span></a>. The entry is
243
243
owned by the <a class="link" href="StEntry.html" title="StEntry"><span class="type">StEntry</span></a> and should not be unref'ed by the application. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
250
250
<div class="refsect2">
251
251
<a name="st-entry-set-hint-text"></a><h3>st_entry_set_hint_text ()</h3>
252
252
<pre class="programlisting"><span class="returnvalue">void</span> st_entry_set_hint_text (<em class="parameter"><code><a class="link" href="StEntry.html" title="StEntry"><span class="type">StEntry</span></a> *entry</code></em>,
253
<em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>);</pre>
253
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *text</code></em>);</pre>
255
255
Sets the text to display when the entry is empty and unfocused. When the
256
256
entry is displaying the hint, it has a pseudo class of "indeterminate".
279
279
<div class="refsect2">
280
280
<a name="st-entry-get-hint-text"></a><h3>st_entry_get_hint_text ()</h3>
281
<pre class="programlisting">const <span class="returnvalue">gchar</span> * st_entry_get_hint_text (<em class="parameter"><code><a class="link" href="StEntry.html" title="StEntry"><span class="type">StEntry</span></a> *entry</code></em>);</pre>
281
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * st_entry_get_hint_text (<em class="parameter"><code><a class="link" href="StEntry.html" title="StEntry"><span class="type">StEntry</span></a> *entry</code></em>);</pre>
283
283
Gets the text that is displayed when the entry is empty and unfocused
398
398
<div class="refsect2">
399
399
<a name="st-entry-set-primary-icon"></a><h3>st_entry_set_primary_icon ()</h3>
400
400
<pre class="programlisting"><span class="returnvalue">void</span> st_entry_set_primary_icon (<em class="parameter"><code><a class="link" href="StEntry.html" title="StEntry"><span class="type">StEntry</span></a> *entry</code></em>,
401
<em class="parameter"><code><span class="type">ClutterActor</span> *icon</code></em>);</pre>
401
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html"><span class="type">ClutterActor</span></a> *icon</code></em>);</pre>
403
403
Set the primary icon of the entry to <em class="parameter"><code>icon</code></em>
417
417
<td><p><span class="term"><em class="parameter"><code>icon</code></em> :</span></p></td>
418
<td>a <span class="type">ClutterActor</span>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
418
<td>a <a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html"><span class="type">ClutterActor</span></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
425
425
<div class="refsect2">
426
426
<a name="st-entry-set-secondary-icon"></a><h3>st_entry_set_secondary_icon ()</h3>
427
427
<pre class="programlisting"><span class="returnvalue">void</span> st_entry_set_secondary_icon (<em class="parameter"><code><a class="link" href="StEntry.html" title="StEntry"><span class="type">StEntry</span></a> *entry</code></em>,
428
<em class="parameter"><code><span class="type">ClutterActor</span> *icon</code></em>);</pre>
428
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html"><span class="type">ClutterActor</span></a> *icon</code></em>);</pre>
430
430
Set the secondary icon of the entry to <em class="parameter"><code>icon</code></em>
444
444
<td><p><span class="term"><em class="parameter"><code>icon</code></em> :</span></p></td>
445
<td>an <span class="type">ClutterActor</span>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
445
<td>an <a href="/usr/share/gtk-doc/html/clutter/ClutterActor.html"><span class="type">ClutterActor</span></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
453
453
<a name="StEntry.property-details"></a><h2>Property Details</h2>
454
454
<div class="refsect2">
455
455
<a name="StEntry--clutter-text"></a><h3>The <code class="literal">"clutter-text"</code> property</h3>
456
<pre class="programlisting"> "clutter-text" <span class="type">ClutterText</span>* : Read</pre>
456
<pre class="programlisting"> "clutter-text" <a href="/usr/share/gtk-doc/html/clutter/ClutterText.html"><span class="type">ClutterText</span></a>* : Read</pre>
457
457
<p>Internal ClutterText actor.</p>
460
460
<div class="refsect2">
461
461
<a name="StEntry--hint-text"></a><h3>The <code class="literal">"hint-text"</code> property</h3>
462
<pre class="programlisting"> "hint-text" <span class="type">gchar</span>* : Read / Write</pre>
462
<pre class="programlisting"> "hint-text" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre>
463
463
<p>Text to display when the entry is not focused and the text property is empty.</p>
464
464
<p>Default value: NULL</p>
480
480
<div class="refsect2">
481
481
<a name="StEntry--text"></a><h3>The <code class="literal">"text"</code> property</h3>
482
<pre class="programlisting"> "text" <span class="type">gchar</span>* : Read / Write</pre>
482
<pre class="programlisting"> "text" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre>
483
483
<p>Text of the entry.</p>
484
484
<p>Default value: NULL</p>
489
489
<div class="refsect2">
490
490
<a name="StEntry-primary-icon-clicked"></a><h3>The <code class="literal">"primary-icon-clicked"</code> signal</h3>
491
491
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="StEntry.html" title="StEntry"><span class="type">StEntry</span></a> *arg0,
492
<span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre>
492
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
494
494
Emitted when the primary icon is clicked
508
508
<div class="refsect2">
509
509
<a name="StEntry-secondary-icon-clicked"></a><h3>The <code class="literal">"secondary-icon-clicked"</code> signal</h3>
510
510
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="StEntry.html" title="StEntry"><span class="type">StEntry</span></a> *arg0,
511
<span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre>
511
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
513
513
Emitted when the secondary icon is clicked