GnomeHRef

GnomeHRef —

Synopsis


#include <libgnomeui/libgnomeui.h>


            GnomeHRef;
GtkWidget*  gnome_href_new                  (const gchar *url,
                                             const gchar *text);
void        gnome_href_set_url              (GnomeHRef *href,
                                             const gchar *url);
const gchar* gnome_href_get_url             (GnomeHRef *href);
void        gnome_href_set_text             (GnomeHRef *href,
                                             const gchar *text);
const gchar* gnome_href_get_text            (GnomeHRef *href);
void        gnome_href_set_label            (GnomeHRef *href,
                                             const gchar *label);
const gchar* gnome_href_get_label           (GnomeHRef *href);


Object Hierarchy


  GObject
   +----GInitiallyUnowned
         +----GtkObject
               +----GtkWidget
                     +----GtkContainer
                           +----GtkBin
                                 +----GtkButton
                                       +----GnomeHRef

Implemented Interfaces

GnomeHRef implements AtkImplementorIface.

Properties


  "text"                 gchararray            : Read / Write
  "url"                  gchararray            : Read / Write

Style Properties


  "link-color"           GdkColor              : Read

Description

Details

GnomeHRef

typedef struct _GnomeHRef GnomeHRef;


gnome_href_new ()

GtkWidget*  gnome_href_new                  (const gchar *url,
                                             const gchar *text);

Created a GNOME href object, a label widget with a clickable action and an associated URL. If text is set to NULL, url is used as the text for the label.

url : URL assigned to this object.
text : Text associated with the URL.
Returns : Pointer to new GNOME href widget.

gnome_href_set_url ()

void        gnome_href_set_url              (GnomeHRef *href,
                                             const gchar *url);

Sets the internal URL value within href to the value of url.

href : Pointer to GnomeHRef widget
url : String containing the URL to be stored within href.

gnome_href_get_url ()

const gchar* gnome_href_get_url             (GnomeHRef *href);

Returns the pointer to the URL associated with the href href object. Note that the string should not be freed as it is internal memory.

href : Pointer to GnomeHRef widget
Returns : Pointer to an internal URL string, or NULL if failure.

gnome_href_set_text ()

void        gnome_href_set_text             (GnomeHRef *href,
                                             const gchar *text);

Sets the internal label widget text (used to display a URL's link text) to the value given in label.

href : Pointer to GnomeHRef widget
text : New link text for the href object.

gnome_href_get_text ()

const gchar* gnome_href_get_text            (GnomeHRef *href);

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.

href : Pointer to GnomeHRef widget
Returns : Pointer to text contained in the label widget.

gnome_href_set_label ()

void        gnome_href_set_label            (GnomeHRef *href,
                                             const gchar *label);

Warning

gnome_href_set_label is deprecated and should not be used in newly-written code.

deprecated, use gnome_href_set_text

href : Pointer to GnomeHRef widget
label : New link text for the href object.

gnome_href_get_label ()

const gchar* gnome_href_get_label           (GnomeHRef *href);

Warning

gnome_href_get_label is deprecated and should not be used in newly-written code.

Deprecated, use gnome_href_get_text.

href : Pointer to GnomeHRef widget
Returns :

Property Details

The "text" property

  "text"                 gchararray            : Read / Write

The text on the button.

Default value: "End World Hunger"


The "url" property

  "url"                  gchararray            : Read / Write

The URL that GnomeHRef activates.

Default value: "http://www.wfp.org"

Style Property Details

The "link-color" style property

  "link-color"           GdkColor              : Read

Color used to draw the link.