Reference Manual
Inti Logo
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Namespace Members | Compound Members | File Members

Inti::Atk::Hyperlink Class Reference

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

#include <inti/atk/hyperlink.h>

Inheritance diagram for Inti::Atk::Hyperlink:

Inti::G::Object Inti::Atk::Action Inti::G::TypeInstance Inti::MemoryHandler Inti::G::TypeInterface Inti::ReferencedBase Inti::G::TypeInstance Inti::ReferencedBase List of all members.

Public Member Functions

Constructors
Accessors

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

Inti::Atk::Hyperlink::Hyperlink AtkHyperlink *  hyperlink,
bool  reference = true
[explicit, protected]
 

Construct a new Hyperlink from an existing AtkHyperlink.

Parameters:
hyperlink A pointer to a AtkHyperlink.
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 Inti::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* Inti::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 Inti::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 Inti::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 Inti::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 Inti::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.


The documentation for this class was generated from the following file: Main Page - Footer


Generated on Sun Sep 14 20:08:07 2003 for Inti by doxygen 1.3.2 written by Dimitri van Heesch, © 1997-2002