wxErlang

Reference Manual

Version 1.8.2

Table of Contents

wxWindow

Module

wxWindow

Module Summary

See external documentation: wxWindow.

Description

See external documentation: wxWindow.

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

DATA TYPES

wxWindow()

An object reference, The representation is internal and can be changed without notice. It can't be used for comparsion stored on disc or distributed for use on other nodes.

Exports

new() -> wxWindow()

new(Parent, Id) -> wxWindow()

Types

Parent = wxWindow()
Id = integer()

Equivalent to new(Parent, Id, []).

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

Types

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

cacheBestSize(This, Size) -> ok

Types

This = wxWindow()
Size = {W::integer(), H::integer()}

captureMouse(This) -> ok

Types

This = wxWindow()

center(This) -> ok

Types

This = wxWindow()

Equivalent to center(This, []).

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

Types

This = wxWindow()
Option = {dir, integer()}

centerOnParent(This) -> ok

Types

This = wxWindow()

Equivalent to centerOnParent(This, []).

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

Types

This = wxWindow()
Option = {dir, integer()}

centre(This) -> ok

Types

This = wxWindow()

Equivalent to centre(This, []).

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

Types

This = wxWindow()
Option = {dir, integer()}

centreOnParent(This) -> ok

Types

This = wxWindow()

Equivalent to centreOnParent(This, []).

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

Types

This = wxWindow()
Option = {dir, integer()}

clearBackground(This) -> ok

Types

This = wxWindow()

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

Types

This = wxWindow()
Pt = {X::integer(), Y::integer()}

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

Types

This = wxWindow()
X = integer()
Y = integer()

close(This) -> boolean()

Types

This = wxWindow()

Equivalent to close(This, []).

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

Types

This = wxWindow()
Option = {force, boolean()}

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

Types

This = wxWindow()
Sz = {W::integer(), H::integer()}

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

Types

This = wxWindow()
Sz = {W::integer(), H::integer()}

Destroy(This) -> boolean()

Types

This = wxWindow()

destroyChildren(This) -> boolean()

Types

This = wxWindow()

disable(This) -> boolean()

Types

This = wxWindow()

dragAcceptFiles(This, Accept) -> ok

Types

This = wxWindow()
Accept = boolean()

enable(This) -> boolean()

Types

This = wxWindow()

Equivalent to enable(This, []).

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

Types

This = wxWindow()
Option = {enable, boolean()}

findFocus() -> wxWindow()

findWindow(This, Winid) -> wxWindow()

Types

This = wxWindow()
Winid = integer()

See external documentation.
Also:
findWindow(This, Name) -> wxWindow() when
This::wxWindow(), Name::unicode:chardata().

findWindowById(Winid) -> wxWindow()

Types

Winid = integer()

Equivalent to findWindowById(Winid, []).

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

Types

Winid = integer()
Option = {parent, wxWindow()}

findWindowByName(Name) -> wxWindow()

Types

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

Types

Option = {parent, wxWindow()}

findWindowByLabel(Label) -> wxWindow()

Types

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

Types

Option = {parent, wxWindow()}

fit(This) -> ok

Types

This = wxWindow()

fitInside(This) -> ok

Types

This = wxWindow()

freeze(This) -> ok

Types

This = wxWindow()

getAcceleratorTable(This) -> wxAcceleratorTable:wxAcceleratorTable()

Types

This = wxWindow()

getBackgroundColour(This) -> wx:wx_colour4()

Types

This = wxWindow()

getBackgroundStyle(This) -> wx:wx_enum()

Types

This = wxWindow()

See external documentation.
Res = ?wxBG_STYLE_SYSTEM | ?wxBG_STYLE_COLOUR | ?wxBG_STYLE_CUSTOM

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

Types

This = wxWindow()

getCaret(This) -> wxCaret:wxCaret()

Types

This = wxWindow()

getCapture() -> wxWindow()

getCharHeight(This) -> integer()

Types

This = wxWindow()

getCharWidth(This) -> integer()

Types

This = wxWindow()

getChildren(This) -> [wxWindow()]

Types

This = wxWindow()

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

Types

This = wxWindow()

