/usr/share/gtk-doc/html/gtkextra-3/GtkDataTextView.html is in libgtkextra-3.0-doc 3.2.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkDataTextView</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="GtkExtra Reference Manual">
<link rel="up" href="ch03.html" title="Widgets">
<link rel="prev" href="GtkDataEntry.html" title="GtkDataEntry">
<link rel="next" href="GtkDirTree.html" title="GtkDirTree">
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="part" href="gtkextra.html" title="Part I. GtkExtra Overview">
<link rel="part" href="gtkextrabase.html" title="Part II. GtkExtra Widgets and Objects">
<link rel="chapter" href="ch01.html" title="Object Hierarchy">
<link rel="chapter" href="ch02.html" title="Widget Gallery">
<link rel="chapter" href="ch03.html" title="Widgets">
<link rel="chapter" href="ch04.html" title="Data Formatter">
<link rel="chapter" href="ch05.html" title="GtkExtra Versioning">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="GtkDataEntry.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch03.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GtkExtra Reference Manual</th>
<td><a accesskey="n" href="GtkDirTree.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GtkDataTextView.synopsis" class="shortcut">Top</a>
|
<a href="#GtkDataTextView.description" class="shortcut">Description</a>
|
<a href="#GtkDataTextView.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GtkDataTextView.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#GtkDataTextView.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry" title="GtkDataTextView">
<a name="GtkDataTextView"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkDataTextView.top_of_page"></a>GtkDataTextView</span></h2>
<p>GtkDataTextView — a data textview widget, based on
GtkTextView</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="GtkDataTextView.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <gtkextra.h>
<a class="link" href="GtkDataTextView.html#GtkDataTextView-struct" title="GtkDataTextView">GtkDataTextView</a>;
<a class="link" href="GtkDataTextView.html" title="GtkDataTextView">GtkDataTextView</a> * <a class="link" href="GtkDataTextView.html#gtk-data-text-view-new" title="gtk_data_text_view_new ()">gtk_data_text_view_new</a> (void);
const <a
href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> * <a class="link" href="GtkDataTextView.html#gtk-data-text-view-get-description" title="gtk_data_text_view_get_description ()">gtk_data_text_view_get_description</a> (<a class="link" href="GtkDataTextView.html" title="GtkDataTextView">GtkDataTextView</a> *data_text_view);
<a
href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"
>gint</a> <a class="link" href="GtkDataTextView.html#gtk-data-text-view-get-max-length" title="gtk_data_text_view_get_max_length ()">gtk_data_text_view_get_max_length</a> (<a class="link" href="GtkDataTextView.html" title="GtkDataTextView">GtkDataTextView</a> *data_text_view);
<a
href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"
>gint</a> <a class="link" href="GtkDataTextView.html#gtk-data-text-view-get-max-length-bytes" title="gtk_data_text_view_get_max_length_bytes ()">gtk_data_text_view_get_max_length_bytes</a>
(<a class="link" href="GtkDataTextView.html" title="GtkDataTextView">GtkDataTextView</a> *data_text_view);
void <a class="link" href="GtkDataTextView.html#gtk-data-text-view-set-description" title="gtk_data_text_view_set_description ()">gtk_data_text_view_set_description</a> (<a class="link" href="GtkDataTextView.html" title="GtkDataTextView">GtkDataTextView</a> *data_text_view,
const <a
href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> *description);
void <a class="link" href="GtkDataTextView.html#gtk-data-text-view-set-max-length" title="gtk_data_text_view_set_max_length ()">gtk_data_text_view_set_max_length</a> (<a class="link" href="GtkDataTextView.html" title="GtkDataTextView">GtkDataTextView</a> *data_text_view,
<a
href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"
>gint</a> max_length);
void <a class="link" href="GtkDataTextView.html#gtk-data-text-view-set-max-length-bytes" title="gtk_data_text_view_set_max_length_bytes ()">gtk_data_text_view_set_max_length_bytes</a>
(<a class="link" href="GtkDataTextView.html" title="GtkDataTextView">GtkDataTextView</a> *data_text_view,
<a
href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"
>gint</a> max_length_bytes);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="GtkDataTextView.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a
href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----<a
href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
>GInitiallyUnowned</a>
+----<a
href="http://library.gnome.org/devel/gtk3/GtkObject.html"
>GtkObject</a>
+----<a
href="http://library.gnome.org/devel/gtk3/GtkWidget.html"
>GtkWidget</a>
+----<a
href="http://library.gnome.org/devel/gtk3/GtkContainer.html"
>GtkContainer</a>
+----<a
href="http://library.gnome.org/devel/gtk3/GtkTextView.html"
>GtkTextView</a>
+----GtkDataTextView
</pre>
</div>
<div class="refsect1" title="Implemented Interfaces">
<a name="GtkDataTextView.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GtkDataTextView implements
AtkImplementorIface and <a
href="http://library.gnome.org/devel/gtk3/GtkBuildable.html"
>GtkBuildable</a>.</p>
</div>
<div class="refsect1" title="Properties">
<a name="GtkDataTextView.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="GtkDataTextView.html#GtkDataTextView--description" title='The "description" property'>description</a>" <a
href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a>* : Read / Write
"<a class="link" href="GtkDataTextView.html#GtkDataTextView--max-length" title='The "max-length" property'>max-length</a>" <a
href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"
>gint</a> : Read / Write
"<a class="link" href="GtkDataTextView.html#GtkDataTextView--max-length-bytes" title='The "max-length-bytes" property'>max-length-bytes</a>" <a
href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"
>gint</a> : Read / Write
</pre>
</div>
<div class="refsect1" title="Description">
<a name="GtkDataTextView.description"></a><h2>Description</h2>
<p>
GtkDataTextView provides additional properties:
</p>
<p>
- <a class="link" href="GtkDataTextView.html#GtkDataTextView--description" title='The "description" property'><span class="type">"description"</span></a> - no functionality, a place for
private information that cannot be put anywhere else
</p>
<p>
- <a class="link" href="GtkDataTextView.html#GtkDataTextView--max-length" title='The "max-length" property'><span class="type">"max-length"</span></a> - set the maximum character
length for the contents of the widget.
</p>
<p>
- <a class="link" href="GtkDataTextView.html#GtkDataTextView--max-length-bytes" title='The "max-length-bytes" property'><span class="type">"max-length-bytes"</span></a> - set the maximum byte
length for the contents of the widget.
</p>
<p>
The main reason for this widget is to provide a length limit
for text contents, required by SQL database systems. There
is always a limit, no matter what you do.
Some database systems may handle character length of UTF-8
strings correctly, others may not. Choose the appropriate
limit for your system, characters or bytes.
Note that setting a byte length limit > 0 on a datatextview
may slow down text insertions. The byte length limit is
imposed upon <a
href="http://library.gnome.org/devel/gtk3/GtkTextBuffer.html#gtk-text-buffer-get-text"
><code class="function">gtk_text_buffer_get_text()</code></a> including invisible
content. See <a
href="http://library.gnome.org/devel/gtk3/GtkTextBuffer.html#gtk-text-buffer-get-text"
><code class="function">gtk_text_buffer_get_text()</code></a> for details.</p>
<p>
</p>
</div>
<div class="refsect1" title="Details">
<a name="GtkDataTextView.details"></a><h2>Details</h2>
<div class="refsect2" title="GtkDataTextView">
<a name="GtkDataTextView-struct"></a><h3>GtkDataTextView</h3>
<pre class="programlisting">typedef struct _GtkDataTextView GtkDataTextView;</pre>
<p>
The GtkDataTextView struct contains only private data. It should
only be accessed through the functions described below.</p>
<p>
</p>
</div>
<hr>
<div class="refsect2" title="gtk_data_text_view_new ()">
<a name="gtk-data-text-view-new"></a><h3>gtk_data_text_view_new ()</h3>
<pre class="programlisting"><a class="link" href="GtkDataTextView.html" title="GtkDataTextView">GtkDataTextView</a> * gtk_data_text_view_new (void);</pre>
<p>
Creates a new GtkDataTextView Widget.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the new GtkDataTextView Widget
</td>
</tr></tbody>
</table></div>
<p class="since">Since 3.0.6</p>
</div>
<hr>
<div class="refsect2" title="gtk_data_text_view_get_description ()">
<a name="gtk-data-text-view-get-description"></a><h3>gtk_data_text_view_get_description ()</h3>
<pre class="programlisting">const <a
href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> * gtk_data_text_view_get_description (<a class="link" href="GtkDataTextView.html" title="GtkDataTextView">GtkDataTextView</a> *data_text_view);</pre>
<p>
Retrieves the <a class="link" href="GtkDataTextView.html" title="GtkDataTextView"><span class="type">GtkDataTextView</span></a> description.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>data_text_view</code></em> :</span></p></td>
<td> a <a class="link" href="GtkDataTextView.html" title="GtkDataTextView"><span class="type">GtkDataTextView</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a pointer to the contents of the widget as a
string. This string points to internally allocated
storage in the widget and must not be freed, modified or
stored.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.0.6</p>
</div>
<hr>
<div class="refsect2" title="gtk_data_text_view_get_max_length ()">
<a name="gtk-data-text-view-get-max-length"></a><h3>gtk_data_text_view_get_max_length ()</h3>
<pre class="programlisting"><a
href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"
>gint</a> gtk_data_text_view_get_max_length (<a class="link" href="GtkDataTextView.html" title="GtkDataTextView">GtkDataTextView</a> *data_text_view);</pre>
<p>
Retrieves the maximum character length for the contents of
<a class="link" href="GtkDataTextView.html" title="GtkDataTextView"><span class="type">GtkDataTextView</span></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>data_text_view</code></em> :</span></p></td>
<td> a <a class="link" href="GtkDataTextView.html" title="GtkDataTextView"><span class="type">GtkDataTextView</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> maximum byte length or 0.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.0.6</p>
</div>
<hr>
<div class="refsect2" title="gtk_data_text_view_get_max_length_bytes ()">
<a name="gtk-data-text-view-get-max-length-bytes"></a><h3>gtk_data_text_view_get_max_length_bytes ()</h3>
<pre class="programlisting"><a
href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"
>gint</a> gtk_data_text_view_get_max_length_bytes
(<a class="link" href="GtkDataTextView.html" title="GtkDataTextView">GtkDataTextView</a> *data_text_view);</pre>
<p>
Retrieves the maximum byte length for the contents of
<a class="link" href="GtkDataTextView.html" title="GtkDataTextView"><span class="type">GtkDataTextView</span></a> data_format.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>data_text_view</code></em> :</span></p></td>
<td> a <a class="link" href="GtkDataTextView.html" title="GtkDataTextView"><span class="type">GtkDataTextView</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> maximum byte length or 0.
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.0.6</p>
</div>
<hr>
<div class="refsect2" title="gtk_data_text_view_set_description ()">
<a name="gtk-data-text-view-set-description"></a><h3>gtk_data_text_view_set_description ()</h3>
<pre class="programlisting">void gtk_data_text_view_set_description (<a class="link" href="GtkDataTextView.html" title="GtkDataTextView">GtkDataTextView</a> *data_text_view,
const <a
href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a> *description);</pre>
<p>
Sets the GtkDataTextView description.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>data_text_view</code></em> :</span></p></td>
<td> a <a class="link" href="GtkDataTextView.html" title="GtkDataTextView"><span class="type">GtkDataTextView</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>description</code></em> :</span></p></td>
<td> the description or NULL
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.0.6</p>
</div>
<hr>
<div class="refsect2" title="gtk_data_text_view_set_max_length ()">
<a name="gtk-data-text-view-set-max-length"></a><h3>gtk_data_text_view_set_max_length ()</h3>
<pre class="programlisting">void gtk_data_text_view_set_max_length (<a class="link" href="GtkDataTextView.html" title="GtkDataTextView">GtkDataTextView</a> *data_text_view,
<a
href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"
>gint</a> max_length);</pre>
<p>
Sets the maximum character length for the contents of the
<a class="link" href="GtkDataTextView.html" title="GtkDataTextView"><span class="type">GtkDataTextView</span></a>. Existing content will not be truncted.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>data_text_view</code></em> :</span></p></td>
<td> a <a class="link" href="GtkDataTextView.html" title="GtkDataTextView"><span class="type">GtkDataTextView</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>max_length</code></em> :</span></p></td>
<td> maximum character length or 0
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.0.6</p>
</div>
<hr>
<div class="refsect2" title="gtk_data_text_view_set_max_length_bytes ()">
<a name="gtk-data-text-view-set-max-length-bytes"></a><h3>gtk_data_text_view_set_max_length_bytes ()</h3>
<pre class="programlisting">void gtk_data_text_view_set_max_length_bytes
(<a class="link" href="GtkDataTextView.html" title="GtkDataTextView">GtkDataTextView</a> *data_text_view,
<a
href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"
>gint</a> max_length_bytes);</pre>
<p>
Sets the maximum byte length for the contents of the
GtkDataTextView. Existing content will not be truncted.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>data_text_view</code></em> :</span></p></td>
<td> a <a class="link" href="GtkDataTextView.html" title="GtkDataTextView"><span class="type">GtkDataTextView</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>max_length_bytes</code></em> :</span></p></td>
<td> maximum byte length or 0
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 3.0.6</p>
</div>
</div>
<div class="refsect1" title="Property Details">
<a name="GtkDataTextView.property-details"></a><h2>Property Details</h2>
<div class="refsect2" title='The "description" property'>
<a name="GtkDataTextView--description"></a><h3>The <code class="literal">"description"</code> property</h3>
<pre class="programlisting"> "description" <a
href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"
>gchar</a>* : Read / Write</pre>
<p>
Description of the GtkDataTextView, no functionality, a place
for private information that cannot be put anywhere else.</p>
<p>
</p>
<p>Default value: ""</p>
<p>Since 3.0.6</p>
</div>
<hr>
<div class="refsect2" title='The "max-length" property'>
<a name="GtkDataTextView--max-length"></a><h3>The <code class="literal">"max-length"</code> property</h3>
<pre class="programlisting"> "max-length" <a
href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"
>gint</a> : Read / Write</pre>
<p>
Set the maximum length in characters for the GtkDataTextView.
For details see <a class="link" href="GtkDataTextView.html#gtk-data-text-view-set-max-length" title="gtk_data_text_view_set_max_length ()"><span class="type">gtk_data_text_view_set_max_length</span></a>.
</p>
<p>
Sometimes, systems cannot handle UTF-8 string length
correctly, to overcome this problem, you can use the maximum
string length in bytes. When setting both limits, max-length
and max-length-bytes, both must be fulfilled.</p>
<p>
</p>
<p>Allowed values: [0,1073741823]</p>
<p>Default value: 0</p>
<p>Since 3.0.6</p>
</div>
<hr>
<div class="refsect2" title='The "max-length-bytes" property'>
<a name="GtkDataTextView--max-length-bytes"></a><h3>The <code class="literal">"max-length-bytes"</code> property</h3>
<pre class="programlisting"> "max-length-bytes" <a
href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint"
>gint</a> : Read / Write</pre>
<p>
Set the maximum length in bytes for the GtkDataTextView. For
details see <a class="link" href="GtkDataTextView.html#gtk-data-text-view-set-max-length-bytes" title="gtk_data_text_view_set_max_length_bytes ()"><span class="type">gtk_data_text_view_set_max_length_bytes</span></a>.
</p>
<p>
Sometimes, systems cannot handle UTF-8 string length
correctly, to overcome this problem, you can use the maximum
string length in bytes. When setting both limits, max-length
and max-length-bytes, both must be fulfilled.</p>
<p>
</p>
<p>Allowed values: [0,1073741823]</p>
<p>Default value: 0</p>
<p>Since 3.0.6</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.11</div>
</body>
</html>
|