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()

See external documentation.

new(Parent::wxWindow(), Id::integer()) -> wxWindow()

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

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

Types:

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

See external documentation.

cacheBestSize(This::wxWindow(), Size::{W::integer(), H::integer()}) -> ok

See external documentation.

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

See external documentation.

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

Equivalent to center(This, []).

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

Types:

Option = {dir, integer()}

See external documentation.

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

Equivalent to centerOnParent(This, []).

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

Types:

Option = {dir, integer()}

See external documentation.

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

Equivalent to centre(This, []).

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

Types:

Option = {dir, integer()}

See external documentation.

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

Equivalent to centreOnParent(This, []).

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

Types:

Option = {dir, integer()}

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

close(This::wxWindow()) -> bool()

Equivalent to close(This, []).

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

Types:

Option = {force, bool()}

See external documentation.

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

See external documentation.

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

See external documentation.

Destroy(This::wxWindow()) -> bool()

See external documentation.

destroyChildren(This::wxWindow()) -> bool()

See external documentation.

disable(This::wxWindow()) -> bool()

See external documentation.

enable(This::wxWindow()) -> bool()

Equivalent to enable(This, []).

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

Types:

Option = {enable, bool()}

See external documentation.

findFocus() -> wxWindow()

See external documentation.

findWindow(This::wxWindow(), X::integer() | string()) -> wxWindow()

See external documentation.
Alternatives:

findWindow(This::wxWindow(), Winid::integer()) -> wxWindow()

findWindow(This::wxWindow(), Name::string()) -> wxWindow()

findWindowById(Winid::integer()) -> wxWindow()

Equivalent to findWindowById(Winid, []).

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

Types:

Option = {parent, wxWindow()}

See external documentation.

findWindowByName(Name::string()) -> wxWindow()

Equivalent to findWindowByName(Name, []).

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

Types:

Option = {parent, wxWindow()}

See external documentation.

findWindowByLabel(Label::string()) -> wxWindow()

Equivalent to findWindowByLabel(Label, []).

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

Types:

Option = {parent, wxWindow()}

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

getBackgroundColour(This::wxWindow()) -> colour() (see module wx)

See external documentation.

getBackgroundStyle(This::wxWindow()) -> WxBackgroundStyle

Types:

WxBackgroundStyle = integer()

See external documentation.
WxBackgroundStyle is one of ?wxBG_STYLE_SYSTEM | ?wxBG_STYLE_COLOUR | ?wxBG_STYLE_CUSTOM

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

See external documentation.

getCaret(This::wxWindow()) -> wxCaret() (see module wxCaret)

See external documentation.

getCapture() -> wxWindow()

See external documentation.

getCharHeight(This::wxWindow()) -> integer()

See external documentation.

getCharWidth(This::wxWindow()) -> integer()

See external documentation.

getChildren(This::wxWindow()) -> [wxWindow()]

See external documentation.

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

See external documentation.

getContainingSizer(This::wxWindow()) -> wxSizer() (see module wxSizer)

See external documentation.

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

See external documentation.

getDropTarget(This::wxWindow()) -> wxDropTarget() (see module wxDropTarget)

See external documentation.

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

See external documentation.

getExtraStyle(This::wxWindow()) -> integer()

See external documentation.

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

See external documentation.

getForegroundColour(This::wxWindow()) -> colour() (see module wx)

See external documentation.

getGrandParent(This::wxWindow()) -> wxWindow()

See external documentation.

getHandle(This::wxWindow()) -> integer()

See external documentation.

getHelpText(This::wxWindow()) -> string()

See external documentation.

getId(This::wxWindow()) -> integer()

See external documentation.

getLabel(This::wxWindow()) -> string()

See external documentation.

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

See external documentation.

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

See external documentation.

getName(This::wxWindow()) -> string()

See external documentation.

getParent(This::wxWindow()) -> wxWindow()

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

getScrollPos(This::wxWindow(), Orient::integer()) -> integer()

See external documentation.

getScrollRange(This::wxWindow(), Orient::integer()) -> integer()

See external documentation.

getScrollThumb(This::wxWindow(), Orient::integer()) -> integer()

See external documentation.

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

See external documentation.

getSizer(This::wxWindow()) -> wxSizer() (see module wxSizer)

See external documentation.

