Provided by: erlang-manpages_20.2.2+dfsg-1ubuntu2_all
NAME
wxWindow - 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, 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()} See external documentation. cacheBestSize(This, Size) -> ok Types: This = wxWindow() Size = {W::integer(), H::integer()} See external documentation. captureMouse(This) -> ok Types: This = wxWindow() See external documentation. center(This) -> ok Types: This = wxWindow() Equivalent to center(This, []). center(This, Options::[Option]) -> ok Types: This = wxWindow() Option = {dir, integer()} See external documentation. centerOnParent(This) -> ok Types: This = wxWindow() Equivalent to centerOnParent(This, []). centerOnParent(This, Options::[Option]) -> ok Types: This = wxWindow() Option = {dir, integer()} See external documentation. centre(This) -> ok Types: This = wxWindow() Equivalent to centre(This, []). centre(This, Options::[Option]) -> ok Types: This = wxWindow() Option = {dir, integer()} See external documentation. centreOnParent(This) -> ok Types: This = wxWindow() Equivalent to centreOnParent(This, []). centreOnParent(This, Options::[Option]) -> ok Types: This = wxWindow() Option = {dir, integer()} See external documentation. clearBackground(This) -> ok Types: This = wxWindow() See external documentation. clientToScreen(This, Pt) -> {X::integer(), Y::integer()} Types: This = wxWindow() Pt = {X::integer(), Y::integer()} See external documentation. clientToScreen(This, X, Y) -> {X::integer(), Y::integer()} Types: This = wxWindow() X = integer() Y = integer() See external documentation. close(This) -> boolean() Types: This = wxWindow() Equivalent to close(This, []). close(This, Options::[Option]) -> boolean() Types: This = wxWindow() Option = {force, boolean()} See external documentation. convertDialogToPixels(This, Sz) -> {W::integer(), H::integer()} Types: This = wxWindow() Sz = {W::integer(), H::integer()} See external documentation. convertPixelsToDialog(This, Sz) -> {W::integer(), H::integer()} Types: This = wxWindow() Sz = {W::integer(), H::integer()} See external documentation. Destroy(This) -> boolean() Types: This = wxWindow() See external documentation. destroyChildren(This) -> boolean() Types: This = wxWindow() See external documentation. disable(This) -> boolean() Types: This = wxWindow() See external documentation. dragAcceptFiles(This, Accept) -> ok Types: This = wxWindow() Accept = boolean() See external documentation. enable(This) -> boolean() Types: This = wxWindow() Equivalent to enable(This, []). enable(This, Options::[Option]) -> boolean() Types: This = wxWindow() Option = {enable, boolean()} See external documentation. findFocus() -> wxWindow() See external documentation. 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()} See external documentation. findWindowByName(Name) -> wxWindow() Types: Name = unicode:chardata() Equivalent to findWindowByName(Name, []). findWindowByName(Name, Options::[Option]) -> wxWindow() Types: Name = unicode:chardata() Option = {parent, wxWindow()} See external documentation. findWindowByLabel(Label) -> wxWindow() Types: Label = unicode:chardata() Equivalent to findWindowByLabel(Label, []). findWindowByLabel(Label, Options::[Option]) -> wxWindow() Types: Label = unicode:chardata() Option = {parent, wxWindow()} See external documentation. fit(This) -> ok Types: This = wxWindow() See external documentation. fitInside(This) -> ok Types: This = wxWindow() See external documentation. freeze(This) -> ok Types: This = wxWindow() See external documentation. getAcceleratorTable(This) -> wxAcceleratorTable:wxAcceleratorTable() Types: This = wxWindow() See external documentation. getBackgroundColour(This) -> wx:wx_colour4() Types: This = wxWindow() See external documentation. 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() See external documentation. getCaret(This) -> wxCaret:wxCaret() Types: This = wxWindow() See external documentation. getCapture() -> wxWindow() See external documentation. getCharHeight(This) -> integer() Types: This = wxWindow() See external documentation. getCharWidth(This) -> integer() Types: This = wxWindow() See external documentation. getChildren(This) -> [wxWindow()] Types: This = wxWindow() See external documentation. getClientSize(This) -> {W::integer(), H::integer()} Types: This = wxWindow() See external documentation. getContainingSizer(This) -> wxSizer:wxSizer() Types: This = wxWindow() See external documentation. getCursor(This) -> wxCursor:wxCursor() Types: This = wxWindow() See external documentation. getDropTarget(This) -> wx:wx_object() Types: This = wxWindow() See external documentation. getEventHandler(This) -> wxEvtHandler:wxEvtHandler() Types: This = wxWindow() See external documentation. getExtraStyle(This) -> integer() Types: This = wxWindow() See external documentation. getFont(This) -> wxFont:wxFont() Types: This = wxWindow() See external documentation. getForegroundColour(This) -> wx:wx_colour4() Types: This = wxWindow() See external documentation. getGrandParent(This) -> wxWindow() Types: This = wxWindow() See external documentation. getHandle(This) -> integer() Types: This = wxWindow() See external documentation. getHelpText(This) -> unicode:charlist() Types: This = wxWindow() See external documentation. getId(This) -> integer() Types: This = wxWindow() See external documentation. getLabel(This) -> unicode:charlist() Types: This = wxWindow() See external documentation. getMaxSize(This) -> {W::integer(), H::integer()} Types: This = wxWindow() See external documentation. getMinSize(This) -> {W::integer(), H::integer()} Types: This = wxWindow() See external documentation. getName(This) -> unicode:charlist() Types: This = wxWindow() See external documentation. getParent(This) -> wxWindow() Types: This = wxWindow() See external documentation. getPosition(This) -> {X::integer(), Y::integer()} Types: This = wxWindow() See external documentation. getRect(This) -> {X::integer(), Y::integer(), W::integer(), H::integer()} Types: This = wxWindow() See external documentation. getScreenPosition(This) -> {X::integer(), Y::integer()} Types: This = wxWindow() See external documentation. getScreenRect(This) -> {X::integer(), Y::integer(), W::integer(), H::integer()} Types: This = wxWindow() See external documentation. getScrollPos(This, Orient) -> integer() Types: This = wxWindow() Orient = integer() See external documentation. getScrollRange(This, Orient) -> integer() Types: This = wxWindow() Orient = integer() See external documentation. getScrollThumb(This, Orient) -> integer() Types: This = wxWindow() Orient = integer() See external documentation. getSize(This) -> {W::integer(), H::integer()} Types: This = wxWindow() See external documentation. getSizer(This) -> wxSizer:wxSizer() Types: This = wxWindow() See external documentation. getTextExtent(This, String) -> Result Types: Result = {X::integer(), Y::integer(), Descent::integer(), ExternalLeading::integer()} This = wxWindow() String = unicode:chardata() Equivalent to getTextExtent(This, String, []). getTextExtent(This, String, Options::[Option]) -> Result Types: Result = {X::integer(), Y::integer(), Descent::integer(), ExternalLeading::integer()} This = wxWindow() String = unicode:chardata() Option = {theFont, wxFont:wxFont()} See external documentation. getToolTip(This) -> wxToolTip:wxToolTip() Types: This = wxWindow() See external documentation. getUpdateRegion(This) -> wxRegion:wxRegion() Types: This = wxWindow() See external documentation. getVirtualSize(This) -> {W::integer(), H::integer()} Types: This = wxWindow() See external documentation. getWindowStyleFlag(This) -> integer() Types: This = wxWindow() See external documentation. 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() See external documentation. hasScrollbar(This, Orient) -> boolean() Types: This = wxWindow() Orient = integer() See external documentation. hasTransparentBackground(This) -> boolean() Types: This = wxWindow() See external documentation. hide(This) -> boolean() Types: This = wxWindow() See external documentation. inheritAttributes(This) -> ok Types: This = wxWindow() See external documentation. initDialog(This) -> ok Types: This = wxWindow() See external documentation. invalidateBestSize(This) -> ok Types: This = wxWindow() See external documentation. isEnabled(This) -> boolean() Types: This = wxWindow() See external documentation. 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() See external documentation. isExposed(This, X, Y, W, H) -> boolean() Types: This = wxWindow() X = integer() Y = integer() W = integer() H = integer() See external documentation. isRetained(This) -> boolean() Types: This = wxWindow() See external documentation. isShown(This) -> boolean() Types: This = wxWindow() See external documentation. isTopLevel(This) -> boolean() Types: This = wxWindow() See external documentation. layout(This) -> boolean() Types: This = wxWindow() See external documentation. lineDown(This) -> boolean() Types: This = wxWindow() See external documentation. lineUp(This) -> boolean() Types: This = wxWindow() See external documentation. lower(This) -> ok Types: This = wxWindow() See external documentation. makeModal(This) -> ok Types: This = wxWindow() Equivalent to makeModal(This, []). makeModal(This, Options::[Option]) -> ok Types: This = wxWindow() Option = {modal, boolean()} See external documentation. 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()} See external documentation. moveAfterInTabOrder(This, Win) -> ok Types: This = wxWindow() Win = wxWindow() See external documentation. moveBeforeInTabOrder(This, Win) -> ok Types: This = wxWindow() Win = wxWindow() See external documentation. navigate(This) -> boolean() Types: This = wxWindow() Equivalent to navigate(This, []). navigate(This, Options::[Option]) -> boolean() Types: This = wxWindow() Option = {flags, integer()} See external documentation. pageDown(This) -> boolean() Types: This = wxWindow() See external documentation. pageUp(This) -> boolean() Types: This = wxWindow() See external documentation. popEventHandler(This) -> wxEvtHandler:wxEvtHandler() Types: This = wxWindow() Equivalent to popEventHandler(This, []). popEventHandler(This, Options::[Option]) -> wxEvtHandler:wxEvtHandler() Types: This = wxWindow() Option = {deleteHandler, boolean()} See external documentation. popupMenu(This, Menu) -> boolean() Types: This = wxWindow() Menu = wxMenu:wxMenu() Equivalent to popupMenu(This, Menu, []). popupMenu(This, Menu, Options::[Option]) -> boolean() Types: This = wxWindow() Menu = wxMenu:wxMenu() Option = {pos, {X::integer(), Y::integer()}} See external documentation. popupMenu(This, Menu, X, Y) -> boolean() Types: This = wxWindow() Menu = wxMenu:wxMenu() X = integer() Y = integer() See external documentation. raise(This) -> ok Types: This = wxWindow() See external documentation. 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()}} See external documentation. refreshRect(This, Rect) -> ok Types: This = wxWindow() Rect = {X::integer(), Y::integer(), W::integer(), H::integer()} Equivalent to refreshRect(This, Rect, []). refreshRect(This, Rect, Options::[Option]) -> ok Types: This = wxWindow() Rect = {X::integer(), Y::integer(), W::integer(), H::integer()} Option = {eraseBackground, boolean()} See external documentation. releaseMouse(This) -> ok Types: This = wxWindow() See external documentation. removeChild(This, Child) -> ok Types: This = wxWindow() Child = wxWindow() See external documentation. reparent(This, NewParent) -> boolean() Types: This = wxWindow() NewParent = wxWindow() See external documentation. screenToClient(This) -> {X::integer(), Y::integer()} Types: This = wxWindow() See external documentation. screenToClient(This, Pt) -> {X::integer(), Y::integer()} Types: This = wxWindow() Pt = {X::integer(), Y::integer()} See external documentation. scrollLines(This, Lines) -> boolean() Types: This = wxWindow() Lines = integer() See external documentation. scrollPages(This, Pages) -> boolean() Types: This = wxWindow() Pages = integer() See external documentation. scrollWindow(This, Dx, Dy) -> ok Types: This = wxWindow() Dx = integer() Dy = integer() Equivalent to scrollWindow(This, Dx, Dy, []). scrollWindow(This, Dx, Dy, Options::[Option]) -> ok Types: This = wxWindow() Dx = integer() Dy = integer() Option = {rect, {X::integer(), Y::integer(), W::integer(), H::integer()}} See external documentation. setAcceleratorTable(This, Accel) -> ok Types: This = wxWindow() Accel = wxAcceleratorTable:wxAcceleratorTable() See external documentation. setAutoLayout(This, AutoLayout) -> ok Types: This = wxWindow() AutoLayout = boolean() See external documentation. setBackgroundColour(This, Colour) -> boolean() Types: This = wxWindow() Colour = wx:wx_colour() See external documentation. 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() Caret = wxCaret:wxCaret() See external documentation. 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() See external documentation. setContainingSizer(This, Sizer) -> ok Types: This = wxWindow() Sizer = wxSizer:wxSizer() See external documentation. setCursor(This, Cursor) -> boolean() Types: This = wxWindow() Cursor = wxCursor:wxCursor() See external documentation. setMaxSize(This, MaxSize) -> ok Types: This = wxWindow() MaxSize = {W::integer(), H::integer()} See external documentation. setMinSize(This, MinSize) -> ok Types: This = wxWindow() MinSize = {W::integer(), H::integer()} See external documentation. setOwnBackgroundColour(This, Colour) -> ok Types: This = wxWindow() Colour = wx:wx_colour() See external documentation. setOwnFont(This, Font) -> ok Types: This = wxWindow() Font = wxFont:wxFont() See external documentation. setOwnForegroundColour(This, Colour) -> ok Types: This = wxWindow() Colour = wx:wx_colour() See external documentation. setDropTarget(This, DropTarget) -> ok Types: This = wxWindow() DropTarget = wx:wx_object() See external documentation. setExtraStyle(This, ExStyle) -> ok Types: This = wxWindow() ExStyle = integer() See external documentation. setFocus(This) -> ok Types: This = wxWindow() See external documentation. setFocusFromKbd(This) -> ok Types: This = wxWindow() See external documentation. setFont(This, Font) -> boolean() Types: This = wxWindow() Font = wxFont:wxFont() See external documentation. setForegroundColour(This, Colour) -> boolean() Types: This = wxWindow() Colour = wx:wx_colour() See external documentation. setHelpText(This, Text) -> ok Types: This = wxWindow() Text = unicode:chardata() See external documentation. setId(This, Winid) -> ok Types: This = wxWindow() Winid = integer() See external documentation. setLabel(This, Label) -> ok Types: This = wxWindow() Label = unicode:chardata() See external documentation. setName(This, Name) -> ok Types: This = wxWindow() Name = unicode:chardata() See external documentation. setPalette(This, Pal) -> ok Types: This = wxWindow() Pal = wxPalette:wxPalette() See external documentation. setScrollbar(This, Orient, Pos, ThumbVisible, Range) -> ok Types: This = wxWindow() Orient = integer() Pos = integer() ThumbVisible = integer() Range = integer() Equivalent to setScrollbar(This, Orient, Pos, ThumbVisible, Range, []). setScrollbar(This, Orient, Pos, ThumbVisible, Range, Options::[Option]) -> ok Types: This = wxWindow() Orient = integer() Pos = integer() ThumbVisible = integer() Range = integer() Option = {refresh, boolean()} See external documentation. setScrollPos(This, Orient, Pos) -> ok Types: This = wxWindow() Orient = integer() Pos = integer() Equivalent to setScrollPos(This, Orient, Pos, []). setScrollPos(This, Orient, Pos, Options::[Option]) -> ok Types: This = wxWindow() Orient = integer() Pos = integer() Option = {refresh, boolean()} See external documentation. 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() Equivalent to setSize(This, X, Y, Width, Height, []). setSize(This, X, Y, Width, Height, Options::[Option]) -> ok Types: This = wxWindow() X = integer() Y = integer() Width = integer() Height = integer() Option = {sizeFlags, integer()} See external documentation. setSizeHints(This, MinSize) -> ok Types: This = wxWindow() MinSize = {W::integer(), H::integer()} Equivalent to setSizeHints(This, MinSize, []). 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()} See external documentation. setSizer(This, Sizer) -> ok Types: This = wxWindow() Sizer = wxSizer:wxSizer() Equivalent to setSizer(This, Sizer, []). setSizer(This, Sizer, Options::[Option]) -> ok Types: This = wxWindow() Sizer = wxSizer:wxSizer() Option = {deleteOld, boolean()} See external documentation. setSizerAndFit(This, Sizer) -> ok Types: This = wxWindow() Sizer = wxSizer:wxSizer() Equivalent to setSizerAndFit(This, Sizer, []). setSizerAndFit(This, Sizer, Options::[Option]) -> ok Types: This = wxWindow() Sizer = wxSizer:wxSizer() Option = {deleteOld, boolean()} See external documentation. setThemeEnabled(This, EnableTheme) -> ok Types: This = wxWindow() EnableTheme = boolean() See external documentation. setToolTip(This, Tip) -> ok Types: This = wxWindow() Tip = unicode:chardata() 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()} See external documentation. setVirtualSize(This, X, Y) -> ok Types: This = wxWindow() X = integer() Y = integer() See external documentation. setVirtualSizeHints(This, MinSize) -> ok Types: This = wxWindow() MinSize = {W::integer(), H::integer()} Equivalent to setVirtualSizeHints(This, MinSize, []). 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()} See external documentation. setWindowStyle(This, Style) -> ok Types: This = wxWindow() Style = integer() See external documentation. setWindowStyleFlag(This, Style) -> ok Types: This = wxWindow() Style = integer() See external documentation. 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() See external documentation. show(This) -> boolean() Types: This = wxWindow() Equivalent to show(This, []). show(This, Options::[Option]) -> boolean() Types: This = wxWindow() Option = {show, boolean()} See external documentation. thaw(This) -> ok Types: This = wxWindow() See external documentation. transferDataFromWindow(This) -> boolean() Types: This = wxWindow() See external documentation. transferDataToWindow(This) -> boolean() Types: This = wxWindow() See external documentation. update(This) -> ok Types: This = wxWindow() See external documentation. updateWindowUI(This) -> ok Types: This = wxWindow() Equivalent to updateWindowUI(This, []). updateWindowUI(This, Options::[Option]) -> ok Types: This = wxWindow() Option = {flags, integer()} See external documentation. validate(This) -> boolean() Types: This = wxWindow() See external documentation. warpPointer(This, X, Y) -> ok Types: This = wxWindow() X = integer() Y = integer() See external documentation. setTransparent(This, Alpha) -> boolean() Types: This = wxWindow() Alpha = integer() See external documentation. canSetTransparent(This) -> boolean() Types: This = wxWindow() See external documentation. isDoubleBuffered(This) -> boolean() Types: This = wxWindow() See external documentation. setDoubleBuffered(This, On) -> ok Types: This = wxWindow() On = boolean() See external documentation. getContentScaleFactor(This) -> number() Types: This = wxWindow() See external documentation. destroy(This::wxWindow()) -> ok Destroys this object, do not use object again
AUTHORS
<> wx 1.8.3 wxWindow(3erl)