getContainingSizer(This) -> wxSizer:wxSizer()

Types

This = wxWindow()

getCursor(This) -> wxCursor:wxCursor()

Types

This = wxWindow()

getDropTarget(This) -> wx:wx_object()

Types

This = wxWindow()

getEventHandler(This) -> wxEvtHandler:wxEvtHandler()

Types

This = wxWindow()

getExtraStyle(This) -> integer()

Types

This = wxWindow()

getFont(This) -> wxFont:wxFont()

Types

This = wxWindow()

getForegroundColour(This) -> wx:wx_colour4()

Types

This = wxWindow()

getGrandParent(This) -> wxWindow()

Types

This = wxWindow()

getHandle(This) -> integer()

Types

This = wxWindow()

getHelpText(This) -> unicode:charlist()

Types

This = wxWindow()

getId(This) -> integer()

Types

This = wxWindow()

getLabel(This) -> unicode:charlist()

Types

This = wxWindow()

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

Types

This = wxWindow()

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

Types

This = wxWindow()

getName(This) -> unicode:charlist()

Types

This = wxWindow()

getParent(This) -> wxWindow()

Types

This = wxWindow()

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

Types

This = wxWindow()

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

Types

This = wxWindow()

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

Types

This = wxWindow()

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

Types

This = wxWindow()

getScrollPos(This, Orient) -> integer()

Types

This = wxWindow()
Orient = integer()

getScrollRange(This, Orient) -> integer()

Types

This = wxWindow()
Orient = integer()

getScrollThumb(This, Orient) -> integer()

Types

This = wxWindow()
Orient = integer()

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

Types

This = wxWindow()

getSizer(This) -> wxSizer:wxSizer()

Types

This = wxWindow()

getTextExtent(This, String) -> Result

Types

Result = {X::integer(), Y::integer(), Descent::integer(), ExternalLeading::integer()}
This = wxWindow()

getTextExtent(This, String, Options::[Option]) -> Result

Types

Result = {X::integer(), Y::integer(), Descent::integer(), ExternalLeading::integer()}
This = wxWindow()
Option = {theFont, wxFont:wxFont()}

getToolTip(This) -> wxToolTip:wxToolTip()

Types

This = wxWindow()

getUpdateRegion(This) -> wxRegion:wxRegion()

Types

This = wxWindow()

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

Types

This = wxWindow()

getWindowStyleFlag(This) -> integer()

Types

This = wxWindow()

getWindowVariant(This) -> wx:wx_enum()

Types

This = wxWindow()

See external documentation.
Res = ?wxWINDOW_VARIANT_NORMAL | ?wxWINDOW_VARIANT_SMALL | ?wxWINDOW_VARIANT_MINI | ?wxWINDOW_VARIANT_LARGE | ?wxWINDOW_VARIANT_MAX

hasCapture(This) -> boolean()

Types

This = wxWindow()

hasScrollbar(This, Orient) -> boolean()

Types

This = wxWindow()
Orient = integer()

hasTransparentBackground(This) -> boolean()

Types

This = wxWindow()

hide(This) -> boolean()

Types

This = wxWindow()

inheritAttributes(This) -> ok

Types

This = wxWindow()

initDialog(This) -> ok

Types

This = wxWindow()

invalidateBestSize(This) -> ok

Types

This = wxWindow()

isEnabled(This) -> boolean()

Types

This = wxWindow()

isExposed(This, Pt) -> boolean()

Types

This = wxWindow()
Pt = {X::integer(), Y::integer()}

See external documentation.
Also:
isExposed(This, Rect) -> boolean() when
This::wxWindow(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}.

isExposed(This, X, Y) -> boolean()

Types

This = wxWindow()
X = integer()
Y = integer()

isExposed(This, X, Y, W, H) -> boolean()

Types

This = wxWindow()
X = integer()
Y = integer()
W = integer()
H = integer()

isRetained(This) -> boolean()

Types

This = wxWindow()

isShown(This) -> boolean()

Types

This = wxWindow()

isTopLevel(This) -> boolean()

Types

This = wxWindow()

layout(This) -> boolean()

Types

This = wxWindow()

