1
<refentry id="GnomeCanvasText">
3
<refentrytitle>GnomeCanvasText</refentrytitle>
4
<manvolnum>3</manvolnum>
5
<refmiscinfo>LIBGNOMECANVAS Library</refmiscinfo>
9
<refname>GnomeCanvasText</refname><refpurpose>Text canvas item</refpurpose>
12
<refsynopsisdiv><title>Synopsis</title>
16
#include <libgnomecanvas/libgnomecanvas.h>
19
struct <link linkend="GnomeCanvasText-struct">GnomeCanvasText</link>;
25
<title>Object Hierarchy</title>
28
<link linkend="GObject">GObject</link>
29
+----<link linkend="GtkObject">GtkObject</link>
30
+----<link linkend="GnomeCanvasItem">GnomeCanvasItem</link>
41
<title>Properties</title>
44
"<link linkend="GnomeCanvasText--anchor">anchor</link>" <link linkend="GtkAnchorType">GtkAnchorType</link> : Read / Write
45
"<link linkend="GnomeCanvasText--attributes">attributes</link>" <link linkend="PangoAttrList">PangoAttrList</link> : Read / Write
46
"<link linkend="GnomeCanvasText--clip">clip</link>" <link linkend="gboolean">gboolean</link> : Read / Write
47
"<link linkend="GnomeCanvasText--clip-height">clip-height</link>" <link linkend="gdouble">gdouble</link> : Read / Write
48
"<link linkend="GnomeCanvasText--clip-width">clip-width</link>" <link linkend="gdouble">gdouble</link> : Read / Write
49
"<link linkend="GnomeCanvasText--family">family</link>" <link linkend="gchararray">gchararray</link> : Read / Write
50
"<link linkend="GnomeCanvasText--family-set">family-set</link>" <link linkend="gboolean">gboolean</link> : Read / Write
51
"<link linkend="GnomeCanvasText--fill-color">fill-color</link>" <link linkend="gchararray">gchararray</link> : Read / Write
52
"<link linkend="GnomeCanvasText--fill-color-gdk">fill-color-gdk</link>" <link linkend="GdkColor">GdkColor</link> : Read / Write
53
"<link linkend="GnomeCanvasText--fill-color-rgba">fill-color-rgba</link>" <link linkend="guint">guint</link> : Read / Write
54
"<link linkend="GnomeCanvasText--fill-stipple">fill-stipple</link>" <link linkend="GdkDrawable">GdkDrawable</link> : Read / Write
55
"<link linkend="GnomeCanvasText--font">font</link>" <link linkend="gchararray">gchararray</link> : Read / Write
56
"<link linkend="GnomeCanvasText--font-desc">font-desc</link>" <link linkend="PangoFontDescription">PangoFontDescription</link> : Read / Write
57
"<link linkend="GnomeCanvasText--justification">justification</link>" <link linkend="GtkJustification">GtkJustification</link> : Read / Write
58
"<link linkend="GnomeCanvasText--markup">markup</link>" <link linkend="gchararray">gchararray</link> : Write
59
"<link linkend="GnomeCanvasText--rise">rise</link>" <link linkend="gint">gint</link> : Read / Write
60
"<link linkend="GnomeCanvasText--rise-set">rise-set</link>" <link linkend="gboolean">gboolean</link> : Read / Write
61
"<link linkend="GnomeCanvasText--scale">scale</link>" <link linkend="gdouble">gdouble</link> : Read / Write
62
"<link linkend="GnomeCanvasText--scale-set">scale-set</link>" <link linkend="gboolean">gboolean</link> : Read / Write
63
"<link linkend="GnomeCanvasText--size">size</link>" <link linkend="gint">gint</link> : Read / Write
64
"<link linkend="GnomeCanvasText--size-points">size-points</link>" <link linkend="gdouble">gdouble</link> : Read / Write
65
"<link linkend="GnomeCanvasText--size-set">size-set</link>" <link linkend="gboolean">gboolean</link> : Read / Write
66
"<link linkend="GnomeCanvasText--stretch">stretch</link>" <link linkend="PangoStretch">PangoStretch</link> : Read / Write
67
"<link linkend="GnomeCanvasText--stretch-set">stretch-set</link>" <link linkend="gboolean">gboolean</link> : Read / Write
68
"<link linkend="GnomeCanvasText--strikethrough">strikethrough</link>" <link linkend="gboolean">gboolean</link> : Read / Write
69
"<link linkend="GnomeCanvasText--strikethrough-set">strikethrough-set</link>" <link linkend="gboolean">gboolean</link> : Read / Write
70
"<link linkend="GnomeCanvasText--style">style</link>" <link linkend="PangoStyle">PangoStyle</link> : Read / Write
71
"<link linkend="GnomeCanvasText--style-set">style-set</link>" <link linkend="gboolean">gboolean</link> : Read / Write
72
"<link linkend="GnomeCanvasText--text">text</link>" <link linkend="gchararray">gchararray</link> : Read / Write
73
"<link linkend="GnomeCanvasText--text-height">text-height</link>" <link linkend="gdouble">gdouble</link> : Read / Write
74
"<link linkend="GnomeCanvasText--text-width">text-width</link>" <link linkend="gdouble">gdouble</link> : Read / Write
75
"<link linkend="GnomeCanvasText--underline">underline</link>" <link linkend="PangoUnderline">PangoUnderline</link> : Read / Write
76
"<link linkend="GnomeCanvasText--underline-set">underline-set</link>" <link linkend="gboolean">gboolean</link> : Read / Write
77
"<link linkend="GnomeCanvasText--variant">variant</link>" <link linkend="PangoVariant">PangoVariant</link> : Read / Write
78
"<link linkend="GnomeCanvasText--variant-set">variant-set</link>" <link linkend="gboolean">gboolean</link> : Read / Write
79
"<link linkend="GnomeCanvasText--weight">weight</link>" <link linkend="gint">gint</link> : Read / Write
80
"<link linkend="GnomeCanvasText--weight-set">weight-set</link>" <link linkend="gboolean">gboolean</link> : Read / Write
81
"<link linkend="GnomeCanvasText--x">x</link>" <link linkend="gdouble">gdouble</link> : Read / Write
82
"<link linkend="GnomeCanvasText--x-offset">x-offset</link>" <link linkend="gdouble">gdouble</link> : Read / Write
83
"<link linkend="GnomeCanvasText--y">y</link>" <link linkend="gdouble">gdouble</link> : Read / Write
84
"<link linkend="GnomeCanvasText--y-offset">y-offset</link>" <link linkend="gdouble">gdouble</link> : Read / Write
91
<title>Description</title>
93
A canvas item for displaying text. See <link linkend="GnomeCanvasRichText"><type>GnomeCanvasRichText</type></link> for a more advanced
94
text display and editing canvas item.
99
<title>Details</title>
101
<title><anchor id="GnomeCanvasText-struct"/>struct GnomeCanvasText</title>
102
<indexterm><primary>GnomeCanvasText</primary></indexterm><programlisting>struct GnomeCanvasText;</programlisting>
104
This structure should not be accessed directly. Use the object's properties
105
for querying or changing its parameters.
110
<title>Properties</title>
111
<refsect2><title><anchor id="GnomeCanvasText--anchor"/>The "<literal>anchor</literal>" property</title>
112
<programlisting> "anchor" <link linkend="GtkAnchorType">GtkAnchorType</link> : Read / Write</programlisting>
114
Anchor position for the text.
115
</para><para>Default value: GTK_ANCHOR_CENTER</para>
117
<refsect2><title><anchor id="GnomeCanvasText--attributes"/>The "<literal>attributes</literal>" property</title>
118
<programlisting> "attributes" <link linkend="PangoAttrList">PangoAttrList</link> : Read / Write</programlisting>
120
Pointer to a Pango attribute list (PangoAttrList).
122
<refsect2><title><anchor id="GnomeCanvasText--clip"/>The "<literal>clip</literal>" property</title>
123
<programlisting> "clip" <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>
125
Use clipping rectangle?
126
</para><para>Default value: FALSE</para>
128
<refsect2><title><anchor id="GnomeCanvasText--clip-height"/>The "<literal>clip-height</literal>" property</title>
129
<programlisting> "clip-height" <link linkend="gdouble">gdouble</link> : Read / Write</programlisting>
131
Height of clip rectangle.
132
</para><para>Default value: 0</para>
134
<refsect2><title><anchor id="GnomeCanvasText--clip-width"/>The "<literal>clip-width</literal>" property</title>
135
<programlisting> "clip-width" <link linkend="gdouble">gdouble</link> : Read / Write</programlisting>
137
Width of clip rectangle.
138
</para><para>Default value: 0</para>
140
<refsect2><title><anchor id="GnomeCanvasText--family"/>The "<literal>family</literal>" property</title>
141
<programlisting> "family" <link linkend="gchararray">gchararray</link> : Read / Write</programlisting>
143
Name of the font family, e.g. Sans, Helvetica, Times, Monospace.
144
</para><para>Default value: NULL</para>
146
<refsect2><title><anchor id="GnomeCanvasText--family-set"/>The "<literal>family-set</literal>" property</title>
147
<programlisting> "family-set" <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>
149
Apply specified font family?
150
</para><para>Default value: FALSE</para>
152
<refsect2><title><anchor id="GnomeCanvasText--fill-color"/>The "<literal>fill-color</literal>" property</title>
153
<programlisting> "fill-color" <link linkend="gchararray">gchararray</link> : Read / Write</programlisting>
155
X color specification for text.
156
</para><para>Default value: NULL</para>
158
<refsect2><title><anchor id="GnomeCanvasText--fill-color-gdk"/>The "<literal>fill-color-gdk</literal>" property</title>
159
<programlisting> "fill-color-gdk" <link linkend="GdkColor">GdkColor</link> : Read / Write</programlisting>
161
Pointer to an allocated GdkColor.
163
<refsect2><title><anchor id="GnomeCanvasText--fill-color-rgba"/>The "<literal>fill-color-rgba</literal>" property</title>
164
<programlisting> "fill-color-rgba" <link linkend="guint">guint</link> : Read / Write</programlisting>
166
RGBA value used for AA color (in the format 0xRRGGBBAA).
167
</para><para>Default value: 0</para>
169
<refsect2><title><anchor id="GnomeCanvasText--fill-stipple"/>The "<literal>fill-stipple</literal>" property</title>
170
<programlisting> "fill-stipple" <link linkend="GdkDrawable">GdkDrawable</link> : Read / Write</programlisting>
172
Stipple pattern for filling the text.
174
<refsect2><title><anchor id="GnomeCanvasText--font"/>The "<literal>font</literal>" property</title>
175
<programlisting> "font" <link linkend="gchararray">gchararray</link> : Read / Write</programlisting>
177
Font description as a string.
178
</para><para>Default value: NULL</para>
180
<refsect2><title><anchor id="GnomeCanvasText--font-desc"/>The "<literal>font-desc</literal>" property</title>
181
<programlisting> "font-desc" <link linkend="PangoFontDescription">PangoFontDescription</link> : Read / Write</programlisting>
183
Font description as a PangoFontDescription struct.
185
<refsect2><title><anchor id="GnomeCanvasText--justification"/>The "<literal>justification</literal>" property</title>
186
<programlisting> "justification" <link linkend="GtkJustification">GtkJustification</link> : Read / Write</programlisting>
188
Justification for multiline text.
189
</para><para>Default value: GTK_JUSTIFY_LEFT</para>
191
<refsect2><title><anchor id="GnomeCanvasText--markup"/>The "<literal>markup</literal>" property</title>
192
<programlisting> "markup" <link linkend="gchararray">gchararray</link> : Write</programlisting>
194
Pango marked up text to render.
195
</para><para>Default value: NULL</para>
197
<refsect2><title><anchor id="GnomeCanvasText--rise"/>The "<literal>rise</literal>" property</title>
198
<programlisting> "rise" <link linkend="gint">gint</link> : Read / Write</programlisting>
200
Offset of text above the baseline (below the baseline if rise is negative).
201
</para><para>Allowed values: >= -2147483647</para>
202
<para>Default value: 0</para>
204
<refsect2><title><anchor id="GnomeCanvasText--rise-set"/>The "<literal>rise-set</literal>" property</title>
205
<programlisting> "rise-set" <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>
207
Apply the specified "rise"?
208
</para><para>Default value: FALSE</para>
210
<refsect2><title><anchor id="GnomeCanvasText--scale"/>The "<literal>scale</literal>" property</title>
211
<programlisting> "scale" <link linkend="gdouble">gdouble</link> : Read / Write</programlisting>
213
Size of font, relative to default size.
214
</para><para>Allowed values: >= 0</para>
215
<para>Default value: 1</para>
217
<refsect2><title><anchor id="GnomeCanvasText--scale-set"/>The "<literal>scale-set</literal>" property</title>
218
<programlisting> "scale-set" <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>
220
Apply specified font scaling ratio?
221
</para><para>Default value: FALSE</para>
223
<refsect2><title><anchor id="GnomeCanvasText--size"/>The "<literal>size</literal>" property</title>
224
<programlisting> "size" <link linkend="gint">gint</link> : Read / Write</programlisting>
226
Size (in pixels) of font.
227
</para><para>Allowed values: >= 0</para>
228
<para>Default value: 0</para>
230
<refsect2><title><anchor id="GnomeCanvasText--size-points"/>The "<literal>size-points</literal>" property</title>
231
<programlisting> "size-points" <link linkend="gdouble">gdouble</link> : Read / Write</programlisting>
233
Size (in points) of font.
234
</para><para>Allowed values: >= 0</para>
235
<para>Default value: 0</para>
237
<refsect2><title><anchor id="GnomeCanvasText--size-set"/>The "<literal>size-set</literal>" property</title>
238
<programlisting> "size-set" <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>
240
Apply specified font size?
241
</para><para>Default value: FALSE</para>
243
<refsect2><title><anchor id="GnomeCanvasText--stretch"/>The "<literal>stretch</literal>" property</title>
244
<programlisting> "stretch" <link linkend="PangoStretch">PangoStretch</link> : Read / Write</programlisting>
246
Pango stretch of font to use (PangoStretch).
247
</para><para>Default value: PANGO_STRETCH_NORMAL</para>
249
<refsect2><title><anchor id="GnomeCanvasText--stretch-set"/>The "<literal>stretch-set</literal>" property</title>
250
<programlisting> "stretch-set" <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>
252
Apply specified pango stretch?
253
</para><para>Default value: FALSE</para>
255
<refsect2><title><anchor id="GnomeCanvasText--strikethrough"/>The "<literal>strikethrough</literal>" property</title>
256
<programlisting> "strikethrough" <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>
258
Whether to strike through the text.
259
</para><para>Default value: FALSE</para>
261
<refsect2><title><anchor id="GnomeCanvasText--strikethrough-set"/>The "<literal>strikethrough-set</literal>" property</title>
262
<programlisting> "strikethrough-set" <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>
264
Apply specified strikethrough option?
265
</para><para>Default value: FALSE</para>
267
<refsect2><title><anchor id="GnomeCanvasText--style"/>The "<literal>style</literal>" property</title>
268
<programlisting> "style" <link linkend="PangoStyle">PangoStyle</link> : Read / Write</programlisting>
270
Pango style of font to use (PangoStyle).
271
</para><para>Default value: PANGO_STYLE_NORMAL</para>
273
<refsect2><title><anchor id="GnomeCanvasText--style-set"/>The "<literal>style-set</literal>" property</title>
274
<programlisting> "style-set" <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>
276
Apply specified pango style?
277
</para><para>Default value: FALSE</para>
279
<refsect2><title><anchor id="GnomeCanvasText--text"/>The "<literal>text</literal>" property</title>
280
<programlisting> "text" <link linkend="gchararray">gchararray</link> : Read / Write</programlisting>
282
The string of the text label.
283
</para><para>Default value: NULL</para>
285
<refsect2><title><anchor id="GnomeCanvasText--text-height"/>The "<literal>text-height</literal>" property</title>
286
<programlisting> "text-height" <link linkend="gdouble">gdouble</link> : Read / Write</programlisting>
288
Used to query the rendered height of the text.
289
</para><para>Allowed values: >= 0</para>
290
<para>Default value: 0</para>
292
<refsect2><title><anchor id="GnomeCanvasText--text-width"/>The "<literal>text-width</literal>" property</title>
293
<programlisting> "text-width" <link linkend="gdouble">gdouble</link> : Read / Write</programlisting>
295
Used to query the width of the rendered text.
296
</para><para>Allowed values: >= 0</para>
297
<para>Default value: 0</para>
299
<refsect2><title><anchor id="GnomeCanvasText--underline"/>The "<literal>underline</literal>" property</title>
300
<programlisting> "underline" <link linkend="PangoUnderline">PangoUnderline</link> : Read / Write</programlisting>
302
Pango underline style for text (PangoUnderline).
303
</para><para>Default value: PANGO_UNDERLINE_NONE</para>
305
<refsect2><title><anchor id="GnomeCanvasText--underline-set"/>The "<literal>underline-set</literal>" property</title>
306
<programlisting> "underline-set" <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>
308
Apply specified pango underline style?
309
</para><para>Default value: FALSE</para>
311
<refsect2><title><anchor id="GnomeCanvasText--variant"/>The "<literal>variant</literal>" property</title>
312
<programlisting> "variant" <link linkend="PangoVariant">PangoVariant</link> : Read / Write</programlisting>
314
Pango variant of font to use (PangoVariant).
315
</para><para>Default value: PANGO_VARIANT_NORMAL</para>
317
<refsect2><title><anchor id="GnomeCanvasText--variant-set"/>The "<literal>variant-set</literal>" property</title>
318
<programlisting> "variant-set" <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>
320
Apply specified pango variant?
321
</para><para>Default value: FALSE</para>
323
<refsect2><title><anchor id="GnomeCanvasText--weight"/>The "<literal>weight</literal>" property</title>
324
<programlisting> "weight" <link linkend="gint">gint</link> : Read / Write</programlisting>
326
Pango weight of font to use.
327
</para><para>Allowed values: >= 0</para>
328
<para>Default value: 400</para>
330
<refsect2><title><anchor id="GnomeCanvasText--weight-set"/>The "<literal>weight-set</literal>" property</title>
331
<programlisting> "weight-set" <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>
333
Apply specified pango weight?
334
</para><para>Default value: FALSE</para>
336
<refsect2><title><anchor id="GnomeCanvasText--x"/>The "<literal>x</literal>" property</title>
337
<programlisting> "x" <link linkend="gdouble">gdouble</link> : Read / Write</programlisting>
339
X coordinate of anchor point.
340
</para><para>Default value: 0</para>
342
<refsect2><title><anchor id="GnomeCanvasText--x-offset"/>The "<literal>x-offset</literal>" property</title>
343
<programlisting> "x-offset" <link linkend="gdouble">gdouble</link> : Read / Write</programlisting>
345
Horizontal offset distance from anchor position.
346
</para><para>Default value: 0</para>
348
<refsect2><title><anchor id="GnomeCanvasText--y"/>The "<literal>y</literal>" property</title>
349
<programlisting> "y" <link linkend="gdouble">gdouble</link> : Read / Write</programlisting>
351
Y coordinate of anchor point.
352
</para><para>Default value: 0</para>
354
<refsect2><title><anchor id="GnomeCanvasText--y-offset"/>The "<literal>y-offset</literal>" property</title>
355
<programlisting> "y-offset" <link linkend="gdouble">gdouble</link> : Read / Write</programlisting>
357
Vertical offset distance from anchor position.
358
</para><para>Default value: 0</para>
366
<title>See Also</title>
368
<link linkend="GnomeCanvasRichText"><type>GnomeCanvasRichText</type></link>
added
removed
docs/reference/xml/gnome-canvas-text.xml
