Module HyperLinksCtrl :: Class HyperLinksCtrl
[show private | hide private]
[frames | no frames]

Type HyperLinksCtrl

object --+                        
         |                        
    Object --+                    
             |                    
    EvtHandler --+                
                 |                
            Window --+            
                     |            
               Control --+        
                         |        
                 PyControl --+    
                             |    
                 GenStaticText --+
                                 |
                                HyperLinksCtrl


Method Summary
  __init__(self, parent, id, label, pos, size, style, name, szURL)
Default Class Constructor.
  AutoBrowse(self, bBrowse)
Automatically Browse To URL When Clicked.
  DisplayError(self, szError, bReportErrors)
Displays An Error Message (Accordingly To bReportErrors Variable) In A MessageBox.
  DoPopup(self, bPopup)
Sets Wether To Show Popup Menu On Right Click Or Not.
  EnableRollover(self, bEnable)
Enable/Disable Rollover.
  GetBold(self)
Returns Wether The HyperLink Has Text In Bold Or Not.
  GetBrowserPath(self)
Returns The Browser Path.
  GetColours(self)
Gets The Colours For The Link, The Visited Link And The Mouse Rollover.
  GetLinkCursor(self)
Gets The Link Cursor.
  GetUnderlines(self)
Returns If Link Is UnderLined, If The Mouse Rollover Is Underlined And If The Visited Link Is Underlined.
  GetURL(self)
Retrieve The URL Associated To The HyperLink.
  GetVisited(self)
Returns Wether A Link Has Been Visited Or Not.
  GotoURL(self, szUrl, szBrowser, bReportErrors, bSameWinIfPossible)
Goto The Specified URL.
  OnMouseEvent(self, event)
Captures Mouse Events For Cursor, Link Colors And Underlines.
  OnPopUpCopy(self, event)
Copy Data From The HyperLink To The ClipBoard.
  OpenInSameWindow(self, bIfPossible)
Open Multiple URL In The Same Window (If Possible).
  ReportErrors(self, bReport)
Set Wether To Report Browser Errors Or Not.
  SetBold(self, bBold)
Sets The HyperLink In Bold Text.
  SetBrowserPath(self, browser)
Sets The Browser Path.
  SetColours(self, link, visited, rollover)
Sets The Colours For The Link, The Visited Link And The Mouse Rollover.
  SetLinkCursor(self, cur)
Sets Link Cursor Properties.
  SetUnderlines(self, link, visited, rollover)
Underlines Properties.
  SetURL(self, szURL)
Sets The HyperLink Text To The Specified URL.
  SetVisited(self, bVisited)
Sets A Link As Visited.
  UpdateLink(self, bRefresh)
Updates The Link.
    Inherited from GenStaticText
  AcceptsFocus(self)
Overridden base class virtual.
  DoGetBestSize(self)
Overridden base class virtual.
  GetDefaultAttributes(self)
Overridden base class virtual.
  OnEraseBackground(self, event)
  OnPaint(self, event)
  SetFont(self, font)
Sets the static text font and updates the control's size to exactly fit the label unless the control has wx.ST_NO_AUTORESIZE flag.
  SetLabel(self, label)
Sets the static text label and updates the control's size to exactly fit the label unless the control has wx.ST_NO_AUTORESIZE flag.
  ShouldInheritColours(self)
Overridden base class virtual.
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
x.__hash__() <==> hash(x)
  __new__(T, S, ...)
T.__new__(S, ...) -> a new object with type S, a subtype of T
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value
  __str__(x)
x.__str__() <==> str(x)

Class Variable Summary
    Inherited from GenStaticText
int labelDelta = 1                                                                     

Instance Method Details

__init__(self, parent, id=-1, label='', pos=wx.Point(-1, -1), size=wx.Size(-1, -1), style=0, name='staticText', szURL='')
(Constructor)

Default Class Constructor.

Pass szURL == "" To Use The Label As The URL Link To Navigate To
Overrides:
wx.lib.stattext.GenStaticText.__init__

AutoBrowse(self, bBrowse=True)

Automatically Browse To URL When Clicked. Set To False To Receive EVT_LINK_CLICKED() Event.

DisplayError(self, szError, bReportErrors=True)

Displays An Error Message (Accordingly To bReportErrors Variable) In A MessageBox.

DoPopup(self, bPopup=True)

Sets Wether To Show Popup Menu On Right Click Or Not.

EnableRollover(self, bEnable=False)

Enable/Disable Rollover.

GetBold(self)

Returns Wether The HyperLink Has Text In Bold Or Not.

GetBrowserPath(self)

Returns The Browser Path.

GetColours(self)

Gets The Colours For The Link, The Visited Link And The Mouse Rollover.

GetLinkCursor(self)

Gets The Link Cursor.

GetUnderlines(self)

Returns If Link Is UnderLined, If The Mouse Rollover Is Underlined And If The Visited Link Is Underlined.

GetURL(self)

Retrieve The URL Associated To The HyperLink.

GetVisited(self)

Returns Wether A Link Has Been Visited Or Not.

GotoURL(self, szUrl, szBrowser='', bReportErrors=True, bSameWinIfPossible=False)

Goto The Specified URL.

The Input Values Are:
  • szBrowser Is The Absolute Path To The Browser Executable. Specify szBrowser As An Empty String To Use The Default Web Browser.
  • Use bReportErrors = True To Display Error Dialog If An Error Occurrs Navigating To The URL.
  • Set bSameWinIfPossible As True To Attempt To Open The URL In The Current Browser Window.

OnMouseEvent(self, event)

Captures Mouse Events For Cursor, Link Colors And Underlines.

OnPopUpCopy(self, event)

Copy Data From The HyperLink To The ClipBoard.

OpenInSameWindow(self, bIfPossible=False)

Open Multiple URL In The Same Window (If Possible).

ReportErrors(self, bReport=True)

Set Wether To Report Browser Errors Or Not.

SetBold(self, bBold=False)

Sets The HyperLink In Bold Text.

SetBrowserPath(self, browser='')

Sets The Browser Path. Set To Empty String To Use The System Default Browser

SetColours(self, link=wx.Colour(0, 0, 255), visited=wx.Colour(79, 47, 79), rollover=wx.Colour(0, 0, 255))

Sets The Colours For The Link, The Visited Link And The Mouse Rollover.

Defaults Are:
  • New Link: RED
  • Visited Link: VIOLET
  • Rollover: BLUE

SetLinkCursor(self, cur=6)

Sets Link Cursor Properties.

SetUnderlines(self, link=True, visited=True, rollover=True)

Underlines Properties.

SetURL(self, szURL)

Sets The HyperLink Text To The Specified URL.

SetVisited(self, bVisited=False)

Sets A Link As Visited.

UpdateLink(self, bRefresh=True)

Updates The Link.

Changing Text Properties If:
  • User Specific Setting
  • Link Visited
  • New Link

Generated by Epydoc 2.1 on Thu Apr 28 23:21:57 2005 http://epydoc.sf.net