wxHyperlinkCtrl Class Reference

#include <hyperlinkctrl.h>

List of all members.

Public Member Functions

 wxHyperlinkCtrl (wxWindow *parent, wxWindowID id, const wxString &label, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, int style=0, const wxString &name=wxT("staticText"), const wxString &szURL=wxEmptyString)
 wxHyperlinkCtrl constructor
void SetColours (const wxColour &link=wxColour(wxT("BLUE")), const wxColour &visited=wxColour(wxT("VIOLET")), const wxColour &rollover=wxColour(wxT("BLUE")))
void GetColous (wxColour &link, wxColour &visited, wxColour &rollover)
void SetUnderlines (const bool link=true, const bool visited=true, const bool rollover=true)
void GetUnderlines (bool link, bool visited, bool rollover)
void SetLinkCursor (const wxCursor &cur=wxCURSOR_HAND)
void GetLinkCursor (wxCursor &cur)
void SetVisited (const bool bVisited=false)
bool GetVisited (void)
void SetBold (const bool bBold=false)
bool GetBold (void)
void SetURL (const wxString &szURL)
wxString GetURL (void)
void OpenInSameWindow (const bool bIfPossible=false)
void SetBrowserPath (const wxString &browser)
wxString GetBrowserPath (void)
void EnableRollover (const bool bEnable=false)
void ReportErrors (const bool bReport=true)
void AutoBrowse (const bool bBrowse=true)
void DoPopup (const bool bPopup=true)
void UpdateLink (const bool bRefresh=true)
 Updates the links colors and underline properties.

Static Public Member Functions

static bool GotoURL (const wxString &szUrl, const wxString &szBrowser=wxEmptyString, const bool bReportErrors=false, const bool bSameWinIfPossible=false)
 Goto the specified URL. This function may be called statically. bSameWindowIfPossible only works with Internet Explorer.

Private Member Functions

void OnPopUpCopy (wxCommandEvent &event)
 Menu pop up copy to clipboard event.
void OnMouseEvent (wxMouseEvent &event)
 Captures mouse events for Cursor, Link colors and Underlines.

Static Private Member Functions

static void DisplayError (const wxString &szError, const bool bReportErrors)

Private Attributes

wxString m_szURL
wxString m_szBrowserPath
wxColour m_crLinkColour
wxColour m_crVisitedColour
wxColour m_crLinkRolloverColor
bool m_bLinkUnderline
bool m_bRolloverUnderline
bool m_bVisitedUnderline
bool m_bEnableRollover
bool m_bVisited
bool m_bBold
wxCursor m_crHand
bool m_bReportErrors
bool m_bAutoBrowse
bool m_bDoPopup
bool m_bSameWinIfPossible
wxMenu * m_menuPopUp

Detailed Description

Definition at line 103 of file hyperlinkctrl.h.

Constructor & Destructor Documentation

wxHyperlinkCtrl::wxHyperlinkCtrl (  wxWindow *  parent,
wxWindowID  id,
const wxString &  label,
const wxPoint &  pos = wxDefaultPosition,
const wxSize &  size = wxDefaultSize,
int  style = 0,
const wxString &  name = wxT("staticText"),
const wxString &  szURL = wxEmptyString
) 
 

wxHyperlinkCtrl constructor

Definition at line 60 of file hyperlinkctrl.cpp.

Member Function Documentation

void wxHyperlinkCtrl::AutoBrowse (  const bool  bBrowse = true  )  [inline]
 

Definition at line 174 of file hyperlinkctrl.h.

References m_bAutoBrowse.

Referenced by InfoDialog::CreateControls().

void wxHyperlinkCtrl::DisplayError (  const wxString &  szError,
const bool  bReportErrors
)  [static, private]
 

Definition at line 338 of file hyperlinkctrl.cpp.

Referenced by GotoURL().

void wxHyperlinkCtrl::DoPopup (  const bool  bPopup = true  )  [inline]
 

Definition at line 177 of file hyperlinkctrl.h.

References m_bDoPopup.

void wxHyperlinkCtrl::EnableRollover (  const bool  bEnable = false  )  [inline]
 

Definition at line 167 of file hyperlinkctrl.h.

References m_bEnableRollover.

