<refentry id="GnomeHRef">
<refmeta>
<refentrytitle role="top_of_page" id="GnomeHRef.top_of_page">GnomeHRef</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGNOMEUI Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>GnomeHRef</refname>
<refpurpose></refpurpose>
</refnamediv>

<refsynopsisdiv id="GnomeHRef.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>

#include &lt;libgnomeui/libgnomeui.h&gt;

                    <link linkend="GnomeHRef-struct">GnomeHRef</link>;
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="gnome-href-new">gnome_href_new</link>                      (const <link linkend="gchar">gchar</link> *url,
                                                         const <link linkend="gchar">gchar</link> *text);
<link linkend="void">void</link>                <link linkend="gnome-href-set-url">gnome_href_set_url</link>                  (<link linkend="GnomeHRef">GnomeHRef</link> *href,
                                                         const <link linkend="gchar">gchar</link> *url);
const <link linkend="gchar">gchar</link> *       <link linkend="gnome-href-get-url">gnome_href_get_url</link>                  (<link linkend="GnomeHRef">GnomeHRef</link> *href);
<link linkend="void">void</link>                <link linkend="gnome-href-set-text">gnome_href_set_text</link>                 (<link linkend="GnomeHRef">GnomeHRef</link> *href,
                                                         const <link linkend="gchar">gchar</link> *text);
const <link linkend="gchar">gchar</link> *       <link linkend="gnome-href-get-text">gnome_href_get_text</link>                 (<link linkend="GnomeHRef">GnomeHRef</link> *href);
<link linkend="void">void</link>                <link linkend="gnome-href-set-label">gnome_href_set_label</link>                (<link linkend="GnomeHRef">GnomeHRef</link> *href,
                                                         const <link linkend="gchar">gchar</link> *label);
const <link linkend="gchar">gchar</link> *       <link linkend="gnome-href-get-label">gnome_href_get_label</link>                (<link linkend="GnomeHRef">GnomeHRef</link> *href);
</synopsis>
</refsynopsisdiv>

<refsect1 id="GnomeHRef.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
  <link linkend="GObject">GObject</link>
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
         +----<link linkend="GtkObject">GtkObject</link>
               +----<link linkend="GtkWidget">GtkWidget</link>
                     +----<link linkend="GtkContainer">GtkContainer</link>
                           +----<link linkend="GtkBin">GtkBin</link>
                                 +----<link linkend="GtkButton">GtkButton</link>
                                       +----GnomeHRef
</synopsis>
</refsect1>



<refsect1 id="GnomeHRef.implemented-interfaces" role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
GnomeHRef implements
 <link linkend="GtkBuildable">GtkBuildable</link>,  <link linkend="GtkActivatable">GtkActivatable</link> and  <link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>
</refsect1>


<refsect1 id="GnomeHRef.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
  &quot;<link linkend="GnomeHRef--text">text</link>&quot;                     <link linkend="gchar">gchar</link>*                : Read / Write
  &quot;<link linkend="GnomeHRef--url">url</link>&quot;                      <link linkend="gchar">gchar</link>*                : Read / Write
</synopsis>
</refsect1>
<refsect1 id="GnomeHRef.style-properties" role="style_properties">
<title role="style_properties.title">Style Properties</title>
<synopsis>
  &quot;<link linkend="GnomeHRef--s-link-color">link-color</link>&quot;               <link linkend="GdkColor">GdkColor</link>*             : Read
</synopsis>
</refsect1>



<refsect1 id="GnomeHRef.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>

<refsect1 id="GnomeHRef.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="GnomeHRef-struct" role="struct">
<title>GnomeHRef</title>
<indexterm zone="GnomeHRef-struct" role="deprecated"><primary sortas="GnomeHRef">GnomeHRef</primary></indexterm><programlisting>typedef struct _GnomeHRef GnomeHRef;</programlisting>
<warning><para><literal>GnomeHRef</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
</para></refsect2>
<refsect2 id="gnome-href-new" role="function" condition="deprecated:">
<title>gnome_href_new ()</title>
<indexterm zone="gnome-href-new" role="deprecated"><primary sortas="gnome_href_new">gnome_href_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> *         gnome_href_new                      (const <link linkend="gchar">gchar</link> *url,
                                                         const <link linkend="gchar">gchar</link> *text);</programlisting>
<warning><para><literal>gnome_href_new</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Created a GNOME href object, a label widget with a clickable action
and an associated URL.  If <parameter>text</parameter> is set to <link linkend="NULL--CAPS"><literal>NULL</literal></link>, <parameter>url</parameter> is used as
the text for the label.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>url</parameter>&#160;:</term>
<listitem><simpara> URL assigned to this object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>text</parameter>&#160;:</term>
<listitem><simpara> Text associated with the URL.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>  Pointer to new GNOME href widget.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-href-set-url" role="function" condition="deprecated:">
<title>gnome_href_set_url ()</title>
<indexterm zone="gnome-href-set-url" role="deprecated"><primary sortas="gnome_href_set_url">gnome_href_set_url</primary></indexterm><programlisting><link linkend="void">void</link>                gnome_href_set_url                  (<link linkend="GnomeHRef">GnomeHRef</link> *href,
                                                         const <link linkend="gchar">gchar</link> *url);</programlisting>