lineDown(This) -> boolean()

Types

This = wxWindow()

lineUp(This) -> boolean()

Types

This = wxWindow()

lower(This) -> ok

Types

This = wxWindow()

makeModal(This) -> ok

Types

This = wxWindow()

Equivalent to makeModal(This, []).

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

Types

This = wxWindow()
Option = {modal, boolean()}

move(This, Pt) -> ok

Types

This = wxWindow()
Pt = {X::integer(), Y::integer()}

Equivalent to move(This, Pt, []).

move(This, X, Y) -> ok

Types

This = wxWindow()
X = integer()
Y = integer()

See external documentation.
Also:
move(This, Pt, [Option]) -> 'ok' when
This::wxWindow(), Pt::{X::integer(), Y::integer()},
Option :: {'flags', integer()}.

move(This, X, Y, Options::[Option]) -> ok

Types

This = wxWindow()
X = integer()
Y = integer()
Option = {flags, integer()}

moveAfterInTabOrder(This, Win) -> ok

Types

This = wxWindow()
Win = wxWindow()

moveBeforeInTabOrder(This, Win) -> ok

Types

This = wxWindow()
Win = wxWindow()

navigate(This) -> boolean()

Types

This = wxWindow()

Equivalent to navigate(This, []).

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

Types

This = wxWindow()
Option = {flags, integer()}

pageDown(This) -> boolean()

Types

This = wxWindow()

pageUp(This) -> boolean()

Types

This = wxWindow()

popEventHandler(This) -> wxEvtHandler:wxEvtHandler()

Types

This = wxWindow()

Equivalent to popEventHandler(This, []).

popEventHandler(This, Options::[Option]) -> wxEvtHandler:wxEvtHandler()

Types

This = wxWindow()
Option = {deleteHandler, boolean()}

popupMenu(This, Menu) -> boolean()

Types

This = wxWindow()

Equivalent to popupMenu(This, Menu, []).

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

Types

This = wxWindow()
Option = {pos, {X::integer(), Y::integer()}}

popupMenu(This, Menu, X, Y) -> boolean()

Types

This = wxWindow()
X = integer()
Y = integer()

raise(This) -> ok

Types

This = wxWindow()

refresh(This) -> ok

Types

This = wxWindow()

Equivalent to refresh(This, []).

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

Types

This = wxWindow()
Option = {eraseBackground, boolean()} | {rect, {X::integer(), Y::integer(), W::integer(), H::integer()}}

refreshRect(This, Rect) -> ok

Types

This = wxWindow()
Rect = {X::integer(), Y::integer(), W::integer(), H::integer()}

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

Types

This = wxWindow()
Rect = {X::integer(), Y::integer(), W::integer(), H::integer()}
Option = {eraseBackground, boolean()}

releaseMouse(This) -> ok

Types

This = wxWindow()

removeChild(This, Child) -> ok

Types

This = wxWindow()
Child = wxWindow()

reparent(This, NewParent) -> boolean()

Types

This = wxWindow()
NewParent = wxWindow()

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

Types

This = wxWindow()

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

Types

This = wxWindow()
Pt = {X::integer(), Y::integer()}

scrollLines(This, Lines) -> boolean()

Types

This = wxWindow()
Lines = integer()

scrollPages(This, Pages) -> boolean()

Types

This = wxWindow()
Pages = integer()

scrollWindow(This, Dx, Dy) -> ok

Types

This = wxWindow()
Dx = integer()
Dy = integer()

scrollWindow(This, Dx, Dy, Options::[Option]) -> ok

Types

This = wxWindow()
Dx = integer()
Dy = integer()
Option = {rect, {X::integer(), Y::integer(), W::integer(), H::integer()}}

setAcceleratorTable(This, Accel) -> ok

setAutoLayout(This, AutoLayout) -> ok

Types

This = wxWindow()
AutoLayout = boolean()

setBackgroundColour(This, Colour) -> boolean()

Types

This = wxWindow()
Colour = wx:wx_colour()

setBackgroundStyle(This, Style) -> boolean()

Types

This = wxWindow()
Style = wx:wx_enum()

