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

wxErlang
Reference Manual
Version 0.98.4


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

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

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

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

Equivalent to center(This, []).

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

Types:

Option = {dir, integer()}

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

Equivalent to centerOnParent(This, []).

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

Types:

Option = {dir, integer()}

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

Equivalent to centre(This, []).

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

Types:

Option = {dir, integer()}

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

Equivalent to centreOnParent(This, []).

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

Types:

Option = {dir, integer()}

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

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

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

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

Equivalent to close(This, []).

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

Types:

Option = {force, bool()}

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

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

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

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

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

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

Equivalent to enable(This, []).

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

Types:

Option = {enable, bool()}

findFocus() -> wxWindow()

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

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

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

Types:

Option = {parent, wxWindow()}

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

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

Types:

Option = {parent, wxWindow()}

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

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

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

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

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

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

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

getCapture() -> wxWindow()

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Types:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Equivalent to makeModal(This, []).

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

Types:

Option = {modal, bool()}

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

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

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

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

Equivalent to navigate(This, []).

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

Types:

Option = {flags, integer()}

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

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

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

Equivalent to popEventHandler(This, []).

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

Types:

Option = {deleteHandler, bool()}

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

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

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

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

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

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

Types:

Option = {eraseBackground, bool()}

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

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

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

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

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

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

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

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

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

Types:

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Types:

Option = {refresh, bool()}

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

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

Types:

Option = {refresh, bool()}

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

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

Types:

Option = {sizeFlags, integer()}

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

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

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

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

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

Types:

Option = {deleteOld, bool()}

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

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

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

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

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

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

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

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

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

Equivalent to show(This, []).

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

Types:

Option = {show, bool()}

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

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

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

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

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

Equivalent to updateWindowUI(This, []).

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

Types:

Option = {flags, integer()}

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

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

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

Destroys this object, do not use object again