#include <wx/html/htmlwin.h>
wxHtmlWindow is probably the only class you will directly use unless you want to do something special (like adding new tag handlers or MIME filters).
The purpose of this class is to display rich content pages (either local file or downloaded via HTTP protocol) in a window based on a subset of the HTML standard. The width of the window is constant, given in the constructor and virtual height is changed dynamically depending on page size. Once the window is created you can set its content by calling SetPage() with raw HTML, LoadPage() with a wxFileSystem location or LoadFile() with a filename.
wxHtmlWindow uses the wxImage class for displaying images, so you need to initialize the handlers for any image formats you use before loading a page. See wxInitAllImageHandlers and wxImage::AddHandler.
This class supports the following styles:
The following event handler macros redirect the events to member function handlers 'func' with prototypes like:
Event macros for events emitted by this class:
Public Member Functions | |
wxHtmlWindow () | |
Default ctor. | |
wxHtmlWindow (wxWindow *parent, wxWindowID id=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxHW_DEFAULT_STYLE, const wxString &name="htmlWindow") | |
Constructor. | |
bool | AppendToPage (const wxString &source) |
Appends HTML fragment to currently displayed text and refreshes the window. | |
wxHtmlContainerCell * | GetInternalRepresentation () const |
Returns pointer to the top-level container. | |
wxString | GetOpenedAnchor () const |
Returns anchor within currently opened page (see wxHtmlWindow::GetOpenedPage). | |
wxString | GetOpenedPage () const |
Returns full location of the opened page. | |
wxString | GetOpenedPageTitle () const |
Returns title of the opened page or wxEmptyString if the current page does not contain <TITLE> tag. | |
wxHtmlWinParser * | GetParser () const |
Returns a pointer to the current parser. | |
wxFrame * | GetRelatedFrame () const |
Returns the related frame. | |
bool | HistoryBack () |
Moves back to the previous page. | |
bool | HistoryCanBack () |
Returns true if it is possible to go back in the history i.e. | |
bool | HistoryCanForward () |
Returns true if it is possible to go forward in the history i.e. | |
void | HistoryClear () |
Clears history. | |
bool | HistoryForward () |
Moves to next page in history. | |
bool | LoadFile (const wxFileName &filename) |
Loads an HTML page from a file and displays it. | |
virtual bool | LoadPage (const wxString &location) |
Unlike SetPage() this function first loads the HTML page from location and then displays it. | |
virtual void | OnLinkClicked (const wxHtmlLinkInfo &link) |
Called when user clicks on hypertext link. | |
virtual wxHtmlOpeningStatus | OnOpeningURL (wxHtmlURLType type, const wxString &url, wxString *redirect) const |
Called when an URL is being opened (either when the user clicks on a link or an image is loaded). | |
virtual void | OnSetTitle (const wxString &title) |
Called on parsing <TITLE> tag. | |
virtual void | ReadCustomization (wxConfigBase *cfg, wxString path=wxEmptyString) |
This reads custom settings from wxConfig. | |
void | SelectAll () |
Selects all text in the window. | |
void | SelectLine (const wxPoint &pos) |
Selects the line of text that pos points at. | |
void | SelectWord (const wxPoint &pos) |
Selects the word at position pos. | |
wxString | SelectionToText () |
Returns the current selection as plain text. | |
void | SetBorders (int b) |
This function sets the space between border of window and HTML contents. | |
void | SetFonts (const wxString &normal_face, const wxString &fixed_face, const int *sizes=NULL) |
This function sets font sizes and faces. | |
void | SetStandardFonts (int size=-1, const wxString &normal_face=wxEmptyString, const wxString &fixed_face=wxEmptyString) |
Sets default font sizes and/or default font size. | |
virtual bool | SetPage (const wxString &source) |
Sets the source of a page and displays it, for example: | |
void | SetRelatedFrame (wxFrame *frame, const wxString &format) |
Sets the frame in which page title will be displayed. | |
void | SetRelatedStatusBar (int index) |
After calling SetRelatedFrame(), this sets statusbar slot where messages will be displayed. | |
void | SetRelatedStatusBar (wxStatusBar *statusbar, int index=0) |
Sets the associated statusbar where messages will be displayed. | |
wxString | ToText () |
Returns content of currently displayed page as plain text. | |
virtual void | WriteCustomization (wxConfigBase *cfg, wxString path=wxEmptyString) |
Saves custom settings into wxConfig. | |
![]() | |
wxScrolled () | |
Default constructor. | |
wxScrolled (wxWindow *parent, wxWindowID id=-1, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxHSCROLL|wxVSCROLL, const wxString &name="scrolledWindow") | |
Constructor. | |
void | CalcScrolledPosition (int x, int y, int *xx, int *yy) const |
Translates the logical coordinates to the device ones. | |
wxPoint | CalcScrolledPosition (const wxPoint &pt) const |
void | CalcUnscrolledPosition (int x, int y, int *xx, int *yy) const |
Translates the device coordinates to the logical ones. | |
wxPoint | CalcUnscrolledPosition (const wxPoint &pt) const |
bool | Create (wxWindow *parent, wxWindowID id=-1, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxHSCROLL|wxVSCROLL, const wxString &name="scrolledWindow") |
Creates the window for two-step construction. | |
void | DisableKeyboardScrolling () |
Disable use of keyboard keys for scrolling. | |
void | DoPrepareDC (wxDC &dc) |
Call this function to prepare the device context for drawing a scrolled image. | |
void | EnableScrolling (bool xScrolling, bool yScrolling) |
Enable or disable use of wxWindow::ScrollWindow() for scrolling. | |
void | ShowScrollbars (wxScrollbarVisibility horz, wxScrollbarVisibility vert) |
Set the scrollbar visibility. | |
void | GetScrollPixelsPerUnit (int *xUnit, int *yUnit) const |
Get the number of pixels per scroll unit (line), in each direction, as set by SetScrollbars(). | |
void | GetViewStart (int *x, int *y) const |
Get the position at which the visible portion of the window starts. | |
wxPoint | GetViewStart () const |
This is a simple overload of GetViewStart(int*,int*); see that function for more info. | |
void | GetVirtualSize (int *x, int *y) const |
Gets the size in device units of the scrollable window area (as opposed to the client size, which is the area of the window currently visible). | |
bool | IsRetained () const |
Motif only: true if the window has a backing bitmap. | |
virtual void | OnDraw (wxDC &dc) |
Called by the default paint event handler to allow the application to define painting behaviour without having to worry about calling DoPrepareDC(). | |
void | PrepareDC (wxDC &dc) |
This function is for backwards compatibility only and simply calls DoPrepareDC() now. | |
void | Scroll (int x, int y) |
Scrolls a window so the view start is at the given point. | |
void | Scroll (const wxPoint &pt) |
This is an overload of Scroll(int,int); see that function for more info. | |
void | SetScrollRate (int xstep, int ystep) |
Set the horizontal and vertical scrolling increment only. | |
void | SetScrollbars (int pixelsPerUnitX, int pixelsPerUnitY, int noUnitsX, int noUnitsY, int xPos=0, int yPos=0, bool noRefresh=false) |
Sets up vertical and/or horizontal scrollbars. | |
void | SetTargetWindow (wxWindow *window) |
Call this function to tell wxScrolled to perform the actual scrolling on a different window (and not on itself). | |
wxWindow * | GetTargetWindow () const |
void | SetTargetRect (const wxRect &rect) |
wxRect | GetTargetRect () const |
int | GetScrollPageSize (int orient) const |
void | SetScrollPageSize (int orient, int pageSize) |
int | GetScrollLines (int orient) const |
void | SetScale (double xs, double ys) |
double | GetScaleX () const |
double | GetScaleY () const |
virtual void | AdjustScrollbars () |
bool | IsAutoScrolling () const |
Are we generating the autoscroll events? | |
void | StopAutoScrolling () |
Stop generating the scroll events when mouse is held outside the window. | |
virtual bool | SendAutoScrollEvents (wxScrollWinEvent &event) const |
This method can be overridden in a derived class to forbid sending the auto scroll events - note that unlike StopAutoScrolling() it doesn't stop the timer, so it will be called repeatedly and will typically return different values depending on the current mouse position. | |
wxScrolled () | |
Default constructor. | |
wxScrolled (wxWindow *parent, wxWindowID id=-1, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxHSCROLL|wxVSCROLL, const wxString &name="scrolledWindow") | |
Constructor. | |
void | CalcScrolledPosition (int x, int y, int *xx, int *yy) const |
Translates the logical coordinates to the device ones. | |
wxPoint | CalcScrolledPosition (const wxPoint &pt) const |
void | CalcUnscrolledPosition (int x, int y, int *xx, int *yy) const |
Translates the device coordinates to the logical ones. | |
wxPoint | CalcUnscrolledPosition (const wxPoint &pt) const |
bool | Create (wxWindow *parent, wxWindowID id=-1, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxHSCROLL|wxVSCROLL, const wxString &name="scrolledWindow") |
Creates the window for two-step construction. | |
void | DisableKeyboardScrolling () |
Disable use of keyboard keys for scrolling. | |
void | DoPrepareDC (wxDC &dc) |
Call this function to prepare the device context for drawing a scrolled image. | |
void | EnableScrolling (bool xScrolling, bool yScrolling) |
Enable or disable use of wxWindow::ScrollWindow() for scrolling. | |
void | ShowScrollbars (wxScrollbarVisibility horz, wxScrollbarVisibility vert) |
Set the scrollbar visibility. | |
void | GetScrollPixelsPerUnit (int *xUnit, int *yUnit) const |
Get the number of pixels per scroll unit (line), in each direction, as set by SetScrollbars(). | |
void | GetViewStart (int *x, int *y) const |
Get the position at which the visible portion of the window starts. | |
wxPoint | GetViewStart () const |
This is a simple overload of GetViewStart(int*,int*); see that function for more info. | |
void | GetVirtualSize (int *x, int *y) const |
Gets the size in device units of the scrollable window area (as opposed to the client size, which is the area of the window currently visible). | |
bool | IsRetained () const |
Motif only: true if the window has a backing bitmap. | |
virtual void | OnDraw (wxDC &dc) |
Called by the default paint event handler to allow the application to define painting behaviour without having to worry about calling DoPrepareDC(). | |
void | PrepareDC (wxDC &dc) |
This function is for backwards compatibility only and simply calls DoPrepareDC() now. | |
void | Scroll (int x, int y) |
Scrolls a window so the view start is at the given point. | |
void | Scroll (const wxPoint &pt) |
This is an overload of Scroll(int,int); see that function for more info. | |
void | SetScrollRate (int xstep, int ystep) |
Set the horizontal and vertical scrolling increment only. | |
void | SetScrollbars (int pixelsPerUnitX, int pixelsPerUnitY, int noUnitsX, int noUnitsY, int xPos=0, int yPos=0, bool noRefresh=false) |
Sets up vertical and/or horizontal scrollbars. | |
void | SetTargetWindow (wxWindow *window) |
Call this function to tell wxScrolled to perform the actual scrolling on a different window (and not on itself). | |
wxWindow * | GetTargetWindow () const |
void | SetTargetRect (const wxRect &rect) |
wxRect | GetTargetRect () const |
int | GetScrollPageSize (int orient) const |
void | SetScrollPageSize (int orient, int pageSize) |
int | GetScrollLines (int orient) const |
void | SetScale (double xs, double ys) |
double | GetScaleX () const |
double | GetScaleY () const |
virtual void | AdjustScrollbars () |
bool | IsAutoScrolling () const |
Are we generating the autoscroll events? | |
void | StopAutoScrolling () |
Stop generating the scroll events when mouse is held outside the window. | |
virtual bool | SendAutoScrollEvents (wxScrollWinEvent &event) const |
This method can be overridden in a derived class to forbid sending the auto scroll events - note that unlike StopAutoScrolling() it doesn't stop the timer, so it will be called repeatedly and will typically return different values depending on the current mouse position. | |
![]() | |
wxPanel () | |
Default constructor. | |
wxPanel (wxWindow *parent, wxWindowID id=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL, const wxString &name=wxPanelNameStr) | |
Constructor. | |
virtual | ~wxPanel () |
Destructor. | |
bool | AcceptsFocus () const |
This method is overridden from wxWindow::AcceptsFocus() and returns true only if there is no child window in the panel which can accept the focus. | |
bool | Create (wxWindow *parent, wxWindowID id=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL, const wxString &name=wxPanelNameStr) |
Used for two-step panel construction. | |
virtual void | InitDialog () |
Sends a wxInitDialogEvent, which in turn transfers data to the dialog via validators. | |
virtual bool | Layout () |
See wxWindow::SetAutoLayout(): when auto layout is on, this function gets called automatically when the window is resized. | |
void | OnSysColourChanged (wxSysColourChangedEvent &event) |
The default handler for wxEVT_SYS_COLOUR_CHANGED . | |
virtual void | SetFocus () |
Overrides wxWindow::SetFocus(). | |
void | SetFocusIgnoringChildren () |
In contrast to SetFocus() (see above) this will set the focus to the panel even if there are child windows in the panel. | |
![]() | |
wxWindow () | |
Default constructor. | |
wxWindow (wxWindow *parent, wxWindowID id, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0, const wxString &name=wxPanelNameStr) | |
Constructs a window, which can be a child of a frame, dialog or any other non-control window. | |
virtual | ~wxWindow () |
Destructor. | |
bool | Create (wxWindow *parent, wxWindowID id, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0, const wxString &name=wxPanelNameStr) |
Construct the actual window object after creating the C++ object. | |
virtual bool | AcceptsFocusFromKeyboard () const |
This method may be overridden in the derived classes to return false to indicate that while this control can, in principle, have focus if the user clicks it with the mouse, it shouldn't be included in the TAB traversal chain when using the keyboard. | |
virtual bool | AcceptsFocusRecursively () const |
Overridden to indicate whether this window or one of its children accepts focus. | |
void | DisableFocusFromKeyboard () |
Disable giving focus to this window using the keyboard navigation keys. | |
bool | IsFocusable () const |
Can this window itself have focus? | |
bool | CanAcceptFocus () const |
Can this window have focus right now? | |
bool | CanAcceptFocusFromKeyboard () const |
Can this window be assigned focus from keyboard right now? | |
virtual bool | HasFocus () const |
Returns true if the window (or in case of composite controls, its main child window) has focus. | |
virtual void | SetCanFocus (bool canFocus) |
This method is only implemented by ports which have support for native TAB traversal (such as GTK+ 2.0). | |
virtual void | EnableVisibleFocus (bool enable) |
Enables or disables visible indication of keyboard focus. | |
virtual void | SetFocusFromKbd () |
This function is called by wxWidgets keyboard navigation code when the user gives the focus to this window from keyboard (e.g. using TAB key). | |
virtual void | AddChild (wxWindow *child) |
Adds a child window. | |
bool | DestroyChildren () |
Destroys all children of a window. | |
wxWindow * | FindWindow (long id) const |
Find a child of this window, by id. | |
wxWindow * | FindWindow (const wxString &name) const |
Find a child of this window, by name. | |
wxWindowList & | GetChildren () |
Returns a reference to the list of the window's children. | |
const wxWindowList & | GetChildren () const |
Returns a const reference to the list of the window's children. | |
virtual void | RemoveChild (wxWindow *child) |
Removes a child window. | |
wxWindow * | GetGrandParent () const |
Returns the grandparent of a window, or NULL if there isn't one. | |
wxWindow * | GetNextSibling () const |
Returns the next window after this one among the parent's children or NULL if this window is the last child. | |
wxWindow * | GetParent () const |
Returns the parent of the window, or NULL if there is no parent. | |
wxWindow * | GetPrevSibling () const |
Returns the previous window before this one among the parent's children or NULL if this window is the first child. | |
bool | IsDescendant (wxWindow *win) const |
Check if the specified window is a descendant of this one. | |
virtual bool | Reparent (wxWindow *newParent) |
Reparents the window, i.e. the window will be removed from its current parent window (e.g. | |
virtual void | AlwaysShowScrollbars (bool hflag=true, bool vflag=true) |
Call this function to force one or both scrollbars to be always shown, even if the window is big enough to show its entire contents without scrolling. | |
virtual int | GetScrollPos (int orientation) const |
Returns the built-in scrollbar position. | |
virtual int | GetScrollRange (int orientation) const |
Returns the built-in scrollbar range. | |
virtual int | GetScrollThumb (int orientation) const |
Returns the built-in scrollbar thumb size. | |
bool | CanScroll (int orient) const |
Returns true if this window can have a scroll bar in this orientation. | |
bool | HasScrollbar (int orient) const |
Returns true if this window currently has a scroll bar for this orientation. | |
virtual bool | IsScrollbarAlwaysShown (int orient) const |
Return whether a scrollbar is always shown. | |
virtual bool | ScrollLines (int lines) |
Scrolls the window by the given number of lines down (if lines is positive) or up. | |
virtual bool | ScrollPages (int pages) |
Scrolls the window by the given number of pages down (if pages is positive) or up. | |
virtual void | ScrollWindow (int dx, int dy, const wxRect *rect=NULL) |
Physically scrolls the pixels in the window and move child windows accordingly. | |
bool | LineUp () |
Same as ScrollLines (-1). | |
bool | LineDown () |
Same as ScrollLines (1). | |
bool | PageUp () |
Same as ScrollPages (-1). | |
bool | PageDown () |
Same as ScrollPages (1). | |
virtual void | SetScrollPos (int orientation, int pos, bool refresh=true) |
Sets the position of one of the built-in scrollbars. | |
virtual void | SetScrollbar (int orientation, int position, int thumbSize, int range, bool refresh=true) |
Sets the scrollbar properties of a built-in scrollbar. | |
void | Center (int dir=wxBOTH) |
A synonym for Centre(). | |
void | CenterOnParent (int dir=wxBOTH) |
A synonym for CentreOnParent(). | |
void | Centre (int direction=wxBOTH) |
Centres the window. | |
void | CentreOnParent (int direction=wxBOTH) |
Centres the window on its parent. | |
void | GetPosition (int *x, int *y) const |
This gets the position of the window in pixels, relative to the parent window for the child windows or relative to the display origin for the top level windows. | |
wxPoint | GetPosition () const |
This gets the position of the window in pixels, relative to the parent window for the child windows or relative to the display origin for the top level windows. | |
wxRect | GetRect () const |
Returns the position and size of the window as a wxRect object. | |
void | GetScreenPosition (int *x, int *y) const |
Returns the window position in screen coordinates, whether the window is a child window or a top level one. | |
wxPoint | GetScreenPosition () const |
Returns the window position in screen coordinates, whether the window is a child window or a top level one. | |
wxRect | GetScreenRect () const |
Returns the position and size of the window on the screen as a wxRect object. | |
virtual wxPoint | GetClientAreaOrigin () const |
Get the origin of the client area of the window relative to the window top left corner (the client area may be shifted because of the borders, scrollbars, other decorations...) | |
wxRect | GetClientRect () const |
Get the client rectangle in window (i.e. client) coordinates. | |
void | Move (int x, int y, int flags=wxSIZE_USE_EXISTING) |
Moves the window to the given position. | |
void | Move (const wxPoint &pt, int flags=wxSIZE_USE_EXISTING) |
Moves the window to the given position. | |
void | SetPosition (const wxPoint &pt) |
Moves the window to the specified position. | |
void | ClientToScreen (int *x, int *y) const |
Converts to screen coordinates from coordinates relative to this window. | |
wxPoint | ClientToScreen (const wxPoint &pt) const |
Converts to screen coordinates from coordinates relative to this window. | |
wxPoint | ConvertDialogToPixels (const wxPoint &pt) const |
Converts a point or size from dialog units to pixels. | |
wxSize | ConvertDialogToPixels (const wxSize &sz) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
wxPoint | ConvertPixelsToDialog (const wxPoint &pt) const |
Converts a point or size from pixels to dialog units. | |
wxSize | ConvertPixelsToDialog (const wxSize &sz) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
void | ScreenToClient (int *x, int *y) const |
Converts from screen to client window coordinates. | |
wxPoint | ScreenToClient (const wxPoint &pt) const |
Converts from screen to client window coordinates. | |
virtual void | ClearBackground () |
Clears the window by filling it with the current background colour. | |
void | Freeze () |
Freezes the window or, in other words, prevents any updates from taking place on screen, the window is not redrawn at all. | |
void | Thaw () |
Re-enables window updating after a previous call to Freeze(). | |
bool | IsFrozen () const |
Returns true if the window is currently frozen by a call to Freeze(). | |
wxColour | GetBackgroundColour () const |
Returns the background colour of the window. | |
virtual wxBackgroundStyle | GetBackgroundStyle () const |
Returns the background style of the window. | |
virtual int | GetCharHeight () const |
Returns the character height for this window. | |
virtual int | GetCharWidth () const |
Returns the average character width for this window. | |
virtual wxVisualAttributes | GetDefaultAttributes () const |
Currently this is the same as calling wxWindow::GetClassDefaultAttributes(wxWindow::GetWindowVariant()). | |
virtual wxSize | GetDPI () const |
Return the DPI of the display used by this window. | |
wxFont | GetFont () const |
Returns the font for this window. | |
wxColour | GetForegroundColour () const |
Returns the foreground colour of the window. | |
void | GetTextExtent (const wxString &string, int *w, int *h, int *descent=NULL, int *externalLeading=NULL, const wxFont *font=NULL) const |
Gets the dimensions of the string as it would be drawn on the window with the currently selected font. | |
wxSize | GetTextExtent (const wxString &string) const |
Gets the dimensions of the string as it would be drawn on the window with the currently selected font. | |
const wxRegion & | GetUpdateRegion () const |
Returns the region specifying which parts of the window have been damaged. | |
wxRect | GetUpdateClientRect () const |
Get the update rectangle bounding box in client coords. | |
virtual bool | HasTransparentBackground () |
Returns true if this window background is transparent (as, for example, for wxStaticText) and should show the parent window background. | |
virtual void | Refresh (bool eraseBackground=true, const wxRect *rect=NULL) |
Causes this window, and all of its children recursively, to be repainted. | |
void | RefreshRect (const wxRect &rect, bool eraseBackground=true) |
Redraws the contents of the given rectangle: only the area inside it will be repainted. | |
virtual void | Update () |
Immediately repaints the invalidated area of the window and all of its children recursively. | |
virtual bool | SetBackgroundColour (const wxColour &colour) |
Sets the background colour of the window. | |
virtual bool | SetBackgroundStyle (wxBackgroundStyle style) |
Sets the background style of the window. | |
virtual bool | IsTransparentBackgroundSupported (wxString *reason=NULL) const |
Checks whether using transparent background might work. | |
virtual bool | SetFont (const wxFont &font) |
Sets the font for this window. | |
virtual bool | SetForegroundColour (const wxColour &colour) |
Sets the foreground colour of the window. | |
void | SetOwnBackgroundColour (const wxColour &colour) |
Sets the background colour of the window but prevents it from being inherited by the children of this window. | |
bool | InheritsBackgroundColour () const |
Return true if this window inherits the background colour from its parent. | |
bool | UseBgCol () const |
Return true if a background colour has been set for this window. | |
bool | UseBackgroundColour () const |
Return true if a background colour has been set for this window. | |
void | SetOwnFont (const wxFont &font) |
Sets the font of the window but prevents it from being inherited by the children of this window. | |
void | SetOwnForegroundColour (const wxColour &colour) |
Sets the foreground colour of the window but prevents it from being inherited by the children of this window. | |
bool | UseForegroundColour () const |
Return true if a foreground colour has been set for this window. | |
bool | InheritsForegroundColour () const |
Return true if this window inherits the foreground colour from its parent. | |
void | SetPalette (const wxPalette &pal) |
virtual bool | ShouldInheritColours () const |
Return true from here to allow the colours of this window to be changed by InheritAttributes(). | |
virtual void | SetThemeEnabled (bool enable) |
This function tells a window if it should use the system's "theme" code to draw the windows' background instead of its own background drawing code. | |
virtual bool | GetThemeEnabled () const |
Returns true if the window uses the system theme for drawing its background. | |
virtual bool | CanSetTransparent () |
Returns true if the system supports transparent windows and calling SetTransparent() may succeed. | |
virtual bool | SetTransparent (wxByte alpha) |
Set the transparency of the window. | |
wxEvtHandler * | GetEventHandler () const |
Returns the event handler for this window. | |
bool | HandleAsNavigationKey (const wxKeyEvent &event) |
This function will generate the appropriate call to Navigate() if the key event is one normally used for keyboard navigation and return true in this case. | |
bool | HandleWindowEvent (wxEvent &event) const |
Shorthand for: | |
bool | ProcessWindowEvent (wxEvent &event) |
Convenient wrapper for ProcessEvent(). | |
bool | ProcessWindowEventLocally (wxEvent &event) |
Wrapper for wxEvtHandler::ProcessEventLocally(). | |
wxEvtHandler * | PopEventHandler (bool deleteHandler=false) |
Removes and returns the top-most event handler on the event handler stack. | |
void | PushEventHandler (wxEvtHandler *handler) |
Pushes this event handler onto the event stack for the window. | |
bool | RemoveEventHandler (wxEvtHandler *handler) |
Find the given handler in the windows event handler stack and removes (but does not delete) it from the stack. | |
void | SetEventHandler (wxEvtHandler *handler) |
Sets the event handler for this window. | |
virtual void | SetNextHandler (wxEvtHandler *handler) |
wxWindows cannot be used to form event handler chains; this function thus will assert when called. | |
virtual void | SetPreviousHandler (wxEvtHandler *handler) |
wxWindows cannot be used to form event handler chains; this function thus will assert when called. | |
long | GetExtraStyle () const |
Returns the extra style bits for the window. | |
virtual long | GetWindowStyleFlag () const |
Gets the window style that was passed to the constructor or Create() method. | |
long | GetWindowStyle () const |
See GetWindowStyleFlag() for more info. | |
bool | HasExtraStyle (int exFlag) const |
Returns true if the window has the given exFlag bit set in its extra styles. | |
bool | HasFlag (int flag) const |
Returns true if the window has the given flag bit set. | |
virtual void | SetExtraStyle (long exStyle) |
Sets the extra style bits for the window. | |
virtual void | SetWindowStyleFlag (long style) |
Sets the style of the window. | |
void | SetWindowStyle (long style) |
See SetWindowStyleFlag() for more info. | |
bool | ToggleWindowStyle (int flag) |
Turns the given flag on if it's currently turned off and vice versa. | |
void | MoveAfterInTabOrder (wxWindow *win) |
Moves this window in the tab navigation order after the specified win. | |
void | MoveBeforeInTabOrder (wxWindow *win) |
Same as MoveAfterInTabOrder() except that it inserts this window just before win instead of putting it right after it. | |
bool | Navigate (int flags=wxNavigationKeyEvent::IsForward) |
Performs a keyboard navigation action starting from this window. | |
bool | NavigateIn (int flags=wxNavigationKeyEvent::IsForward) |
Performs a keyboard navigation action inside this window. | |
virtual void | Lower () |
Lowers the window to the bottom of the window hierarchy (Z-order). | |
virtual void | Raise () |
Raises the window to the top of the window hierarchy (Z-order). | |
bool | Hide () |
Equivalent to calling wxWindow::Show(false). | |
virtual bool | HideWithEffect (wxShowEffect effect, unsigned int timeout=0) |
This function hides a window, like Hide(), but using a special visual effect if possible. | |
bool | IsEnabled () const |
Returns true if the window is enabled, i.e. if it accepts user input, false otherwise. | |
bool | IsExposed (int x, int y) const |
Returns true if the given point or rectangle area has been exposed since the last repaint. | |
bool | IsExposed (wxPoint &pt) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
bool | IsExposed (int x, int y, int w, int h) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
bool | IsExposed (wxRect &rect) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
virtual bool | IsShown () const |
Returns true if the window is shown, false if it has been hidden. | |
virtual bool | IsShownOnScreen () const |
Returns true if the window is physically visible on the screen, i.e. it is shown and all its parents up to the toplevel window are shown as well. | |
bool | Disable () |
Disables the window. | |
virtual bool | Enable (bool enable=true) |
Enable or disable the window for user input. | |
virtual bool | Show (bool show=true) |
Shows or hides the window. | |
virtual bool | ShowWithEffect (wxShowEffect effect, unsigned int timeout=0) |
This function shows a window, like Show(), but using a special visual effect if possible. | |
wxString | GetHelpText () const |
Gets the help text to be used as context-sensitive help for this window. | |
void | SetHelpText (const wxString &helpText) |
Sets the help text to be used as context-sensitive help for this window. | |
virtual wxString | GetHelpTextAtPoint (const wxPoint &point, wxHelpEvent::Origin origin) const |
Gets the help text to be used as context-sensitive help for this window. | |
wxToolTip * | GetToolTip () const |
Get the associated tooltip or NULL if none. | |
wxString | GetToolTipText () const |
Get the text of the associated tooltip or empty string if none. | |
void | SetToolTip (const wxString &tipString) |
Attach a tooltip to the window. | |
void | SetToolTip (wxToolTip *tip) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
void | UnsetToolTip () |
Unset any existing tooltip. | |
int | GetPopupMenuSelectionFromUser (wxMenu &menu, const wxPoint &pos=wxDefaultPosition) |
This function shows a popup menu at the given position in this window and returns the selected id. | |
int | GetPopupMenuSelectionFromUser (wxMenu &menu, int x, int y) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
bool | PopupMenu (wxMenu *menu, const wxPoint &pos=wxDefaultPosition) |
Pops up the given menu at the specified coordinates, relative to this window, and returns control when the user has dismissed the menu. | |
bool | PopupMenu (wxMenu *menu, int x, int y) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
virtual wxValidator * | GetValidator () |
Validator functions. | |
virtual void | SetValidator (const wxValidator &validator) |
Deletes the current validator (if any) and sets the window validator, having called wxValidator::Clone to create a new validator of this type. | |
virtual bool | TransferDataFromWindow () |
Transfers values from child controls to data areas specified by their validators. | |
virtual bool | TransferDataToWindow () |
Transfers values to child controls from data areas specified by their validators. | |
virtual bool | Validate () |
Validates the current values of the child controls using their validators. | |
wxWindowID | GetId () const |
Returns the identifier of the window. | |
virtual wxString | GetLabel () const |
Generic way of getting a label from any window, for identification purposes. | |
virtual wxLayoutDirection | GetLayoutDirection () const |
Returns the layout direction for this window, Note that wxLayout_Default is returned if layout direction is not supported. | |
virtual wxCoord | AdjustForLayoutDirection (wxCoord x, wxCoord width, wxCoord widthTotal) const |
Mirror coordinates for RTL layout if this window uses it and if the mirroring is not done automatically like Win32. | |
virtual wxString | GetName () const |
Returns the window's name. | |
wxWindowVariant | GetWindowVariant () const |
Returns the value previously passed to SetWindowVariant(). | |
void | SetId (wxWindowID winid) |
Sets the identifier of the window. | |
virtual void | SetLabel (const wxString &label) |
Sets the window's label. | |
virtual void | SetLayoutDirection (wxLayoutDirection dir) |
Sets the layout direction for this window. | |
virtual void | SetName (const wxString &name) |
Sets the window's name. | |
void | SetWindowVariant (wxWindowVariant variant) |
Chooses a different variant of the window display to use. | |
wxAcceleratorTable * | GetAcceleratorTable () |
Gets the accelerator table for this window. | |
wxAccessible * | GetAccessible () |
Returns the accessible object for this window, if any. | |
virtual void | SetAcceleratorTable (const wxAcceleratorTable &accel) |
Sets the accelerator table for this window. | |
void | SetAccessible (wxAccessible *accessible) |
Sets the accessible for this window. | |
virtual wxAccessible * | CreateAccessible () |
Override to create a specific accessible object. | |
wxAccessible * | GetOrCreateAccessible () |
Returns the accessible object, calling CreateAccessible if necessary. | |
bool | Close (bool force=false) |
This function simply generates a wxCloseEvent whose handler usually tries to close the window. | |
virtual bool | Destroy () |
Destroys the window safely. | |
bool | IsBeingDeleted () const |
Returns true if this window is in process of being destroyed. | |
virtual wxDropTarget * | GetDropTarget () const |
Returns the associated drop target, which may be NULL. | |
virtual void | SetDropTarget (wxDropTarget *target) |
Associates a drop target with this window. | |
virtual void | DragAcceptFiles (bool accept) |
Enables or disables eligibility for drop file events (OnDropFiles). | |
wxSizer * | GetContainingSizer () const |
Returns the sizer of which this window is a member, if any, otherwise NULL. | |
wxSizer * | GetSizer () const |
Returns the sizer associated with the window by a previous call to SetSizer(), or NULL. | |
void | SetSizer (wxSizer *sizer, bool deleteOld=true) |
Sets the window to have the given layout sizer. | |
void | SetSizerAndFit (wxSizer *sizer, bool deleteOld=true) |
Associate the sizer with the window and set the window size and minimal size accordingly. | |
wxLayoutConstraints * | GetConstraints () const |
Returns a pointer to the window's layout constraints, or NULL if there are none. | |
void | SetConstraints (wxLayoutConstraints *constraints) |
Sets the window to have the given layout constraints. | |
void | SetAutoLayout (bool autoLayout) |
Determines whether the Layout() function will be called automatically when the window is resized. | |
bool | GetAutoLayout () const |
Returns true if Layout() is called automatically when the window is resized. | |
void | CaptureMouse () |
Directs all mouse input to this window. | |
wxCaret * | GetCaret () const |
Returns the caret() associated with the window. | |
const wxCursor & | GetCursor () const |
Return the cursor associated with this window. | |
virtual bool | HasCapture () const |
Returns true if this window has the current mouse capture. | |
void | ReleaseMouse () |
Releases mouse input captured with CaptureMouse(). | |
void | SetCaret (wxCaret *caret) |
Sets the caret() associated with the window. | |
virtual bool | SetCursor (const wxCursor &cursor) |
Sets the window's cursor. | |
virtual void | WarpPointer (int x, int y) |
Moves the pointer to the given position on the window. | |
virtual bool | EnableTouchEvents (int eventsMask) |
Request generation of touch events for this window. | |
wxHitTest | HitTest (wxCoord x, wxCoord y) const |
Return where the given point lies, exactly. | |
wxHitTest | HitTest (const wxPoint &pt) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
wxBorder | GetBorder (long flags) const |
Get the window border style from the given flags: this is different from simply doing flags & wxBORDER_MASK because it uses GetDefaultBorder() to translate wxBORDER_DEFAULT to something reasonable. | |
wxBorder | GetBorder () const |
Get border for the flags of this window. | |
virtual void | DoUpdateWindowUI (wxUpdateUIEvent &event) |
Does the window-specific updating after processing the update event. | |
virtual WXWidget | GetHandle () const |
Returns the platform-specific handle of the physical window. | |
virtual bool | HasMultiplePages () const |
This method should be overridden to return true if this window has multiple pages. | |
virtual void | InheritAttributes () |
This function is (or should be, in case of custom controls) called during window creation to intelligently set up the window visual attributes, that is the font and the foreground and background colours. | |
virtual bool | IsDoubleBuffered () const |
Returns true if the window contents is double-buffered by the system, i.e. if any drawing done on the window is really done on a temporary backing surface and transferred to the screen all at once later. | |
void | SetDoubleBuffered (bool on) |
Turn on or off double buffering of the window if the system supports it. | |
bool | IsThisEnabled () const |
Returns true if this window is intrinsically enabled, false otherwise, i.e. if Enable() Enable(false) had been called. | |
virtual bool | IsTopLevel () const |
Returns true if the given window is a top-level one. | |
virtual void | OnInternalIdle () |
This virtual function is normally only used internally, but sometimes an application may need it to implement functionality that should not be disabled by an application defining an OnIdle handler in a derived class. | |
virtual bool | SendIdleEvents (wxIdleEvent &event) |
Send idle event to window and all subwindows. | |
virtual bool | RegisterHotKey (int hotkeyId, int modifiers, int virtualKeyCode) |
Registers a system wide hotkey. | |
virtual bool | UnregisterHotKey (int hotkeyId) |
Unregisters a system wide hotkey. | |
virtual void | UpdateWindowUI (long flags=wxUPDATE_UI_NONE) |
This function sends one or more wxUpdateUIEvent to the window. | |
bool | BeginRepositioningChildren () |
Prepare for changing positions of multiple child windows. | |
void | EndRepositioningChildren () |
Fix child window positions after setting all of them at once. | |
void | CacheBestSize (const wxSize &size) const |
Sets the cached best size value. | |
virtual wxSize | ClientToWindowSize (const wxSize &size) const |
Converts client area size size to corresponding window size. | |
virtual wxSize | WindowToClientSize (const wxSize &size) const |
Converts window size size to corresponding client area size In other words, the returned value is what would GetClientSize() return if this window had given window size. | |
virtual void | Fit () |
Sizes the window to fit its best size. | |
virtual void | FitInside () |
Similar to Fit(), but sizes the interior (virtual) size of a window. | |
wxSize | FromDIP (const wxSize &sz) const |
Convert DPI-independent pixel values to the value in pixels appropriate for the current toolkit. | |
wxPoint | FromDIP (const wxPoint &pt) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
int | FromDIP (int d) const |
Convert DPI-independent distance in pixels to the value in pixels appropriate for the current toolkit. | |
wxSize | ToDIP (const wxSize &sz) const |
Convert pixel values of the current toolkit to DPI-independent pixel values. | |
wxPoint | ToDIP (const wxPoint &pt) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
int | ToDIP (int d) const |
Convert pixel values of the current toolkit to DPI-independent pixel values. | |
wxSize | FromPhys (const wxSize &sz) const |
Convert from physical pixels to logical pixels. | |
wxPoint | FromPhys (const wxPoint &pt) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
int | FromPhys (int d) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
wxSize | ToPhys (const wxSize &sz) const |
Convert from logical pixels to physical pixels. | |
wxPoint | ToPhys (const wxPoint &pt) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
int | ToPhys (int d) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
wxSize | GetBestSize () const |
This functions returns the best acceptable minimal size for the window. | |
int | GetBestHeight (int width) const |
Returns the best height needed by this window if it had the given width. | |
int | GetBestWidth (int height) const |
Returns the best width needed by this window if it had the given height. | |
void | GetClientSize (int *width, int *height) const |
Returns the size of the window 'client area' in pixels. | |
wxSize | GetClientSize () const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
virtual wxSize | GetEffectiveMinSize () const |
Merges the window's best size into the min size and returns the result. | |
virtual wxSize | GetMaxClientSize () const |
Returns the maximum size of window's client area. | |
virtual wxSize | GetMaxSize () const |
Returns the maximum size of the window. | |
virtual wxSize | GetMinClientSize () const |
Returns the minimum size of window's client area, an indication to the sizer layout mechanism that this is the minimum required size of its client area. | |
virtual wxSize | GetMinSize () const |
Returns the minimum size of the window, an indication to the sizer layout mechanism that this is the minimum required size. | |
int | GetMinWidth () const |
Returns the horizontal component of window minimal size. | |
int | GetMinHeight () const |
Returns the vertical component of window minimal size. | |
int | GetMaxWidth () const |
Returns the horizontal component of window maximal size. | |
int | GetMaxHeight () const |
Returns the vertical component of window maximal size. | |
void | GetSize (int *width, int *height) const |
Returns the size of the entire window in pixels, including title bar, border, scrollbars, etc. | |
wxSize | GetSize () const |
See the GetSize(int*,int*) overload for more info. | |
wxSize | GetVirtualSize () const |
This gets the virtual size of the window in pixels. | |
void | GetVirtualSize (int *width, int *height) const |
Like the other GetVirtualSize() overload but uses pointers instead. | |
virtual wxSize | GetBestVirtualSize () const |
Return the largest of ClientSize and BestSize (as determined by a sizer, interior children, or other means) | |
double | GetContentScaleFactor () const |
Returns the factor mapping logical pixels of this window to physical pixels. | |
double | GetDPIScaleFactor () const |
Returns the ratio of the DPI used by this window to the standard DPI. | |
virtual wxSize | GetWindowBorderSize () const |
Returns the size of the left/right and top/bottom borders of this window in x and y components of the result respectively. | |
virtual bool | InformFirstDirection (int direction, int size, int availableOtherDir) |
wxSizer and friends use this to give a chance to a component to recalc its min size once one of the final size components is known. | |
void | InvalidateBestSize () |
Resets the cached best size value so it will be recalculated the next time it is needed. | |
void | PostSizeEvent () |
Posts a size event to the window. | |
void | PostSizeEventToParent () |
Posts a size event to the parent of this window. | |
virtual void | SendSizeEvent (int flags=0) |
This function sends a dummy size event to the window allowing it to re-layout its children positions. | |
void | SendSizeEventToParent (int flags=0) |
Safe wrapper for GetParent()->SendSizeEvent(). | |
void | SetClientSize (int width, int height) |
This sets the size of the window client area in pixels. | |
void | SetClientSize (const wxSize &size) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
void | SetClientSize (const wxRect &rect) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
void | SetContainingSizer (wxSizer *sizer) |
Used by wxSizer internally to notify the window about being managed by the given sizer. | |
void | SetInitialSize (const wxSize &size=wxDefaultSize) |
A smart SetSize that will fill in default size components with the window's best size values. | |
virtual void | SetMaxClientSize (const wxSize &size) |
Sets the maximum client size of the window, to indicate to the sizer layout mechanism that this is the maximum possible size of its client area. | |
virtual void | SetMaxSize (const wxSize &size) |
Sets the maximum size of the window, to indicate to the sizer layout mechanism that this is the maximum possible size. | |
virtual void | SetMinClientSize (const wxSize &size) |
Sets the minimum client size of the window, to indicate to the sizer layout mechanism that this is the minimum required size of window's client area. | |
virtual void | SetMinSize (const wxSize &size) |
Sets the minimum size of the window, to indicate to the sizer layout mechanism that this is the minimum required size. | |
void | SetSize (int x, int y, int width, int height, int sizeFlags=wxSIZE_AUTO) |
Sets the size of the window in pixels. | |
void | SetSize (const wxRect &rect) |
Sets the size of the window in pixels. | |
void | SetSize (const wxSize &size) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
void | SetSize (int width, int height) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
virtual void | SetSizeHints (const wxSize &minSize, const wxSize &maxSize=wxDefaultSize, const wxSize &incSize=wxDefaultSize) |
Use of this function for windows which are not toplevel windows (such as wxDialog or wxFrame) is discouraged. | |
virtual void | SetSizeHints (int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1, int incH=-1) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
void | SetVirtualSize (int width, int height) |
Sets the virtual size of the window in pixels. | |
void | SetVirtualSize (const wxSize &size) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
![]() | |
wxEvtHandler () | |
Constructor. | |
virtual | ~wxEvtHandler () |
Destructor. | |
template<typename T, typename T1, ...> | |
void | CallAfter (void(T::*method)(T1,...), T1 x1,...) |
Asynchronously call the given method. | |
template<typename T> | |
void | CallAfter (const T &functor) |
Asynchronously call the given functor. | |
bool | ProcessEventLocally (wxEvent &event) |
Try to process the event in this handler and all those chained to it. | |
bool | SafelyProcessEvent (wxEvent &event) |
Processes an event by calling ProcessEvent() and handles any exceptions that occur in the process. | |
void | ProcessPendingEvents () |
Processes the pending events previously queued using QueueEvent() or AddPendingEvent(); you must call this function only if you are sure there are pending events for this handler, otherwise a wxCHECK will fail. | |
void | DeletePendingEvents () |
Deletes all events queued on this event handler using QueueEvent() or AddPendingEvent(). | |
void | Connect (int id, int lastId, wxEventType eventType, wxObjectEventFunction function, wxObject *userData=NULL, wxEvtHandler *eventSink=NULL) |
Connects the given function dynamically with the event handler, id and event type. | |
void | Connect (int id, wxEventType eventType, wxObjectEventFunction function, wxObject *userData=NULL, wxEvtHandler *eventSink=NULL) |
See the Connect(int, int, wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*) overload for more info. | |
void | Connect (wxEventType eventType, wxObjectEventFunction function, wxObject *userData=NULL, wxEvtHandler *eventSink=NULL) |
See the Connect(int, int, wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*) overload for more info. | |
bool | Disconnect (wxEventType eventType, wxObjectEventFunction function, wxObject *userData=NULL, wxEvtHandler *eventSink=NULL) |
Disconnects the given function dynamically from the event handler, using the specified parameters as search criteria and returning true if a matching function has been found and removed. | |
bool | Disconnect (int id=wxID_ANY, wxEventType eventType=wxEVT_NULL, wxObjectEventFunction function=NULL, wxObject *userData=NULL, wxEvtHandler *eventSink=NULL) |
See the Disconnect(wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*) overload for more info. | |
bool | Disconnect (int id, int lastId, wxEventType eventType, wxObjectEventFunction function=NULL, wxObject *userData=NULL, wxEvtHandler *eventSink=NULL) |
See the Disconnect(wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*) overload for more info. | |
template<typename EventTag, typename Functor> | |
void | Bind (const EventTag &eventType, Functor functor, int id=wxID_ANY, int lastId=wxID_ANY, wxObject *userData=NULL) |
Binds the given function, functor or method dynamically with the event. | |
template<typename EventTag, typename Class, typename EventArg, typename EventHandler> | |
void | Bind (const EventTag &eventType, void(Class::*method)(EventArg &), EventHandler *handler, int id=wxID_ANY, int lastId=wxID_ANY, wxObject *userData=NULL) |
See the Bind<>(const EventTag&, Functor, int, int, wxObject*) overload for more info. | |
template<typename EventTag, typename Functor> | |
bool | Unbind (const EventTag &eventType, Functor functor, int id=wxID_ANY, int lastId=wxID_ANY, wxObject *userData=NULL) |
Unbinds the given function, functor or method dynamically from the event handler, using the specified parameters as search criteria and returning true if a matching function has been found and removed. | |
template<typename EventTag, typename Class, typename EventArg, typename EventHandler> | |
bool | Unbind (const EventTag &eventType, void(Class::*method)(EventArg &), EventHandler *handler, int id=wxID_ANY, int lastId=wxID_ANY, wxObject *userData=NULL) |
See the Unbind<>(const EventTag&, Functor, int, int, wxObject*) overload for more info. | |
void * | GetClientData () const |
Returns user-supplied client data. | |
wxClientData * | GetClientObject () const |
Returns a pointer to the user-supplied client data object. | |
void | SetClientData (void *data) |
Sets user-supplied client data. | |
void | SetClientObject (wxClientData *data) |
Set the client data object. | |
bool | GetEvtHandlerEnabled () const |
Returns true if the event handler is enabled, false otherwise. | |
wxEvtHandler * | GetNextHandler () const |
Returns the pointer to the next handler in the chain. | |
wxEvtHandler * | GetPreviousHandler () const |
Returns the pointer to the previous handler in the chain. | |
void | SetEvtHandlerEnabled (bool enabled) |
Enables or disables the event handler. | |
void | Unlink () |
Unlinks this event handler from the chain it's part of (if any); then links the "previous" event handler to the "next" one (so that the chain won't be interrupted). | |
bool | IsUnlinked () const |
Returns true if the next and the previous handler pointers of this event handler instance are NULL. | |
![]() | |
wxObject () | |
Default ctor; initializes to NULL the internal reference data. | |
wxObject (const wxObject &other) | |
Copy ctor. | |
virtual | ~wxObject () |
Destructor. | |
virtual wxClassInfo * | GetClassInfo () const |
This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar). | |
wxObjectRefData * | GetRefData () const |
Returns the wxObject::m_refData pointer, i.e. the data referenced by this object. | |
bool | IsKindOf (const wxClassInfo *info) const |
Determines whether this class is a subclass of (or the same class as) the given class. | |
bool | IsSameAs (const wxObject &obj) const |
Returns true if this object has the same data pointer as obj. | |
void | Ref (const wxObject &clone) |
Makes this object refer to the data in clone. | |
void | SetRefData (wxObjectRefData *data) |
Sets the wxObject::m_refData pointer. | |
void | UnRef () |
Decrements the reference count in the associated data, and if it is zero, deletes the data. | |
void | UnShare () |
This is the same of AllocExclusive() but this method is public. | |
void | operator delete (void *buf) |
The delete operator is defined for debugging versions of the library only, when the identifier __WXDEBUG__ is defined. | |
void * | operator new (size_t size, const wxString &filename=NULL, int lineNum=0) |
The new operator is defined for debugging versions of the library only, when the identifier __WXDEBUG__ is defined. | |
![]() | |
wxHtmlWindowInterface () | |
Ctor. | |
virtual | ~wxHtmlWindowInterface () |
virtual void | SetHTMLWindowTitle (const wxString &title)=0 |
Called by the parser to set window's title to given text. | |
virtual void | OnHTMLLinkClicked (const wxHtmlLinkInfo &link)=0 |
Called when a link is clicked. | |
virtual wxHtmlOpeningStatus | OnHTMLOpeningURL (wxHtmlURLType type, const wxString &url, wxString *redirect) const =0 |
Called when the parser needs to open another URL (e.g. | |
virtual wxPoint | HTMLCoordsToWindow (wxHtmlCell *cell, const wxPoint &pos) const =0 |
Converts coordinates pos relative to given cell to physical coordinates in the window. | |
virtual wxWindow * | GetHTMLWindow ()=0 |
Returns the window used for rendering (may be NULL). | |
virtual wxColour | GetHTMLBackgroundColour () const =0 |
Returns background colour to use by default. | |
virtual void | SetHTMLBackgroundColour (const wxColour &clr)=0 |
Sets window's background to colour clr. | |
virtual void | SetHTMLBackgroundImage (const wxBitmapBundle &bmpBg)=0 |
Sets window's background to given bitmap. | |
virtual void | SetHTMLStatusText (const wxString &text)=0 |
Sets status bar text. | |
virtual wxCursor | GetHTMLCursor (wxHtmlWindowInterface::HTMLCursor type) const =0 |
Returns mouse cursor of given type. | |
Static Public Member Functions | |
static void | AddFilter (wxHtmlFilter *filter) |
Adds an input filter to the static list of available filters. | |
static wxCursor | GetDefaultHTMLCursor (HTMLCursor type) |
Retrieves the default cursor for a given HTMLCursor type. | |
static void | SetDefaultHTMLCursor (HTMLCursor type, const wxCursor &cursor) |
Sets the default cursor for a given HTMLCursor type. | |
![]() | |
static wxVisualAttributes | GetClassDefaultAttributes (wxWindowVariant variant=wxWINDOW_VARIANT_NORMAL) |
Returns the default font and colours which are used by the control. | |
static wxWindow * | FindFocus () |
Finds the window or control which currently has the keyboard focus. | |
static wxWindow * | FindWindowById (long id, const wxWindow *parent=0) |
Find the first window with the given id. | |
static wxWindow * | FindWindowByLabel (const wxString &label, const wxWindow *parent=0) |
Find a window by its label. | |
static wxWindow * | FindWindowByName (const wxString &name, const wxWindow *parent=0) |
Find a window by its name (as given in a window constructor or Create() function call). | |
static wxWindow * | GetCapture () |
Returns the currently captured window. | |
static wxWindowID | NewControlId (int count=1) |
Create a new ID or range of IDs that are not currently in use. | |
static void | UnreserveControlId (wxWindowID id, int count=1) |
Unreserve an ID or range of IDs that was reserved by NewControlId(). | |
static wxSize | FromDIP (const wxSize &sz, const wxWindow *w) |
Non window-specific DPI-independent pixels conversion functions. | |
static wxPoint | FromDIP (const wxPoint &pt, const wxWindow *w) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
static int | FromDIP (int d, const wxWindow *w) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
static wxSize | ToDIP (const wxSize &sz, const wxWindow *w) |
Non window-specific pixel to DPI-independent pixels conversion functions. | |
static wxPoint | ToDIP (const wxPoint &pt, const wxWindow *w) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
static int | ToDIP (int d, const wxWindow *w) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
static wxSize | FromPhys (const wxSize &sz, const wxWindow *w) |
Convert from physical pixels to logical pixels for any window. | |
static wxPoint | FromPhys (const wxPoint &pt, const wxWindow *w) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
static int | FromPhys (int d, const wxWindow *w) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
static wxSize | ToPhys (const wxSize &sz, const wxWindow *w) |
Convert from logical pixels to physical pixels for any window. | |
static wxPoint | ToPhys (const wxPoint &pt, const wxWindow *w) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
static int | ToPhys (int d, const wxWindow *w) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
![]() | |
static void | AddFilter (wxEventFilter *filter) |
Add an event filter whose FilterEvent() method will be called for each and every event processed by wxWidgets. | |
static void | RemoveFilter (wxEventFilter *filter) |
Remove a filter previously installed with AddFilter(). | |
Protected Member Functions | |
virtual bool | OnCellClicked (wxHtmlCell *cell, wxCoord x, wxCoord y, const wxMouseEvent &event) |
This method is called when a mouse button is clicked inside wxHtmlWindow. | |
virtual void | OnCellMouseHover (wxHtmlCell *cell, wxCoord x, wxCoord y) |
This method is called when a mouse moves over an HTML cell. | |
![]() | |
virtual bool | ShouldScrollToChildOnFocus (wxWindow *child) |
This method can be overridden in a derived class to prevent scrolling the child window into view automatically when it gets focus. | |
virtual wxSize | GetSizeAvailableForScrollTarget (const wxSize &size) |
Function which must be overridden to implement the size available for the scroll target for the given size of the main window. | |
virtual bool | ShouldScrollToChildOnFocus (wxWindow *child) |
This method can be overridden in a derived class to prevent scrolling the child window into view automatically when it gets focus. | |
virtual wxSize | GetSizeAvailableForScrollTarget (const wxSize &size) |
Function which must be overridden to implement the size available for the scroll target for the given size of the main window. | |
![]() | |
virtual void | DoCentre (int direction) |
Centres the window. | |
virtual wxSize | DoGetBestSize () const |
Implementation of GetBestSize() that can be overridden. | |
virtual wxSize | DoGetBestClientSize () const |
Override this method to return the best size for a custom control. | |
virtual int | DoGetBestClientHeight (int width) const |
Override this method to implement height-for-width best size calculation. | |
virtual int | DoGetBestClientWidth (int height) const |
Override this method to implement width-for-height best size calculation. | |
virtual void | SetInitialBestSize (const wxSize &size) |
Sets the initial window size if none is given (i.e. at least one of the components of the size passed to ctor/Create() is wxDefaultCoord). | |
void | SendDestroyEvent () |
Generate wxWindowDestroyEvent for this window. | |
virtual bool | ProcessEvent (wxEvent &event) |
This function is public in wxEvtHandler but protected in wxWindow because for wxWindows you should always call ProcessEvent() on the pointer returned by GetEventHandler() and not on the wxWindow object itself. | |
bool | SafelyProcessEvent (wxEvent &event) |
See ProcessEvent() for more info about why you shouldn't use this function and the reason for making this function protected in wxWindow. | |
virtual void | QueueEvent (wxEvent *event) |
See ProcessEvent() for more info about why you shouldn't use this function and the reason for making this function protected in wxWindow. | |
virtual void | AddPendingEvent (const wxEvent &event) |
See ProcessEvent() for more info about why you shouldn't use this function and the reason for making this function protected in wxWindow. | |
void | ProcessPendingEvents () |
See ProcessEvent() for more info about why you shouldn't use this function and the reason for making this function protected in wxWindow. | |
bool | ProcessThreadEvent (const wxEvent &event) |
See ProcessEvent() for more info about why you shouldn't use this function and the reason for making this function protected in wxWindow. | |
![]() | |
virtual bool | TryBefore (wxEvent &event) |
Method called by ProcessEvent() before examining this object event tables. | |
virtual bool | TryAfter (wxEvent &event) |
Method called by ProcessEvent() as last resort. | |
![]() | |
void | AllocExclusive () |
Ensure that this object's data is not shared with any other object. | |
virtual wxObjectRefData * | CreateRefData () const |
Creates a new instance of the wxObjectRefData-derived class specific to this object and returns it. | |
virtual wxObjectRefData * | CloneRefData (const wxObjectRefData *data) const |
Creates a new instance of the wxObjectRefData-derived class specific to this object and initializes it copying data. | |
Additional Inherited Members | |
![]() | |
enum | HTMLCursor { HTMLCursor_Default , HTMLCursor_Link , HTMLCursor_Text } |
Type of mouse cursor. More... | |
![]() | |
wxObjectRefData * | m_refData |
Pointer to an object which is the object's reference-counted data. | |
wxHtmlWindow::wxHtmlWindow | ( | ) |
Default ctor.
wxHtmlWindow::wxHtmlWindow | ( | wxWindow * | parent, |
wxWindowID | id = wxID_ANY, | ||
const wxPoint & | pos = wxDefaultPosition, | ||
const wxSize & | size = wxDefaultSize, | ||
long | style = wxHW_DEFAULT_STYLE, | ||
const wxString & | name = "htmlWindow" ) |
Constructor.
The parameters are the same as wxScrolled::wxScrolled() constructor.
|
static |
Adds an input filter to the static list of available filters.
These filters are present by default:
The plain text filter will be used if no other filter matches.
bool wxHtmlWindow::AppendToPage | ( | const wxString & | source | ) |
Appends HTML fragment to currently displayed text and refreshes the window.
source | HTML code fragment |
|
static |
Retrieves the default cursor for a given HTMLCursor type.
type | HTMLCursor type to retrieve. |
wxHtmlContainerCell * wxHtmlWindow::GetInternalRepresentation | ( | ) | const |
Returns pointer to the top-level container.
wxString wxHtmlWindow::GetOpenedAnchor | ( | ) | const |
Returns anchor within currently opened page (see wxHtmlWindow::GetOpenedPage).
If no page is opened or if the displayed page wasn't produced by call to LoadPage(), empty string is returned.
wxString wxHtmlWindow::GetOpenedPage | ( | ) | const |
Returns full location of the opened page.
If no page is opened or if the displayed page wasn't produced by call to LoadPage(), empty string is returned.
wxString wxHtmlWindow::GetOpenedPageTitle | ( | ) | const |
Returns title of the opened page or wxEmptyString if the current page does not contain <TITLE> tag.
wxHtmlWinParser * wxHtmlWindow::GetParser | ( | ) | const |
Returns a pointer to the current parser.
wxFrame * wxHtmlWindow::GetRelatedFrame | ( | ) | const |
Returns the related frame.
bool wxHtmlWindow::HistoryBack | ( | ) |
Moves back to the previous page.
Only pages displayed using LoadPage() are stored in history list.
bool wxHtmlWindow::HistoryCanBack | ( | ) |
Returns true if it is possible to go back in the history i.e.
HistoryBack() won't fail.
bool wxHtmlWindow::HistoryCanForward | ( | ) |
Returns true if it is possible to go forward in the history i.e.
HistoryForward() won't fail.
void wxHtmlWindow::HistoryClear | ( | ) |
Clears history.
bool wxHtmlWindow::HistoryForward | ( | ) |
Moves to next page in history.
Only pages displayed using LoadPage() are stored in history list.
bool wxHtmlWindow::LoadFile | ( | const wxFileName & | filename | ) |
Loads an HTML page from a file and displays it.
|
virtual |
Unlike SetPage() this function first loads the HTML page from location and then displays it.
location | The address of the document. See the wxFileSystem Overview for details on the address format and wxFileSystem for a description of how the file is opened. |
|
protectedvirtual |
This method is called when a mouse button is clicked inside wxHtmlWindow.
The default behaviour is to emit a wxHtmlCellEvent and, if the event was not processed or skipped, call OnLinkClicked() if the cell contains a hypertext link.
Overloading this method is deprecated; intercept the event instead.
cell | The cell inside which the mouse was clicked, always a simple (i.e. non-container) cell |
x | The logical x coordinate of the click point |
y | The logical y coordinate of the click point |
event | The mouse event containing other information about the click |
|
protectedvirtual |
This method is called when a mouse moves over an HTML cell.
Default behaviour is to emit a wxHtmlCellEvent.
Overloading this method is deprecated; intercept the event instead.
cell | The cell inside which the mouse is currently, always a simple (i.e. non-container) cell |
x | The logical x coordinate of the click point |
y | The logical y coordinate of the click point |
|
virtual |
Called when user clicks on hypertext link.
Default behaviour is to emit a wxHtmlLinkEvent and, if the event was not processed or skipped, call LoadPage() and do nothing else.
Overloading this method is deprecated; intercept the event instead.
Also see wxHtmlLinkInfo.
|
virtual |
Called when an URL is being opened (either when the user clicks on a link or an image is loaded).
The URL will be opened only if OnOpeningURL() returns wxHTML_OPEN
. This method is called by wxHtmlParser::OpenURL.
You can override OnOpeningURL() to selectively block some URLs (e.g. for security reasons) or to redirect them elsewhere. Default behaviour is to always return wxHTML_OPEN
.
type | Indicates type of the resource. Is one of
|
url | URL being opened. |
redirect | Pointer to wxString variable that must be filled with an URL if OnOpeningURL() returns wxHTML_REDIRECT . |
The return value is:
|
virtual |
Called on parsing <TITLE> tag.
|
virtual |
This reads custom settings from wxConfig.
It uses the path 'path' if given, otherwise it saves info into currently selected path. The values are stored in sub-path wxHtmlWindow
. Read values: all things set by SetFonts(), SetBorders().
cfg | wxConfig from which you want to read the configuration. |
path | Optional path in config tree. If not given current path is used. |
void wxHtmlWindow::SelectAll | ( | ) |
Selects all text in the window.
wxString wxHtmlWindow::SelectionToText | ( | ) |
Returns the current selection as plain text.
Returns an empty string if no text is currently selected.
void wxHtmlWindow::SelectLine | ( | const wxPoint & | pos | ) |
Selects the line of text that pos points at.
Note that pos is relative to the top of displayed page, not to window's origin, use wxScrolled::CalcUnscrolledPosition() to convert physical coordinate.
void wxHtmlWindow::SelectWord | ( | const wxPoint & | pos | ) |
Selects the word at position pos.
Note that pos is relative to the top of displayed page, not to window's origin, use wxScrolled::CalcUnscrolledPosition() to convert physical coordinate.
void wxHtmlWindow::SetBorders | ( | int | b | ) |
This function sets the space between border of window and HTML contents.
See image:
b | indentation from borders in pixels |
|
static |
Sets the default cursor for a given HTMLCursor type.
These cursors are used for all wxHtmlWindow objects by default, but can be overridden on a per-window basis.
type | HTMLCursor type to retrieve. |
cursor | The default cursor for the specified cursor type. |
void wxHtmlWindow::SetFonts | ( | const wxString & | normal_face, |
const wxString & | fixed_face, | ||
const int * | sizes = NULL ) |
This function sets font sizes and faces.
See wxHtmlDCRenderer::SetFonts for detailed description.
|
virtual |
Sets the source of a page and displays it, for example:
If you want to load a document from some location use LoadPage() instead.
source | The HTML to be displayed. |
Sets the frame in which page title will be displayed.
format is the format of the frame title, e.g. "HtmlHelp : %s". It must contain exactly one s. This s is substituted with HTML page title.
void wxHtmlWindow::SetRelatedStatusBar | ( | int | index | ) |
After calling SetRelatedFrame(), this sets statusbar slot where messages will be displayed.
(Default is -1 = no messages.)
index | Statusbar slot number (0..n) |
void wxHtmlWindow::SetRelatedStatusBar | ( | wxStatusBar * | statusbar, |
int | index = 0 ) |
Sets the associated statusbar where messages will be displayed.
Call this instead of SetRelatedFrame() if you want statusbar updates only, no changing of the frame title.
statusbar | Statusbar pointer |
index | Statusbar slot number (0..n) |
void wxHtmlWindow::SetStandardFonts | ( | int | size = -1, |
const wxString & | normal_face = wxEmptyString, | ||
const wxString & | fixed_face = wxEmptyString ) |
Sets default font sizes and/or default font size.
See wxHtmlDCRenderer::SetStandardFonts for detailed description.
wxString wxHtmlWindow::ToText | ( | ) |
Returns content of currently displayed page as plain text.
|
virtual |
Saves custom settings into wxConfig.
It uses the path 'path' if given, otherwise it saves info into currently selected path. Regardless of whether the path is given or not, the function creates sub-path wxHtmlWindow
.
Saved values: all things set by SetFonts(), SetBorders().
cfg | wxConfig to which you want to save the configuration. |
path | Optional path in config tree. If not given, the current path is used. |