<warning><para><literal>gnome_href_set_url</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Sets the internal URL value within <parameter>href</parameter> to the value of <parameter>url</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>href</parameter>&#160;:</term>
<listitem><simpara> Pointer to GnomeHRef widget
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>url</parameter>&#160;:</term>
<listitem><simpara> String containing the URL to be stored within <parameter>href</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-href-get-url" role="function" condition="deprecated:">
<title>gnome_href_get_url ()</title>
<indexterm zone="gnome-href-get-url" role="deprecated"><primary sortas="gnome_href_get_url">gnome_href_get_url</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link> *       gnome_href_get_url                  (<link linkend="GnomeHRef">GnomeHRef</link> *href);</programlisting>
<warning><para><literal>gnome_href_get_url</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Returns the pointer to the URL associated with the <parameter>href</parameter> href object.  Note
that the string should not be freed as it is internal memory.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>href</parameter>&#160;:</term>
<listitem><simpara> Pointer to GnomeHRef widget
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>  Pointer to an internal URL string, or <link linkend="NULL--CAPS"><literal>NULL</literal></link> if failure.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-href-set-text" role="function" condition="deprecated:">
<title>gnome_href_set_text ()</title>
<indexterm zone="gnome-href-set-text" role="deprecated"><primary sortas="gnome_href_set_text">gnome_href_set_text</primary></indexterm><programlisting><link linkend="void">void</link>                gnome_href_set_text                 (<link linkend="GnomeHRef">GnomeHRef</link> *href,
                                                         const <link linkend="gchar">gchar</link> *text);</programlisting>
<warning><para><literal>gnome_href_set_text</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Sets the internal label widget text (used to display a URL's link
text) to the value given in <parameter>label</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>href</parameter>&#160;:</term>
<listitem><simpara> Pointer to GnomeHRef widget
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>text</parameter>&#160;:</term>
<listitem><simpara> New link text for the href object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-href-get-text" role="function" condition="deprecated:">
<title>gnome_href_get_text ()</title>
<indexterm zone="gnome-href-get-text" role="deprecated"><primary sortas="gnome_href_get_text">gnome_href_get_text</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link> *       gnome_href_get_text                 (<link linkend="GnomeHRef">GnomeHRef</link> *href);</programlisting>
<warning><para><literal>gnome_href_get_text</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
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.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>href</parameter>&#160;:</term>
<listitem><simpara> Pointer to GnomeHRef widget
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>  Pointer to text contained in the label widget.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-href-set-label" role="function" condition="deprecated:">
<title>gnome_href_set_label ()</title>
<indexterm zone="gnome-href-set-label" role="deprecated"><primary sortas="gnome_href_set_label">gnome_href_set_label</primary></indexterm><programlisting><link linkend="void">void</link>                gnome_href_set_label                (<link linkend="GnomeHRef">GnomeHRef</link> *href,
                                                         const <link linkend="gchar">gchar</link> *label);</programlisting>
<warning><para><literal>gnome_href_set_label</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
deprecated, use <link linkend="gnome-href-set-text"><type>gnome_href_set_text</type></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>href</parameter>&#160;:</term>
<listitem><simpara> Pointer to GnomeHRef widget
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>label</parameter>&#160;:</term>
<listitem><simpara> New link text for the href object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="gnome-href-get-label" role="function" condition="deprecated:">
<title>gnome_href_get_label ()</title>
<indexterm zone="gnome-href-get-label" role="deprecated"><primary sortas="gnome_href_get_label">gnome_href_get_label</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link> *       gnome_href_get_label                (<link linkend="GnomeHRef">GnomeHRef</link> *href);</programlisting>
<warning><para><literal>gnome_href_get_label</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Deprecated, use <link linkend="gnome-href-get-text"><type>gnome_href_get_text</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>href</parameter>&#160;:</term>
<listitem><simpara> Pointer to GnomeHRef widget
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>
<refsect1 id="GnomeHRef.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="GnomeHRef--text" role="property"><title>The <literal>&quot;text&quot;</literal> property</title>
<indexterm zone="GnomeHRef--text"><primary sortas="GnomeHRef:text">GnomeHRef:text</primary></indexterm><programlisting>  &quot;text&quot;                     <link linkend="gchar">gchar</link>*                : Read / Write</programlisting>
<para>The text on the button.</para><para>Default value: "End World Hunger"</para>
</refsect2>
<refsect2 id="GnomeHRef--url" role="property"><title>The <literal>&quot;url&quot;</literal> property</title>
<indexterm zone="GnomeHRef--url"><primary sortas="GnomeHRef:url">GnomeHRef:url</primary></indexterm><programlisting>  &quot;url&quot;                      <link linkend="gchar">gchar</link>*                : Read / Write</programlisting>
<para>The URL that GnomeHRef activates.</para><para>Default value: "http://www.wfp.org"</para>
</refsect2>
</refsect1>
<refsect1 id="GnomeHRef.style-property-details" role="style_properties_details">
<title role="style_properties_details.title">Style Property Details</title>
<refsect2 id="GnomeHRef--s-link-color" role="property"><title>The <literal>&quot;link-color&quot;</literal> style property</title>
<indexterm zone="GnomeHRef--s-link-color"><primary sortas="GnomeHRef:link-color">GnomeHRef:link-color</primary></indexterm><programlisting>  &quot;link-color&quot;               <link linkend="GdkColor">GdkColor</link>*             : Read</programlisting>
<para>Color used to draw the link.</para></refsect2>
</refsect1>




</refentry>