bool wxHyperlinkCtrl::GetBold (  void   )  [inline]
 

Definition at line 153 of file hyperlinkctrl.h.

References m_bBold.

wxString wxHyperlinkCtrl::GetBrowserPath (  void   )  [inline]
 

Definition at line 164 of file hyperlinkctrl.h.

References m_szBrowserPath.

void wxHyperlinkCtrl::GetColous (  wxColour &  link,
wxColour &  visited,
wxColour &  rollover
)  [inline]
 

Definition at line 122 of file hyperlinkctrl.h.

References m_crLinkColour, m_crLinkRolloverColor, and m_crVisitedColour.

void wxHyperlinkCtrl::GetLinkCursor (  wxCursor &  cur  )  [inline]
 

Definition at line 145 of file hyperlinkctrl.h.

References m_crHand.

void wxHyperlinkCtrl::GetUnderlines (  bool  link,
bool  visited,
bool  rollover
)  [inline]
 

Definition at line 136 of file hyperlinkctrl.h.

References m_bLinkUnderline, m_bRolloverUnderline, and m_bVisitedUnderline.

wxString wxHyperlinkCtrl::GetURL (  void   )  [inline]
 

Definition at line 157 of file hyperlinkctrl.h.

References m_szURL.

bool wxHyperlinkCtrl::GetVisited (  void   )  [inline]
 

Definition at line 149 of file hyperlinkctrl.h.

References m_bVisited.

bool wxHyperlinkCtrl::GotoURL (  const wxString &  szUrl,
const wxString &  szBrowser = wxEmptyString,
const bool  bReportErrors = false,
const bool  bSameWinIfPossible = false
)  [static]
 

Goto the specified URL. This function may be called statically. bSameWindowIfPossible only works with Internet Explorer.

Definition at line 92 of file hyperlinkctrl.cpp.

References DisplayError().

void wxHyperlinkCtrl::OnMouseEvent (  wxMouseEvent &  event  )  [private]
 

Captures mouse events for Cursor, Link colors and Underlines.

Definition at line 193 of file hyperlinkctrl.cpp.

References m_bBold, m_bEnableRollover, m_bRolloverUnderline, m_crHand, and m_crLinkRolloverColor.

void wxHyperlinkCtrl::OnPopUpCopy (  wxCommandEvent &  event  )  [private]
 

Menu pop up copy to clipboard event.

Definition at line 292 of file hyperlinkctrl.cpp.

References m_szURL.

void wxHyperlinkCtrl::OpenInSameWindow (  const bool  bIfPossible = false  )  [inline]
 

Definition at line 160 of file hyperlinkctrl.h.

References m_bSameWinIfPossible.

void wxHyperlinkCtrl::ReportErrors (  const bool  bReport = true  )  [inline]
 

Definition at line 170 of file hyperlinkctrl.h.

References m_bReportErrors.

void wxHyperlinkCtrl::SetBold (  const bool  bBold = false  )  [inline]
 

Definition at line 152 of file hyperlinkctrl.h.

References m_bBold.

void wxHyperlinkCtrl::SetBrowserPath (  const wxString &  browser  )  [inline]
 

Definition at line 163 of file hyperlinkctrl.h.

References m_szBrowserPath.

void wxHyperlinkCtrl::SetColours (  const wxColour &  link = wxColour( wxT("BLUE") ),
const wxColour &  visited = wxColour(wxT("VIOLET")),
const wxColour &  rollover = wxColour( wxT("BLUE") )
)  [inline]
 

Definition at line 116 of file hyperlinkctrl.h.

References m_crLinkColour, m_crLinkRolloverColor, and m_crVisitedColour.

void wxHyperlinkCtrl::SetLinkCursor (  const wxCursor &  cur = wxCURSOR_HAND  )  [inline]
 

Definition at line 144 of file hyperlinkctrl.h.

References m_crHand.

Referenced by InfoDialog::CreateControls().

void wxHyperlinkCtrl::SetUnderlines (  const bool  link = true,
const bool  visited = true,
const bool  rollover = true
)  [inline]
 

Definition at line 130 of file hyperlinkctrl.h.

References m_bLinkUnderline, m_bRolloverUnderline, and m_bVisitedUnderline.

void wxHyperlinkCtrl::SetURL (  const wxString &  szURL  )  [inline]
 

