DzTextBrowser Class Reference
[Interface Widget Objects]

A rich text browser widget with hypertext navigation. More...

Inheritance diagram for DzTextBrowser:

DzTextEdit DzWidget List of all members.

Properties

String source

Methods

void backward ()
void forward ()
void home ()
void reload ()

Constructors

 DzTextBrowser (DzWidget parent)

Signals

void anchorClicked (String name, String link)
 Signature: "anchorClicked(const QString&,const QString&)"
void backwardAvailable (Boolean available)
 Signature: "backwardAvailable(bool)"
void forwardAvailable (Boolean available)
 Signature: "forwardAvailable(bool)"
void highlighted (String link)
 Signature: "highlighted(const QString&)"
void linkClicked (String link)
 Signature: "linkClicked(const QString&)"
void sourceChanged (String src)
 Signature: "sourceChanged(const QString&)"

Detailed Description

A rich text browser widget with hypertext navigation.

This class extends DzTextEdit (in read-only mode), adding functionality to allow users to navigate hyperlinked documents.


Constructor & Destructor Documentation

DzTextBrowser::DzTextBrowser ( DzWidget  parent  ) 

Creates a text browser widget as a child of the given parent widget


Member Function Documentation

void DzTextBrowser::anchorClicked ( String  name,
String  link 
) [signal]

Signature: "anchorClicked(const QString&,const QString&)"

Emitted when the user clicks an anchor.

Parameters:
name The value of the href, or the name of the target document
link The name of the anchor

void DzTextBrowser::backward (  ) 

Changes the document displayed to the previous document in the list built by navigating links. Does nothing if there is no previous document.

void DzTextBrowser::backwardAvailable ( Boolean  available  )  [signal]

Signature: "backwardAvailable(bool)"

Emitted when the availability of backward() changes.

Parameters:
available FALSE when user is at home(), otherwise TRUE.

void DzTextBrowser::forward (  ) 

Changes the document displayed to the next document in the list built by navigating links. Does nothing if there is no next document.

void DzTextBrowser::forwardAvailable ( Boolean  available  )  [signal]

Signature: "forwardAvailable(bool)"

Emitted when the availability of forward() changes.

Parameters:
available TRUE when the user navigates backward(), FALSE when the user goes forward() or if there is no next document.

void DzTextBrowser::highlighted ( String  link  )  [signal]

Signature: "highlighted(const QString&)"

Emitted when the user selects a link but does not activate it.

Parameters:
link The selected link

void DzTextBrowser::home (  ) 

Changes the current document displayed to be the first document displayed.

void DzTextBrowser::linkClicked ( String  link  )  [signal]

Signature: "linkClicked(const QString&)"

Emitted when the user clicks a link

Parameters:
link The value of the href, or the name of the target document
Attention:
The link will be the absolute location of the document, based on the value of the anchor's href tag.

void DzTextBrowser::reload (  ) 

Reloads the current document.

void DzTextBrowser::sourceChanged ( String  src  )  [signal]

Signature: "sourceChanged(const QString&)"

Emitted when the mime source of the browser chages

Parameters:
src The name of the document being displayed in the browser


Member Data Documentation

QString DzTextBrowser::source

The name of the displayed document.


Generated on Thu Sep 24 12:21:16 2009

Copyright © 2002 - 2009 DAZ 3D, Inc.