/usr/share/gtk-doc/html/libsexy/SexyIconEntry.html is in libsexy-doc 0.1.11-2.1ubuntu1.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>SexyIconEntry</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
<link rel="start" href="index.html" title="libsexy Reference Manual">
<link rel="up" href="ch01.html" title="libsexy">
<link rel="prev" href="SexyTreeView.html" title="SexyTreeView">
<link rel="next" href="SexyTooltip.html" title="SexyTooltip">
<meta name="generator" content="GTK-Doc V1.7 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="libsexy">
</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="SexyTreeView.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.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">libsexy Reference Manual</th>
<td><a accesskey="n" href="SexyTooltip.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2529276" class="shortcut">Top</a>
 | 
<a href="#id2544795" class="shortcut">Description</a>
 | 
<a href="#id2566064" class="shortcut">Object Hierarchy</a>
 | 
<a href="#id2543480" class="shortcut">Implemented Interfaces</a>
 | 
<a href="#id2543513" class="shortcut">Signals</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="SexyIconEntry"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id2529276"></a><span class="refentrytitle">SexyIconEntry</span>
</h2>
<p>SexyIconEntry — A GtkEntry with support for inline icons.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
<a href="SexyIconEntry.html#SexyIconEntry-struct">SexyIconEntry</a>;
enum <a href="SexyIconEntry.html#SexyIconEntryPosition">SexyIconEntryPosition</a>;
GtkWidget* <a href="SexyIconEntry.html#sexy-icon-entry-new">sexy_icon_entry_new</a> (void);
void <a href="SexyIconEntry.html#sexy-icon-entry-set-icon">sexy_icon_entry_set_icon</a> (<a href="SexyIconEntry.html" title="SexyIconEntry">SexyIconEntry</a> *entry,
<a href="SexyIconEntry.html#SexyIconEntryPosition">SexyIconEntryPosition</a> position,
GtkImage *icon);
void <a href="SexyIconEntry.html#sexy-icon-entry-set-icon-highlight">sexy_icon_entry_set_icon_highlight</a>
(<a href="SexyIconEntry.html" title="SexyIconEntry">SexyIconEntry</a> *entry,
<a href="SexyIconEntry.html#SexyIconEntryPosition">SexyIconEntryPosition</a> position,
gboolean highlight);
GtkImage* <a href="SexyIconEntry.html#sexy-icon-entry-get-icon">sexy_icon_entry_get_icon</a> (const <a href="SexyIconEntry.html" title="SexyIconEntry">SexyIconEntry</a> *entry,
<a href="SexyIconEntry.html#SexyIconEntryPosition">SexyIconEntryPosition</a> position);
gboolean <a href="SexyIconEntry.html#sexy-icon-entry-get-icon-highlight">sexy_icon_entry_get_icon_highlight</a>
(const <a href="SexyIconEntry.html" title="SexyIconEntry">SexyIconEntry</a> *entry,
<a href="SexyIconEntry.html#SexyIconEntryPosition">SexyIconEntryPosition</a> position);
void <a href="SexyIconEntry.html#sexy-icon-entry-add-clear-button">sexy_icon_entry_add_clear_button</a>
(<a href="SexyIconEntry.html" title="SexyIconEntry">SexyIconEntry</a> *icon_entry);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2566064"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----GInitiallyUnowned
+----GtkObject
+----GtkWidget
+----GtkEntry
+----SexyIconEntry
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2543480"></a><h2>Implemented Interfaces</h2>
<p>
SexyIconEntry implements
GtkEditable, AtkImplementorIface and GtkCellEditable.</p>
</div>
<div class="refsect1" lang="en">
<a name="id2543513"></a><h2>Signals</h2>
<pre class="synopsis">
"<a href="SexyIconEntry.html#SexyIconEntry-icon-pressed">icon-pressed</a>"
void user_function (<a href="SexyIconEntry.html" title="SexyIconEntry">SexyIconEntry</a> *entry,
gint icon_pos,
gint button,
gpointer user_data) : Run last / Action
"<a href="SexyIconEntry.html#SexyIconEntry-icon-released">icon-released</a>"
void user_function (<a href="SexyIconEntry.html" title="SexyIconEntry">SexyIconEntry</a> *entry,
gint icon_pos,
gint button,
gpointer user_data) : Run last / Action
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id2544795"></a><h2>Description</h2>
<p>
SexyIconEntry is a GtkEntry with support for inline icons. They can appear on
either side of the entry or on both sides. There's also built-in support for
adding a clear button for clearing the entry. This widget is particularly
useful as search fields.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id2544815"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2544826"></a><h3>
<a name="SexyIconEntry-struct"></a>SexyIconEntry</h3>
<a class="indexterm" name="id2544837"></a><pre class="programlisting">typedef struct _SexyIconEntry SexyIconEntry;</pre>
<p>
The <a href="SexyIconEntry.html" title="SexyIconEntry"><span class="type">SexyIconEntry</span></a> struct contains private data only, and should be manipulated using the functions below.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2544862"></a><h3>
<a name="SexyIconEntryPosition"></a>enum SexyIconEntryPosition</h3>
<a class="indexterm" name="id2544874"></a><pre class="programlisting">typedef enum
{
SEXY_ICON_ENTRY_PRIMARY,
SEXY_ICON_ENTRY_SECONDARY
} SexyIconEntryPosition;
</pre>
<p>
The position used when setting or retrieving an icon.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><a name="SEXY-ICON-ENTRY-PRIMARY:CAPS"></a><code class="literal">SEXY_ICON_ENTRY_PRIMARY</code></span></td>
<td>Icon at the beginning of the entry (left for LTR languages, right for RTL).
</td>
</tr>
<tr>
<td>
<span class="term"><a name="SEXY-ICON-ENTRY-SECONDARY:CAPS"></a><code class="literal">SEXY_ICON_ENTRY_SECONDARY</code></span></td>
<td>Icon at the end of the entry.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2544940"></a><h3>
<a name="sexy-icon-entry-new"></a>sexy_icon_entry_new ()</h3>
<a class="indexterm" name="id2544952"></a><pre class="programlisting">GtkWidget* sexy_icon_entry_new (void);</pre>
<p>
Creates a new SexyIconEntry widget.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>a new <a href="SexyIconEntry.html" title="SexyIconEntry"><span class="type">SexyIconEntry</span></a>.
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2544998"></a><h3>
<a name="sexy-icon-entry-set-icon"></a>sexy_icon_entry_set_icon ()</h3>
<a class="indexterm" name="id2545010"></a><pre class="programlisting">void sexy_icon_entry_set_icon (<a href="SexyIconEntry.html" title="SexyIconEntry">SexyIconEntry</a> *entry,
<a href="SexyIconEntry.html#SexyIconEntryPosition">SexyIconEntryPosition</a> position,
GtkImage *icon);</pre>
<p>
Sets the icon shown in the entry</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
<td> A <a href="SexyIconEntry.html" title="SexyIconEntry"><span class="type">SexyIconEntry</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>position</code></em> :</span></td>
<td> Icon position.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>icon</code></em> :</span></td>
<td> A <span class="type">GtkImage</span> to set as the icon.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2530916"></a><h3>
<a name="sexy-icon-entry-set-icon-highlight"></a>sexy_icon_entry_set_icon_highlight ()</h3>
<a class="indexterm" name="id2530930"></a><pre class="programlisting">void sexy_icon_entry_set_icon_highlight
(<a href="SexyIconEntry.html" title="SexyIconEntry">SexyIconEntry</a> *entry,
<a href="SexyIconEntry.html#SexyIconEntryPosition">SexyIconEntryPosition</a> position,
gboolean highlight);</pre>
<p>
Determines whether the icon will highlight on mouse-over.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
<td> A <a href="SexyIconEntry.html" title="SexyIconEntry"><span class="type">SexyIconEntry</span></a>;
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>position</code></em> :</span></td>
<td> Icon position.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>highlight</code></em> :</span></td>
<td> TRUE if the icon should highlight on mouse-over
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2531030"></a><h3>
<a name="sexy-icon-entry-get-icon"></a>sexy_icon_entry_get_icon ()</h3>
<a class="indexterm" name="id2531042"></a><pre class="programlisting">GtkImage* sexy_icon_entry_get_icon (const <a href="SexyIconEntry.html" title="SexyIconEntry">SexyIconEntry</a> *entry,
<a href="SexyIconEntry.html#SexyIconEntryPosition">SexyIconEntryPosition</a> position);</pre>
<p>
Retrieves the image used for the icon</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
<td> A <a href="SexyIconEntry.html" title="SexyIconEntry"><span class="type">SexyIconEntry</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>position</code></em> :</span></td>
<td> Icon position.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> A <span class="type">GtkImage</span>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2567796"></a><h3>
<a name="sexy-icon-entry-get-icon-highlight"></a>sexy_icon_entry_get_icon_highlight ()</h3>
<a class="indexterm" name="id2567809"></a><pre class="programlisting">gboolean sexy_icon_entry_get_icon_highlight
(const <a href="SexyIconEntry.html" title="SexyIconEntry">SexyIconEntry</a> *entry,
<a href="SexyIconEntry.html#SexyIconEntryPosition">SexyIconEntryPosition</a> position);</pre>
<p>
Retrieves whether entry will highlight the icon on mouseover.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
<td> A <a href="SexyIconEntry.html" title="SexyIconEntry"><span class="type">SexyIconEntry</span></a>.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>position</code></em> :</span></td>
<td> Icon position.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> TRUE if icon highlights.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2567889"></a><h3>
<a name="sexy-icon-entry-add-clear-button"></a>sexy_icon_entry_add_clear_button ()</h3>
<a class="indexterm" name="id2567902"></a><pre class="programlisting">void sexy_icon_entry_add_clear_button
(<a href="SexyIconEntry.html" title="SexyIconEntry">SexyIconEntry</a> *icon_entry);</pre>
<p>
A convenience function to add a clear button to the end of the entry.
This is useful for search boxes.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td>
<span class="term"><em class="parameter"><code>icon_entry</code></em> :</span></td>
<td> A <a href="SexyIconEntry.html" title="SexyIconEntry"><span class="type">SexyIconEntry</span></a>.
</td>
</tr></tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2567964"></a><h2>Signal Details</h2>
<div class="refsect2" lang="en">
<a name="id2567974"></a><h3>
<a name="SexyIconEntry-icon-pressed"></a>The "icon-pressed" signal</h3>
<a class="indexterm" name="id2567982"></a><pre class="programlisting">void user_function (<a href="SexyIconEntry.html" title="SexyIconEntry">SexyIconEntry</a> *entry,
gint icon_pos,
gint button,
gpointer user_data) : Run last / Action</pre>
<p>
The ::icon-pressed signal is emitted when an icon is clicked.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
<td> The entry on which the signal is emitted.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>icon_pos</code></em> :</span></td>
<td> The position of the clicked icon.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>button</code></em> :</span></td>
<td> The mouse button clicked.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2568097"></a><h3>
<a name="SexyIconEntry-icon-released"></a>The "icon-released" signal</h3>
<a class="indexterm" name="id2568104"></a><pre class="programlisting">void user_function (<a href="SexyIconEntry.html" title="SexyIconEntry">SexyIconEntry</a> *entry,
gint icon_pos,
gint button,
gpointer user_data) : Run last / Action</pre>
<p>
The ::icon-released signal is emitted on the button release from a
mouse click.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>entry</code></em> :</span></td>
<td> The entry on which the signal is emitted.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>icon_pos</code></em> :</span></td>
<td> The position of the clicked icon.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>button</code></em> :</span></td>
<td> The mouse button clicked.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>user_data</code></em> :</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>
|