getTextExtent(This::wxWindow(), String::string()) -> {X::integer(), Y::integer(), Descent::integer(), ExternalLeading::integer()}

Equivalent to getTextExtent(This, String, []).

getTextExtent(This::wxWindow(), String::string(), Options::[Option]) -> {X::integer(), Y::integer(), Descent::integer(), ExternalLeading::integer()}

Types:

Option = {theFont, wxFont() (see module wxFont)}

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

getWindowStyleFlag(This::wxWindow()) -> integer()

See external documentation.

getWindowVariant(This::wxWindow()) -> WxWindowVariant

Types:

WxWindowVariant = integer()

See external documentation.
WxWindowVariant is one of ?wxWINDOW_VARIANT_NORMAL | ?wxWINDOW_VARIANT_SMALL | ?wxWINDOW_VARIANT_MINI | ?wxWINDOW_VARIANT_LARGE | ?wxWINDOW_VARIANT_MAX

hasCapture(This::wxWindow()) -> bool()

See external documentation.

hasScrollbar(This::wxWindow(), Orient::integer()) -> bool()

See external documentation.

hasTransparentBackground(This::wxWindow()) -> bool()

See external documentation.

hide(This::wxWindow()) -> bool()

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

isEnabled(This::wxWindow()) -> bool()

See external documentation.

isExposed(This::wxWindow(), X::term()) -> bool()

See external documentation.
Alternatives:

isExposed(This::wxWindow(), Pt::{X::integer(),Y::integer()}) -> bool()

isExposed(This::wxWindow(), Rect::{X::integer(),Y::integer(),W::integer(),H::integer()}) -> bool()

isExposed(This::wxWindow(), X::integer(), Y::integer()) -> bool()

See external documentation.

isExposed(This::wxWindow(), X::integer(), Y::integer(), W::integer(), H::integer()) -> bool()

See external documentation.

isRetained(This::wxWindow()) -> bool()

See external documentation.

isShown(This::wxWindow()) -> bool()

See external documentation.

isTopLevel(This::wxWindow()) -> bool()

See external documentation.

layout(This::wxWindow()) -> bool()

See external documentation.

lineDown(This::wxWindow()) -> bool()

See external documentation.

lineUp(This::wxWindow()) -> bool()

See external documentation.

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

See external documentation.

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

Equivalent to makeModal(This, []).

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

Types:

Option = {modal, bool()}

See external documentation.

move(This::wxWindow(), Pt::{X::integer(), Y::integer()}) -> ok

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

move(This::wxWindow(), X::integer() | term(), X::integer() | term()) -> ok

See external documentation.
Alternatives:

move(This::wxWindow(), X::integer(), Y::integer()) -> move(This,X,Y, [])

move(This::wxWindow(), Pt::{X::integer(),Y::integer()}, [Option]) -> ok
Option = {flags, integer()}

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

Types:

Option = {flags, integer()}

See external documentation.

moveAfterInTabOrder(This::wxWindow(), Win::wxWindow()) -> ok

See external documentation.

moveBeforeInTabOrder(This::wxWindow(), Win::wxWindow()) -> ok

See external documentation.

navigate(This::wxWindow()) -> bool()

Equivalent to navigate(This, []).

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

Types:

Option = {flags, integer()}

See external documentation.

pageDown(This::wxWindow()) -> bool()

See external documentation.

pageUp(This::wxWindow()) -> bool()

See external documentation.

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

Equivalent to popEventHandler(This, []).

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

Types:

Option = {deleteHandler, bool()}

See external documentation.

popupMenu(This::wxWindow(), Menu::wxMenu() (see module wxMenu)) -> bool()

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

popupMenu(This::wxWindow(), Menu::wxMenu() (see module wxMenu), Options::[Option]) -> bool()

Types:

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

See external documentation.

popupMenu(This::wxWindow(), Menu::wxMenu() (see module wxMenu), X::integer(), Y::integer()) -> bool()

See external documentation.

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

See external documentation.

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

Equivalent to refresh(This, []).

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

Types:

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

See external documentation.

refreshRect(This::wxWindow(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}) -> ok

Equivalent to refreshRect(This, Rect, []).

refreshRect(This::wxWindow(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}, Options::[Option]) -> ok

Types:

Option = {eraseBackground, bool()}

See external documentation.

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

See external documentation.

