Links Class Reference

Class that handles information related to html links. More...

#include <Links.h>

List of all members.

Public Member Functions

string getDisplayUrl ()
 Returns the name of the url is to be on the web page.
string getHtmlLink ()
 Returns the html of the full url.
string getTemplateString ()
 Returns the template string.
string getUrl ()
 Returns the url.
void setDisplayUrl (const string &displayUrl)
 Sets what the name of the url is to be on a web page.
void setTemplateString (string templateString)
 Sets the template string.
void setUrl (const string &url)
 Sets the url.

Private Attributes

string m_displayUrl
 The display name of the url link on the web page.
string m_templateString
 The template string to use instead of a html link.
string m_url
 The url link.


Detailed Description

Class that handles information related to html links.


Member Function Documentation

string getDisplayUrl  )  [inline]
 

Returns the name of the url is to be on the web page.

Returns:
the name of the url on the web page

string getHtmlLink  )  [inline]
 

Returns the html of the full url.

If the displayUrl is empty but the m_templateString is not, it will not create an actual link. Instead it will display what is in the m_templateString. This is for the final web page that doesn't have any more links but instead displays the template string

Returns:
the html of the full url

string getTemplateString  )  [inline]
 

Returns the template string.

Returns:
The template string.

string getUrl  )  [inline]
 

Returns the url.

Returns:
the url

void setDisplayUrl const string &  displayUrl  )  [inline]
 

Sets what the name of the url is to be on a web page.

Parameters:
displayUrl The string of what the url is to be on the web page

void setTemplateString string  templateString  )  [inline]
 

Sets the template string.

Parameters:
templateString the string to set the internal templateString with.

void setUrl const string &  url  )  [inline]
 

Sets the url.

Parameters:
url the url to set


Member Data Documentation

string m_displayUrl [private]
 

The display name of the url link on the web page.

string m_templateString [private]
 

The template string to use instead of a html link.

If this is set this class will use it instead of creating an actual link

string m_url [private]
 

The url link.


The documentation for this class was generated from the following file:
Generated on Thu Sep 7 22:05:52 2006 for RebeccaAIML by  doxygen 1.4.5