HyperLinkCtrl is a control for wxPython that acts like a hyper link in a typical browser. Latest features include the ability to capture your own left, middle, and right click events to perform your own custom event handling and ability to open link in a new or current browser window.
__init__ | Default class constructor. |
AutoBrowse | Automatically browse to URL when clicked. |
DisplayError | Displays an error message (according to the ReportErrors parameter) in a |
DoPopup | Sets whether to show popup menu on right click or not. |
EnableRollover | Enable/disable rollover. |
GetBold | Returns whether the HyperLinkCtrl has text in bold or not. |
GetColours | Gets the colours for the link, the visited link and the mouse |
GetLinkCursor | Gets the link cursor. |
GetURL | Retrieve the URL associated to the HyperLinkCtrl. |
GetUnderlines | Returns if link is underlined, if the mouse rollover is |
GetVisited | Returns whether a link has been visited or not. |
GotoURL | Goto the specified URL. |
OnMouseEvent | Handles the wx.EVT_MOUSE_EVENTS events for HyperLinkCtrl. |
OnPopUpCopy | Handles the wx.EVT_MENU event for HyperLinkCtrl. |
OpenInSameWindow | Open multiple URL in the same window (if possible). |
ReportErrors | Set whether to report browser errors or not. |
SetBold | Sets the HyperLinkCtrl label in bold text. |
SetColours | Sets the colours for the link, the visited link and the mouse rollover. |
SetLinkCursor | Sets link cursor properties. |
SetURL | Sets the HyperLinkCtrl text to the specified URL. |
SetUnderlines | Sets whether the text should be underlined or not for new links, visited links and rollovers. |
SetVisited | Sets a link as visited. |
UpdateLink | Updates the link, changing text properties if: |
HyperLinkCtrl is a control for wxPython that acts like a hyper link in a typical browser. Latest features include the ability to capture your own left, middle, and right click events to perform your own custom event handling and ability to open link in a new or current browser window.
Default class constructor.
Parameters: |
|
---|
Note
Pass URL=”” to use the label as the url link to navigate to.
Automatically browse to URL when clicked.
Parameters: | AutoBrowse – True to automatically browse to an URL when clicked, False otherwise. |
---|
Note
Set AutoBrowse to False to receive EVT_HYPERLINK_LEFT events.
Displays an error message (according to the ReportErrors parameter) in a wx.MessageBox.
Parameters: |
|
---|
Sets whether to show popup menu on right click or not.
Parameters: | DoPopup – True to show a popup menu on right click, False otherwise. |
---|
Enable/disable rollover.
Parameters: | EnableRollover – True to enable text effects during rollover, False to disable them. |
---|
Returns whether the HyperLinkCtrl has text in bold or not.
Retrieve the URL associated to the HyperLinkCtrl.
Returns if link is underlined, if the mouse rollover is underlined and if the visited link is underlined.
Goto the specified URL.
Parameters: |
|
---|
Handles the wx.EVT_MOUSE_EVENTS events for HyperLinkCtrl.
Parameters: | event – a wx.MouseEvent event to be processed. |
---|
Handles the wx.EVT_MENU event for HyperLinkCtrl.
Parameters: | event – a wx.MenuEvent event to be processed. |
---|
Note
This method copies the data from the HyperLinkCtrl to the clipboard.
Open multiple URL in the same window (if possible).
Parameters: | NotSameWinIfPossible – True to open an hyperlink in a new browser window, False to use an existing browser window. |
---|
Set whether to report browser errors or not.
Parameters: | ReportErrors – Use True to display error dialog if an error occurrs navigating to the URL; |
---|
Sets the HyperLinkCtrl label in bold text.
Parameters: | Bold – True to set the HyperLinkCtrl label as bold, False otherwise. |
---|
Sets the colours for the link, the visited link and the mouse rollover.
Parameters: |
---|
Sets link cursor properties.
Parameters: | cur – an integer representing a wx.StockCursor constant. |
---|
Sets the HyperLinkCtrl text to the specified URL.
Parameters: | URL – the new URL associated with HyperLinkCtrl. |
---|
Sets whether the text should be underlined or not for new links, visited links and rollovers.
Parameters: |
|
---|
Sets a link as visited.
Parameters: | Visited – True to set a link as visited, False otherwise. |
---|