removeChild(This::wxWindow(), Child::wxWindow()) -> ok

See external documentation.

reparent(This::wxWindow(), NewParent::wxWindow()) -> bool()

See external documentation.

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

See external documentation.

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

See external documentation.

scrollLines(This::wxWindow(), Lines::integer()) -> bool()

See external documentation.

scrollPages(This::wxWindow(), Pages::integer()) -> bool()

See external documentation.

scrollWindow(This::wxWindow(), Dx::integer(), Dy::integer()) -> ok

Equivalent to scrollWindow(This, Dx, Dy, []).

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

Types:

Option = {rect, {X::integer(), Y::integer(), W::integer(), H::integer()}}

See external documentation.

setAcceleratorTable(This::wxWindow(), Accel::wxAcceleratorTable() (see module wxAcceleratorTable)) -> ok

See external documentation.

setAutoLayout(This::wxWindow(), AutoLayout::bool()) -> ok

See external documentation.

setBackgroundColour(This::wxWindow(), Colour::colour() (see module wx)) -> bool()

See external documentation.

setBackgroundStyle(This::wxWindow(), Style::WxBackgroundStyle) -> bool()

Types:

WxBackgroundStyle = integer()

See external documentation.
WxBackgroundStyle is one of ?wxBG_STYLE_SYSTEM | ?wxBG_STYLE_COLOUR | ?wxBG_STYLE_CUSTOM

setCaret(This::wxWindow(), Caret::wxCaret() (see module wxCaret)) -> ok

See external documentation.

setClientSize(This::wxWindow(), X::term()) -> ok

See external documentation.
Alternatives:

setClientSize(This::wxWindow(), Size::{W::integer(), H::integer()}) -> ok

setClientSize(This::wxWindow(), Rect::{X::integer(), Y::integer(), W::integer(), H::integer()}) -> ok

setClientSize(This::wxWindow(), Width::integer(), Height::integer()) -> ok

See external documentation.

setContainingSizer(This::wxWindow(), Sizer::wxSizer() (see module wxSizer)) -> ok

See external documentation.

setCursor(This::wxWindow(), Cursor::wxCursor() (see module wxCursor)) -> bool()

See external documentation.

setMaxSize(This::wxWindow(), MaxSize::{W::integer(), H::integer()}) -> ok

See external documentation.

setMinSize(This::wxWindow(), MinSize::{W::integer(), H::integer()}) -> ok

See external documentation.

setOwnBackgroundColour(This::wxWindow(), Colour::colour() (see module wx)) -> ok

See external documentation.

setOwnFont(This::wxWindow(), Font::wxFont() (see module wxFont)) -> ok

See external documentation.

setOwnForegroundColour(This::wxWindow(), Colour::colour() (see module wx)) -> ok

See external documentation.

setDropTarget(This::wxWindow(), DropTarget::wxDropTarget() (see module wxDropTarget)) -> ok

See external documentation.

setExtraStyle(This::wxWindow(), ExStyle::integer()) -> ok

See external documentation.

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

See external documentation.

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

See external documentation.

setFont(This::wxWindow(), Font::wxFont() (see module wxFont)) -> bool()

See external documentation.

setForegroundColour(This::wxWindow(), Colour::colour() (see module wx)) -> bool()

See external documentation.

setHelpText(This::wxWindow(), Text::string()) -> ok

See external documentation.

setId(This::wxWindow(), Winid::integer()) -> ok

See external documentation.

setLabel(This::wxWindow(), Label::string()) -> ok

See external documentation.

setName(This::wxWindow(), Name::string()) -> ok

See external documentation.

setPalette(This::wxWindow(), Pal::wxPalette() (see module wxPalette)) -> ok

See external documentation.

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

Equivalent to setScrollbar(This, Orient, Pos, ThumbVisible, Range, []).

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

Types:

Option = {refresh, bool()}

See external documentation.

setScrollPos(This::wxWindow(), Orient::integer(), Pos::integer()) -> ok

Equivalent to setScrollPos(This, Orient, Pos, []).

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

Types:

Option = {refresh, bool()}

See external documentation.

setSize(This::wxWindow(), X::term()) -> ok

See external documentation.
Alternatives:

setSize(This::wxWindow(), Rect::{X::integer(),Y::integer(),W::integer(),H::integer()}) -> setSize(This,Rect, [])

