// Purpose: interface of wxHyperlinkEvent
// Author: wxWidgets team
// RCS-ID: $Id$
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
+#define wxHL_CONTEXTMENU 0x0001
+#define wxHL_ALIGN_LEFT 0x0002
+#define wxHL_ALIGN_RIGHT 0x0004
+#define wxHL_ALIGN_CENTRE 0x0008
+#define wxHL_DEFAULT_STYLE (wxHL_CONTEXTMENU|wxNO_BORDER|wxHL_ALIGN_CENTRE)
+
/**
@class wxHyperlinkEvent
};
+wxEventType wxEVT_HYPERLINK;
/**
@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
@style{wxHL_ALIGN_LEFT}
Align the text to the left.
@style{wxHL_ALIGN_RIGHT}
- Align the text to the right.
+ Align the text to the right. This style is not supported under
+ Windows XP but is supported under all the other Windows versions.
@style{wxHL_ALIGN_CENTRE}
- Center the text (horizontally).
+ Center the text (horizontally). This style is not supported by the
+ native MSW implementation used under Windows XP and later.
@style{wxHL_CONTEXTMENU}
Pop up a context menu when the hyperlink is right-clicked. The
context menu contains a "Copy URL" menu item which is automatically
wxBORDER_NONE|wxHL_CONTEXTMENU|wxHL_ALIGN_CENTRE.
@endStyleTable
- @beginEventTable{wxHyperlinkEvent}
+ @beginEventEmissionTable{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
+ Currently this class is implemented using native support in wxGTK and wxMSW
+ (under Windows XP and later only) and a generic version is used by the
+ other ports.
@library{wxadv}
@category{ctrl}
- @appearance{hyperlinkctrl.png}
+ @appearance{hyperlinkctrl}
@see wxURL, wxHyperlinkEvent
*/
class wxHyperlinkCtrl : public wxControl
{
public:
+ wxHyperlinkCtrl();
+
/**
Constructor. See Create() for more info.
*/
- wxHyperLinkCtrl(wxWindow* parent, wxWindowID id,
+ wxHyperlinkCtrl(wxWindow* parent, wxWindowID id,
const wxString& label,
const wxString& url,
const wxPoint& pos = wxDefaultPosition,