wxWindow

Module

wxWindow

Module Summary

Functions for wxWindow class

Description

wxWindow is the base class for all windows and represents any visible object on screen. All controls, top level windows and so on are windows. Sizers and device contexts are not, however, as they don't appear on screen themselves.

Please note that all children of the window will be deleted automatically by the destructor before the window itself is deleted which means that you don't have to worry about deleting them manually. Please see the window deletion overview for more information.

Also note that in this, and many others, wxWidgets classes some GetXXX() methods may be overloaded (as, for example, getSize/1 or getClientSize/1). In this case, the overloads are non-virtual because having multiple virtual functions with the same name results in a virtual function name hiding at the derived class level (in English, this means that the derived class has to override all overloaded variants if it overrides any of them). To allow overriding them in the derived class, wxWidgets uses a unique protected virtual DoGetXXX() method and all GetXXX() ones are forwarded to it, so overriding the former changes the behaviour of the latter.

Styles

This class supports the following styles:

Extra Styles

This class supports the following extra styles:

See: Overview events, Overview windowsizing

This class is derived (and can use functions) from: wxEvtHandler

wxWidgets docs: wxWindow

Events

Event types emitted from this class: activate, child_focus, context_menu, help, drop_files, erase_background, set_focus, kill_focus, idle, joy_button_down, joy_button_up, joy_move, joy_zmove, key_down, key_up, char, char_hook, mouse_capture_lost, mouse_capture_changed, left_down, left_up, middle_down, middle_up, right_down, right_up, motion, enter_window, leave_window, left_dclick, middle_dclick, right_dclick, mousewheel, aux1_down, aux1_up, aux1_dclick, aux2_down, aux2_up, aux2_dclick, paint, scrollwin_top, scrollwin_bottom, scrollwin_lineup, scrollwin_linedown, scrollwin_pageup, scrollwin_pagedown, scrollwin_thumbtrack, scrollwin_thumbrelease, set_cursor, size, sys_colour_changed

Data Types

wxWindow() = wx:wx_object()

Exports

new() -> wxWindow()

Default constructor.

new(Parent, Id) -> wxWindow()

Types

Parent = wxWindow()

Id = integer()

new(Parent, Id, Options :: [Option]) -> wxWindow()

Types

Parent = wxWindow()

Id = integer()

Option =
    {pos, {X :: integer(), Y :: integer()}} |
    {size, {W :: integer(), H :: integer()}} |
    {style, integer()}

Constructs a window, which can be a child of a frame, dialog or any other non-control window.

destroy(This :: wxWindow()) -> ok

Destructor.

Deletes all sub-windows, then deletes itself. Instead of using the delete operator explicitly, you should normally use 'Destroy'/1 so that wxWidgets can delete a window only when it is safe to do so, in idle time.

See: Window Deletion Overview, 'Destroy'/1, wxCloseEvent

create(This, Parent, Id) -> boolean()

Types

This = Parent = wxWindow()

Id = integer()

create(This, Parent, Id, Options :: [Option]) -> boolean()

Types

This = Parent = wxWindow()

Id = integer()

Option =
    {pos, {X :: integer(), Y :: integer()}} |
    {size, {W :: integer(), H :: integer()}} |
    {style, integer()}

Construct the actual window object after creating the C++ object.

The non-default constructor of wxWindow class does two things: it initializes the C++ object and it also creates the window object in the underlying graphical toolkit. The create/4 method can be used to perform the second part later, while the default constructor can be used to perform the first part only.

Please note that the underlying window must be created exactly once, i.e. if you use the default constructor, which doesn't do this, you must call create/4 before using the window and if you use the non-default constructor, you can not call create/4, as the underlying window is already created.

Note that it is possible and, in fact, useful, to call some methods on the object between creating the C++ object itself and calling create/4 on it, e.g. a common pattern to avoid showing the contents of a window before it is fully initialized is:

Also note that it is possible to create an object of a derived type and then call create/4 on it: This is notably used by overview_xrc.

The parameters of this method have exactly the same meaning as the non-default constructor parameters, please refer to them for their description.

Return: true if window creation succeeded or false if it failed

wxWindow

wxWindow

Module

Module Summary

Description

Events

Data Types

wxWindow() = wx:wx_object()

Exports

new() -> wxWindow()

new(Parent, Id) -> wxWindow()

Types

new(Parent, Id, Options :: [Option]) -> wxWindow()

Types

destroy(This :: wxWindow()) -> ok

create(This, Parent, Id) -> boolean()

Types

create(This, Parent, Id, Options :: [Option]) -> boolean()

Types

cacheBestSize(This, Size) -> ok

Types

captureMouse(This) -> ok

Types

center(This) -> ok

Types

centre(This) -> ok

Types

center(This, Options :: [Option]) -> ok

Types

centre(This, Options :: [Option]) -> ok

Types

centerOnParent(This) -> ok

Types

centreOnParent(This) -> ok

Types

centerOnParent(This, Options :: [Option]) -> ok

Types

centreOnParent(This, Options :: [Option]) -> ok

Types

clearBackground(This) -> ok

Types

clientToScreen(This, Pt) -> {X :: integer(), Y :: integer()}

Types

clientToScreen(This, X, Y) -> {X :: integer(), Y :: integer()}

Types

close(This) -> boolean()

Types

close(This, Options :: [Option]) -> boolean()

Types

convertDialogToPixels(This, Sz) -> {W :: integer(), H :: integer()}

Types

convertPixelsToDialog(This, Sz) -> {W :: integer(), H :: integer()}

Types

'Destroy'(This) -> boolean()

Types

destroyChildren(This) -> boolean()

Types

disable(This) -> boolean()

Types

dragAcceptFiles(This, Accept) -> ok

Types

enable(This) -> boolean()

Types

enable(This, Options :: [Option]) -> boolean()

Types

findFocus() -> wxWindow()

findWindow(This, Id) -> wxWindow()

findWindow(This, Name) -> wxWindow()

Types

findWindowById(Id) -> wxWindow()

Types

findWindowById(Id, Options :: [Option]) -> wxWindow()

Types

findWindowByName(Name) -> wxWindow()

Types

findWindowByName(Name, Options :: [Option]) -> wxWindow()

Types

findWindowByLabel(Label) -> wxWindow()

Types

findWindowByLabel(Label, Options :: [Option]) -> wxWindow()

convertDialogToPixels(This, Sz) ->
{W :: integer(), H :: integer()}

convertPixelsToDialog(This, Sz) ->
{W :: integer(), H :: integer()}

getAcceleratorTable(This) ->
wxAcceleratorTable:wxAcceleratorTable()

getRect(This) ->
{X :: integer(),
Y :: integer(),
W :: integer(),
H :: integer()}

getScreenRect(This) ->
{X :: integer(),
Y :: integer(),
W :: integer(),
H :: integer()}