setSize(This::wxWindow(), Size::{W::integer(),H::integer()}) -> ok

setSize(This::wxWindow(), X::integer() | term(), X::integer() | term()) -> ok

See external documentation.
Alternatives:

setSize(This::wxWindow(), Width::integer(), Height::integer()) -> ok

setSize(This::wxWindow(), Rect::{X::integer(),Y::integer(),W::integer(),H::integer()}, [Option]) -> ok
Option = {sizeFlags, integer()}

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

Equivalent to setSize(This, X, Y, Width, Height, []).

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

Types:

Option = {sizeFlags, integer()}

See external documentation.

setSizeHints(This::wxWindow(), MinSize::{W::integer(), H::integer()}) -> ok

Equivalent to setSizeHints(This, MinSize, []).

setSizeHints(This::wxWindow(), X::integer() | term(), X::integer() | term()) -> ok

See external documentation.
Alternatives:

setSizeHints(This::wxWindow(), MinW::integer(), MinH::integer()) -> setSizeHints(This,MinW,MinH, [])

setSizeHints(This::wxWindow(), MinSize::{W::integer(),H::integer()}, [Option]) -> ok
Option = {maxSize, {W::integer(),H::integer()}} | {incSize, {W::integer(),H::integer()}}

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

Types:

Option = {maxW, integer()} | {maxH, integer()} | {incW, integer()} | {incH, integer()}

See external documentation.

setSizer(This::wxWindow(), Sizer::wxSizer() (see module wxSizer)) -> ok

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

setSizer(This::wxWindow(), Sizer::wxSizer() (see module wxSizer), Options::[Option]) -> ok

Types:

Option = {deleteOld, bool()}

See external documentation.

setSizerAndFit(This::wxWindow(), Sizer::wxSizer() (see module wxSizer)) -> ok

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

setSizerAndFit(This::wxWindow(), Sizer::wxSizer() (see module wxSizer), Options::[Option]) -> ok

Types:

Option = {deleteOld, bool()}

See external documentation.

setThemeEnabled(This::wxWindow(), EnableTheme::bool()) -> ok

See external documentation.

setToolTip(This::wxWindow(), X::string() | term()) -> ok

See external documentation.
Alternatives:

setToolTip(This::wxWindow(), Tip::string()) -> ok

setToolTip(This::wxWindow(), Tip::wxToolTip:wxToolTip()) -> ok

setVirtualSize(This::wxWindow(), Size::{W::integer(), H::integer()}) -> ok

See external documentation.

setVirtualSize(This::wxWindow(), X::integer(), Y::integer()) -> ok

See external documentation.

setVirtualSizeHints(This::wxWindow(), MinSize::{W::integer(), H::integer()}) -> ok

Equivalent to setVirtualSizeHints(This, MinSize, []).

setVirtualSizeHints(This::wxWindow(), X::integer() | term(), X::integer() | term()) -> ok

See external documentation.
Alternatives:

setVirtualSizeHints(This::wxWindow(), MinW::integer(), MinH::integer()) -> setVirtualSizeHints(This,MinW,MinH, [])

setVirtualSizeHints(This::wxWindow(), MinSize::{W::integer(),H::integer()}, [Option]) -> ok
Option = {maxSize, {W::integer(),H::integer()}}

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

Types:

Option = {maxW, integer()} | {maxH, integer()}

See external documentation.

setWindowStyle(This::wxWindow(), Style::integer()) -> ok

See external documentation.

setWindowStyleFlag(This::wxWindow(), Style::integer()) -> ok

See external documentation.

setWindowVariant(This::wxWindow(), Variant::WxWindowVariant) -> ok

Types:

WxWindowVariant = integer()

See external documentation.
WxWindowVariant is one of ?wxWINDOW_VARIANT_NORMAL | ?wxWINDOW_VARIANT_SMALL | ?wxWINDOW_VARIANT_MINI | ?wxWINDOW_VARIANT_LARGE | ?wxWINDOW_VARIANT_MAX

shouldInheritColours(This::wxWindow()) -> bool()

See external documentation.

show(This::wxWindow()) -> bool()

Equivalent to show(This, []).

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

Types:

Option = {show, bool()}

See external documentation.

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

See external documentation.

transferDataFromWindow(This::wxWindow()) -> bool()

See external documentation.