← Back to branch summary

~ubuntu-branches/debian/jessie/gnome-shell/jessie

« back to all changes in this revision

Viewing changes to docs/reference/st/html/StLabel.html

  • Committer: Package Import Robot
  • Author(s): Michael Biebl
  • Date: 2012-05-30 13:19:38 UTC
  • mfrom: (18.1.24 experimental)
  • Revision ID: package-import@ubuntu.com-20120530131938-i3trc1g1p3is2u6x
Tags: 3.4.1-3
Upload to unstable.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/st/html/StLabel.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html>
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 
5
<title>StLabel</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
 
7
<link rel="home" href="index.html" title="St Reference Manual">
 
8
<link rel="up" href="widgets.html" title="Widgets">
 
9
<link rel="prev" href="StIcon.html" title="StIcon">
 
10
<link rel="next" href="containers.html" title="Containers">
 
11
<meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
</head>
 
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="StIcon.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
18
<td><a accesskey="u" href="widgets.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">St Reference Manual</th>
 
21
<td><a accesskey="n" href="containers.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="#StLabel.synopsis" class="shortcut">Top</a>
 
25
                   | 
 
26
                  <a href="#StLabel.description" class="shortcut">Description</a>
 
27
                   | 
 
28
                  <a href="#StLabel.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
29
                   | 
 
30
                  <a href="#StLabel.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
 
31
                   | 
 
32
                  <a href="#StLabel.properties" class="shortcut">Properties</a>
 
33
</td></tr>
 
34
</table>
 
35
<div class="refentry">
 
36
<a name="StLabel"></a><div class="titlepage"></div>
 
37
<div class="refnamediv"><table width="100%"><tr>
 
38
<td valign="top">
 
39
<h2><span class="refentrytitle"><a name="StLabel.top_of_page"></a>StLabel</span></h2>
 
40
<p>StLabel — Widget for displaying text</p>
 
41
</td>
 
42
<td valign="top" align="right"></td>
 
43
</tr></table></div>
 
44
<div class="refsynopsisdiv">
 
45
<a name="StLabel.synopsis"></a><h2>Synopsis</h2>
 
46
<pre class="synopsis">struct              <a class="link" href="StLabel.html#StLabel-struct" title="struct StLabel">StLabel</a>;
 
47
struct              <a class="link" href="StLabel.html#StLabelClass" title="struct StLabelClass">StLabelClass</a>;
 
48
<span class="returnvalue">ClutterActor</span> *      <a class="link" href="StLabel.html#st-label-get-clutter-text" title="st_label_get_clutter_text ()">st_label_get_clutter_text</a>           (<em class="parameter"><code><a class="link" href="StLabel.html" title="StLabel"><span class="type">StLabel</span></a> *label</code></em>);
 
49
const <span class="returnvalue">gchar</span> *       <a class="link" href="StLabel.html#st-label-get-text" title="st_label_get_text ()">st_label_get_text</a>                   (<em class="parameter"><code><a class="link" href="StLabel.html" title="StLabel"><span class="type">StLabel</span></a> *label</code></em>);
 
50
<a class="link" href="StWidget.html" title="StWidget"><span class="returnvalue">StWidget</span></a> *          <a class="link" href="StLabel.html#st-label-new" title="st_label_new ()">st_label_new</a>                        (<em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>);
 
51
<span class="returnvalue">void</span>                <a class="link" href="StLabel.html#st-label-set-text" title="st_label_set_text ()">st_label_set_text</a>                   (<em class="parameter"><code><a class="link" href="StLabel.html" title="StLabel"><span class="type">StLabel</span></a> *label</code></em>,
 
52
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>);
 
53
</pre>
 
54
</div>
 
55
<div class="refsect1">
 
56
<a name="StLabel.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
57
<pre class="synopsis">
 
58
  GObject
 
59
   +----GInitiallyUnowned
 
60
         +----ClutterActor
 