Definition at line 156 of file hyperlinkctrl.h.

References m_szURL.

Referenced by InfoDialog::CreateControls().

void wxHyperlinkCtrl::SetVisited (  const bool  bVisited = false  )  [inline]
 

Definition at line 148 of file hyperlinkctrl.h.

References m_bVisited.

void wxHyperlinkCtrl::UpdateLink (  const bool  bRefresh = true  ) 
 

Updates the links colors and underline properties.

Definition at line 306 of file hyperlinkctrl.cpp.

References m_bBold, m_bLinkUnderline, m_bVisited, m_bVisitedUnderline, m_crLinkColour, and m_crVisitedColour.

Referenced by InfoDialog::CreateControls().

Member Data Documentation

bool wxHyperlinkCtrl::m_bAutoBrowse [private]
 

Definition at line 231 of file hyperlinkctrl.h.

Referenced by AutoBrowse().

bool wxHyperlinkCtrl::m_bBold [private]
 

Definition at line 220 of file hyperlinkctrl.h.

Referenced by GetBold(), OnMouseEvent(), SetBold(), and UpdateLink().

bool wxHyperlinkCtrl::m_bDoPopup [private]
 

Definition at line 234 of file hyperlinkctrl.h.

Referenced by DoPopup().

bool wxHyperlinkCtrl::m_bEnableRollover [private]
 

Definition at line 214 of file hyperlinkctrl.h.

Referenced by EnableRollover(), and OnMouseEvent().

bool wxHyperlinkCtrl::m_bLinkUnderline [private]
 

Definition at line 209 of file hyperlinkctrl.h.

Referenced by GetUnderlines(), SetUnderlines(), and UpdateLink().

bool wxHyperlinkCtrl::m_bReportErrors [private]
 

Definition at line 226 of file hyperlinkctrl.h.

Referenced by ReportErrors().

bool wxHyperlinkCtrl::m_bRolloverUnderline [private]
 

Definition at line 210 of file hyperlinkctrl.h.

Referenced by GetUnderlines(), OnMouseEvent(), and SetUnderlines().

bool wxHyperlinkCtrl::m_bSameWinIfPossible [private]
 

Definition at line 237 of file hyperlinkctrl.h.

Referenced by OpenInSameWindow().

bool wxHyperlinkCtrl::m_bVisited [private]
 

Definition at line 217 of file hyperlinkctrl.h.

Referenced by GetVisited(), SetVisited(), and UpdateLink().

bool wxHyperlinkCtrl::m_bVisitedUnderline [private]
 

Definition at line 211 of file hyperlinkctrl.h.

Referenced by GetUnderlines(), SetUnderlines(), and UpdateLink().

wxCursor wxHyperlinkCtrl::m_crHand [private]
 

Definition at line 223 of file hyperlinkctrl.h.

Referenced by GetLinkCursor(), OnMouseEvent(), and SetLinkCursor().

wxColour wxHyperlinkCtrl::m_crLinkColour [private]
 

Definition at line 204 of file hyperlinkctrl.h.

Referenced by GetColous(), SetColours(), and UpdateLink().

wxColour wxHyperlinkCtrl::m_crLinkRolloverColor [private]
 

Definition at line 206 of file hyperlinkctrl.h.

Referenced by GetColous(), OnMouseEvent(), and SetColours().

wxColour wxHyperlinkCtrl::m_crVisitedColour [private]
 

Definition at line 205 of file hyperlinkctrl.h.

Referenced by GetColous(), SetColours(), and UpdateLink().

wxMenu* wxHyperlinkCtrl::m_menuPopUp [private]
 

Definition at line 239 of file hyperlinkctrl.h.

wxString wxHyperlinkCtrl::m_szBrowserPath [private]
 

Definition at line 201 of file hyperlinkctrl.h.

Referenced by GetBrowserPath(), and SetBrowserPath().

wxString wxHyperlinkCtrl::m_szURL [private]
 

Definition at line 198 of file hyperlinkctrl.h.

Referenced by GetURL(), OnPopUpCopy(), and SetURL().

The documentation for this class was generated from the following files:
Generated on Mon Mar 19 17:14:10 2007 for CAENScope by  doxygen 1.4.6-NO