1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
6
<meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
7
<link rel="home" href="index.html" title="GTK+ 2 Reference Manual">
8
<link rel="up" href="DeprecatedObjects.html" title="Deprecated">
9
<link rel="prev" href="GtkProgress.html" title="GtkProgress">
10
<link rel="next" href="GtkTooltips.html" title="GtkTooltips">
11
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12
<link rel="stylesheet" href="style.css" type="text/css">
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">
17
<td><a accesskey="p" href="GtkProgress.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
<td><a accesskey="u" href="DeprecatedObjects.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">GTK+ 2 Reference Manual</th>
21
<td><a accesskey="n" href="GtkTooltips.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23
<tr><td colspan="5" class="shortcuts">
24
<a href="#GtkText.synopsis" class="shortcut">Top</a>
26
<a href="#GtkText.description" class="shortcut">Description</a>
28
<a href="#GtkText.object-hierarchy" class="shortcut">Object Hierarchy</a>
30
<a href="#GtkText.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
32
<a href="#GtkText.properties" class="shortcut">Properties</a>
34
<a href="#GtkText.signals" class="shortcut">Signals</a>
37
<div class="refentry">
38
<a name="GtkText"></a><div class="titlepage"></div>
39
<div class="refnamediv"><table width="100%"><tr>
41
<h2><span class="refentrytitle"><a name="GtkText.top_of_page"></a>GtkText</span></h2>
42
<p>GtkText — A text widget</p>
44
<td valign="top" align="right"></td>
46
<div class="refsynopsisdiv">
47
<a name="GtkText.synopsis"></a><h2>Synopsis</h2>
48
<pre class="synopsis">
49
#include <gtk/gtk.h>
51
struct <a class="link" href="GtkText.html#GtkText-struct" title="struct GtkText">GtkText</a>;
52
<a class="link" href="GtkText.html#GtkTextFont" title="GtkTextFont">GtkTextFont</a>;
53
struct <a class="link" href="GtkText.html#GtkPropertyMark" title="struct GtkPropertyMark">GtkPropertyMark</a>;
54
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> * <a class="link" href="GtkText.html#gtk-text-new" title="gtk_text_new ()">gtk_text_new</a> (<em class="parameter"><code><a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a> *hadj</code></em>,
55
<em class="parameter"><code><a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a> *vadj</code></em>);
56
<span class="returnvalue">void</span> <a class="link" href="GtkText.html#gtk-text-set-editable" title="gtk_text_set_editable ()">gtk_text_set_editable</a> (<em class="parameter"><code><a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> *text</code></em>,
57
<em class="parameter"><code><span class="type">gboolean</span> editable</code></em>);
58
<span class="returnvalue">void</span> <a class="link" href="GtkText.html#gtk-text-set-word-wrap" title="gtk_text_set_word_wrap ()">gtk_text_set_word_wrap</a> (<em class="parameter"><code><a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> *text</code></em>,
59
<em class="parameter"><code><span class="type">gboolean</span> word_wrap</code></em>);
60
<span class="returnvalue">void</span> <a class="link" href="GtkText.html#gtk-text-set-line-wrap" title="gtk_text_set_line_wrap ()">gtk_text_set_line_wrap</a> (<em class="parameter"><code><a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> *text</code></em>,
61
<em class="parameter"><code><span class="type">gboolean</span> line_wrap</code></em>);
62
<span class="returnvalue">void</span> <a class="link" href="GtkText.html#gtk-text-set-adjustments" title="gtk_text_set_adjustments ()">gtk_text_set_adjustments</a> (<em class="parameter"><code><a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> *text</code></em>,
63
<em class="parameter"><code><a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a> *hadj</code></em>,
64
<em class="parameter"><code><a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a> *vadj</code></em>);
65
<span class="returnvalue">void</span> <a class="link" href="GtkText.html#gtk-text-set-point" title="gtk_text_set_point ()">gtk_text_set_point</a> (<em class="parameter"><code><a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> *text</code></em>,
66
<em class="parameter"><code><span class="type">guint</span> index</code></em>);
67
<span class="returnvalue">guint</span> <a class="link" href="GtkText.html#gtk-text-get-point" title="gtk_text_get_point ()">gtk_text_get_point</a> (<em class="parameter"><code><a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> *text</code></em>);
68
<span class="returnvalue">guint</span> <a class="link" href="GtkText.html#gtk-text-get-length" title="gtk_text_get_length ()">gtk_text_get_length</a> (<em class="parameter"><code><a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> *text</code></em>);
69
<span class="returnvalue">void</span> <a class="link" href="GtkText.html#gtk-text-freeze" title="gtk_text_freeze ()">gtk_text_freeze</a> (<em class="parameter"><code><a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> *text</code></em>);
70
<span class="returnvalue">void</span> <a class="link" href="GtkText.html#gtk-text-thaw" title="gtk_text_thaw ()">gtk_text_thaw</a> (<em class="parameter"><code><a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> *text</code></em>);
71
<span class="returnvalue">void</span> <a class="link" href="GtkText.html#gtk-text-insert" title="gtk_text_insert ()">gtk_text_insert</a> (<em class="parameter"><code><a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> *text</code></em>,
72
<em class="parameter"><code><a href="../gdk2/gdk2-Fonts.html#GdkFont"><span class="type">GdkFont</span></a> *font</code></em>,
73
<em class="parameter"><code>const <a href="../gdk2/gdk2-Colormaps-and-Colors.html#GdkColor"><span class="type">GdkColor</span></a> *fore</code></em>,
74
<em class="parameter"><code>const <a href="../gdk2/gdk2-Colormaps-and-Colors.html#GdkColor"><span class="type">GdkColor</span></a> *back</code></em>,
75
<em class="parameter"><code>const <span class="type">char</span> *chars</code></em>,
76
<em class="parameter"><code><span class="type">gint</span> length</code></em>);
77
<span class="returnvalue">gboolean</span> <a class="link" href="GtkText.html#gtk-text-backward-delete" title="gtk_text_backward_delete ()">gtk_text_backward_delete</a> (<em class="parameter"><code><a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> *text</code></em>,
78
<em class="parameter"><code><span class="type">guint</span> nchars</code></em>);
79
<span class="returnvalue">gboolean</span> <a class="link" href="GtkText.html#gtk-text-forward-delete" title="gtk_text_forward_delete ()">gtk_text_forward_delete</a> (<em class="parameter"><code><a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> *text</code></em>,
80
<em class="parameter"><code><span class="type">guint</span> nchars</code></em>);
81
#define <a class="link" href="GtkText.html#GTK-TEXT-INDEX:CAPS" title="GTK_TEXT_INDEX()">GTK_TEXT_INDEX</a> (t,
85
<div class="refsect1">
86
<a name="GtkText.object-hierarchy"></a><h2>Object Hierarchy</h2>
87
<pre class="synopsis">
89
+----GInitiallyUnowned
90
+----<a class="link" href="GtkObject.html" title="GtkObject">GtkObject</a>
91
+----<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
92
+----<a class="link" href="GtkOldEditable.html" title="GtkOldEditable">GtkOldEditable</a>
96
<div class="refsect1">
97
<a name="GtkText.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
100
AtkImplementorIface, <a class="link" href="GtkBuildable.html" title="GtkBuildable">GtkBuildable</a> and <a class="link" href="GtkEditable.html" title="GtkEditable">GtkEditable</a>.</p>
102
<div class="refsect1">
103
<a name="GtkText.properties"></a><h2>Properties</h2>
104
<pre class="synopsis">
105
"<a class="link" href="GtkText.html#GtkText--hadjustment" title='The "hadjustment" property'>hadjustment</a>" <a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a>* : Read / Write
106
"<a class="link" href="GtkText.html#GtkText--line-wrap" title='The "line-wrap" property'>line-wrap</a>" <span class="type">gboolean</span> : Read / Write
107
"<a class="link" href="GtkText.html#GtkText--vadjustment" title='The "vadjustment" property'>vadjustment</a>" <a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a>* : Read / Write
108
"<a class="link" href="GtkText.html#GtkText--word-wrap" title='The "word-wrap" property'>word-wrap</a>" <span class="type">gboolean</span> : Read / Write
111
<div class="refsect1">
112
<a name="GtkText.signals"></a><h2>Signals</h2>
113
<pre class="synopsis">
114
"<a class="link" href="GtkText.html#GtkText-set-scroll-adjustments" title='The "set-scroll-adjustments" signal'>set-scroll-adjustments</a>" : <code class="literal">Run Last</code>
117
<div class="refsect1">
118
<a name="GtkText.description"></a><h2>Description</h2>
121
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
122
<h3 class="title">Warning</h3>
124
<a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> is deprecated and unsupported. It is known to be
125
buggy. To use it, you must define the symbol <code class="literal">GTK_ENABLE_BROKEN</code>
126
prior to including the GTK+ header files. Use <a class="link" href="GtkTextView.html" title="GtkTextView"><span class="type">GtkTextView</span></a> instead.
130
A <a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> widget allows one to display any given text and manipulate it
131
by deleting from one point to another, selecting a region, and various
132
other functions as outlined below. It is inherited from <a class="link" href="GtkEditable.html" title="GtkEditable"><span class="type">GtkEditable</span></a>.
135
<div class="refsect1">
136
<a name="GtkText.details"></a><h2>Details</h2>
137
<div class="refsect2">
138
<a name="GtkText-struct"></a><h3>struct GtkText</h3>
139
<pre class="programlisting">struct GtkText;</pre>
140
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
141
<h3 class="title">Warning</h3>
142
<p><code class="literal">GtkText</code> is deprecated and should not be used in newly-written code.</p>
145
Most of the <a class="link" href="GtkText.html#GtkText-struct" title="struct GtkText"><span class="type">GtkText</span></a> struct members should not be accessed directly.
146
Listed below are a few exceptions and how to use them.
150
<div class="refsect2">
151
<a name="GtkTextFont"></a><h3>GtkTextFont</h3>
152
<pre class="programlisting">typedef struct _GtkTextFont GtkTextFont;</pre>
153
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
154
<h3 class="title">Warning</h3>
155
<p><code class="literal">GtkTextFont</code> is deprecated and should not be used in newly-written code.</p>
158
Internal <a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> data type.
163
<div class="refsect2">
164
<a name="GtkPropertyMark"></a><h3>struct GtkPropertyMark</h3>
165
<pre class="programlisting">struct GtkPropertyMark {
166
/* Position in list. */
169
/* Offset into that property. */
176
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
177
<h3 class="title">Warning</h3>
178
<p><code class="literal">GtkPropertyMark</code> is deprecated and should not be used in newly-written code.</p>
181
Internal <a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> data type. Should not be accessed directly.
186
<div class="refsect2">
187
<a name="gtk-text-new"></a><h3>gtk_text_new ()</h3>
188
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> * gtk_text_new (<em class="parameter"><code><a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a> *hadj</code></em>,
189
<em class="parameter"><code><a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a> *vadj</code></em>);</pre>
190
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
191
<h3 class="title">Warning</h3>
192
<p><code class="literal">gtk_text_new</code> is deprecated and should not be used in newly-written code.</p>
195
Creates a new <a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> widget, initialized with the given pointers to
196
<a href="GtkAdjustment.html"><span class="type">GtkAdjustments</span></a>. These pointers can be used to track the viewing position
197
of the <a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> widget. Passing <a href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"><code class="literal">NULL</code></a> to either or both of them will make
198
the <a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> create its own. You can set these later with the function
199
<code class="function">gtk_text_set_adjustment()</code>.
201
<div class="variablelist"><table border="0" class="variablelist">
203
<col align="left" valign="top">
208
<td><p><span class="term"><em class="parameter"><code>hadj</code></em> :</span></p></td>
209
<td>horizontal adjustment.</td>
212
<td><p><span class="term"><em class="parameter"><code>vadj</code></em> :</span></p></td>
213
<td>vertical adjustment.</td>
216
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
217
<td>the new <a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> widget.</td>
223
<div class="refsect2">
224
<a name="gtk-text-set-editable"></a><h3>gtk_text_set_editable ()</h3>
225
<pre class="programlisting"><span class="returnvalue">void</span> gtk_text_set_editable (<em class="parameter"><code><a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> *text</code></em>,
226
<em class="parameter"><code><span class="type">gboolean</span> editable</code></em>);</pre>
227
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
228
<h3 class="title">Warning</h3>
229
<p><code class="literal">gtk_text_set_editable</code> is deprecated and should not be used in newly-written code.</p>
232
Sets whether the <a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> widget can be edited by the user or not. This
233
still allows you the programmer to make changes with the various <a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a>
236
<div class="variablelist"><table border="0" class="variablelist">
238
<col align="left" valign="top">
243
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
244
<td>the <a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> widget</td>
247
<td><p><span class="term"><em class="parameter"><code>editable</code></em> :</span></p></td>
249
<code class="literal">TRUE</code> makes it editable, <code class="literal">FALSE</code> makes it immutable by the user</td>
255
<div class="refsect2">
256
<a name="gtk-text-set-word-wrap"></a><h3>gtk_text_set_word_wrap ()</h3>
257
<pre class="programlisting"><span class="returnvalue">void</span> gtk_text_set_word_wrap (<em class="parameter"><code><a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> *text</code></em>,
258
<em class="parameter"><code><span class="type">gboolean</span> word_wrap</code></em>);</pre>
259
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
260
<h3 class="title">Warning</h3>
261
<p><code class="literal">gtk_text_set_word_wrap</code> is deprecated and should not be used in newly-written code.</p>
264
Sets whether the <a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> widget wraps words down to the next line if it
265
can't be completed on the current line.
267
<div class="variablelist"><table border="0" class="variablelist">
269
<col align="left" valign="top">
274
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
275
<td>the <a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> widget</td>
278
<td><p><span class="term"><em class="parameter"><code>word_wrap</code></em> :</span></p></td>
280
<code class="literal">TRUE</code> makes it word wrap, <code class="literal">FALSE</code> disables word wrapping</td>
286
<div class="refsect2">
287
<a name="gtk-text-set-line-wrap"></a><h3>gtk_text_set_line_wrap ()</h3>
288
<pre class="programlisting"><span class="returnvalue">void</span> gtk_text_set_line_wrap (<em class="parameter"><code><a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> *text</code></em>,
289
<em class="parameter"><code><span class="type">gboolean</span> line_wrap</code></em>);</pre>
290
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
291
<h3 class="title">Warning</h3>
292
<p><code class="literal">gtk_text_set_line_wrap</code> is deprecated and should not be used in newly-written code.</p>
295
Controls how <a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> handles long lines of continuous text. If line wrap
296
is on, the line is broken when it reaches the extent of the <a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> widget
297
viewing area and the rest is displayed on the next line. If it is not set,
298
the line continues regardless size of current viewing area. Similar to word
299
wrap but it disregards word boundaries.
301
<div class="variablelist"><table border="0" class="variablelist">
303
<col align="left" valign="top">
308
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
309
<td>the <a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> widget</td>
312
<td><p><span class="term"><em class="parameter"><code>line_wrap</code></em> :</span></p></td>
314
<code class="literal">TRUE</code> turns line wrap on, <code class="literal">FALSE</code> turns it off</td>
320
<div class="refsect2">
321
<a name="gtk-text-set-adjustments"></a><h3>gtk_text_set_adjustments ()</h3>
322
<pre class="programlisting"><span class="returnvalue">void</span> gtk_text_set_adjustments (<em class="parameter"><code><a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> *text</code></em>,
323
<em class="parameter"><code><a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a> *hadj</code></em>,
324
<em class="parameter"><code><a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a> *vadj</code></em>);</pre>
325
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
326
<h3 class="title">Warning</h3>
327
<p><code class="literal">gtk_text_set_adjustments</code> is deprecated and should not be used in newly-written code.</p>
330
Allows you to set <a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a> pointers which in turn allows you to
331
keep track of the viewing position of the <a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> widget.
333
<div class="variablelist"><table border="0" class="variablelist">
335
<col align="left" valign="top">
340
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
341
<td>the <a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> widget</td>
344
<td><p><span class="term"><em class="parameter"><code>hadj</code></em> :</span></p></td>
345
<td>the horizontal adjustment</td>
348
<td><p><span class="term"><em class="parameter"><code>vadj</code></em> :</span></p></td>
349
<td>the vertical adjustment</td>
355
<div class="refsect2">
356
<a name="gtk-text-set-point"></a><h3>gtk_text_set_point ()</h3>
357
<pre class="programlisting"><span class="returnvalue">void</span> gtk_text_set_point (<em class="parameter"><code><a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> *text</code></em>,
358
<em class="parameter"><code><span class="type">guint</span> index</code></em>);</pre>
359
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
360
<h3 class="title">Warning</h3>
361
<p><code class="literal">gtk_text_set_point</code> is deprecated and should not be used in newly-written code.</p>
364
Sets the cursor at the given point. In this case a point constitutes
365
the number of characters from the extreme upper left corner of the <a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a>
368
<div class="variablelist"><table border="0" class="variablelist">
370
<col align="left" valign="top">
375
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
376
<td>the <a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> widget</td>
379
<td><p><span class="term"><em class="parameter"><code>index</code></em> :</span></p></td>
380
<td>the number of characters from the upper left corner</td>
386
<div class="refsect2">
387
<a name="gtk-text-get-point"></a><h3>gtk_text_get_point ()</h3>
388
<pre class="programlisting"><span class="returnvalue">guint</span> gtk_text_get_point (<em class="parameter"><code><a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> *text</code></em>);</pre>
389
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
390
<h3 class="title">Warning</h3>
391
<p><code class="literal">gtk_text_get_point</code> is deprecated and should not be used in newly-written code.</p>
394
Gets the current position of the cursor as the number of characters from
395
the upper left corner of the <a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> widget.
397
<div class="variablelist"><table border="0" class="variablelist">
399
<col align="left" valign="top">
404
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
405
<td>the <a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> widget</td>
408
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
409
<td>the number of characters from the upper left corner</td>
415
<div class="refsect2">
416
<a name="gtk-text-get-length"></a><h3>gtk_text_get_length ()</h3>
417
<pre class="programlisting"><span class="returnvalue">guint</span> gtk_text_get_length (<em class="parameter"><code><a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> *text</code></em>);</pre>
418
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
419
<h3 class="title">Warning</h3>
420
<p><code class="literal">gtk_text_get_length</code> is deprecated and should not be used in newly-written code.</p>
423
Returns the length of the all the text contained within the <a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> widget;
424
disregards current point position.
426
<div class="variablelist"><table border="0" class="variablelist">
428
<col align="left" valign="top">
433
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
434
<td>the <a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> widget</td>
437
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
438
<td>the length of the text</td>
444
<div class="refsect2">
445
<a name="gtk-text-freeze"></a><h3>gtk_text_freeze ()</h3>
446
<pre class="programlisting"><span class="returnvalue">void</span> gtk_text_freeze (<em class="parameter"><code><a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> *text</code></em>);</pre>
447
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
448
<h3 class="title">Warning</h3>
449
<p><code class="literal">gtk_text_freeze</code> is deprecated and should not be used in newly-written code.</p>
452
Freezes the <a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> widget which disallows redrawing of the widget until
453
it is thawed. This is useful if a large number of changes are going to
454
made to the text within the widget, reducing the amount of flicker seen
457
<div class="variablelist"><table border="0" class="variablelist">
459
<col align="left" valign="top">
463
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
464
<td>the <a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> widget</td>
469
<div class="refsect2">
470
<a name="gtk-text-thaw"></a><h3>gtk_text_thaw ()</h3>
471
<pre class="programlisting"><span class="returnvalue">void</span> gtk_text_thaw (<em class="parameter"><code><a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> *text</code></em>);</pre>
472
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
473
<h3 class="title">Warning</h3>
474
<p><code class="literal">gtk_text_thaw</code> is deprecated and should not be used in newly-written code.</p>
477
Allows the <a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> widget to be redrawn again by GTK.
479
<div class="variablelist"><table border="0" class="variablelist">
481
<col align="left" valign="top">
485
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
486
<td>the <a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> widget</td>
491
<div class="refsect2">
492
<a name="gtk-text-insert"></a><h3>gtk_text_insert ()</h3>
493
<pre class="programlisting"><span class="returnvalue">void</span> gtk_text_insert (<em class="parameter"><code><a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> *text</code></em>,
494
<em class="parameter"><code><a href="../gdk2/gdk2-Fonts.html#GdkFont"><span class="type">GdkFont</span></a> *font</code></em>,
495
<em class="parameter"><code>const <a href="../gdk2/gdk2-Colormaps-and-Colors.html#GdkColor"><span class="type">GdkColor</span></a> *fore</code></em>,
496
<em class="parameter"><code>const <a href="../gdk2/gdk2-Colormaps-and-Colors.html#GdkColor"><span class="type">GdkColor</span></a> *back</code></em>,
497
<em class="parameter"><code>const <span class="type">char</span> *chars</code></em>,
498
<em class="parameter"><code><span class="type">gint</span> length</code></em>);</pre>
499
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
500
<h3 class="title">Warning</h3>
501
<p><code class="literal">gtk_text_insert</code> is deprecated and should not be used in newly-written code.</p>
504
Inserts given text into the <a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> widget with the given properties as
507
<div class="variablelist"><table border="0" class="variablelist">
509
<col align="left" valign="top">
514
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
515
<td>the <a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> widget</td>
518
<td><p><span class="term"><em class="parameter"><code>font</code></em> :</span></p></td>
519
<td>the <a href="../gdk2/gdk2-Fonts.html#GdkFont"><span class="type">GdkFont</span></a> to use</td>
522
<td><p><span class="term"><em class="parameter"><code>fore</code></em> :</span></p></td>
523
<td>the foreground color to insert with</td>
526
<td><p><span class="term"><em class="parameter"><code>back</code></em> :</span></p></td>
527
<td>the background color to insert with</td>
530
<td><p><span class="term"><em class="parameter"><code>chars</code></em> :</span></p></td>
531
<td>the actual text to be inserted</td>
534
<td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
535
<td>the length of the text to be inserted, passing -1 makes it insert
542
<div class="refsect2">
543
<a name="gtk-text-backward-delete"></a><h3>gtk_text_backward_delete ()</h3>
544
<pre class="programlisting"><span class="returnvalue">gboolean</span> gtk_text_backward_delete (<em class="parameter"><code><a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> *text</code></em>,
545
<em class="parameter"><code><span class="type">guint</span> nchars</code></em>);</pre>
546
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
547
<h3 class="title">Warning</h3>
548
<p><code class="literal">gtk_text_backward_delete</code> is deprecated and should not be used in newly-written code.</p>
551
Deletes from the current point position backward the given number of
554
<div class="variablelist"><table border="0" class="variablelist">
556
<col align="left" valign="top">
561
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
562
<td>the <a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> widget</td>
565
<td><p><span class="term"><em class="parameter"><code>nchars</code></em> :</span></p></td>
566
<td>the number of characters to delete</td>
569
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
571
<code class="literal">TRUE</code> if the operation was successful, otherwise returns <code class="literal">FALSE</code>
578
<div class="refsect2">
579
<a name="gtk-text-forward-delete"></a><h3>gtk_text_forward_delete ()</h3>
580
<pre class="programlisting"><span class="returnvalue">gboolean</span> gtk_text_forward_delete (<em class="parameter"><code><a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> *text</code></em>,
581
<em class="parameter"><code><span class="type">guint</span> nchars</code></em>);</pre>
582
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
583
<h3 class="title">Warning</h3>
584
<p><code class="literal">gtk_text_forward_delete</code> is deprecated and should not be used in newly-written code.</p>
587
Deletes from the current point position forward the given number of
590
<div class="variablelist"><table border="0" class="variablelist">
592
<col align="left" valign="top">
597
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
598
<td>the <a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> widget</td>
601
<td><p><span class="term"><em class="parameter"><code>nchars</code></em> :</span></p></td>
602
<td>the number of characters to delete</td>
605
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
607
<code class="literal">TRUE</code> if the operation was successful, otherwise returns <code class="literal">FALSE</code>
614
<div class="refsect2">
615
<a name="GTK-TEXT-INDEX:CAPS"></a><h3>GTK_TEXT_INDEX()</h3>
616
<pre class="programlisting">#define GTK_TEXT_INDEX(t, index)</pre>
617
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
618
<h3 class="title">Warning</h3>
619
<p><code class="literal">GTK_TEXT_INDEX</code> is deprecated and should not be used in newly-written code.</p>
622
Returns the character at the given index within the <a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> widget.
624
<div class="variablelist"><table border="0" class="variablelist">
626
<col align="left" valign="top">
631
<td><p><span class="term"><em class="parameter"><code>t</code></em> :</span></p></td>
632
<td>the <a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> widget</td>
635
<td><p><span class="term"><em class="parameter"><code>index</code></em> :</span></p></td>
636
<td>the number of characters from the upper left corner</td>
642
<div class="refsect1">
643
<a name="GtkText.property-details"></a><h2>Property Details</h2>
644
<div class="refsect2">
645
<a name="GtkText--hadjustment"></a><h3>The <code class="literal">"hadjustment"</code> property</h3>
646
<pre class="programlisting"> "hadjustment" <a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a>* : Read / Write</pre>
648
Used by the <a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> widget to keep track of the size of its horizontal
653
<div class="refsect2">
654
<a name="GtkText--line-wrap"></a><h3>The <code class="literal">"line-wrap"</code> property</h3>
655
<pre class="programlisting"> "line-wrap" <span class="type">gboolean</span> : Read / Write</pre>
657
Boolean value indicating whether line wrap is enabled or not.
659
<p>Default value: TRUE</p>
662
<div class="refsect2">
663
<a name="GtkText--vadjustment"></a><h3>The <code class="literal">"vadjustment"</code> property</h3>
664
<pre class="programlisting"> "vadjustment" <a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a>* : Read / Write</pre>
666
Used by the <a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> widget to keep track of the size of its vertical
671
<div class="refsect2">
672
<a name="GtkText--word-wrap"></a><h3>The <code class="literal">"word-wrap"</code> property</h3>
673
<pre class="programlisting"> "word-wrap" <span class="type">gboolean</span> : Read / Write</pre>
675
Boolean value indicated whether word wrap is enabled or not.
677
<p>Default value: FALSE</p>
680
<div class="refsect1">
681
<a name="GtkText.signal-details"></a><h2>Signal Details</h2>
682
<div class="refsect2">
683
<a name="GtkText-set-scroll-adjustments"></a><h3>The <code class="literal">"set-scroll-adjustments"</code> signal</h3>
684
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="GtkText.html" title="GtkText"><span class="type">GtkText</span></a> *text,
685
<a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a> *arg1,
686
<a class="link" href="GtkAdjustment.html" title="GtkAdjustment"><span class="type">GtkAdjustment</span></a> *arg2,
687
<span class="type">gpointer</span> user_data) : <code class="literal">Run Last</code></pre>
690
<div class="variablelist"><table border="0" class="variablelist">
692
<col align="left" valign="top">
697
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
698
<td>the object which received the signal.</td>
701
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
702
<td>user data set when the signal handler was connected.</td>
711
Generated by GTK-Doc V1.18</div>
b'\\ No newline at end of file'
added
removed
share/gtk-doc/html/gtk2/GtkText.html