61
               +----<a class="link" href="StWidget.html" title="StWidget">StWidget</a>
 
62
                     +----StLabel
 
63
</pre>
 
64
</div>
 
65
<div class="refsect1">
 
66
<a name="StLabel.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
 
67
<p>
 
68
StLabel implements
 
69
 ClutterContainer,  ClutterScriptable,  ClutterAnimatable and  AtkImplementorIface.</p>
 
70
</div>
 
71
<div class="refsect1">
 
72
<a name="StLabel.properties"></a><h2>Properties</h2>
 
73
<pre class="synopsis">
 
74
  "<a class="link" href="StLabel.html#StLabel--clutter-text" title='The "clutter-text" property'>clutter-text</a>"             <span class="type">ClutterText</span>*          : Read
 
75
  "<a class="link" href="StLabel.html#StLabel--text" title='The "text" property'>text</a>"                     <span class="type">gchar</span>*                : Read / Write
 
76
</pre>
 
77
</div>
 
78
<div class="refsect1">
 
79
<a name="StLabel.description"></a><h2>Description</h2>
 
80
<p>
 
81
<a class="link" href="StLabel.html" title="StLabel"><span class="type">StLabel</span></a> is a simple widget for displaying text. It derives from
 
82
<a class="link" href="StWidget.html" title="StWidget"><span class="type">StWidget</span></a> to add extra style and placement functionality over
 
83
<span class="type">ClutterText</span>. The internal <span class="type">ClutterText</span> is publicly accessibly to allow
 
84
applications to set further properties.
 
85
</p>
 
86
</div>
 
87
<div class="refsect1">
 
88
<a name="StLabel.details"></a><h2>Details</h2>
 
89
<div class="refsect2">
 
90
<a name="StLabel-struct"></a><h3>struct StLabel</h3>
 
91
<pre class="programlisting">struct StLabel;</pre>
 
92
<p>
 
93
The contents of this structure is private and should only be accessed using
 
94
the provided API.
 
95
</p>
 
96
</div>
 
97
<hr>
 
98
<div class="refsect2">
 
99
<a name="StLabelClass"></a><h3>struct StLabelClass</h3>
 
100
<pre class="programlisting">struct StLabelClass {
 
101
  StWidgetClass parent_class;
 
102
};
 
103
</pre>
 
104
</div>
 
105
<hr>
 
106
<div class="refsect2">
 
107
<a name="st-label-get-clutter-text"></a><h3>st_label_get_clutter_text ()</h3>
 
108
<pre class="programlisting"><span class="returnvalue">ClutterActor</span> *      st_label_get_clutter_text           (<em class="parameter"><code><a class="link" href="StLabel.html" title="StLabel"><span class="type">StLabel</span></a> *label</code></em>);</pre>
 
109
<p>
 
110
Retrieve the internal <span class="type">ClutterText</span> so that extra parameters can be set
 
111
</p>
 
112
<div class="variablelist"><table border="0">
 
113
<col align="left" valign="top">
 
114
<tbody>
 
115
<tr>
 
116
<td><p><span class="term"><em class="parameter"><code>label</code></em> :</span></p></td>
 
117
<td>a <a class="link" href="StLabel.html" title="StLabel"><span class="type">StLabel</span></a>
 
118
</td>
 
119
</tr>
 
120
<tr>
 
121
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
122
<td>ethe <span class="type">ClutterText</span> used by <a class="link" href="StLabel.html" title="StLabel"><span class="type">StLabel</span></a>. The label
 
123
is owned by the <a class="link" href="StLabel.html" title="StLabel"><span class="type">StLabel</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>
 
124
</td>
 
125
</tr>
 
126
</tbody>
 
127
</table></div>
 
128
</div>
 
129
<hr>
 
130
<div class="refsect2">
 
131
<a name="st-label-get-text"></a><h3>st_label_get_text ()</h3>
 
