|
Server : Apache/2.2.17 (Unix) mod_ssl/2.2.17 OpenSSL/0.9.8e-fips-rhel5 DAV/2 PHP/5.2.17 System : Linux localhost 2.6.18-419.el5 #1 SMP Fri Feb 24 22:47:42 UTC 2017 x86_64 User : nobody ( 99) PHP Version : 5.2.17 Disable Function : NONE Directory : /proc/21572/root/usr/share/gtk-doc/html/libgnomeui/ |
Upload File : |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>GnomeHRef</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.69.1">
<link rel="start" href="index.html" title="GNOME UI Library Reference Manual">
<link rel="up" href="fixme.html" title="Miscellaneous Widgets">
<link rel="prev" href="GnomeFontPicker.html" title="GnomeFontPicker">
<link rel="next" href="GnomeIconTextItem.html" title="GnomeIconTextItem">
<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="GNOME UI Library (libgnomeui)">
</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="GnomeFontPicker.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="GnomeIconTextItem.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="#id3029756" class="shortcut">Top</a>
 | 
<a href="#id3030140" class="shortcut">Description</a>
 | 
<a href="#id3029965" class="shortcut">Object Hierarchy</a>
 | 
<a href="#id3030033" class="shortcut">Implemented Interfaces</a>
 | 
<a href="#id3030056" class="shortcut">Properties</a>
 | 
