Version: 3.0.4
wxHtmlLinkInfo Class Reference

#include <wx/html/htmlcell.h>

+ Inheritance diagram for wxHtmlLinkInfo:

Detailed Description

This class stores all necessary information about hypertext links (as represented by <A> tag in HTML documents).

In current implementation it stores URL and target frame name.

Note
Frames are not currently supported by wxHTML!

Library:  wxHTML
Category:  HTML

Public Member Functions

 wxHtmlLinkInfo ()
 Default ctor. More...
 
 wxHtmlLinkInfo (const wxString &href, const wxString &target=wxEmptyString)
 Construct hypertext link from HREF (aka URL) and TARGET (name of target frame). More...
 
const wxMouseEventGetEvent () const
 Return pointer to event that generated OnLinkClicked() event. More...
 
wxString GetHref () const
 Return HREF value of the <A> tag. More...
 
const wxHtmlCellGetHtmlCell () const
 Return pointer to the cell that was clicked. More...
 
wxString GetTarget () const
 Return TARGET value of the <A> tag (this value is used to specify in which frame should be the page pointed by GetHref() Href opened). More...
 
- Public Member Functions inherited from wxObject
 wxObject ()
 Default ctor; initializes to NULL the internal reference data. More...
 
 wxObject (const wxObject &other)
 Copy ctor. More...
 
virtual ~wxObject ()
 Destructor. More...
 
virtual wxClassInfoGetClassInfo () const
 This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar). More...
 
wxObjectRefDataGetRefData () const
 Returns the wxObject::m_refData pointer, i.e. the data referenced by this object. More...
 
bool IsKindOf (const wxClassInfo *info) const
 Determines whether this class is a subclass of (or the same class as) the given class. More...
 
bool IsSameAs (const wxObject &obj) const
 Returns true if this object has the same data pointer as obj. More...
 
void Ref (const wxObject &clone)
 Makes this object refer to the data in clone. More...
 
void SetRefData (wxObjectRefData *data)
 Sets the wxObject::m_refData pointer. More...
 
void UnRef ()
 Decrements the reference count in the associated data, and if it is zero, deletes the data. More...
 
void UnShare ()
 This is the same of AllocExclusive() but this method is public. More...
 
void operator delete (void *buf)
 The delete operator is defined for debugging versions of the library only, when the identifier WXDEBUG is defined. More...
 
void * operator new (size_t size, const wxString &filename=NULL, int lineNum=0)
 The new operator is defined for debugging versions of the library only, when the identifier WXDEBUG is defined. More...
 

Additional Inherited Members

- Protected Member Functions inherited from wxObject
void AllocExclusive ()
 Ensure that this object's data is not shared with any other object. More...
 
virtual wxObjectRefDataCreateRefData () const
 Creates a new instance of the wxObjectRefData-derived class specific to this object and returns it. More...
 
virtual wxObjectRefDataCloneRefData (const wxObjectRefData *data) const
 Creates a new instance of the wxObjectRefData-derived class specific to this object and initializes it copying data. More...
 
- Protected Attributes inherited from wxObject
wxObjectRefDatam_refData
 Pointer to an object which is the object's reference-counted data. More...
 

Constructor & Destructor Documentation

wxHtmlLinkInfo::wxHtmlLinkInfo ( )

Default ctor.

wxHtmlLinkInfo::wxHtmlLinkInfo ( const wxString href,
const wxString target = wxEmptyString 
)

Construct hypertext link from HREF (aka URL) and TARGET (name of target frame).

Member Function Documentation

const wxMouseEvent* wxHtmlLinkInfo::GetEvent ( ) const

Return pointer to event that generated OnLinkClicked() event.

Valid only within wxHtmlWindow::OnLinkClicked, NULL otherwise.

wxString wxHtmlLinkInfo::GetHref ( ) const

Return HREF value of the <A> tag.

const wxHtmlCell* wxHtmlLinkInfo::GetHtmlCell ( ) const

Return pointer to the cell that was clicked.

Valid only within wxHtmlWindow::OnLinkClicked, NULL otherwise.

wxString wxHtmlLinkInfo::GetTarget ( ) const

Return TARGET value of the <A> tag (this value is used to specify in which frame should be the page pointed by GetHref() Href opened).