wxWindow

See external documentation: wxWindow.

See external documentation: wxWindow.

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

Functions


new() -> wxWindow()

See external documentation.

new(Parent, Id) -> wxWindow()

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

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

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

See external documentation.

cacheBestSize(This, Size) -> ok

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

See external documentation.

captureMouse(This) -> ok

See external documentation.

center(This) -> ok

Equivalent to center(This, []).

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

See external documentation.

centerOnParent(This) -> ok

Equivalent to centerOnParent(This, []).

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

See external documentation.

centre(This) -> ok

Equivalent to centre(This, []).

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

See external documentation.

centreOnParent(This) -> ok

Equivalent to centreOnParent(This, []).

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

See external documentation.

clearBackground(This) -> ok

See external documentation.

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

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

See external documentation.

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

See external documentation.

close(This) -> boolean()

Equivalent to close(This, []).

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

See external documentation.

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

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

See external documentation.

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

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

See external documentation.

Destroy(This) -> boolean()

See external documentation.

destroyChildren(This) -> boolean()

See external documentation.

disable(This) -> boolean()

See external documentation.

dragAcceptFiles(This, Accept) -> ok

See external documentation.

enable(This) -> boolean()

Equivalent to enable(This, []).

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

See external documentation.

findFocus() -> wxWindow()

See external documentation.

findWindow(This, Winid) -> wxWindow()

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

findWindowById(Winid) -> wxWindow()

  • Winid = integer()

Equivalent to findWindowById(Winid, []).

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

See external documentation.

findWindowByName(Name) -> wxWindow()

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

See external documentation.

findWindowByLabel(Label) -> wxWindow()

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

See external documentation.

fit(This) -> ok

See external documentation.

fitInside(This) -> ok

See external documentation.

freeze(This) -> ok

See external documentation.

getAcceleratorTable(This) -> wxAcceleratorTable:wxAcceleratorTable()

See external documentation.

getBackgroundColour(This) -> wx:wx_colour4()

See external documentation.

getBackgroundStyle(This) -> wx:wx_enum()

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

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

See external documentation.

getCaret(This) -> wxCaret:wxCaret()

See external documentation.

getCapture() -> wxWindow()

See external documentation.

getCharHeight(This) -> integer()

See external documentation.

getCharWidth(This) -> integer()

See external documentation.

getChildren(This) -> [wxWindow()]

See external documentation.

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

See external documentation.

getContainingSizer(This) -> wxSizer:wxSizer()

See external documentation.

getCursor(This) -> wxCursor:wxCursor()

See external documentation.

getDropTarget(This) -> wx:wx_object()

See external documentation.

getEventHandler(This) -> wxEvtHandler:wxEvtHandler()

See external documentation.

getExtraStyle(This) -> integer()

See external documentation.

getFont(This) -> wxFont:wxFont()

See external documentation.

getForegroundColour(This) -> wx:wx_colour4()

See external documentation.

getGrandParent(This) -> wxWindow()

See external documentation.

getHandle(This) -> integer()

See external documentation.

getHelpText(This) -> unicode:charlist()

See external documentation.

getId(This) -> integer()

See external documentation.

getLabel(This) -> unicode:charlist()

See external documentation.

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

See external documentation.

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

See external documentation.

getName(This) -> unicode:charlist()

See external documentation.

getParent(This) -> wxWindow()

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

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

See external documentation.

getScrollPos(This, Orient) -> integer()

See external documentation.

getScrollRange(This, Orient) -> integer()

See external documentation.

getScrollThumb(This, Orient) -> integer()

See external documentation.

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

See external documentation.

getSizer(This) -> wxSizer:wxSizer()

See external documentation.

getTextExtent(This, String) -> Result

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

See external documentation.

getToolTip(This) -> wxToolTip:wxToolTip()

See external documentation.

getUpdateRegion(This) -> wxRegion:wxRegion()

See external documentation.

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

See external documentation.

getWindowStyleFlag(This) -> integer()

See external documentation.

getWindowVariant(This) -> wx:wx_enum()

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

hasCapture(This) -> boolean()

See external documentation.

hasScrollbar(This, Orient) -> boolean()

See external documentation.

hasTransparentBackground(This) -> boolean()

See external documentation.

hide(This) -> boolean()

See external documentation.

inheritAttributes(This) -> ok

See external documentation.

initDialog(This) -> ok

See external documentation.

invalidateBestSize(This) -> ok

See external documentation.

isEnabled(This) -> boolean()

See external documentation.

isExposed(This, Pt) -> boolean()

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

See external documentation.

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

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

See external documentation.

isRetained(This) -> boolean()

See external documentation.

isShown(This) -> boolean()

See external documentation.

isTopLevel(This) -> boolean()

See external documentation.

layout(This) -> boolean()

See external documentation.

lineDown(This) -> boolean()

See external documentation.

lineUp(This) -> boolean()

See external documentation.

lower(This) -> ok

See external documentation.

makeModal(This) -> ok

