Erlang logo
User's Guide
Reference Manual
Release Notes
PDF
Top

wxErlang
Reference Manual
Version 1.2


Expand All
Contract All

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, Option::[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, Option::[Option]) -> ok

Types:

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

centerOnParent(This) -> ok

Types:

This = wxWindow()

Equivalent to centerOnParent(This, []).

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

Types:

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

centre(This) -> ok

Types:

This = wxWindow()

Equivalent to centre(This, []).

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

Types:

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

centreOnParent(This) -> ok

Types:

This = wxWindow()

Equivalent to centreOnParent(This, []).

centreOnParent(This, Option::[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, Option::[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()

enable(This) -> boolean()

Types:

This = wxWindow()

Equivalent to enable(This, []).

enable(This, Option::[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, Option::[Option]) -> wxWindow()

Types:

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

findWindowByName(Name) -> wxWindow()

Types:

Name = chardata() (see module unicode)

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

Types:

Name = chardata() (see module unicode)
Option = {parent, wxWindow()}

findWindowByLabel(Label) -> wxWindow()

Types:

Label = chardata() (see module unicode)

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

Types:

Label = chardata() (see module unicode)
Option = {parent, wxWindow()}

fit(This) -> ok

Types:

This = wxWindow()

fitInside(This) -> ok

Types:

This = wxWindow()

freeze(This) -> ok

Types:

This = wxWindow()

getAcceleratorTable(This) -> wxAcceleratorTable() (see module wxAcceleratorTable)

Types:

This = wxWindow()

getBackgroundColour(This) -> wx_colour4() (see module wx)

Types:

This = wxWindow()

getBackgroundStyle(This) -> wx_enum() (see module wx)

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() (see module 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() (see module wxSizer)

Types:

This = wxWindow()

getCursor(This) -> wxCursor() (see module wxCursor)

Types:

This = wxWindow()

getDropTarget(This) -> wx_object() (see module wx)

Types:

This = wxWindow()

getEventHandler(This) -> wxEvtHandler() (see module wxEvtHandler)

Types:

This = wxWindow()

getExtraStyle(This) -> integer()

Types:

This = wxWindow()

getFont(This) -> wxFont() (see module wxFont)

Types:

This = wxWindow()

getForegroundColour(This) -> wx_colour4() (see module wx)

Types:

This = wxWindow()

getGrandParent(This) -> wxWindow()

Types:

This = wxWindow()

getHandle(This) -> integer()

Types:

This = wxWindow()

getHelpText(This) -> charlist() (see module unicode)

Types:

This = wxWindow()

getId(This) -> integer()

Types:

This = wxWindow()

getLabel(This) -> charlist() (see module unicode)

Types:

This = wxWindow()

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

Types:

This = wxWindow()

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

Types:

This = wxWindow()

getName(This) -> charlist() (see module unicode)

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() (see module wxSizer)

Types:

This = wxWindow()

getTextExtent(This, String) -> Result

Types:

Result = {X::integer(), Y::integer(), Descent::integer(), ExternalLeading::integer()}
This = wxWindow()
String = chardata() (see module unicode)

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

Types:

Result = {X::integer(), Y::integer(), Descent::integer(), ExternalLeading::integer()}
This = wxWindow()
String = chardata() (see module unicode)
Option = {theFont, wxFont() (see module wxFont)}

getToolTip(This) -> wxToolTip() (see module wxToolTip)

Types:

This = wxWindow()

getUpdateRegion(This) -> wxRegion() (see module wxRegion)

Types:

This = wxWindow()

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

Types:

This = wxWindow()

getWindowStyleFlag(This) -> integer()

Types:

This = wxWindow()

getWindowVariant(This) -> wx_enum() (see module wx)

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, Option::[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, Option::[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, Option::[Option]) -> boolean()

Types:

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

pageDown(This) -> boolean()

Types:

This = wxWindow()

pageUp(This) -> boolean()

Types:

This = wxWindow()

popEventHandler(This) -> wxEvtHandler() (see module wxEvtHandler)

Types:

This = wxWindow()

Equivalent to popEventHandler(This, []).

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

Types:

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

popupMenu(This, Menu) -> boolean()

Types:

This = wxWindow()
Menu = wxMenu() (see module wxMenu)

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

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

Types:

This = wxWindow()
Menu = wxMenu() (see module wxMenu)
Option = {pos, {X::integer(), Y::integer()}}

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

Types:

This = wxWindow()
Menu = wxMenu() (see module wxMenu)
X = integer()
Y = integer()

raise(This) -> ok

Types:

This = wxWindow()

refresh(This) -> ok

Types:

This = wxWindow()

Equivalent to refresh(This, []).

refresh(This, Option::[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, Option::[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, Option::[Option]) -> ok

Types:

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

setAcceleratorTable(This, Accel) -> ok

Types:

This = wxWindow()
Accel = wxAcceleratorTable() (see module wxAcceleratorTable)

setAutoLayout(This, AutoLayout) -> ok

Types:

This = wxWindow()
AutoLayout = boolean()

setBackgroundColour(This, Colour) -> boolean()

Types:

This = wxWindow()
Colour = wx_colour() (see module wx)

setBackgroundStyle(This, Style) -> boolean()

Types:

This = wxWindow()
Style = wx_enum() (see module wx)

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

setCaret(This, Caret) -> ok

Types:

This = wxWindow()
Caret = wxCaret() (see module wxCaret)

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()
Sizer = wxSizer() (see module wxSizer)

setCursor(This, Cursor) -> boolean()

Types:

This = wxWindow()
Cursor = wxCursor() (see module wxCursor)

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_colour() (see module wx)

setOwnFont(This, Font) -> ok

Types:

This = wxWindow()
Font = wxFont() (see module wxFont)

setOwnForegroundColour(This, Colour) -> ok

Types:

This = wxWindow()
Colour = wx_colour() (see module wx)

setDropTarget(This, DropTarget) -> ok

Types:

This = wxWindow()
DropTarget = wx_object() (see module wx)

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()
Font = wxFont() (see module wxFont)

setForegroundColour(This, Colour) -> boolean()

Types:

This = wxWindow()
Colour = wx_colour() (see module wx)

setHelpText(This, Text) -> ok

Types:

This = wxWindow()
Text = chardata() (see module unicode)

setId(This, Winid) -> ok

Types:

This = wxWindow()
Winid = integer()

setLabel(This, Label) -> ok

Types:

This = wxWindow()
Label = chardata() (see module unicode)

setName(This, Name) -> ok

Types:

This = wxWindow()
Name = chardata() (see module unicode)

setPalette(This, Pal) -> ok

Types:

This = wxWindow()
Pal = wxPalette() (see module wxPalette)

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

Types:

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

setScrollbar(This, Orient, Pos, ThumbVisible, Range, Option::[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, Option::[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, Option::[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, Option::[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()
Sizer = wxSizer() (see module wxSizer)

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

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

Types:

This = wxWindow()
Sizer = wxSizer() (see module wxSizer)
Option = {deleteOld, boolean()}

setSizerAndFit(This, Sizer) -> ok

Types:

This = wxWindow()
Sizer = wxSizer() (see module wxSizer)

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

Types:

This = wxWindow()
Sizer = wxSizer() (see module wxSizer)
Option = {deleteOld, boolean()}

setThemeEnabled(This, EnableTheme) -> ok

Types:

This = wxWindow()
EnableTheme = boolean()

setToolTip(This, Tip) -> ok

Types:

This = wxWindow()
Tip = chardata() (see module unicode)

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, Option::[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_enum() (see module wx)

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, Option::[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, Option::[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()

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

Destroys this object, do not use object again