wxGLCanvas Class Reference | wxWidgets

wxGLCanvas Class Reference | wxWidgets
Version: 3.3.3
Public Types
Public Member Functions
Static Public Member Functions
Static Public Attributes
List of all members
wxGLCanvas Class Reference
Class List by Category
OpenGL
#include
Inheritance diagram for wxGLCanvas:
legend
Detailed Description
wxGLCanvas
is a class for displaying OpenGL graphics.
It is always used in conjunction with
wxGLContext
as the context can only be made current (i.e. active for the OpenGL commands) when it is associated to a
wxGLCanvas
More precisely, you first need to create a
wxGLCanvas
window and then create an instance of a
wxGLContext
that is initialized with this
wxGLCanvas
and then later use either
SetCurrent()
with the instance of the
wxGLContext
or
wxGLContext::SetCurrent()
with the instance of the
wxGLCanvas
(which might be not the same as was used for the creation of the context) to bind the OpenGL state that is represented by the rendering context to the canvas, and then finally call
SwapBuffers()
to swap the buffers of the OpenGL canvas and thus show your current output.
Please note that
wxGLContext
always uses physical pixels, even on the platforms where
wxWindow
uses logical pixels, affected by the coordinate scaling, on high DPI displays. Thus, if you want to set the OpenGL view port to the size of entire window, you must multiply the result returned by
wxWindow::GetClientSize()
by
wxGLCanvas::GetContentScaleFactor()
before passing it to
glViewport()
. Same considerations apply to other OpenGL functions and other coordinates, notably those retrieved from
wxMouseEvent
in the event handlers.
Notice that versions of wxWidgets previous to 2.9 used to implicitly create a
wxGLContext
inside
wxGLCanvas
itself. This is still supported in the current version but is deprecated now and will be removed in the future, please update your code to create the rendering contexts explicitly.
To set up the attributes for the canvas (number of bits for the depth buffer, number of bits for the stencil buffer and so on) you pass them in the constructor using a
wxGLAttributes
instance. You can still use the way before 3.1.0 (setting up the correct values of the
attribList
parameter) but it's discouraged.
Note
On those platforms which use a configure script (e.g. Linux and macOS) OpenGL support is automatically enabled if the relative headers and libraries are found. On Windows, OpenGL support is enabled by default (
wxUSE_GLCANVAS
set to
in the
setup.h
file). If your program links with wxWidgets statically, you need to add
opengl32.lib
to the list of libraries your program is linked with.
Library:
wxGL
Category:
OpenGL
See also
wxGLContext
wxGLAttributes
wxGLContextAttrs
Public Types
enum class
SwapInterval
NotSet
= 0
Set
= 1
NonAdaptive
= 2
Return values of
SetSwapInterval()
More...
Public Member Functions
wxGLCanvas
()
Default constructor not creating the window.
More...
wxGLCanvas
wxWindow
*parent, const
wxGLAttributes
&dispAttrs,
wxWindowID
id=
wxID_ANY
, const
wxPoint
&pos=
wxDefaultPosition
, const
wxSize
&size=
wxDefaultSize
, long style=0, const
wxString
&name=wxGLCanvasName, const
wxPalette
&palette=
wxNullPalette
Creates a window with the given parameters.
More...
wxGLCanvas
wxWindow
*parent,
wxWindowID
id=
wxID_ANY
, const int *attribList=nullptr, const
wxPoint
&pos=
wxDefaultPosition
, const
wxSize
&size=
wxDefaultSize
, long style=0, const
wxString
&name="GLCanvas", const
wxPalette
&palette=
wxNullPalette
This constructor is still available only for compatibility reasons.
More...
int
GetSwapInterval
() const
Return the current swap interval.
More...
bool
SetColour
(const
wxString
&colour)
Sets the current colour for this window (using
glcolor3f()
), using the wxWidgets colour database to find a named colour.
More...
bool
SetCurrent
(const
wxGLContext
&context) const
Makes the OpenGL state that is represented by the OpenGL rendering context
context
current, i.e.
More...
SwapInterval
SetSwapInterval
(int interval)
Set swap interval to the specified value.
More...
virtual bool
SwapBuffers
()
Swaps the double-buffer of this window, making the back-buffer the front-buffer and vice versa, so that the output of the previous OpenGL commands is displayed on the window.
More...
Public Member Functions inherited from
wxWindow
wxWindow
()
Default constructor.
More...
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.
More...
virtual
~wxWindow
()
Destructor.
More...
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.
More...
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.
More...
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.
More...
virtual bool
AcceptsFocusRecursively
() const
Overridden to indicate whether this window or one of its children accepts focus.
More...
void
DisableFocusFromKeyboard
()
Disable giving focus to this window using the keyboard navigation keys.
More...
bool
IsFocusable
() const
Can this window itself have focus?
More...
bool
CanAcceptFocus
() const
Can this window have focus right now?
More...
bool
CanAcceptFocusFromKeyboard
() const
Can this window be assigned focus from keyboard right now?
More...
virtual bool
HasFocus
() const
Returns
true
if the window (or in case of composite controls, its main child window) has focus.
More...
virtual void
SetCanFocus
(bool canFocus)
This method is only implemented by ports which have support for native TAB traversal (such as GTK+ 2.0).
More...
virtual void
EnableVisibleFocus
(bool enable)
Enables or disables visible indication of keyboard focus.
More...
virtual void
SetFocus
()
This sets the window to receive keyboard input.
More...
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).
More...
virtual void
AddChild
wxWindow
*child)
Adds a child window.
More...
template
void
CallForEachChild
(const T &functor)
Invoke the given functor for all children of the given window recursively.
More...
bool
DestroyChildren
()
Destroys all children of a window.
More...
wxWindow
FindWindow
(long id) const
Find a child of this window, by
id
More...
wxWindow
FindWindow
(const
wxString
&name) const
Find a child of this window, by name.
More...
wxWindowList &
GetChildren
()
Returns a reference to the list of the window's children.
More...
const wxWindowList &
GetChildren
() const
Returns a const reference to the list of the window's children.
More...
virtual void
RemoveChild
wxWindow
*child)
Removes a child window.
More...
wxWindow
GetGrandParent
() const
Returns the grandparent of a window, or
nullptr
if there isn't one.
More...
wxWindow
GetNextSibling
() const
Returns the next window after this one among the parent's children or
nullptr
if this window is the last child.
More...
wxWindow
GetParent
() const
Returns the parent of the window, or
nullptr
if there is no parent.
More...
wxWindow
GetPrevSibling
() const
Returns the previous window before this one among the parent's children or
nullptr
if this window is the first child.
More...
bool
IsDescendant
wxWindow
*win) const
Check if the specified window is a descendant of this one.
More...
virtual bool
Reparent
wxWindow
*newParent)
Reparents the window, i.e. the window will be removed from its current parent window (e.g.
More...
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.
More...
virtual int
GetScrollPos
(int orientation) const
Returns the built-in scrollbar position.
More...
virtual int
GetScrollRange
(int orientation) const
Returns the built-in scrollbar range.
More...
virtual int
GetScrollThumb
(int orientation) const
Returns the built-in scrollbar thumb size.
More...
bool
CanScroll
(int orient) const
Returns
true
if this window can have a scroll bar in this orientation.
More...
bool
HasScrollbar
(int orient) const
Returns
true
if this window currently has a scroll bar for this orientation.
More...
virtual bool
IsScrollbarAlwaysShown
(int orient) const
Return whether a scrollbar is always shown.
More...
virtual bool
ScrollLines
(int lines)
Scrolls the window by the given number of lines down (if
lines
is positive) or up.
More...
virtual bool
ScrollPages
(int pages)
Scrolls the window by the given number of pages down (if
pages
is positive) or up.
More...
virtual void
ScrollWindow
(int dx, int dy, const
wxRect
*rect=nullptr)
Physically scrolls the pixels in the window and move child windows accordingly.
More...
bool
LineUp
()
Same as
ScrollLines
(-1).
More...
bool
LineDown
()
Same as
ScrollLines
(1).
More...
bool
PageUp
()
Same as
ScrollPages
(-1).
More...
bool
PageDown
()
Same as
ScrollPages
(1).
More...
virtual void
SetScrollPos
(int orientation, int pos, bool refresh=true)
Sets the position of one of the built-in scrollbars.
More...
virtual void
SetScrollbar
(int orientation, int position, int thumbSize, int range, bool refresh=true)
Sets the scrollbar properties of a built-in scrollbar.
More...
void
Center
(int dir=
wxBOTH
A synonym for
Centre()
More...
void
CenterOnParent
(int dir=
wxBOTH
A synonym for
CentreOnParent()
More...
void
Centre
(int direction=
wxBOTH
Centres the window.
More...
void
CentreOnParent
(int direction=
wxBOTH
Centres the window on its parent.
More...
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.
More...
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.
More...
wxRect
GetRect
() const
Returns the position and size of the window as a
wxRect
object.
More...
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.
More...
wxPoint
GetScreenPosition
() const
Returns the window position in screen coordinates, whether the window is a child window or a top level one.
More...
wxRect
GetScreenRect
() const
Returns the position and size of the window on the screen as a
wxRect
object.
More...
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...)
More...
wxRect
GetClientRect
() const
Get the client rectangle in window (i.e. client) coordinates.
More...
void
Move
(int x, int y, int flags=
wxSIZE_USE_EXISTING
Moves the window to the given position.
More...
void
Move
(const
wxPoint
&pt, int flags=
wxSIZE_USE_EXISTING
Moves the window to the given position.
More...
void
SetPosition
(const
wxPoint
&pt)
Moves the window to the specified position.
More...
void
ClientToScreen
(int *x, int *y) const
Converts to screen coordinates from coordinates relative to this window.
More...
wxPoint
ClientToScreen
(const
wxPoint
&pt) const
Converts to screen coordinates from coordinates relative to this window.
More...
wxPoint
ConvertDialogToPixels
(const
wxPoint
&pt) const
Converts a point or size from dialog units to pixels.
More...
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.
More...
wxPoint
ConvertPixelsToDialog
(const
wxPoint
&pt) const
Converts a point or size from pixels to dialog units.
More...
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.
More...
void
ScreenToClient
(int *x, int *y) const
Converts from screen to client window coordinates.
More...
wxPoint
ScreenToClient
(const
wxPoint
&pt) const
Converts from screen to client window coordinates.
More...
virtual void
ClearBackground
()
Clears the window by filling it with the current background colour.
More...
void
Freeze
()
Freezes the window or, in other words, prevents any updates from taking place on screen, the window is not redrawn at all.
More...
void
Thaw
()
Re-enables window updating after a previous call to
Freeze()
More...
bool
IsFrozen
() const
Returns
true
if the window is currently frozen by a call to
Freeze()
More...
wxColour
GetBackgroundColour
() const
Returns the background colour of the window.
More...
virtual
wxBackgroundStyle
GetBackgroundStyle
() const
Returns the background style of the window.
More...
virtual int
GetCharHeight
() const
Returns the character height for this window.
More...
virtual int
GetCharWidth
() const
Returns the average character width for this window.
More...
virtual
wxVisualAttributes
GetDefaultAttributes
() const
Currently this is the same as calling wxWindow::GetClassDefaultAttributes(wxWindow::GetWindowVariant()).
More...
virtual
wxSize
GetDPI
() const
Return the DPI of the display used by this window.
More...
wxFont
GetFont
() const
Returns the font for this window.
More...
wxColour
GetForegroundColour
() const
Returns the foreground colour of the window.
More...
void
GetTextExtent
(const
wxString
&string, int *w, int *h, int *descent=nullptr, int *externalLeading=nullptr, const
wxFont
*font=nullptr) const
Gets the dimensions of the string as it would be drawn on the window with the currently selected font.
More...
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.
More...
const
wxRegion
GetUpdateRegion
() const
Returns the region specifying which parts of the window have been damaged.
More...
wxRect
GetUpdateClientRect
() const
Get the update rectangle bounding box in client coords.
More...
virtual bool
HasTransparentBackground
()
Returns
true
if this window background is transparent (as, for example, for
wxStaticText
) and should show the parent window background.
More...
virtual void
Refresh
(bool eraseBackground=true, const
wxRect
*rect=nullptr)
Causes this window, and all of its children recursively, to be repainted.
More...
void
RefreshRect
(const
wxRect
&rect, bool eraseBackground=true)
Redraws the contents of the given rectangle: only the area inside it will be repainted.
More...
virtual void
Update
()
Immediately repaints the invalidated area of the window and all of its children recursively.
More...
virtual bool
SetBackgroundColour
(const
wxColour
&colour)
Sets the background colour of the window.
More...
virtual bool
SetBackgroundStyle
wxBackgroundStyle
style)
Sets the background style of the window.
More...
virtual bool
IsTransparentBackgroundSupported
wxString
*reason=nullptr) const
Checks whether using transparent background might work.
More...
virtual bool
SetFont
(const
wxFont
&font)
Sets the font for this window.
More...
virtual bool
SetForegroundColour
(const
wxColour
&colour)
Sets the foreground colour of the window.
More...
void
SetOwnBackgroundColour
(const
wxColour
&colour)
Sets the background colour of the window but prevents it from being inherited by the children of this window.
More...
bool
InheritsBackgroundColour
() const
Return
true
if this window inherits the background colour from its parent.
More...
bool
UseBgCol
() const
Return
true
if a background colour has been set for this window.
More...
bool
UseBackgroundColour
() const
Return
true
if a background colour has been set for this window.
More...
void
SetOwnFont
(const
wxFont
&font)
Sets the font of the window but prevents it from being inherited by the children of this window.
More...
void
SetOwnForegroundColour
(const
wxColour
&colour)
Sets the foreground colour of the window but prevents it from being inherited by the children of this window.
More...
bool
UseForegroundColour
() const
Return
true
if a foreground colour has been set for this window.
More...
bool
InheritsForegroundColour
() const
Return
true
if this window inherits the foreground colour from its parent.
More...
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()
More...
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.
More...
virtual bool
GetThemeEnabled
() const
Returns
true
if the window uses the system theme for drawing its background.
More...
virtual bool
CanSetTransparent
()
Returns
true
if the system supports transparent windows and calling
SetTransparent()
may succeed.
More...
virtual bool
SetTransparent
wxByte
alpha)
Set the transparency of the window.
More...
wxEvtHandler
GetEventHandler
() const
Returns the event handler for this window.
More...
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.
More...
bool
HandleWindowEvent
wxEvent
&event) const
Shorthand for:
More...
bool
ProcessWindowEvent
wxEvent
&event)
Convenient wrapper for
ProcessEvent()
More...
bool
ProcessWindowEventLocally
wxEvent
&event)
Wrapper for
wxEvtHandler::ProcessEventLocally()
More...
wxEvtHandler
PopEventHandler
(bool deleteHandler=false)
Removes and returns the top-most event handler on the event handler stack.
More...
void
PushEventHandler
wxEvtHandler
*handler)
Pushes this event handler onto the event stack for the window.
More...
bool
RemoveEventHandler
wxEvtHandler
*handler)
Find the given
handler
in the windows event handler stack and removes (but does not delete) it from the stack.
More...
void
SetEventHandler
wxEvtHandler
*handler)
Sets the event handler for this window.
More...
virtual void
SetNextHandler
wxEvtHandler
*handler)
wxWindows cannot be used to form event handler chains; this function thus will assert when called.
More...
virtual void
SetPreviousHandler
wxEvtHandler
*handler)
wxWindows cannot be used to form event handler chains; this function thus will assert when called.
More...
long
GetExtraStyle
() const
Returns the extra style bits for the window.
More...
virtual long
GetWindowStyleFlag
() const
Gets the window style that was passed to the constructor or
Create()
method.
More...
long
GetWindowStyle
() const
See
GetWindowStyleFlag()
for more info.
More...
bool
HasExtraStyle
(int exFlag) const
Returns
true
if the window has the given
exFlag
bit set in its extra styles.
More...
bool
HasFlag
(int flag) const
Returns
true
if the window has the given
flag
bit set.
More...
virtual void
SetExtraStyle
(long exStyle)
Sets the extra style bits for the window.
More...
virtual void
SetWindowStyleFlag
(long style)
Sets the style of the window.
More...
void
SetWindowStyle
(long style)
See
SetWindowStyleFlag()
for more info.
More...
bool
ToggleWindowStyle
(int flag)
Turns the given
flag
on if it's currently turned off and vice versa.
More...
void
MoveAfterInTabOrder
wxWindow
*win)
Moves this window in the tab navigation order after the specified
win
More...
void
MoveBeforeInTabOrder
wxWindow
*win)
Same as
MoveAfterInTabOrder()
except that it inserts this window just before
win
instead of putting it right after it.
More...
bool
Navigate
(int flags=
wxNavigationKeyEvent::IsForward
Performs a keyboard navigation action starting from this window.
More...
bool
NavigateIn
(int flags=
wxNavigationKeyEvent::IsForward
Performs a keyboard navigation action inside this window.
More...
virtual void
Lower
()
Lowers the window to the bottom of the window hierarchy (Z-order).
More...
virtual void
Raise
()
Raises the window to the top of the window hierarchy (Z-order).
More...
bool
Hide
()
Equivalent to calling
wxWindow::Show
false
).
More...
virtual bool
HideWithEffect
wxShowEffect
effect, unsigned int timeout=0)
This function hides a window, like
Hide()
, but using a special visual effect if possible.
More...
bool
IsEnabled
() const
Returns
true
if the window is enabled, i.e. if it accepts user input,
false
otherwise.
More...
bool
IsExposed
(int x, int y) const
Returns
true
if the given point or rectangle area has been exposed since the last repaint.
More...
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.
More...
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.
More...
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.
More...
virtual bool
IsShown
() const
Returns
true
if the window is shown,
false
if it has been hidden.
More...
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.
More...
bool
Disable
()
Disables the window.
More...
virtual bool
Enable
(bool enable=true)
Enable or disable the window for user input.
More...
virtual bool
Show
(bool show=true)
Shows or hides the window.
More...
virtual bool
ShowWithEffect
wxShowEffect
effect, unsigned int timeout=0)
This function shows a window, like
Show()
, but using a special visual effect if possible.
More...
virtual int
GetHelpIdAtPoint
(const
wxPoint
&pt)
Get the ID to be used for help events generated at the given point.
More...
wxString
GetHelpText
() const
Gets the help text to be used as context-sensitive help for this window.
More...
void
SetHelpText
(const
wxString
&helpText)
Sets the help text to be used as context-sensitive help for this window.
More...
virtual
wxString
GetHelpTextAtPoint
(const
wxPoint
&point,
wxHelpEvent::Origin
origin) const
Gets the help text to be used as context-sensitive help for this window.
More...
wxToolTip
GetToolTip
() const
Get the associated tooltip or
nullptr
if none.
More...
wxString
GetToolTipText
() const
Get the text of the associated tooltip or empty string if none.
More...
void
SetToolTip
(const
wxString
&tipString)
Attach a tooltip to the window.
More...
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.
More...
void
UnsetToolTip
()
Unset any existing tooltip.
More...
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.
More...
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.
More...
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.
More...
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.
More...
virtual
wxValidator
GetValidator
()
Validator functions.
More...
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.
More...
virtual bool
TransferDataFromWindow
()
Transfers values from child controls to data areas specified by their validators.
More...
virtual bool
TransferDataToWindow
()
Transfers values to child controls from data areas specified by their validators.
More...
virtual bool
Validate
()
Validates the current values of the child controls using their validators.
More...
wxWindowID
GetId
() const
Returns the identifier of the window.
More...
virtual
wxString
GetLabel
() const
Generic way of getting a label from any window, for identification purposes.
More...
virtual
wxLayoutDirection
GetLayoutDirection
() const
Returns the layout direction for this window, Note that
wxLayout_Default
is returned if layout direction is not supported.
More...
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.
More...
virtual
wxString
GetName
() const
Returns the window's name.
More...
wxWindowVariant
GetWindowVariant
() const
Returns the value previously passed to
SetWindowVariant()
More...
void
SetId
wxWindowID
winid)
Sets the identifier of the window.
More...
virtual void
SetLabel
(const
wxString
&label)
Sets the window's label.
More...
virtual void
SetLayoutDirection
wxLayoutDirection
dir)
Sets the layout direction for this window.
More...
virtual void
SetName
(const
wxString
&name)
Sets the window's name.
More...
void
SetWindowVariant
wxWindowVariant
variant)
Chooses a different variant of the window display to use.
More...
wxAcceleratorTable
GetAcceleratorTable
()
Gets the accelerator table for this window.
More...
wxAccessible
GetAccessible
()
Returns the accessible object for this window, if any.
More...
virtual void
SetAcceleratorTable
(const
wxAcceleratorTable
&accel)
Sets the accelerator table for this window.
More...
void
SetAccessible
wxAccessible
*accessible)
Sets the accessible for this window.
More...
virtual
wxAccessible
CreateAccessible
()
Override to create a specific accessible object.
More...
wxAccessible
GetOrCreateAccessible
()
Returns the accessible object, calling CreateAccessible if necessary.
More...
bool
Close
(bool force=false)
This function simply generates a
wxCloseEvent
whose handler usually tries to close the window.
More...
virtual bool
Destroy
()
Destroys the window safely.
More...
bool
IsBeingDeleted
() const
Returns true if this window is in process of being destroyed.
More...
virtual
wxDropTarget
GetDropTarget
() const
Returns the associated drop target, which may be
nullptr
More...
virtual void
SetDropTarget
wxDropTarget
*target)
Associates a drop target with this window.
More...
virtual void
DragAcceptFiles
(bool accept)
Enables or disables eligibility for drop file events (OnDropFiles).
More...
wxSizer
GetContainingSizer
() const
Returns the sizer of which this window is a member, if any, otherwise
nullptr
More...
wxSizer
GetSizer
() const
Returns the sizer associated with the window by a previous call to
SetSizer()
, or
nullptr
More...
void
SetSizer
wxSizer
*sizer, bool deleteOld=true)
Sets the window to have the given layout sizer.
More...
void
SetSizerAndFit
wxSizer
*sizer, bool deleteOld=true)
Associate the sizer with the window and set the window size and minimal size accordingly.
More...
wxLayoutConstraints
GetConstraints
() const
Returns a pointer to the window's layout constraints, or
nullptr
if there are none.
More...
void
SetConstraints
wxLayoutConstraints
*constraints)
Sets the window to have the given layout constraints.
More...
virtual bool
Layout
()
Lays out the children of this window using the associated sizer.
More...
void
SetAutoLayout
(bool autoLayout)
Determines whether the
Layout()
function will be called automatically when the window is resized.
More...
bool
GetAutoLayout
() const
Returns true if
Layout()
is called automatically when the window is resized.
More...
void
CaptureMouse
()
Directs all mouse input to this window.
More...
wxCaret
GetCaret
() const
Returns the caret() associated with the window.
More...
wxCursor
GetCursor
() const
Return the cursor associated with this window.
More...
wxCursorBundle
GetCursorBundle
() const
Returns the cursor bundle associated with this window.
More...
virtual bool
HasCapture
() const
Returns
true
if this window has the current mouse capture.
More...
void
ReleaseMouse
()
Releases mouse input captured with
CaptureMouse()
More...
void
SetCaret
wxCaret
*caret)
Sets the caret() associated with the window.
More...
virtual bool
SetCursor
(const
wxCursor
&cursor)
Sets the window's cursor.
More...
virtual bool
SetCursorBundle
(const
wxCursorBundle
&cursors)
Sets a collection of cursors to be used by the window.
More...
virtual void
WarpPointer
(int x, int y)
Moves the pointer to the given position on the window.
More...
virtual bool
EnableTouchEvents
(int eventsMask)
Request generation of touch events for this window.
More...
wxHitTest
HitTest
wxCoord
x,
wxCoord
y) const
Return where the given point lies, exactly.
More...
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.
More...
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.
More...
wxBorder
GetBorder
() const
Get border for the flags of this window.
More...
virtual void
DoUpdateWindowUI
wxUpdateUIEvent
&event)
Does the window-specific updating after processing the update event.
More...
virtual WXWidget
GetHandle
() const
Returns the platform-specific handle of the physical window.
More...
WXHWND
GTKGetWin32Handle
() const
This function is used only with wxGTK when running on Windows, to receive a
wxWindow
's underlying HWND.
More...
virtual bool
HasMultiplePages
() const
This method should be overridden to return
true
if this window has multiple pages.
More...
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.
More...
virtual void
InitDialog
()
Sends an
wxEVT_INIT_DIALOG
event, whose handler usually transfers data to the dialog via validators.
More...
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.
More...
void
SetDoubleBuffered
(bool on)
Turn on or off double buffering of the window if the system supports it.
More...
virtual bool
IsRetained
() const
Returns
true
if the window is retained,
false
otherwise.
More...
bool
IsThisEnabled
() const
Returns
true
if this window is intrinsically enabled,
false
otherwise, i.e. if
Enable()
Enable(
false
) had been called.
More...
virtual bool
IsTopLevel
() const
Returns
true
if the given window is a top-level one.
More...
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.
More...
virtual bool
SendIdleEvents
wxIdleEvent
&event)
Send idle event to window and all subwindows.
More...
virtual bool
RegisterHotKey
(int hotkeyId, int modifiers, int virtualKeyCode)
Registers a system wide hotkey.
More...
virtual bool
UnregisterHotKey
(int hotkeyId)
Unregisters a system wide hotkey.
More...
virtual void
UpdateWindowUI
(long flags=
wxUPDATE_UI_NONE
This function sends one or more
wxUpdateUIEvent
to the window.
More...
virtual void
DoPrepareUpdateWindowUI
wxUpdateUIEvent
&event) const
When
UpdateWindowUI()
runs, it creates instances of
wxUpdateUIEvent
More...
bool
BeginRepositioningChildren
()
Prepare for changing positions of multiple child windows.
More...
void
EndRepositioningChildren
()
Fix child window positions after setting all of them at once.
More...
void
CacheBestSize
(const
wxSize
&size) const
Sets the cached best size value.
More...
virtual
wxSize
ClientToWindowSize
(const
wxSize
&size) const
Converts client area size
size
to corresponding window size.
More...
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.
More...
virtual void
Fit
()
Sizes the window to fit its best size.
More...
virtual void
FitInside
()
Similar to
Fit()
, but sizes the interior (virtual) size of a window.
More...
wxSize
FromDIP
(const
wxSize
&sz) const
Convert DPI-independent pixel values to the value in pixels appropriate for the current toolkit.
More...
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.
More...
int
FromDIP
(int d) const
Convert DPI-independent distance in pixels to the value in pixels appropriate for the current toolkit.
More...
wxSize
ToDIP
(const
wxSize
&sz) const
Convert pixel values of the current toolkit to DPI-independent pixel values.
More...
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.
More...
int
ToDIP
(int d) const
Convert pixel values of the current toolkit to DPI-independent pixel values.
More...
wxSize
FromPhys
(const
wxSize
&sz) const
Convert from physical pixels to logical pixels.
More...
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.
More...
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.
More...
wxSize
ToPhys
(const
wxSize
&sz) const
Convert from logical pixels to physical pixels.
More...
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.
More...
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.
More...
wxSize
GetBestSize
() const
This functions returns the best acceptable minimal size for the window.
More...
int
GetBestHeight
(int width) const
Returns the best height needed by this window if it had the given width.
More...
int
GetBestWidth
(int height) const
Returns the best width needed by this window if it had the given height.
More...
void
GetClientSize
(int *width, int *height) const
Returns the size of the window 'client area' in pixels.
More...
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.
More...
virtual
wxSize
GetEffectiveMinSize
() const
Merges the window's best size into the min size and returns the result.
More...
virtual
wxSize
GetMinSizeFromKnownDirection
(int direction, int size, int availableOtherDir)
May be overridden if the control minimal size depends on the layout direction.
More...
virtual
wxSize
GetMaxClientSize
() const
Returns the maximum size of window's client area.
More...
virtual
wxSize
GetMaxSize
() const
Returns the maximum size of the window.
More...
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.
More...
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.
More...
int
GetMinWidth
() const
Returns the horizontal component of window minimal size.
More...
int
GetMinHeight
() const
Returns the vertical component of window minimal size.
More...
int
GetMaxWidth
() const
Returns the horizontal component of window maximal size.
More...
int
GetMaxHeight
() const
Returns the vertical component of window maximal size.
More...
void
GetSize
(int *width, int *height) const
Returns the size of the entire window in pixels, including title bar, border, scrollbars, etc.
More...
wxSize
GetSize
() const
See the GetSize(int*,int*) overload for more info.
More...
wxSize
GetVirtualSize
() const
This gets the virtual size of the window in pixels.
More...
void
GetVirtualSize
(int *width, int *height) const
Like the other
GetVirtualSize()
overload but uses pointers instead.
More...
virtual
wxSize
GetBestVirtualSize
() const
Return the largest of ClientSize and BestSize (as determined by a sizer, interior children, or other means)
More...
double
GetContentScaleFactor
() const
Returns the factor mapping logical pixels of this window to physical pixels.
More...
double
GetDPIScaleFactor
() const
Returns the ratio of the DPI used by this window to the standard DPI.
More...
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.
More...
virtual bool
InformFirstDirection
(int direction, int size, int availableOtherDir)
Compatibility function called by
GetMinSizeFromKnownDirection()
More...
void
InvalidateBestSize
()
Resets the cached best size value so it will be recalculated the next time it is needed.
More...
void
PostSizeEvent
()
Posts a size event to the window.
More...
void
PostSizeEventToParent
()
Posts a size event to the parent of this window.
More...
virtual void
SendSizeEvent
(int flags=0)
This function sends a dummy
size event
to the window allowing it to re-layout its children positions.
More...
void
SendSizeEventToParent
(int flags=0)
Safe wrapper for
GetParent()
->
SendSizeEvent()
More...
void
SetClientSize
(int width, int height)
This sets the size of the window client area in pixels.
More...
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.
More...
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.
More...
void
SetContainingSizer
wxSizer
*sizer)
Used by
wxSizer
internally to notify the window about being managed by the given sizer.
More...
void
SetInitialSize
(const
wxSize
&size=
wxDefaultSize
smart
SetSize that will fill in default size components with the window's
best
size values.
More...
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.
More...
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.
More...
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.
More...
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.
More...
void
SetSize
(int x, int y, int width, int height, int sizeFlags=
wxSIZE_AUTO
Sets the size of the window in pixels.
More...
void
SetSize
(const
wxRect
&rect)
Sets the size of the window in pixels.
More...
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.
More...
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.
More...
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.
More...
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.
More...
void
SetVirtualSize
(int width, int height)
Sets the virtual size of the window in pixels.
More...
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.
More...
Public Member Functions inherited from
wxEvtHandler
wxEvtHandler
()
Constructor.
More...
virtual
~wxEvtHandler
()
Destructor.
More...
template
void
CallAfter
(void(T::*method)(T1,...), T1 x1,...)
Asynchronously call the given method.
More...
template
void
CallAfter
(const T &functor)
Asynchronously call the given functor.
More...
bool
ProcessEventLocally
wxEvent
&event)
Try to process the event in this handler and all those chained to it.
More...
bool
SafelyProcessEvent
wxEvent
&event)
Processes an event by calling
ProcessEvent()
and handles any exceptions that occur in the process.
More...
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.
More...
void
DeletePendingEvents
()
Deletes all events queued on this event handler using
QueueEvent()
or
AddPendingEvent()
More...
void
Connect
(int id, int lastId,
wxEventType
eventType, wxObjectEventFunction function,
wxObject
*userData=nullptr,
wxEvtHandler
*eventSink=nullptr)
Connects the given function dynamically with the event handler, id and event type.
More...
void
Connect
(int id,
wxEventType
eventType, wxObjectEventFunction function,
wxObject
*userData=nullptr,
wxEvtHandler
*eventSink=nullptr)
See the
Connect(int, int, wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*)
overload for more info.
More...
void
Connect
wxEventType
eventType, wxObjectEventFunction function,
wxObject
*userData=nullptr,
wxEvtHandler
*eventSink=nullptr)
See the
Connect(int, int, wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*)
overload for more info.
More...
bool
Disconnect
wxEventType
eventType, wxObjectEventFunction function,
wxObject
*userData=nullptr,
wxEvtHandler
*eventSink=nullptr)
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.
More...
bool
Disconnect
(int id=
wxID_ANY
wxEventType
eventType=
wxEVT_NULL
, wxObjectEventFunction function=nullptr,
wxObject
*userData=nullptr,
wxEvtHandler
*eventSink=nullptr)
See the
Disconnect(wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*)
overload for more info.
More...
bool
Disconnect
(int id, int lastId,
wxEventType
eventType, wxObjectEventFunction function=nullptr,
wxObject
*userData=nullptr,
wxEvtHandler
*eventSink=nullptr)
See the
Disconnect(wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*)
overload for more info.
More...
template
void
Bind
(const EventTag &eventType, Functor functor, int id=
wxID_ANY
, int lastId=
wxID_ANY
wxObject
*userData=nullptr)
Binds the given function, functor or method dynamically with the event.
More...
template
void
Bind
(const EventTag &eventType, void(Class::*method)(EventArg &), EventHandler *handler, int id=
wxID_ANY
, int lastId=
wxID_ANY
wxObject
*userData=nullptr)
See the
Bind<>(const EventTag&, Functor, int, int, wxObject*)
overload for more info.
More...
template
bool
Unbind
(const EventTag &eventType, Functor functor, int id=
wxID_ANY
, int lastId=
wxID_ANY
wxObject
*userData=nullptr)
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.
More...
template
bool
Unbind
(const EventTag &eventType, void(Class::*method)(EventArg &), EventHandler *handler, int id=
wxID_ANY
, int lastId=
wxID_ANY
wxObject
*userData=nullptr)
See the
Unbind<>(const EventTag&, Functor, int, int, wxObject*)
overload for more info.
More...
void *
GetClientData
() const
Returns user-supplied client data.
More...
wxClientData
GetClientObject
() const
Returns a pointer to the user-supplied client data object.
More...
void
SetClientData
(void *data)
Sets user-supplied client data.
More...
void
SetClientObject
wxClientData
*data)
Set the client data object.
More...
bool
GetEvtHandlerEnabled
() const
Returns
true
if the event handler is enabled,
false
otherwise.
More...
wxEvtHandler
GetNextHandler
() const
Returns the pointer to the next handler in the chain.
More...
wxEvtHandler
GetPreviousHandler
() const
Returns the pointer to the previous handler in the chain.
More...
void
SetEvtHandlerEnabled
(bool enabled)
Enables or disables the event handler.
More...
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).
More...
bool
IsUnlinked
() const
Returns
true
if the next and the previous handler pointers of this event handler instance are
nullptr
More...
Public Member Functions inherited from
wxObject
wxObject
()
Default ctor; initializes to
nullptr
the internal reference data.
More...
wxObject
(const
wxObject
&other)
Copy ctor.
More...
virtual
~wxObject
()
Destructor.
More...
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).
More...
wxObjectRefData
GetRefData
() const
Returns the
wxObject::m_refData
pointer, i.e. the data referenced by this object.
More...
bool
IsKindOf
(const
wxClassInfo
*info) const
Determines whether this class is a subclass of (or the same class as) the given class.
More...
bool
IsSameAs
(const
wxObject
&obj) const
Returns
true
if this object has the same data pointer as
obj
More...
void
Ref
(const
wxObject
&clone)
Makes this object refer to the data in
clone
More...
void
SetRefData
wxObjectRefData
*data)
Sets the
wxObject::m_refData
pointer.
More...
void
UnRef
()
Decrements the reference count in the associated data, and if it is zero, deletes the data.
More...
void
UnShare
()
This is the same of
AllocExclusive()
but this method is public.
More...
void
operator delete
(void *buf)
The
delete
operator is defined for debugging versions of the library only, when the identifier
__WXDEBUG__
is defined.
More...
void *
operator new
(size_t size, const
wxString
&filename=nullptr, int lineNum=0)
The
new
operator is defined for debugging versions of the library only, when the identifier
__WXDEBUG__
is defined.
More...
Static Public Member Functions
static bool
GetEGLVersion
(int *major, int *minor)
Return the version of EGL being used or
false
if not using EGL.
More...
static int
GetGLXVersion
()
Return the version of GLX being used or 0 if not using GLX.
More...
static bool
IsDisplaySupported
(const
wxGLAttributes
&dispAttrs)
Determines if a canvas having the specified attributes is available.
More...
static bool
IsDisplaySupported
(const int *attribList)
Determines if a canvas having the specified attributes is available.
More...
static bool
IsExtensionSupported
(const char *extension)
Returns true if the extension with given name is supported.
More...
static void
PreferGLX
()
Prefer using GLX over other OpenGL implementations on Unix-like systems where multiple implementations are available (such as GLX and EGL).
More...
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.
More...
static
wxWindow
FindFocus
()
Finds the window or control which currently has the keyboard focus.
More...
static
wxWindow
FindWindowById
(long id, const
wxWindow
*parent=0)
Find the first window with the given
id
More...
static
wxWindow
FindWindowByLabel
(const
wxString
&label, const
wxWindow
*parent=0)
Find a window by its label.
More...
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).
More...
static
wxWindow
GetCapture
()
Returns the currently captured window.
More...
static
wxWindowID
NewControlId
(int count=1)
Create a new ID or range of IDs that are not currently in use.
More...
static void
UnreserveControlId
wxWindowID
id, int count=1)
Unreserve an ID or range of IDs that was reserved by
NewControlId()
More...
static
wxSize
FromDIP
(const
wxSize
&sz, const
wxWindow
*w)
Non window-specific DPI-independent pixels conversion functions.
More...
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.
More...
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.
More...
static
wxSize
ToDIP
(const
wxSize
&sz, const
wxWindow
*w)
Non window-specific pixel to DPI-independent pixels conversion functions.
More...
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.
More...
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.
More...
static
wxSize
FromPhys
(const
wxSize
&sz, const
wxWindow
*w)
Convert from physical pixels to logical pixels for any window.
More...
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.
More...
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.
More...
static
wxSize
ToPhys
(const
wxSize
&sz, const
wxWindow
*w)
Convert from logical pixels to physical pixels for any window.
More...
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.
More...
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.
More...
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.
More...
static void
RemoveFilter
wxEventFilter
*filter)
Remove a filter previously installed with
AddFilter()
More...
Static Public Attributes
static constexpr int
DefaultSwapInterval
= INT_MAX
Constant used with
SetSwapInterval()
and
GetSwapInterval()
More...
Additional Inherited Members
Protected Member Functions inherited from
wxWindow
virtual void
DoCentre
(int direction)
Centres the window.
More...
virtual
wxSize
DoGetBestSize
() const
Implementation of
GetBestSize()
that can be overridden.
More...
virtual
wxSize
DoGetBestClientSize
() const
Override this method to return the best size for a custom control.
More...
virtual int
DoGetBestClientHeight
(int width) const
Override this method to implement height-for-width best size calculation.
More...
virtual int
DoGetBestClientWidth
(int height) const
Override this method to implement width-for-height best size calculation.
More...
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).
More...
void
SendDestroyEvent
()
Generate
wxWindowDestroyEvent
for this window.
More...
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.
More...
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
More...
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
More...
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
More...
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
More...
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
More...
Protected Member Functions inherited from
wxEvtHandler
virtual bool
TryBefore
wxEvent
&event)
Method called by
ProcessEvent()
before examining this object event tables.
More...
virtual bool
TryAfter
wxEvent
&event)
Method called by
ProcessEvent()
as last resort.
More...
Protected Member Functions inherited from
wxObject
void
AllocExclusive
()
Ensure that this object's data is not shared with any other object.
More...
virtual
wxObjectRefData
CreateRefData
() const
Creates a new instance of the wxObjectRefData-derived class specific to this object and returns it.
More...
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
More...
Protected Attributes inherited from
wxObject
wxObjectRefData
m_refData
Pointer to an object which is the object's reference-counted data.
More...
Member Enumeration Documentation
SwapInterval
enum
wxGLCanvas::SwapInterval
strong
Return values of
SetSwapInterval()
Since
3.3.2
Enumerator
NotSet
SetSwapInterval()
failed to set the requested swap interval.
Set
SetSwapInterval()
successfully set the requested swap interval.
NonAdaptive
SetSwapInterval()
failed to enable adaptive VSync but successfully enabled standard VSync instead.
Constructor & Destructor Documentation
wxGLCanvas()
[1/3]
wxGLCanvas::wxGLCanvas
Default constructor not creating the window.
Create()
must be used to actually create it later.
Since
3.3.0
wxGLCanvas()
[2/3]
wxGLCanvas::wxGLCanvas
wxWindow
parent
const
wxGLAttributes
dispAttrs
wxWindowID
id
wxID_ANY
const
wxPoint
pos
wxDefaultPosition
const
wxSize
size
wxDefaultSize
long
style
const
wxString
name
wxGLCanvasName
const
wxPalette
palette
wxNullPalette
Creates a window with the given parameters.
Notice that you need to create and use a
wxGLContext
to output to this window.
Parameters
parent
Pointer to a parent window.
dispAttrs
The
wxGLAttributes
used for setting display attributes (not for rendering context attributes).
id
Window identifier. If -1, will automatically create an identifier.
pos
Window position. wxDefaultPosition is (-1, -1) which indicates that wxWidgets should generate a default position for the window.
size
Window size. wxDefaultSize is (-1, -1) which indicates that wxWidgets should generate a default size for the window. If no suitable size can be found, the window will be sized to 20x20 pixels so that the window is visible but obviously not correctly sized.
style
Window style.
name
Window name.
palette
Palette for indexed colour (i.e. non WX_GL_RGBA) mode. Ignored under most platforms.
Since
3.1.0
wxGLCanvas()
[3/3]
wxGLCanvas::wxGLCanvas
wxWindow
parent
wxWindowID
id
wxID_ANY
const int *
attribList
nullptr
const
wxPoint
pos
wxDefaultPosition
const
wxSize
size
wxDefaultSize
long
style
const
wxString
name
"GLCanvas"
const
wxPalette
palette
wxNullPalette
This constructor is still available only for compatibility reasons.
Please use the constructor with
wxGLAttributes
instead.
If
attribList
is not specified,
wxGLAttributes::PlatformDefaults()
is used, plus some other attributes (see below).
Parameters
parent
Pointer to a parent window.
id
Window identifier. If -1, will automatically create an identifier.
attribList
Array of integers. With this parameter you can set the device context attributes associated to this window. This array is zero-terminated: it should be set up using
wxGL_FLAGS
constants. If a constant should be followed by a value, put it in the next array position. For example, WX_GL_DEPTH_SIZE should be followed by the value that indicates the number of bits for the depth buffer, e.g.:
attribList[n++] =
WX_GL_DEPTH_SIZE
attribList[n++] = 32;
attribList[n] = 0;
// terminate the list
WX_GL_DEPTH_SIZE
@ WX_GL_DEPTH_SIZE
(F) Specifies number of bits for Z-buffer (typically 0, 16 or 32).
Definition:
glcanvas.h:665
If the attribute list is not specified at all, i.e. if this parameter is
nullptr
, the default attributes including WX_GL_RGBA and WX_GL_DOUBLEBUFFER are used. But notice that if you do specify some attributes you also need to explicitly include these two default attributes in the list if you need them.
pos
Window position. wxDefaultPosition is (-1, -1) which indicates that wxWidgets should generate a default position for the window.
size
Window size. wxDefaultSize is (-1, -1) which indicates that wxWidgets should generate a default size for the window. If no suitable size can be found, the window will be sized to 20x20 pixels so that the window is visible but obviously not correctly sized.
style
Window style.
name
Window name.
palette
Palette for indexed colour (i.e. non WX_GL_RGBA) mode. Ignored under most platforms.
Member Function Documentation
GetEGLVersion()
static bool wxGLCanvas::GetEGLVersion
int *
major
int *
minor
static
Return the version of EGL being used or
false
if not using EGL.
This function is only available when
wxHAS_GLX
preprocessor symbol is defined, i.e. in the builds where either GLX or EGL can be used. Note that it is still available when
wxHAS_EGL
is
not
defined, and simply always returns
false
in this case.
Parameters
major
Pointer to an integer to receive the major version number. May be
nullptr
minor
Pointer to an integer to receive the minor version number. May be
nullptr
Returns
true
if EGL is being used and version numbers were returned,
false
otherwise, e.g. if GLX is being used instead.
Since
3.3.2
GetGLXVersion()
static int wxGLCanvas::GetGLXVersion
static
Return the version of GLX being used or 0 if not using GLX.
The returned value combines major and minor version numbers in a single integer, e.g. version 1.3 will be returned as 13.
This function is only available when
wxHAS_GLX
preprocessor symbol is defined (which will be the case for wxGTK and wxX11 under Unix systems).
GetSwapInterval()
int wxGLCanvas::GetSwapInterval
const
Return the current swap interval.
Note that the swap interval is not necessarily the same as the one set by
SetSwapInterval()
as the implementation may clamp it to the maximum supported value.
Returns
The current swap interval or DefaultSwapInterval if the function is not implemented for the current platform or an error occurred.
Since
3.3.2
IsDisplaySupported()
[1/2]
static bool wxGLCanvas::IsDisplaySupported
const int *
attribList
static
Determines if a canvas having the specified attributes is available.
This only applies for visual attributes, not rendering context attributes. Please, use the new form of this method, using
wxGLAttributes
Parameters
attribList
See
attribList
for
wxGLCanvas()
Returns
true
if attributes are supported.
IsDisplaySupported()
[2/2]
static bool wxGLCanvas::IsDisplaySupported
const
wxGLAttributes
dispAttrs
static
Determines if a canvas having the specified attributes is available.
This only applies for visual attributes, not rendering context attributes.
Parameters
dispAttrs
The requested attributes.
Returns
true
if attributes are supported.
Since
3.1.0
IsExtensionSupported()
static bool wxGLCanvas::IsExtensionSupported
const char *
extension
static
Returns true if the extension with given name is supported.
Notice that while this function is implemented for all of GLX, WGL and NSOpenGL the extensions names are usually not the same for different platforms and so the code using it still usually uses conditional compilation.
PreferGLX()
static void wxGLCanvas::PreferGLX
static
Prefer using GLX over other OpenGL implementations on Unix-like systems where multiple implementations are available (such as GLX and EGL).
This function is only available when
wxHAS_GLX
preprocessor symbol is defined (which will be the case for wxGTK and wxX11 under Unix systems).
It must be called before using any OpenGL functionality, which includes not only creating
wxGLCanvas
but also checking for extension support or creating attributes objects, doing it afterwards will trigger an assert failure and have no other effect.
Note that when using wxGTK with Wayland, calling this function will have no effect anyhow as only EGL is supported in this case.
Finally please note that the same effect can be achieved by setting the environment variable
wx_opengl_egl=0
before starting the application.
Since
3.3.2
SetColour()
bool wxGLCanvas::SetColour
const
wxString
colour
Sets the current colour for this window (using
glcolor3f()
), using the wxWidgets colour database to find a named colour.
SetCurrent()
bool wxGLCanvas::SetCurrent
const
wxGLContext
context
const
Makes the OpenGL state that is represented by the OpenGL rendering context
context
current, i.e.
it will be used by all subsequent OpenGL calls.
This is equivalent to
wxGLContext::SetCurrent()
called with this window as parameter.
Note
This function may only be called when the window is shown on screen, in particular it can't usually be called from the constructor as the window isn't yet shown at this moment.
Returns
false
if an error occurred.
SetSwapInterval()
SwapInterval
wxGLCanvas::SetSwapInterval
int
interval
Set swap interval to the specified value.
interval
specifies the minimum number of video frame periods per buffer swap, i.e. for each call to
SwapBuffers()
. Using the value of 0 means to disable synchronizing buffer swaps to video frames.
The value may be negative to enable adaptive VSync if supported by the implementation, i.e. to allow swapping buffers without waiting for VSync when the refresh late is too low.
Parameters
interval
The swap interval to set or the special value DefaultSwapInterval which means to turn off automatically setting it to 0 by default, as needs to be done under some platforms currently. Typical values are 1 to enable VSync, 0 to disable it and -1 to enable adaptive VSync if supported.
Returns
SwapInterval::Set
if the swap interval was set successfully,
SwapInterval::NotSet
if setting it failed completely, e.g. if the function is not implemented for the current platform and
SwapInterval::NonAdaptive
if the adaptive VSync was requested but is not supported and standard VSync was enabled instead.
See also
GetSwapInterval()
Since
3.3.2
SwapBuffers()
virtual bool wxGLCanvas::SwapBuffers
virtual
Swaps the double-buffer of this window, making the back-buffer the front-buffer and vice versa, so that the output of the previous OpenGL commands is displayed on the window.
Returns
false
if an error occurred.
Member Data Documentation
DefaultSwapInterval
constexpr int wxGLCanvas::DefaultSwapInterval = INT_MAX
static
constexpr
Constant used with
SetSwapInterval()
and
GetSwapInterval()
When used with
SetSwapInterval()
, it disables changing the default swap interval. When returned by
GetSwapInterval()
, it indicates that the swap interval value couldn't be retrieved.
Since
3.3.2
Generated on Sat Apr 18 2026 22:28:14 for wxWidgets by
Doxygen
1.9.1