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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GnomeHRef</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="GNOME UI Library Reference Manual">
<link rel="up" href="fixme.html" title="Miscellaneous Widgets">
<link rel="prev" href="libgnomeui-gnome-dateedit.html" title="GnomeDateEdit">
<link rel="next" href="libgnomeui-GnomeIce.html" title="gnome-ice">
<meta name="generator" content="GTK-Doc V1.16 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="libgnomeui-gnome-dateedit.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="fixme.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">GNOME UI Library Reference Manual</th>
<td><a accesskey="n" href="libgnomeui-GnomeIce.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GnomeHRef.synopsis" class="shortcut">Top</a>
|
<a href="#GnomeHRef.description" class="shortcut">Description</a>
|
<a href="#GnomeHRef.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GnomeHRef.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#GnomeHRef.properties" class="shortcut">Properties</a>
|
<a href="#GnomeHRef.style-properties" class="shortcut">Style Properties</a>
</td></tr>
</table>
<div class="refentry">
<a name="GnomeHRef"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GnomeHRef.top_of_page"></a>GnomeHRef</span></h2>
<p>GnomeHRef</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GnomeHRef.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <libgnomeui/libgnomeui.h>
struct <a class="link" href="GnomeHRef.html#GnomeHRef-struct" title="struct GnomeHRef">GnomeHRef</a>;
<a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * <a class="link" href="GnomeHRef.html#gnome-href-new" title="gnome_href_new ()">gnome_href_new</a> (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *url</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *text</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GnomeHRef.html#gnome-href-set-url" title="gnome_href_set_url ()">gnome_href_set_url</a> (<em class="parameter"><code><a class="link" href="GnomeHRef.html" title="GnomeHRef"><span class="type">GnomeHRef</span></a> *href</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *url</code></em>);
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="GnomeHRef.html#gnome-href-get-url" title="gnome_href_get_url ()">gnome_href_get_url</a> (<em class="parameter"><code><a class="link" href="GnomeHRef.html" title="GnomeHRef"><span class="type">GnomeHRef</span></a> *href</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GnomeHRef.html#gnome-href-set-text" title="gnome_href_set_text ()">gnome_href_set_text</a> (<em class="parameter"><code><a class="link" href="GnomeHRef.html" title="GnomeHRef"><span class="type">GnomeHRef</span></a> *href</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *text</code></em>);
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="GnomeHRef.html#gnome-href-get-text" title="gnome_href_get_text ()">gnome_href_get_text</a> (<em class="parameter"><code><a class="link" href="GnomeHRef.html" title="GnomeHRef"><span class="type">GnomeHRef</span></a> *href</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GnomeHRef.html#gnome-href-set-label" title="gnome_href_set_label ()">gnome_href_set_label</a> (<em class="parameter"><code><a class="link" href="GnomeHRef.html" title="GnomeHRef"><span class="type">GnomeHRef</span></a> *href</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *label</code></em>);
const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="GnomeHRef.html#gnome-href-get-label" title="gnome_href_get_label ()">gnome_href_get_label</a> (<em class="parameter"><code><a class="link" href="GnomeHRef.html" title="GnomeHRef"><span class="type">GnomeHRef</span></a> *href</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GnomeHRef.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
+----<a href="http://library.gnome.org/devel/gtk/unstable/GtkObject.html">GtkObject</a>
+----<a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html">GtkWidget</a>
+----<a href="http://library.gnome.org/devel/gtk/unstable/GtkContainer.html">GtkContainer</a>
+----<a href="http://library.gnome.org/devel/gtk/unstable/GtkBin.html">GtkBin</a>
+----<a href="http://library.gnome.org/devel/gtk/unstable/GtkButton.html">GtkButton</a>
+----GnomeHRef
</pre>
</div>
<div class="refsect1">
<a name="GnomeHRef.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GnomeHRef implements
AtkImplementorIface, <a href="http://library.gnome.org/devel/gtk/unstable/GtkBuildable.html">GtkBuildable</a> and <a href="http://library.gnome.org/devel/gtk/unstable/GtkActivatable.html">GtkActivatable</a>.</p>
</div>
<div class="refsect1">
<a name="GnomeHRef.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="GnomeHRef.html#GnomeHRef--text" title='The "text" property'>text</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write
"<a class="link" href="GnomeHRef.html#GnomeHRef--url" title='The "url" property'>url</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write
</pre>
</div>
<div class="refsect1">
<a name="GnomeHRef.style-properties"></a><h2>Style Properties</h2>
<pre class="synopsis">
"<a class="link" href="GnomeHRef.html#GnomeHRef--s-link-color" title='The "link-color" style property'>link-color</a>" <a href="http://library.gnome.org/devel/gdk/unstable/gdk-Colormaps-and-Colors.html#GdkColor"><span class="type">GdkColor</span></a>* : Read
</pre>
</div>
<div class="refsect1">
<a name="GnomeHRef.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="GnomeHRef.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GnomeHRef-struct"></a><h3>struct GnomeHRef</h3>
<pre class="programlisting">struct GnomeHRef;</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">GnomeHRef</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gnome-href-new"></a><h3>gnome_href_new ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/gtk/unstable/GtkWidget.html"><span class="returnvalue">GtkWidget</span></a> * gnome_href_new (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *url</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *text</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_href_new</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Created a GNOME href object, a label widget with a clickable action
and an associated URL. If <em class="parameter"><code>text</code></em> is set to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, <em class="parameter"><code>url</code></em> is used as
the text for the label.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>url</code></em> :</span></p></td>
<td>URL assigned to this object.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
<td>Text associated with the URL.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Pointer to new GNOME href widget.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-href-set-url"></a><h3>gnome_href_set_url ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gnome_href_set_url (<em class="parameter"><code><a class="link" href="GnomeHRef.html" title="GnomeHRef"><span class="type">GnomeHRef</span></a> *href</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *url</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_href_set_url</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Sets the internal URL value within <em class="parameter"><code>href</code></em> to the value of <em class="parameter"><code>url</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>href</code></em> :</span></p></td>
<td>Pointer to GnomeHRef widget</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>url</code></em> :</span></p></td>
<td>String containing the URL to be stored within <em class="parameter"><code>href</code></em>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-href-get-url"></a><h3>gnome_href_get_url ()</h3>
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gnome_href_get_url (<em class="parameter"><code><a class="link" href="GnomeHRef.html" title="GnomeHRef"><span class="type">GnomeHRef</span></a> *href</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_href_get_url</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Returns the pointer to the URL associated with the <em class="parameter"><code>href</code></em> href object. Note
that the string should not be freed as it is internal memory.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>href</code></em> :</span></p></td>
<td>Pointer to GnomeHRef widget</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Pointer to an internal URL string, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if failure.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-href-set-text"></a><h3>gnome_href_set_text ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gnome_href_set_text (<em class="parameter"><code><a class="link" href="GnomeHRef.html" title="GnomeHRef"><span class="type">GnomeHRef</span></a> *href</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *text</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_href_set_text</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Sets the internal label widget text (used to display a URL's link
text) to the value given in <em class="parameter"><code>label</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>href</code></em> :</span></p></td>
<td>Pointer to GnomeHRef widget</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
<td>New link text for the href object.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-href-get-text"></a><h3>gnome_href_get_text ()</h3>
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gnome_href_get_text (<em class="parameter"><code><a class="link" href="GnomeHRef.html" title="GnomeHRef"><span class="type">GnomeHRef</span></a> *href</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_href_get_text</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Returns the contents of the label widget used to display the link text.
Note that the string should not be freed as it points to internal memory.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>href</code></em> :</span></p></td>
<td>Pointer to GnomeHRef widget</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Pointer to text contained in the label widget.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-href-set-label"></a><h3>gnome_href_set_label ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gnome_href_set_label (<em class="parameter"><code><a class="link" href="GnomeHRef.html" title="GnomeHRef"><span class="type">GnomeHRef</span></a> *href</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *label</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_href_set_label</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
deprecated, use <a class="link" href="GnomeHRef.html#gnome-href-set-text" title="gnome_href_set_text ()"><span class="type">gnome_href_set_text</span></a>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>href</code></em> :</span></p></td>
<td>Pointer to GnomeHRef widget</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>label</code></em> :</span></p></td>
<td>New link text for the href object.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gnome-href-get-label"></a><h3>gnome_href_get_label ()</h3>
<pre class="programlisting">const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gnome_href_get_label (<em class="parameter"><code><a class="link" href="GnomeHRef.html" title="GnomeHRef"><span class="type">GnomeHRef</span></a> *href</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gnome_href_get_label</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Deprecated, use <a class="link" href="GnomeHRef.html#gnome-href-get-text" title="gnome_href_get_text ()"><span class="type">gnome_href_get_text</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>href</code></em> :</span></p></td>
<td>Pointer to GnomeHRef widget</td>
</tr></tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="GnomeHRef.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GnomeHRef--text"></a><h3>The <code class="literal">"text"</code> property</h3>
<pre class="programlisting"> "text" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre>
<p>The text on the button.</p>
<p>Default value: "End World Hunger"</p>
</div>
<hr>
<div class="refsect2">
<a name="GnomeHRef--url"></a><h3>The <code class="literal">"url"</code> property</h3>
<pre class="programlisting"> "url" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre>
<p>The URL that GnomeHRef activates.</p>
<p>Default value: "http://www.wfp.org"</p>
</div>
</div>
<div class="refsect1">
<a name="GnomeHRef.style-property-details"></a><h2>Style Property Details</h2>
<div class="refsect2">
<a name="GnomeHRef--s-link-color"></a><h3>The <code class="literal">"link-color"</code> style property</h3>
<pre class="programlisting"> "link-color" <a href="http://library.gnome.org/devel/gdk/unstable/gdk-Colormaps-and-Colors.html#GdkColor"><span class="type">GdkColor</span></a>* : Read</pre>
<p>Color used to draw the link.</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.16</div>
</body>
</html>
|