See external documentation.
Style = ?wxBG_STYLE_SYSTEM | ?wxBG_STYLE_COLOUR | ?wxBG_STYLE_CUSTOM

setCaret(This, Caret) -> ok

Types

This = wxWindow()

setClientSize(This, Size) -> ok

Types

This = wxWindow()
Size = {W::integer(), H::integer()}

See external documentation.
Also:
setClientSize(This, Rect) -> 'ok' when
This::wxWindow(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}.

setClientSize(This, Width, Height) -> ok

Types

This = wxWindow()
Width = integer()
Height = integer()

setContainingSizer(This, Sizer) -> ok

Types

This = wxWindow()

setCursor(This, Cursor) -> boolean()

Types

This = wxWindow()

setMaxSize(This, MaxSize) -> ok

Types

This = wxWindow()
MaxSize = {W::integer(), H::integer()}

setMinSize(This, MinSize) -> ok

Types

This = wxWindow()
MinSize = {W::integer(), H::integer()}

setOwnBackgroundColour(This, Colour) -> ok

Types

This = wxWindow()
Colour = wx:wx_colour()

setOwnFont(This, Font) -> ok

Types

This = wxWindow()

setOwnForegroundColour(This, Colour) -> ok

Types

This = wxWindow()
Colour = wx:wx_colour()

setDropTarget(This, DropTarget) -> ok

Types

This = wxWindow()
DropTarget = wx:wx_object()

setExtraStyle(This, ExStyle) -> ok

Types

This = wxWindow()
ExStyle = integer()

setFocus(This) -> ok

Types

This = wxWindow()

setFocusFromKbd(This) -> ok

Types

This = wxWindow()

setFont(This, Font) -> boolean()

Types

This = wxWindow()

setForegroundColour(This, Colour) -> boolean()

Types

This = wxWindow()
Colour = wx:wx_colour()

setHelpText(This, Text) -> ok

Types

This = wxWindow()

setId(This, Winid) -> ok

Types

This = wxWindow()
Winid = integer()

setLabel(This, Label) -> ok

Types

This = wxWindow()

setName(This, Name) -> ok

Types

This = wxWindow()

setPalette(This, Pal) -> ok

Types

This = wxWindow()

setScrollbar(This, Orient, Pos, ThumbVisible, Range) -> ok

Types

This = wxWindow()
Orient = integer()
Pos = integer()
ThumbVisible = integer()
Range = integer()

setScrollbar(This, Orient, Pos, ThumbVisible, Range, Options::[Option]) -> ok

Types

This = wxWindow()
Orient = integer()
Pos = integer()
ThumbVisible = integer()
Range = integer()
Option = {refresh, boolean()}

setScrollPos(This, Orient, Pos) -> ok

Types

This = wxWindow()
Orient = integer()
Pos = integer()

setScrollPos(This, Orient, Pos, Options::[Option]) -> ok

Types

This = wxWindow()
Orient = integer()
Pos = integer()
Option = {refresh, boolean()}

setSize(This, Rect) -> ok

Types

This = wxWindow()
Rect = {X::integer(), Y::integer(), W::integer(), H::integer()}

See external documentation.
Also:
setSize(This, Size) -> 'ok' when
This::wxWindow(), Size::{W::integer(), H::integer()}.

setSize(This, Width, Height) -> ok

Types

This = wxWindow()
Width = integer()
Height = integer()

See external documentation.
Also:
setSize(This, Rect, [Option]) -> 'ok' when
This::wxWindow(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()},
Option :: {'sizeFlags', integer()}.

setSize(This, X, Y, Width, Height) -> ok

Types

This = wxWindow()
X = integer()
Y = integer()
Width = integer()
Height = integer()

setSize(This, X, Y, Width, Height, Options::[Option]) -> ok

Types

This = wxWindow()
X = integer()
Y = integer()
Width = integer()
Height = integer()
Option = {sizeFlags, integer()}

setSizeHints(This, MinSize) -> ok

Types

This = wxWindow()
MinSize = {W::integer(), H::integer()}

setSizeHints(This, MinW, MinH) -> ok

Types

This = wxWindow()
MinW = integer()
MinH = integer()