<a href="#id3030106" class="shortcut">Style Properties</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="GnomeHRef"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id3029756"></a><span class="refentrytitle">GnomeHRef</span>
</h2>
<p>GnomeHRef — </p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
#include <libgnomeui/libgnomeui.h>
<a href="GnomeHRef.html#GnomeHRef-struct">GnomeHRef</a>;
<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a>* <a href="GnomeHRef.html#gnome-href-new">gnome_href_new</a> (const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *url,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *text);
void <a href="GnomeHRef.html#gnome-href-set-url">gnome_href_set_url</a> (<a href="GnomeHRef.html" title="GnomeHRef">GnomeHRef</a> *href,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *url);
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="GnomeHRef.html#gnome-href-get-url">gnome_href_get_url</a> (<a href="GnomeHRef.html" title="GnomeHRef">GnomeHRef</a> *href);
void <a href="GnomeHRef.html#gnome-href-set-text">gnome_href_set_text</a> (<a href="GnomeHRef.html" title="GnomeHRef">GnomeHRef</a> *href,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *text);
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="GnomeHRef.html#gnome-href-get-text">gnome_href_get_text</a> (<a href="GnomeHRef.html" title="GnomeHRef">GnomeHRef</a> *href);
void <a href="GnomeHRef.html#gnome-href-set-label">gnome_href_set_label</a> (<a href="GnomeHRef.html" title="GnomeHRef">GnomeHRef</a> *href,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *label);
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>* <a href="GnomeHRef.html#gnome-href-get-label">gnome_href_get_label</a> (<a href="GnomeHRef.html" title="GnomeHRef">GnomeHRef</a> *href);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3029965"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
>GObject</a>
+----<a
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned"
>GInitiallyUnowned</a>
+----<a
href="/usr/share/gtk-doc/html/gtk/GtkObject.html"
>GtkObject</a>
+----<a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a>
+----<a
href="/usr/share/gtk-doc/html/gtk/GtkContainer.html"
>GtkContainer</a>
+----<a
href="/usr/share/gtk-doc/html/gtk/GtkBin.html"
>GtkBin</a>
+----<a
href="/usr/share/gtk-doc/html/gtk/GtkButton.html"
>GtkButton</a>
+----GnomeHRef
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3030033"></a><h2>Implemented Interfaces</h2>
<p>
GnomeHRef implements
AtkImplementorIface.</p>
</div>
<div class="refsect1" lang="en">
<a name="id3030056"></a><h2>Properties</h2>
<pre class="synopsis">
"<a href="GnomeHRef.html#GnomeHRef--text">text</a>" <a
href="/usr/share/gtk-doc/html/gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
>gchararray</a> : Read / Write
"<a href="GnomeHRef.html#GnomeHRef--url">url</a>" <a
href="/usr/share/gtk-doc/html/gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
>gchararray</a> : Read / Write
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3030106"></a><h2>Style Properties</h2>
<pre class="synopsis">
"<a href="GnomeHRef.html#GnomeHRef--link-color">link-color</a>" <a
href="/usr/share/gtk-doc/html/gdk/gdk-Colormaps-and-Colors.html#GdkColor"
>GdkColor</a> : Read
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3030140"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="id3030154"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id3030165"></a><h3>
<a name="GnomeHRef-struct"></a>GnomeHRef</h3>
<a class="indexterm" name="id3030178"></a><pre class="programlisting">typedef struct _GnomeHRef GnomeHRef;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3030193"></a><h3>
<a name="gnome-href-new"></a>gnome_href_new ()</h3>
<a class="indexterm" name="id3030206"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/gtk/GtkWidget.html"
>GtkWidget</a>* gnome_href_new (const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *url,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *text);</pre>
<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="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.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>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>url</code></em> :</span></td>
<td> URL assigned to this object.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>text</code></em> :</span></td>
<td> Text associated with the URL.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> Pointer to new GNOME href widget.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3030312"></a><h3>
<a name="gnome-href-set-url"></a>gnome_href_set_url ()</h3>
<a class="indexterm" name="id3030325"></a><pre class="programlisting">void gnome_href_set_url (<a href="GnomeHRef.html" title="GnomeHRef">GnomeHRef</a> *href,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *url);</pre>
<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>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>href</code></em> :</span></td>
<td> Pointer to GnomeHRef widget
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>url</code></em> :</span></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" lang="en">
<a name="id3030415"></a><h3>
<a name="gnome-href-get-url"></a>gnome_href_get_url ()</h3>
<a class="indexterm" name="id3030428"></a><pre class="programlisting">const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>* gnome_href_get_url (<a href="GnomeHRef.html" title="GnomeHRef">GnomeHRef</a> *href);</pre>
<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>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>href</code></em> :</span></td>
<td> Pointer to GnomeHRef widget
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> Pointer to an internal URL string, or <a
href="/usr/share/gtk-doc/html/liboil/liboil-liboiljunk.html#NULL:CAPS"
><code class="literal">NULL</code></a> if failure.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3030508"></a><h3>
<a name="gnome-href-set-text"></a>gnome_href_set_text ()</h3>
<a class="indexterm" name="id3030522"></a><pre class="programlisting">void gnome_href_set_text (<a href="GnomeHRef.html" title="GnomeHRef">GnomeHRef</a> *href,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *text);</pre>
<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>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>href</code></em> :</span></td>
<td> Pointer to GnomeHRef widget
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>text</code></em> :</span></td>
<td> New link text for the href object.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3030600"></a><h3>
<a name="gnome-href-get-text"></a>gnome_href_get_text ()</h3>
<a class="indexterm" name="id3030614"></a><pre class="programlisting">const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>* gnome_href_get_text (<a href="GnomeHRef.html" title="GnomeHRef">GnomeHRef</a> *href);</pre>
<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>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>href</code></em> :</span></td>
<td> Pointer to GnomeHRef widget
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> Pointer to text contained in the label widget.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3030678"></a><h3>
<a name="gnome-href-set-label"></a>gnome_href_set_label ()</h3>
<a class="indexterm" name="id3030694"></a><pre class="programlisting">void gnome_href_set_label (<a href="GnomeHRef.html" title="GnomeHRef">GnomeHRef</a> *href,
const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a> *label);</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 href="GnomeHRef.html#gnome-href-set-text"><span class="type">gnome_href_set_text</span></a></p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>href</code></em> :</span></td>
<td> Pointer to GnomeHRef widget
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>label</code></em> :</span></td>
<td> New link text for the href object.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3030786"></a><h3>
<a name="gnome-href-get-label"></a>gnome_href_get_label ()</h3>
<a class="indexterm" name="id3030801"></a><pre class="programlisting">const <a
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"
>gchar</a>* gnome_href_get_label (<a href="GnomeHRef.html" title="GnomeHRef">GnomeHRef</a> *href);</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 href="GnomeHRef.html#gnome-href-get-text"><span class="type">gnome_href_get_text</span></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><em class="parameter"><code>href</code></em> :</span></td>
<td> Pointer to GnomeHRef widget
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id3030884"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="id3030895"></a><h3>
<a name="GnomeHRef--text"></a>The "<code class="literal">text</code>" property</h3>
<a class="indexterm" name="id3030911"></a><pre class="programlisting"> "text" <a
href="/usr/share/gtk-doc/html/gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
>gchararray</a> : Read / Write</pre>
<p>The text on the button.</p>
<p>Default value: "End World Hunger"</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3030938"></a><h3>
<a name="GnomeHRef--url"></a>The "<code class="literal">url</code>" property</h3>
<a class="indexterm" name="id3030954"></a><pre class="programlisting"> "url" <a
href="/usr/share/gtk-doc/html/gobject/gobject-Standard-Parameter-and-Value-Types.html#gchararray"
>gchararray</a> : Read / Write</pre>
<p>The URL that GnomeHRef activates.</p>
<p>Default value: "http://www.wfp.org"</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id3030982"></a><h2>Style Property Details</h2>
<div class="refsect2" lang="en">
<a name="id3030993"></a><h3>
<a name="GnomeHRef--link-color"></a>The "<code class="literal">link-color</code>" style property</h3>
<a class="indexterm" name="id3031010"></a><pre class="programlisting"> "link-color" <a
href="/usr/share/gtk-doc/html/gdk/gdk-Colormaps-and-Colors.html#GdkColor"
>GdkColor</a> : Read</pre>
<p>Color used to draw the link.</p>
</div>
</div>
</div>
</body>
</html>