/usr/share/gtk-doc/html/libgwydgets/GwySciText.html is in libgwyddion20-doc 2.34-3ubuntu1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Gwyddion Widgets Library Reference Manual: GwySciText</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Gwyddion Widgets Library Reference Manual">
<link rel="up" href="GeneralWidgets.html" title="General Widgets">
<link rel="prev" href="GwyHMarkerBox.html" title="GwyHMarkerBox">
<link rel="next" href="GwyStatusbar.html" title="GwyStatusbar">
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</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="10"><tr valign="middle">
<td width="100%" align="left">
<a href="#" class="shortcut">Top</a>
|
<a href="#GwySciText.description" class="shortcut">Description</a>
|
<a href="#GwySciText.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GwySciText.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#GwySciText.properties" class="shortcut">Properties</a>
|
<a href="#GwySciText.signals" class="shortcut">Signals</a>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="GeneralWidgets.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GwyHMarkerBox.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GwyStatusbar.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GwySciText"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GwySciText.top_of_page"></a>GwySciText</span></h2>
<p>GwySciText — Text entry with markup and special symbol helper widgets</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GwySciText.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libgwydgets/gwydgets.h>
struct <a class="link" href="GwySciText.html#GwySciText-struct" title="struct GwySciText">GwySciText</a>;
struct <a class="link" href="GwySciText.html#GwySciTextClass" title="struct GwySciTextClass">GwySciTextClass</a>;
<a href="http://developer.gnome.org/doc/API/2.0/gtk/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * <a class="link" href="GwySciText.html#gwy-sci-text-new" title="gwy_sci_text_new ()">gwy_sci_text_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="GwySciText.html#gwy-sci-text-get-text" title="gwy_sci_text_get_text ()">gwy_sci_text_get_text</a> (<em class="parameter"><code><a class="link" href="GwySciText.html" title="GwySciText"><span class="type">GwySciText</span></a> *sci_text</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GwySciText.html#gwy-sci-text-set-text" title="gwy_sci_text_set_text ()">gwy_sci_text_set_text</a> (<em class="parameter"><code><a class="link" href="GwySciText.html" title="GwySciText"><span class="type">GwySciText</span></a> *sci_text</code></em>,
<em class="parameter"><code>const <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *new_text</code></em>);
<a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GwySciText.html#gwy-sci-text-get-has-preview" title="gwy_sci_text_get_has_preview ()">gwy_sci_text_get_has_preview</a> (<em class="parameter"><code><a class="link" href="GwySciText.html" title="GwySciText"><span class="type">GwySciText</span></a> *sci_text</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GwySciText.html#gwy-sci-text-set-has-preview" title="gwy_sci_text_set_has_preview ()">gwy_sci_text_set_has_preview</a> (<em class="parameter"><code><a class="link" href="GwySciText.html" title="GwySciText"><span class="type">GwySciText</span></a> *sci_text</code></em>,
<em class="parameter"><code><a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> has_preview</code></em>);
<a href="http://developer.gnome.org/doc/API/2.0/gtk/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * <a class="link" href="GwySciText.html#gwy-sci-text-get-entry" title="gwy_sci_text_get_entry ()">gwy_sci_text_get_entry</a> (<em class="parameter"><code><a class="link" href="GwySciText.html" title="GwySciText"><span class="type">GwySciText</span></a> *sci_text</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GwySciText.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="http://developer.gnome.org/doc/API/2.0/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----<a href="http://developer.gnome.org/doc/API/2.0/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
+----<a href="http://developer.gnome.org/doc/API/2.0/gtk/GtkObject.html">GtkObject</a>
+----<a href="http://developer.gnome.org/doc/API/2.0/gtk/GtkWidget.html">GtkWidget</a>
+----<a href="http://developer.gnome.org/doc/API/2.0/gtk/GtkContainer.html">GtkContainer</a>
+----<a href="http://developer.gnome.org/doc/API/2.0/gtk/GtkBox.html">GtkBox</a>
+----<a href="http://developer.gnome.org/doc/API/2.0/gtk/GtkVBox.html">GtkVBox</a>
+----GwySciText
</pre>
</div>
<div class="refsect1">
<a name="GwySciText.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GwySciText implements
AtkImplementorIface, <a href="http://developer.gnome.org/doc/API/2.0/gtk/GtkBuildable.html">GtkBuildable</a> and <a href="http://developer.gnome.org/doc/API/2.0/gtk/gtk3-Orientable.html#GtkOrientable">GtkOrientable</a>.</p>
</div>
<div class="refsect1">
<a name="GwySciText.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="GwySciText.html#GwySciText--has-preview" title='The "has-preview" property'>has-preview</a>" <a href="http://developer.gnome.org/doc/API/2.0/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
</pre>
</div>
<div class="refsect1">
<a name="GwySciText.signals"></a><h2>Signals</h2>
<pre class="synopsis">
"<a class="link" href="GwySciText.html#GwySciText-edited" title='The "edited" signal'>edited</a>" : <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a>
</pre>
</div>
<div class="refsect1">
<a name="GwySciText.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="GwySciText.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GwySciText-struct"></a><h3>struct GwySciText</h3>
<pre class="programlisting">struct GwySciText;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="GwySciTextClass"></a><h3>struct GwySciTextClass</h3>
<pre class="programlisting">struct GwySciTextClass {
GtkVBoxClass parent_class;
/* Signals */
void (*edited)(GwySciText *sci_text);
void (*reserved1)(void);
void (*reserved2)(void);
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gwy-sci-text-new"></a><h3>gwy_sci_text_new ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * gwy_sci_text_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Creates a new scientific text entry.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A newly created scientific text entry.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-sci-text-get-text"></a><h3>gwy_sci_text_get_text ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gwy_sci_text_get_text (<em class="parameter"><code><a class="link" href="GwySciText.html" title="GwySciText"><span class="type">GwySciText</span></a> *sci_text</code></em>);</pre>
<p>
Gets the text in a scientific text entry.
</p>
<p>
The text is already in UTF-8 with all entities converted.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>sci_text</code></em> :</span></p></td>
<td>A scientific text widget.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The text as a newly allocated string. It should be freed when no
longer used.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-sci-text-set-text"></a><h3>gwy_sci_text_set_text ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_sci_text_set_text (<em class="parameter"><code><a class="link" href="GwySciText.html" title="GwySciText"><span class="type">GwySciText</span></a> *sci_text</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *new_text</code></em>);</pre>
<p>
Sets the text a scientific text widget displays.
</p>
<p>
It can contain both UTF-8 and entities. UTF-8 characters corresponding to
known entities are converted to entities, other characters are left as they
are.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>sci_text</code></em> :</span></p></td>
<td>A scientific text widget.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>new_text</code></em> :</span></p></td>
<td>The text to display.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-sci-text-get-has-preview"></a><h3>gwy_sci_text_get_has_preview ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gwy_sci_text_get_has_preview (<em class="parameter"><code><a class="link" href="GwySciText.html" title="GwySciText"><span class="type">GwySciText</span></a> *sci_text</code></em>);</pre>
<p>
Tests the display of a preview in a scientific text entry.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>sci_text</code></em> :</span></p></td>
<td>A scientific text widget.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if there is a preview, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if preview is not shown.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-sci-text-set-has-preview"></a><h3>gwy_sci_text_set_has_preview ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gwy_sci_text_set_has_preview (<em class="parameter"><code><a class="link" href="GwySciText.html" title="GwySciText"><span class="type">GwySciText</span></a> *sci_text</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> has_preview</code></em>);</pre>
<p>
Sets the display of a preview in a scientific text entry.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>sci_text</code></em> :</span></p></td>
<td>A scientific text widget.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>has_preview</code></em> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to display a preview, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> to disable it.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gwy-sci-text-get-entry"></a><h3>gwy_sci_text_get_entry ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/gtk3/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * gwy_sci_text_get_entry (<em class="parameter"><code><a class="link" href="GwySciText.html" title="GwySciText"><span class="type">GwySciText</span></a> *sci_text</code></em>);</pre>
<p>
Gets the entry widget of a scientific text entry.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>sci_text</code></em> :</span></p></td>
<td>A scientific text widget.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The entry widget, no reference is added.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="GwySciText.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GwySciText--has-preview"></a><h3>The <code class="literal">"has-preview"</code> property</h3>
<pre class="programlisting"> "has-preview" <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
<p>
The :has-preview property controls whether a <a class="link" href="GwySciText.html" title="GwySciText"><span class="type">GwySciText</span></a> has a preview.
</p>
<p>Default value: TRUE</p>
</div>
</div>
<div class="refsect1">
<a name="GwySciText.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="GwySciText-edited"></a><h3>The <code class="literal">"edited"</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="GwySciText.html" title="GwySciText"><span class="type">GwySciText</span></a> *gwyscitext,
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="/usr/share/gtk-doc/html/gobject/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a></pre>
<p>
The ::edited signal is emitted when the text in its entry changes
to a valid markup. If you need to react to all changes in entry
contents, you can use <a class="link" href="GwySciText.html#gwy-sci-text-get-entry" title="gwy_sci_text_get_entry ()"><code class="function">gwy_sci_text_get_entry()</code></a> to get the entry and
connect to its signal.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>gwyscitext</code></em> :</span></p></td>
<td>The <a class="link" href="GwySciText.html" title="GwySciText"><span class="type">GwySciText</span></a> which received the signal.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|