See external documentation.
Also:
setSizeHints(This, MinSize, [Option]) -> 'ok' when
This::wxWindow(), MinSize::{W::integer(), H::integer()},
Option :: {'maxSize', {W::integer(), H::integer()}}
| {'incSize', {W::integer(), H::integer()}}.

setSizeHints(This, MinW, MinH, Options::[Option]) -> ok

Types

This = wxWindow()
MinW = integer()
MinH = integer()
Option = {maxW, integer()} | {maxH, integer()} | {incW, integer()} | {incH, integer()}

setSizer(This, Sizer) -> ok

Types

This = wxWindow()

Equivalent to setSizer(This, Sizer, []).

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

Types

This = wxWindow()
Option = {deleteOld, boolean()}

setSizerAndFit(This, Sizer) -> ok

Types

This = wxWindow()

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

Types

This = wxWindow()
Option = {deleteOld, boolean()}

setThemeEnabled(This, EnableTheme) -> ok

Types

This = wxWindow()
EnableTheme = boolean()

setToolTip(This, Tip) -> ok

Types

This = wxWindow()

See external documentation.
Also:
setToolTip(This, Tip) -> 'ok' when
This::wxWindow(), Tip::wxToolTip:wxToolTip().

setVirtualSize(This, Size) -> ok

Types

This = wxWindow()
Size = {W::integer(), H::integer()}

setVirtualSize(This, X, Y) -> ok

Types

This = wxWindow()
X = integer()
Y = integer()

setVirtualSizeHints(This, MinSize) -> ok

Types

This = wxWindow()
MinSize = {W::integer(), H::integer()}

setVirtualSizeHints(This, MinW, MinH) -> ok

Types

This = wxWindow()
MinW = integer()
MinH = integer()

See external documentation.
Also:
setVirtualSizeHints(This, MinSize, [Option]) -> 'ok' when
This::wxWindow(), MinSize::{W::integer(), H::integer()},
Option :: {'maxSize', {W::integer(), H::integer()}}.

setVirtualSizeHints(This, MinW, MinH, Options::[Option]) -> ok

Types

This = wxWindow()
MinW = integer()
MinH = integer()
Option = {maxW, integer()} | {maxH, integer()}

setWindowStyle(This, Style) -> ok

Types

This = wxWindow()
Style = integer()

setWindowStyleFlag(This, Style) -> ok

Types

This = wxWindow()
Style = integer()

setWindowVariant(This, Variant) -> ok

Types

This = wxWindow()
Variant = wx:wx_enum()

See external documentation.
Variant = ?wxWINDOW_VARIANT_NORMAL | ?wxWINDOW_VARIANT_SMALL | ?wxWINDOW_VARIANT_MINI | ?wxWINDOW_VARIANT_LARGE | ?wxWINDOW_VARIANT_MAX

shouldInheritColours(This) -> boolean()

Types

This = wxWindow()

show(This) -> boolean()

Types

This = wxWindow()

Equivalent to show(This, []).

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

Types

This = wxWindow()
Option = {show, boolean()}

thaw(This) -> ok

Types

This = wxWindow()

transferDataFromWindow(This) -> boolean()

Types

This = wxWindow()

transferDataToWindow(This) -> boolean()

Types

This = wxWindow()

update(This) -> ok

Types

This = wxWindow()

updateWindowUI(This) -> ok

Types

This = wxWindow()

Equivalent to updateWindowUI(This, []).

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

Types

This = wxWindow()
Option = {flags, integer()}

validate(This) -> boolean()

Types

This = wxWindow()

warpPointer(This, X, Y) -> ok

Types

This = wxWindow()
X = integer()
Y = integer()

setTransparent(This, Alpha) -> boolean()

Types

This = wxWindow()
Alpha = integer()

canSetTransparent(This) -> boolean()

Types

This = wxWindow()

isDoubleBuffered(This) -> boolean()

Types

This = wxWindow()

setDoubleBuffered(This, On) -> ok

Types

This = wxWindow()
On = boolean()

getContentScaleFactor(This) -> number()

Types

This = wxWindow()

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

Destroys this object, do not use object again