Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

remaining h* interface header revision

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@56662 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-11-03 14:37:14 +00:00
parent f9bb777f88
commit 9cc56d1fc0
6 changed files with 627 additions and 241 deletions
Download Patch File Download Diff File Expand all files Collapse all files

55
interface/wx/hyperlink.h
View File

@@ -9,11 +9,15 @@
/**
@class wxHyperlinkEvent
This event class is used for the events generated by
wxHyperlinkCtrl.
This event class is used for the events generated by wxHyperlinkCtrl.
@beginEventTable{wxHyperlinkEvent}
@event{EVT_HYPERLINK(id, func)}
User clicked on an hyperlink.
@endEventTable
@library{wxadv}
@category{FIXME}
@category{events}
*/
class wxHyperlinkEvent : public wxCommandEvent
{
@@ -21,8 +25,7 @@ public:
/**
The constructor is not normally used by the user code.
*/
wxHyperlinkEvent(wxObject* generator, int id,
const wxString& url);
wxHyperlinkEvent(wxObject* generator, int id, const wxString& url);
/**
Returns the URL of the hyperlink where the user has just clicked.
@@ -41,15 +44,15 @@ public:
@class wxHyperlinkCtrl
This class shows a static text element which links to an URL.
Appearance and behaviour is completely customizable. In fact, when the user
clicks on the hyperlink, a wxHyperlinkEvent is
sent but if that event is not handled (or it's skipped; see
wxEvent::Skip), then a call to
wxLaunchDefaultBrowser() is done with the
hyperlink's URL.
Appearance and behaviour is completely customizable.
In fact, when the user clicks on the hyperlink, a wxHyperlinkEvent is
sent but if that event is not handled (or it's skipped; see wxEvent::Skip),
then a call to wxLaunchDefaultBrowser() is done with the hyperlink's URL.
Note that standard wxWindow functions like wxWindow::SetBackgroundColour,
wxWindow::SetFont, wxWindow::SetCursor, wxWindow::SetLabel can be used to customize appearance of the hyperlink.
wxWindow::SetFont, wxWindow::SetCursor, wxWindow::SetLabel can be used to
customize appearance of the hyperlink.
@beginStyleTable
@style{wxHL_ALIGN_LEFT}
@@ -68,6 +71,14 @@ public:
wxBORDER_NONE|wxHL_CONTEXTMENU|wxHL_ALIGN_CENTRE.
@endStyleTable
@beginEventTable{wxHyperlinkEvent}
@event{EVT_HYPERLINK(id, func)}
The hyperlink was (left) clicked. If this event is not handled in user's
code (or it's skipped; see wxEvent::Skip), then a call to wxLaunchDefaultBrowser
is done with the hyperlink's URL.
@endEventTable
@library{wxadv}
@category{ctrl}
@appearance{hyperlinkctrl.png}
@@ -102,12 +113,10 @@ public:
@param pos
Window position.
@param size
Window size. If the wxDefaultSize is specified then the window is sized
appropriately.
Window size.
If the wxDefaultSize is specified then the window is sized appropriately.
@param style
Window style. See wxHyperlinkCtrl.
@param validator
Window validator.
@param name
Window name.
*/
@@ -125,8 +134,7 @@ public:
/**
Returns the colour used to print the label when the link has never been clicked
before
(i.e. the link has not been @e visited) and the mouse is not over the control.
before (i.e. the link has not been @e visited) and the mouse is not over the control.
*/
virtual wxColour GetNormalColour() const;
@@ -143,9 +151,8 @@ public:
/**
Returns the colour used to print the label when the mouse is not over the
control
and the link has already been clicked before (i.e. the link has been @e
visited).
control and the link has already been clicked before (i.e. the link has
been @e visited).
*/
virtual wxColour GetVisitedColour() const;
@@ -156,8 +163,7 @@ public:
virtual void SetHoverColour(const wxColour& colour);
/**
Sets the colour used to print the label when the link has never been clicked
before
Sets the colour used to print the label when the link has never been clicked before
(i.e. the link has not been @e visited) and the mouse is not over the control.
*/
virtual void SetNormalColour(const wxColour& colour);
@@ -174,8 +180,7 @@ public:
/**
Sets the colour used to print the label when the mouse is not over the control
and the link has already been clicked before (i.e. the link has been @e
visited).
and the link has already been clicked before (i.e. the link has been @e visited).
*/
virtual void SetVisitedColour(const wxColour& colour);
};