Moved all interface headers into a 'wx' subdirectory for proper use of Doxygen path settings.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@54385 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Bryan Petty
186
interface/wx/hyperlink.h
Normal file
186
interface/wx/hyperlink.h
Normal file
@@ -0,0 +1,186 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: hyperlink.h
|
||||
// Purpose: interface of wxHyperlinkEvent
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
/**
|
||||
@class wxHyperlinkEvent
|
||||
@wxheader{hyperlink.h}
|
||||
|
||||
This event class is used for the events generated by
|
||||
wxHyperlinkCtrl.
|
||||
|
||||
@library{wxadv}
|
||||
@category{FIXME}
|
||||
*/
|
||||
class wxHyperlinkEvent : public wxCommandEvent
|
||||
{
|
||||
public:
|
||||
/**
|
||||
The constructor is not normally used by the user code.
|
||||
*/
|
||||
wxHyperlinkEvent(wxObject* generator, int id,
|
||||
const wxString& url);
|
||||
|
||||
/**
|
||||
Returns the URL of the hyperlink where the user has just clicked.
|
||||
*/
|
||||
wxString GetURL() const;
|
||||
|
||||
/**
|
||||
Sets the URL associated with the event.
|
||||
*/
|
||||
void SetURL(const wxString& url);
|
||||
};
|
||||
|
||||
|
||||
|
||||
/**
|
||||
@class wxHyperlinkCtrl
|
||||
@wxheader{hyperlink.h}
|
||||
|
||||
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.
|
||||
|
||||
Note that standard wxWindow functions like wxWindow::SetBackgroundColour,
|
||||
wxWindow::SetFont, wxWindow::SetCursor, wxWindow::SetLabel can be used to customize appearance of the hyperlink.
|
||||
|
||||
@beginStyleTable
|
||||
@style{wxHL_ALIGN_LEFT}
|
||||
Align the text to the left.
|
||||
@style{wxHL_ALIGN_RIGHT}
|
||||
Align the text to the right.
|
||||
@style{wxHL_ALIGN_CENTRE}
|
||||
Center the text (horizontally).
|
||||
@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
|
||||
handled by the hyperlink and which just copies in the clipboard the
|
||||
URL (not the label) of the control.
|
||||
@style{wxHL_DEFAULT_STYLE}
|
||||
The default style for wxHyperlinkCtrl:
|
||||
wxBORDER_NONE|wxHL_CONTEXTMENU|wxHL_ALIGN_CENTRE.
|
||||
@endStyleTable
|
||||
|
||||
@library{wxadv}
|
||||
@category{ctrl}
|
||||
<!-- @appearance{hyperlinkctrl.png} -->
|
||||
|
||||
@see wxURL, wxHyperlinkEvent
|
||||
*/
|
||||
class wxHyperlinkCtrl : public wxControl
|
||||
{
|
||||
public:
|
||||
/**
|
||||
Constructor. See Create() for more info.
|
||||
*/
|
||||
wxHyperLink(wxWindow* parent, wxWindowID id,
|
||||
const wxString& label,
|
||||
const wxString& url,
|
||||
const wxPoint& pos = wxDefaultPosition,
|
||||
const wxSize& size = wxDefaultSize,
|
||||
long style = wxHL_DEFAULT_STYLE,
|
||||
const wxString& name = "hyperlink");
|
||||
|
||||
/**
|
||||
Creates the hyperlink control.
|
||||
|
||||
@param parent
|
||||
Parent window. Must not be @NULL.
|
||||
@param id
|
||||
Window identifier. A value of wxID_ANY indicates a default value.
|
||||
@param label
|
||||
The label of the hyperlink.
|
||||
@param url
|
||||
The URL associated with the given label.
|
||||
@param pos
|
||||
Window position.
|
||||
@param size
|
||||
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.
|
||||
*/
|
||||
bool Create(wxWindow* parent, wxWindowID id,
|
||||
const wxString& label,
|
||||
const wxString& url,
|
||||
const wxPoint& pos = wxDefaultPosition,
|
||||
const wxSize& size = wxDefaultSize,
|
||||
long style = wxHL_DEFAULT_STYLE,
|
||||
const wxString& name = "hyperlink");
|
||||
|
||||
/**
|
||||
Returns the colour used to print the label of the hyperlink when the mouse is
|
||||
over the control.
|
||||
*/
|
||||
wxColour GetHoverColour() const;
|
||||
|
||||
/**
|
||||
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.
|
||||
*/
|
||||
wxColour GetNormalColour() const;
|
||||
|
||||
/**
|
||||
Returns the URL associated with the hyperlink.
|
||||
*/
|
||||
wxString GetURL() const;
|
||||
|
||||
/**
|
||||
Returns @true if the hyperlink has already been clicked by the user at least
|
||||
one time.
|
||||
*/
|
||||
virtual bool GetVisited() const = 0;
|
||||
|
||||
/**
|
||||
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).
|
||||
*/
|
||||
wxColour GetVisitedColour() const;
|
||||
|
||||
/**
|
||||
Sets the colour used to print the label of the hyperlink when the mouse is over
|
||||
the control.
|
||||
*/
|
||||
void SetHoverColour(const wxColour& colour);
|
||||
|
||||
/**
|
||||
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.
|
||||
*/
|
||||
void SetNormalColour(const wxColour& colour);
|
||||
|
||||
/**
|
||||
Sets the URL associated with the hyperlink.
|
||||
*/
|
||||
void SetURL(const wxString& url);
|
||||
|
||||
/**
|
||||
Marks the hyperlink as visited (see wxHyperlinkCtrl::SetVisitedColour).
|
||||
*/
|
||||
virtual void SetVisited(bool visited = true) = 0;
|
||||
|
||||
/**
|
||||
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).
|
||||
*/
|
||||
void SetVisitedColour(const wxColour& colour);
|
||||
};
|
||||
|
||||
Reference in New Issue
Block a user