132
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       st_label_get_text                   (<em class="parameter"><code><a class="link" href="StLabel.html" title="StLabel"><span class="type">StLabel</span></a> *label</code></em>);</pre>
 
133
<p>
 
134
Get the text displayed on the label
 
135
</p>
 
136
<div class="variablelist"><table border="0">
 
137
<col align="left" valign="top">
 
138
<tbody>
 
139
<tr>
 
140
<td><p><span class="term"><em class="parameter"><code>label</code></em> :</span></p></td>
 
141
<td>a <a class="link" href="StLabel.html" title="StLabel"><span class="type">StLabel</span></a>
 
142
</td>
 
143
</tr>
 
144
<tr>
 
145
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
146
<td>the text for the label. This must not be freed by the application</td>
 
147
</tr>
 
148
</tbody>
 
149
</table></div>
 
150
</div>
 
151
<hr>
 
152
<div class="refsect2">
 
153
<a name="st-label-new"></a><h3>st_label_new ()</h3>
 
154
<pre class="programlisting"><a class="link" href="StWidget.html" title="StWidget"><span class="returnvalue">StWidget</span></a> *          st_label_new                        (<em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>);</pre>
 
155
<p>
 
156
Create a new <a class="link" href="StLabel.html" title="StLabel"><span class="type">StLabel</span></a> with the specified label
 
157
</p>
 
158
<div class="variablelist"><table border="0">
 
159
<col align="left" valign="top">
 
160
<tbody>
 
161
<tr>
 
162
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
 
163
<td>text to set the label to</td>
 
164
</tr>
 
165
<tr>
 
166
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
167
<td>a new <a class="link" href="StLabel.html" title="StLabel"><span class="type">StLabel</span></a>
 
168
</td>
 
169
</tr>
 
170
</tbody>
 
171
</table></div>
 
172
</div>
 
173
<hr>
 
174
<div class="refsect2">
 
175
<a name="st-label-set-text"></a><h3>st_label_set_text ()</h3>
 
176
<pre class="programlisting"><span class="returnvalue">void</span>                st_label_set_text                   (<em class="parameter"><code><a class="link" href="StLabel.html" title="StLabel"><span class="type">StLabel</span></a> *label</code></em>,
 
177
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>);</pre>
 
178
<p>
 
179
Sets the text displayed on the label
 
180
</p>
 
181
<div class="variablelist"><table border="0">
 
182
<col align="left" valign="top">
 
183
<tbody>
 
184
<tr>
 
185
<td><p><span class="term"><em class="parameter"><code>label</code></em> :</span></p></td>
 
186
<td>a <a class="link" href="StLabel.html" title="StLabel"><span class="type">StLabel</span></a>
 
187
</td>
 
188
</tr>
 
189
<tr>
 
190
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
 
191
<td>text to set the label to</td>
 
192
</tr>
 
193
</tbody>
 
194
</table></div>
 
195
</div>
 
196
</div>
 
197
<div class="refsect1">
 
198
<a name="StLabel.property-details"></a><h2>Property Details</h2>
 
199
<div class="refsect2">
 
200
<a name="StLabel--clutter-text"></a><h3>The <code class="literal">"clutter-text"</code> property</h3>
 
201
<pre class="programlisting">  "clutter-text"             <span class="type">ClutterText</span>*          : Read</pre>
 
202
<p>Internal ClutterText actor.</p>
 
203
</div>
 
204
<hr>
 
205
<div class="refsect2">
 
206
<a name="StLabel--text"></a><h3>The <code class="literal">"text"</code> property</h3>
 
207
<pre class="programlisting">  "text"                     <span class="type">gchar</span>*                : Read / Write</pre>
 
208
<p>Text of the label.</p>
 
209
<p>Default value: NULL</p>
 
210
</div>
 
211
</div>
 
212
</div>
 
213
<div class="footer">
 
214
<hr>
 
215
          Generated by GTK-Doc V1.18.1</div>
 
216
</body>
 
217
</html>
 
 
b'\\ No newline at end of file'