#include <wx/webview.h>
This control may be used to render web (HTML / CSS / javascript) documents.
It is designed to allow the creation of multiple backends for each port, although currently just one is available. It differs from wxHtmlWindow in that each backend is actually a full rendering engine, Trident on MSW and Webkit on OSX and GTK. This allows the correct viewing complex pages with javascript and css.
The IE backend uses Microsoft's Trident rendering engine, specifically the version used by the locally installed copy of Internet Explorer. As such it is only available for the MSW port. By default recent versions of the WebBrowser control, which this backend uses, emulate Internet Explorer 7. This can be changed with a registry setting, see this article for more information. This backend has full support for custom schemes and virtual file systems.
Under GTK the WebKit backend uses WebKitGTK+. The current minimum version required is 1.3.1 which ships by default with Ubuntu Natty and Debian Wheezy and has the package name libwebkitgtk-dev. Custom schemes and virtual files systems are supported under this backend, however embedded resources such as images and stylesheets are currently loaded using the data:// scheme.
The OSX WebKit backend uses Apple's WebView class. This backend has full support for custom schemes and virtual file systems.
Many of the methods in wxWebView are asynchronous, i.e. they return immediately and perform their work in the background. This includes functions such as LoadURL() and Reload(). To receive notification of the progress and completion of these functions you need to handle the events that are provided. Specifically wxEVT_WEBVIEW_LOADED
notifies when the page or a sub-frame has finished loading and wxEVT_WEBVIEW_ERROR
notifies that an error has occurred.
wxWebView supports the registering of custom scheme handlers, for example file
or http
. To do this create a new class which inherits from wxWebViewHandler, where wxWebHandler::GetFile() returns a pointer to a wxFSFile which represents the given url. You can then register your handler with RegisterHandler() it will be called for all pages and resources.
wxWebViewFSHandler is provided to access the virtual file system encapsulated by wxFileSystem. The wxMemoryFSHandler documentation gives an example of how this may be used.
wxWebViewArchiveHandler is provided to allow the navigation of pages inside a zip archive. It supports paths of the form: scheme:///C
:/example/docs.zip;protocol=zip/main.htm
The following event handler macros redirect the events to member function handlers 'func' with prototypes like:
Event macros for events emitted by this class:
wxEVT_WEBVIEW_NAVIGATING
event, generated before trying to get a resource. This event may be vetoed to prevent navigating to this resource. Note that if the displayed HTML document has several frames, one such event will be generated per frame. wxEVT_WEBVIEW_NAVIGATED
event generated after it was confirmed that a resource would be requested. This event may not be vetoed. Note that if the displayed HTML document has several frames, one such event will be generated per frame. wxEVT_WEBVIEW_LOADED
event generated when the document is fully loaded and displayed. Note that if the displayed HTML document has several frames, one such event will be generated per frame. wxEVT_WEBVIEW_ERROR
event generated when a navigation error occurs. The integer associated with this event will be a wxWebNavigationError item. The string associated with this event may contain a backend-specific more precise error message/code. wxEVT_WEBVIEW_NEWWINDOW
event, generated when a new window is created. You must handle this event if you want anything to happen, for example to load the page in a new window or tab. wxEVT_WEBVIEW_TITLE_CHANGED
event, generated when the page title changes. Use GetString to get the title. Public Member Functions | |
virtual bool | Create (wxWindow *parent, wxWindowID id, const wxString &url=wxWebViewDefaultURLStr, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0, const wxString &name=wxWebViewNameStr)=0 |
Creation function for two-step creation. | |
virtual wxString | GetCurrentTitle () const =0 |
Get the title of the current web page, or its URL/path if title is not available. | |
virtual wxString | GetCurrentURL () const =0 |
Get the URL of the currently displayed document. | |
virtual void * | GetNativeBackend () const =0 |
Return the pointer to the native backend used by this control. | |
virtual wxString | GetPageSource () const =0 |
Get the HTML source code of the currently displayed document. | |
virtual wxString | GetPageText () const =0 |
Get the text of the current page. | |
virtual bool | IsBusy () const =0 |
Returns whether the web control is currently busy (e.g. loading a page). | |
virtual bool | IsEditable () const =0 |
Returns whether the web control is currently editable. | |
virtual void | LoadURL (const wxString &url)=0 |
Load a web page from a URL. | |
virtual void | Print ()=0 |
Opens a print dialog so that the user may print the currently displayed page. | |
virtual void | RegisterHandler (wxSharedPtr< wxWebViewHandler > handler)=0 |
Registers a custom scheme handler. | |
virtual void | Reload (wxWebViewReloadFlags flags=wxWEBVIEW_RELOAD_DEFAULT)=0 |
Reload the currently displayed URL. | |
virtual void | RunScript (const wxString &javascript)=0 |
Runs the given javascript code. | |
virtual void | SetEditable (bool enable=true)=0 |
Set the editable property of the web control. | |
virtual void | SetPage (const wxString &html, const wxString &baseUrl)=0 |
Set the displayed page source to the contents of the given string. | |
virtual void | SetPage (wxInputStream &html, wxString baseUrl) |
Set the displayed page source to the contents of the given stream. | |
virtual void | Stop ()=0 |
Stop the current page loading process, if any. | |
Clipboard | |
virtual bool | CanCopy () const =0 |
Returns true if the current selection can be copied. | |
virtual bool | CanCut () const =0 |
Returns true if the current selection can be cut. | |
virtual bool | CanPaste () const =0 |
Returns true if data can be pasted. | |
virtual void | Copy ()=0 |
Copies the current selection. | |
virtual void | Cut ()=0 |
Cuts the current selection. | |
virtual void | Paste ()=0 |
Pastes the current data. | |
Context Menu | |
virtual void | EnableContextMenu (bool enable=true) |
Enable or disable the right click context menu. | |
virtual bool | IsContextMenuEnabled () const |
Returns true if a context menu will be shown on right click. | |
History | |
virtual bool | CanGoBack () const =0 |
Returns true if it is possible to navigate backward in the history of visited pages. | |
virtual bool | CanGoForward () const =0 |
Returns true if it is possible to navigate forward in the history of visited pages. | |
virtual void | ClearHistory ()=0 |
Clear the history, this will also remove the visible page. | |
virtual void | EnableHistory (bool enable=true)=0 |
Enable or disable the history. | |
virtual wxVector< wxSharedPtr < wxWebViewHistoryItem > > | GetBackwardHistory ()=0 |
Returns a list of items in the back history. | |
virtual wxVector< wxSharedPtr < wxWebViewHistoryItem > > | GetForwardHistory ()=0 |
Returns a list of items in the forward history. | |
virtual void | GoBack ()=0 |
Navigate back in the history of visited pages. | |
virtual void | GoForward ()=0 |
Navigate forward in the history of visited pages. | |
virtual void | LoadHistoryItem (wxSharedPtr< wxWebViewHistoryItem > item)=0 |
Loads a history item. | |
Selection | |
virtual void | ClearSelection ()=0 |
Clears the current selection. | |
virtual void | DeleteSelection ()=0 |
Deletes the current selection. | |
virtual wxString | GetSelectedSource () const =0 |
Returns the currently selected source, if any. | |
virtual wxString | GetSelectedText () const =0 |
Returns the currently selected text, if any. | |
virtual bool | HasSelection () const =0 |
Returns true if there is a current selection. | |
virtual void | SelectAll ()=0 |
Selects the entire page. | |
Undo / Redo | |
virtual bool | CanRedo () const =0 |
Returns true if there is an action to redo. | |
virtual bool | CanUndo () const =0 |
Returns true if there is an action to undo. | |
virtual void | Redo ()=0 |
Redos the last action. | |
virtual void | Undo ()=0 |
Undos the last action. | |
Finding | |
virtual long | Find (const wxString &text, wxWebViewFindFlags flags=wxWEBVIEW_FIND_DEFAULT)=0 |
Finds a phrase on the current page and if found, the control will scroll the phrase into view and select it. | |
Zoom | |
virtual bool | CanSetZoomType (wxWebViewZoomType type) const =0 |
Retrieve whether the current HTML engine supports a zoom type. | |
virtual wxWebViewZoom | GetZoom () const =0 |
Get the zoom factor of the page. | |
virtual wxWebViewZoomType | GetZoomType () const =0 |
Get how the zoom factor is currently interpreted. | |
virtual void | SetZoom (wxWebViewZoom zoom)=0 |
Set the zoom factor of the page. | |
virtual void | SetZoomType (wxWebViewZoomType zoomType)=0 |
Set how to interpret the zoom factor. | |
Public Member Functions inherited from wxControl | |
wxControl (wxWindow *parent, wxWindowID id, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0, const wxValidator &validator=wxDefaultValidator, const wxString &name=wxControlNameStr) | |
Constructs a control. | |
wxControl () | |
Default constructor to allow 2-phase creation. | |
bool | Create (wxWindow *parent, wxWindowID id, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0, const wxValidator &validator=wxDefaultValidator, const wxString &name=wxControlNameStr) |
virtual void | Command (wxCommandEvent &event) |
Simulates the effect of the user issuing a command to the item. | |
wxString | GetLabel () const |
Returns the control's label, as it was passed to SetLabel(). | |
wxString | GetLabelText () const |
Returns the control's label without mnemonics. | |
wxSize | GetSizeFromTextSize (int xlen, int ylen=-1) const |
Determine the size needed by the control to leave the given area for its text. | |
wxSize | GetSizeFromTextSize (const wxSize &tsize) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
void | SetLabel (const wxString &label) |
Sets the control's label. | |
void | SetLabelText (const wxString &text) |
Sets the control's label to exactly the given string. | |
bool | SetLabelMarkup (const wxString &markup) |
Sets the controls label to a string using markup. | |
Public Member Functions inherited from wxWindow | |
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) |
virtual bool | AcceptsFocus () const |
This method may be overridden in the derived classes to return false to indicate that this control doesn't accept input at all (i.e. behaves like e.g. wxStaticText) and so doesn't need focus. | |
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. | |
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 | SetFocus () |
This sets the window to receive keyboard input. | |
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. | |
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 |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
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 (wxWindowBase *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. | |
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 so that it fits around its subwindows. | |
virtual void | FitInside () |
Similar to Fit(), but sizes the interior (virtual) size of a window. | |
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) | |
virtual double | GetContentScaleFactor () const |
Returns the magnification of the backing store of this window, eg 2.0 for a window on a retina screen. | |
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) |
This normally does not need to be called by user code. | |
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. | |
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) |
A synonym for Centre(). | |
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()). | |
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 (except under wxGTK1 where this is not implemented), 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 () |
Calling this method immediately repaints the invalidated area of the window and all of its children recursively (this normally only happens when the flow of control returns to the event loop). | |
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. | |
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. | |
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 |
Clears the window by filling it with the current background colour. | |
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 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 | 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. | |
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) |
This method calls SetSizer() and then wxSizer::SetSizeHints which sets the initial window size to the size needed to accommodate all sizer elements and sets the size hints which, if this window is a top level one, prevent the user from resizing it to be less than this minimal size. | |
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. | |
virtual bool | Layout () |
Invokes the constraint-based layout algorithm or the sizer-based algorithm for this window. | |
void | SetAutoLayout (bool autoLayout) |
Determines whether the Layout() function will be called automatically when the window is resized. | |
bool | GetAutoLayout () const |
Returns the sizer of which this window is a member, if any, otherwise NULL. | |
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. | |
wxHitTest | HitTest (wxCoord x, wxCoord y) 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. | |
wxHitTest | HitTest (const wxPoint &pt) 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 (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 void | InitDialog () |
Sends an wxEVT_INIT_DIALOG event, whose handler usually transfers data to the dialog via validators. | |
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. | |
virtual bool | IsRetained () const |
Returns true if the window is retained, false otherwise. | |
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. | |
Public Member Functions inherited from wxEvtHandler | |
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(). | |
virtual bool | SearchEventTable (wxEventTable &table, wxEvent &event) |
Searches the event table, executing an event handler function if an appropriate one is found. | |
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. | |
Public Member Functions inherited from wxObject | |
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. | |
Static Public Member Functions | |
static wxWebView * | New (const wxString &backend=wxWebViewBackendDefault) |
Factory function to create a new wxWebView with two-step creation, wxWebView::Create should be called on the returned object. | |
static wxWebView * | New (wxWindow *parent, wxWindowID id, const wxString &url=wxWebViewDefaultURLStr, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, const wxString &backend=wxWebViewBackendDefault, long style=0, const wxString &name=wxWebViewNameStr) |
Factory function to create a new wxWebView using a wxWebViewFactory. | |
static void | RegisterFactory (const wxString &backend, wxSharedPtr< wxWebViewFactory > factory) |
Allows the registering of new backend for wxWebView. | |
Static Public Member Functions inherited from wxControl | |
static wxString | GetLabelText (const wxString &label) |
Returns the given label string without mnemonics ("&" characters). | |
static wxString | RemoveMnemonics (const wxString &str) |
Returns the given str string without mnemonics ("&" characters). | |
static wxString | EscapeMnemonics (const wxString &text) |
Escapes the special mnemonics characters ("&") in the given string. | |
static wxString | Ellipsize (const wxString &label, const wxDC &dc, wxEllipsizeMode mode, int maxWidth, int flags=wxELLIPSIZE_FLAGS_DEFAULT) |
Replaces parts of the label string with ellipsis, if needed, so that it fits into maxWidth pixels if possible. | |
Static Public Member Functions inherited from wxWindow | |
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 Public Member Functions inherited from wxEvtHandler | |
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(). | |
Additional Inherited Members | |
Protected Member Functions inherited from wxWindow | |
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. | |
Protected Attributes inherited from wxObject | |
wxObjectRefData * | m_refData |
Pointer to an object which is the object's reference-counted data. | |
|
pure virtual |
Returns true if the current selection can be copied.
true
on the OSX WebKit backend. Implemented in wxWebViewChromium.
|
pure virtual |
Returns true if the current selection can be cut.
true
on the OSX WebKit backend. Implemented in wxWebViewChromium.
|
pure virtual |
Returns true if it is possible to navigate backward in the history of visited pages.
Implemented in wxWebViewChromium.
|
pure virtual |
Returns true if it is possible to navigate forward in the history of visited pages.
Implemented in wxWebViewChromium.
|
pure virtual |
Returns true if data can be pasted.
true
on the OSX WebKit backend. Implemented in wxWebViewChromium.
|
pure virtual |
Returns true if there is an action to redo.
Implemented in wxWebViewChromium.
|
pure virtual |
Retrieve whether the current HTML engine supports a zoom type.
type | The zoom type to test. |
Implemented in wxWebViewChromium.
|
pure virtual |
Returns true if there is an action to undo.
Implemented in wxWebViewChromium.
|
pure virtual |
Clear the history, this will also remove the visible page.
Implemented in wxWebViewChromium.
|
pure virtual |
Clears the current selection.
Implemented in wxWebViewChromium.
|
pure virtual |
Copies the current selection.
Implemented in wxWebViewChromium.
|
pure virtual |
Creation function for two-step creation.
Implemented in wxWebViewChromium.
|
pure virtual |
Cuts the current selection.
Implemented in wxWebViewChromium.
|
pure virtual |
Deletes the current selection.
Note that for wxWEBVIEW_BACKEND_WEBKIT
the selection must be editable, either through SetEditable or the correct HTML attribute.
Implemented in wxWebViewChromium.
|
virtual |
Enable or disable the right click context menu.
By default the standard context menu is enabled, this method can be used to disable it or re-enable it later.
|
pure virtual |
|
pure virtual |
Finds a phrase on the current page and if found, the control will scroll the phrase into view and select it.
text | The phrase to search for. |
flags | The flags for the search. |
wxNOT_FOUND
is returned. If called for the first time with search phrase then the total number of results will be returned. Then for every time its called with the same search phrase it will return the number of the current match. wxWEBVIEW_FIND_ENTIRE_WORD
or wxWEBVIEW_FIND_MATCH_CASE
are changed, since this will require a new search. To reset the search, for example resetting the highlights call the function with an empty search phrase. This always returns wxNOT_FOUND
on the OSX WebKit backend.
|
pure virtual |
Returns a list of items in the back history.
The first item in the vector is the first page that was loaded by the control.
Implemented in wxWebViewChromium.
|
pure virtual |
Get the title of the current web page, or its URL/path if title is not available.
Implemented in wxWebViewChromium.
|
pure virtual |
Get the URL of the currently displayed document.
Implemented in wxWebViewChromium.
|
pure virtual |
Returns a list of items in the forward history.
The first item in the vector is the next item in the history with respect to the currently loaded page.
Implemented in wxWebViewChromium.
|
pure virtual |
Return the pointer to the native backend used by this control.
This method can be used to retrieve the pointer to the native rendering engine used by this control. The return value needs to be down-casted to the appropriate type depending on the platform: under Windows, it's a pointer to IWebBrowser2 interface, under OS X it's a WebView pointer and under GTK it's a WebKitWebView.
For example, you could set the WebKit options using this method:
Implemented in wxWebViewChromium.
|
pure virtual |
Get the HTML source code of the currently displayed document.
Implemented in wxWebViewChromium.
|
pure virtual |
Get the text of the current page.
Implemented in wxWebViewChromium.
|
pure virtual |
Returns the currently selected source, if any.
Implemented in wxWebViewChromium.
|
pure virtual |
Returns the currently selected text, if any.
Implemented in wxWebViewChromium.
|
pure virtual |
Get the zoom factor of the page.
Implemented in wxWebViewChromium.
|
pure virtual |
Get how the zoom factor is currently interpreted.
Implemented in wxWebViewChromium.
|
pure virtual |
Navigate back in the history of visited pages.
Only valid if CanGoBack() returns true.
Implemented in wxWebViewChromium.
|
pure virtual |
Navigate forward in the history of visited pages.
Only valid if CanGoForward() returns true.
Implemented in wxWebViewChromium.
|
pure virtual |
Returns true if there is a current selection.
Implemented in wxWebViewChromium.
|
pure virtual |
Returns whether the web control is currently busy (e.g. loading a page).
Implemented in wxWebViewChromium.
|
virtual |
Returns true if a context menu will be shown on right click.
|
pure virtual |
Returns whether the web control is currently editable.
Implemented in wxWebViewChromium.
|
pure virtual |
Loads a history item.
Implemented in wxWebViewChromium.
|
pure virtual |
Load a web page from a URL.
url | The URL of the page to be loaded. |
Implemented in wxWebViewChromium.
Factory function to create a new wxWebView with two-step creation, wxWebView::Create should be called on the returned object.
backend | The backend web rendering engine to use. wxWebViewBackendDefault , wxWebViewBackendIE and wxWebViewBackendWebKit are predefined where appropriate. |
|
static |
Factory function to create a new wxWebView using a wxWebViewFactory.
parent | Parent window for the control |
id | ID of this control |
url | Initial URL to load |
pos | Position of the control |
size | Size of the control |
backend | The backend web rendering engine to use. wxWebViewBackendDefault , wxWebViewBackendIE and wxWebViewBackendWebKit are predefined where appropriate. |
style | Window style. For generic window styles, please see wxWindow. |
name | Window name. |
NULL
if the requested backend is not available
|
pure virtual |
Pastes the current data.
Implemented in wxWebViewChromium.
|
pure virtual |
Opens a print dialog so that the user may print the currently displayed page.
Implemented in wxWebViewChromium.
|
pure virtual |
Redos the last action.
Implemented in wxWebViewChromium.
|
static |
|
pure virtual |
Registers a custom scheme handler.
handler | A shared pointer to a wxWebHandler. |
Implemented in wxWebViewChromium.
|
pure virtual |
Reload the currently displayed URL.
flags | A bit array that may optionally contain reload options. |
Implemented in wxWebViewChromium.
|
pure virtual |
Runs the given javascript code.
Implemented in wxWebViewChromium.
|
pure virtual |
Selects the entire page.
Implemented in wxWebViewChromium.
|
pure virtual |
Set the editable property of the web control.
Enabling allows the user to edit the page even if the contenteditable
attribute is not set. The exact capabilities vary with the backend being used.
Implemented in wxWebViewChromium.
Set the displayed page source to the contents of the given string.
html | The string that contains the HTML data to display. |
baseUrl | URL assigned to the HTML data, to be used to resolve relative paths, for instance. |
wxWEBVIEW_BACKEND_IE
you must wait for the current page to finish loading before calling SetPage(). The baseURL parameter is not used in this backend.
|
virtual |
Set the displayed page source to the contents of the given stream.
html | The stream to read HTML data from. |
baseUrl | URL assigned to the HTML data, to be used to resolve relative paths, for instance. |
|
pure virtual |
Set the zoom factor of the page.
zoom | How much to zoom (scale) the HTML document. |
Implemented in wxWebViewChromium.
|
pure virtual |
Set how to interpret the zoom factor.
zoomType | How the zoom factor should be interpreted by the HTML engine. |
Implemented in wxWebViewChromium.
|
pure virtual |
Stop the current page loading process, if any.
May trigger an error event of type wxWEBVIEW_NAV_ERR_USER_CANCELLED
. TODO: make wxWEBVIEW_NAV_ERR_USER_CANCELLED
errors uniform across ports.
Implemented in wxWebViewChromium.
|
pure virtual |
Undos the last action.
Implemented in wxWebViewChromium.