Equivalent to makeModal(This, []).

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

See external documentation.

move(This, Pt) -> ok

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

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

move(This, X, Y) -> ok

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

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

See external documentation.

moveAfterInTabOrder(This, Win) -> ok

See external documentation.

moveBeforeInTabOrder(This, Win) -> ok

See external documentation.

Equivalent to navigate(This, []).

See external documentation.

pageDown(This) -> boolean()

See external documentation.

pageUp(This) -> boolean()

See external documentation.

popEventHandler(This) -> wxEvtHandler:wxEvtHandler()

Equivalent to popEventHandler(This, []).

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

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

See external documentation.

popupMenu(This, Menu) -> boolean()

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

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

See external documentation.

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

See external documentation.

raise(This) -> ok

See external documentation.

refresh(This) -> ok

Equivalent to refresh(This, []).

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

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

See external documentation.

refreshRect(This, Rect) -> ok

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

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

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

See external documentation.

releaseMouse(This) -> ok

See external documentation.

removeChild(This, Child) -> ok

See external documentation.

reparent(This, NewParent) -> boolean()

See external documentation.

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

See external documentation.

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

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

See external documentation.

scrollLines(This, Lines) -> boolean()

See external documentation.

scrollPages(This, Pages) -> boolean()

See external documentation.

scrollWindow(This, Dx, Dy) -> ok

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

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

See external documentation.

setAcceleratorTable(This, Accel) -> ok

See external documentation.

setAutoLayout(This, AutoLayout) -> ok

See external documentation.

setBackgroundColour(This, Colour) -> boolean()

See external documentation.

setBackgroundStyle(This, Style) -> boolean()

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

setCaret(This, Caret) -> ok

See external documentation.

setClientSize(This, Size) -> ok

  • 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

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

See external documentation.

setContainingSizer(This, Sizer) -> ok

See external documentation.

setCursor(This, Cursor) -> boolean()

See external documentation.

setMaxSize(This, MaxSize) -> ok

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

See external documentation.

setMinSize(This, MinSize) -> ok

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

See external documentation.

setOwnBackgroundColour(This, Colour) -> ok

See external documentation.

setOwnFont(This, Font) -> ok

See external documentation.

setOwnForegroundColour(This, Colour) -> ok

See external documentation.

setDropTarget(This, DropTarget) -> ok

See external documentation.

setExtraStyle(This, ExStyle) -> ok

See external documentation.

setFocus(This) -> ok

See external documentation.

setFocusFromKbd(This) -> ok

See external documentation.

setFont(This, Font) -> boolean()

See external documentation.

setForegroundColour(This, Colour) -> boolean()

See external documentation.

setHelpText(This, Text) -> ok

See external documentation.

setId(This, Winid) -> ok

See external documentation.

setLabel(This, Label) -> ok

See external documentation.

setName(This, Name) -> ok

See external documentation.

setPalette(This, Pal) -> ok

See external documentation.

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

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

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

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

See external documentation.

setScrollPos(This, Orient, Pos) -> ok

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

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

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

See external documentation.

setSize(This, Rect) -> ok

  • 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

  • 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

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

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

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

See external documentation.

setSizeHints(This, MinSize) -> ok

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

setSizeHints(This, MinW, MinH) -> ok

  • 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

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

See external documentation.

setSizer(This, Sizer) -> ok

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

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

See external documentation.

setSizerAndFit(This, Sizer) -> ok

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

See external documentation.

setThemeEnabled(This, EnableTheme) -> ok

See external documentation.

setToolTip(This, Tip) -> ok

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

setVirtualSize(This, Size) -> ok

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

See external documentation.

setVirtualSize(This, X, Y) -> ok

See external documentation.

setVirtualSizeHints(This, MinSize) -> ok

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

setVirtualSizeHints(This, MinW, MinH) -> ok

  • 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

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

See external documentation.

setWindowStyle(This, Style) -> ok

See external documentation.

setWindowStyleFlag(This, Style) -> ok

See external documentation.

setWindowVariant(This, Variant) -> ok

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

shouldInheritColours(This) -> boolean()

See external documentation.

show(This) -> boolean()

Equivalent to show(This, []).

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

See external documentation.

thaw(This) -> ok

See external documentation.

transferDataFromWindow(This) -> boolean()

See external documentation.

transferDataToWindow(This) -> boolean()

See external documentation.

update(This) -> ok

See external documentation.

updateWindowUI(This) -> ok

Equivalent to updateWindowUI(This, []).

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

See external documentation.

validate(This) -> boolean()

See external documentation.

warpPointer(This, X, Y) -> ok

See external documentation.

setTransparent(This, Alpha) -> boolean()

See external documentation.

canSetTransparent(This) -> boolean()

See external documentation.

isDoubleBuffered(This) -> boolean()

See external documentation.

setDoubleBuffered(This, On) -> ok

See external documentation.

getContentScaleFactor(This) -> number()

See external documentation.

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

Destroys this object, do not use object again