GFC Logo GFC Title Logo
Reference Manual
Main Page  |  Namespace List  |  Alphabetical List  |  Class List  |  File List

GFC::Atk::Hyperlink Class Reference

An AtkHyperlink C++ wrapper class. More...

#include <gfc/atk/hyperlink.hh>

Inheritance diagram for GFC::Atk::Hyperlink:

GFC::G::Object GFC::Atk::Action GFC::G::TypeInstance GFC::G::TypeInterface GFC::Trackable GFC::G::TypeInstance GFC::Trackable List of all members.

Signal Prototpyes

Public Member Functions

Constructors
Accessors
Signal Proxies

Protected Member Functions

Constructors

Detailed Description

An AtkHyperlink C++ wrapper class.

Hyperlink is an Atk::Object which encapsulates a link or set of links in a hypertext document. It implements the Atk::Action interface.


Constructor & Destructor Documentation

GFC::Atk::Hyperlink::Hyperlink AtkHyperlink *  hyperlink,
bool  owns_reference = true
[explicit, protected]
 

Construct a new Hyperlink from an existing AtkHyperlink.

Parameters:
hyperlink A pointer to a AtkHyperlink.
owns_reference Set false if the initial reference count is floating, set true if it's not.

The hyperlink can be a newly created AtkHyperlink or an existing AtkHyperlink. (see G::Object::Object).


Member Function Documentation

int GFC::Atk::Hyperlink::get_end_index  )  const
 

Gets the index with the hypertext document at which this link ends.

Returns:
The index with the hypertext document at which this link ends.

Atk::Object* GFC::Atk::Hyperlink::get_object int  i  )  const
 

Returns the item associated with this hyperlink's nth anchor.

Parameters:
i A zero-index integer specifying the desired anchor.
Returns:
An Atk::Object associated with this hyperlink's i-th anchor.

For instance, the returned Atk::Object will implement Text if the link is a text hyperlink, Image if the link is an image hyperlink etc. Multiple anchors are primarily used by client-side image maps.

int GFC::Atk::Hyperlink::get_start_index  )  const
 

Gets the index with the hypertext document at which this link begins.

Returns:
The index with the hypertext document at which this link begins.

String GFC::Atk::Hyperlink::get_uri int  i  )  const
 

Gets the URI associated with the anchor of the link specified by i.

Parameters:
i A zero-index integer specifying the desired anchor.
Returns:
A string specifying the URI.

Multiple anchors are primarily used by client-side image maps.

bool GFC::Atk::Hyperlink::is_inline  )  const
 

Indicates whether the link currently displays some or all of its content inline.

Returns:
Whether or not this link displays its content inline.

Ordinary HTML links will usually return false, but an inline source HTML element will return true.

bool GFC::Atk::Hyperlink::is_selected_link  )  const
 

Determines whether this hyperlink is selected.

Returns:
true if the AtkHyperlink is selected, false otherwise.

bool GFC::Atk::Hyperlink::is_valid  )  const
 

Since the document that a link is associated with may have changed this method returns true if the link is still valid (with respect to the document it references) and false otherwise.

Returns:
Whether or not this link is still valid.


Member Data Documentation

const LinkActivatedSignalType GFC::Atk::Hyperlink::link_activated_signal [static, protected]
 

Link activated signal (see sig_link_activated()).

Calls a slot with the signature:

             void function();


The documentation for this class was generated from the following file:
Generated on Tue Aug 24 00:34:34 2004 for GFC-UI by doxygen 1.3.8