Scroll to navigation

wxNotebook(3erl) Erlang Module Definition wxNotebook(3erl)

NAME

wxNotebook - See external documentation: wxNotebook.

DESCRIPTION

See external documentation: wxNotebook.
This class is derived (and can use functions) from:
 
wxControl
 
wxWindow
 
wxEvtHandler

DATA TYPES

wxNotebook():
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() -> wxNotebook()
 
See external documentation.
new(Parent, Winid) -> wxNotebook()
 
Types:
Parent = wxWindow:wxWindow()
 
Winid = integer()
 
Equivalent to new(Parent, Winid, []).
new(Parent, Winid, Options::[Option]) -> wxNotebook()
 
Types:
Parent = wxWindow:wxWindow()
 
Winid = integer()
 
Option = {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()}
 
See external documentation.
addPage(This, Page, Text) -> boolean()
 
Types:
This = wxNotebook()
 
Page = wxWindow:wxWindow()
 
Text = unicode:chardata()
 
Equivalent to addPage(This, Page, Text, []).
addPage(This, Page, Text, Options::[Option]) -> boolean()
 
Types:
This = wxNotebook()
 
Page = wxWindow:wxWindow()
 
Text = unicode:chardata()
 
Option = {bSelect, boolean()} | {imageId, integer()}
 
See external documentation.
advanceSelection(This) -> ok
 
Types:
This = wxNotebook()
 
Equivalent to advanceSelection(This, []).
advanceSelection(This, Options::[Option]) -> ok
 
Types:
This = wxNotebook()
 
Option = {forward, boolean()}
 
See external documentation.
assignImageList(This, ImageList) -> ok
 
Types:
This = wxNotebook()
 
ImageList = wxImageList:wxImageList()
 
See external documentation.
create(This, Parent, Id) -> boolean()
 
Types:
This = wxNotebook()
 
Parent = wxWindow:wxWindow()
 
Id = integer()
 
Equivalent to create(This, Parent, Id, []).
create(This, Parent, Id, Options::[Option]) -> boolean()
 
Types:
This = wxNotebook()
 
Parent = wxWindow:wxWindow()
 
Id = integer()
 
Option = {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()}
 
See external documentation.
deleteAllPages(This) -> boolean()
 
Types:
This = wxNotebook()
 
See external documentation.
deletePage(This, NPage) -> boolean()
 
Types:
This = wxNotebook()
 
NPage = integer()
 
See external documentation.
removePage(This, NPage) -> boolean()
 
Types:
This = wxNotebook()
 
NPage = integer()
 
See external documentation.
getCurrentPage(This) -> wxWindow:wxWindow()
 
Types:
This = wxNotebook()
 
See external documentation.
getImageList(This) -> wxImageList:wxImageList()
 
Types:
This = wxNotebook()
 
See external documentation.
getPage(This, N) -> wxWindow:wxWindow()
 
Types:
This = wxNotebook()
 
N = integer()
 
See external documentation.
getPageCount(This) -> integer()
 
Types:
This = wxNotebook()
 
See external documentation.
getPageImage(This, NPage) -> integer()
 
Types:
This = wxNotebook()
 
NPage = integer()
 
See external documentation.
getPageText(This, NPage) -> unicode:charlist()
 
Types:
This = wxNotebook()
 
NPage = integer()
 
See external documentation.
getRowCount(This) -> integer()
 
Types:
This = wxNotebook()
 
See external documentation.
getSelection(This) -> integer()
 
Types:
This = wxNotebook()
 
See external documentation.
getThemeBackgroundColour(This) -> wx:wx_colour4()
 
Types:
This = wxNotebook()
 
See external documentation.
hitTest(This, Pt) -> Result
 
Types:
Result = {Res::integer(), Flags::integer()}
 
This = wxNotebook()
 
Pt = {X::integer(), Y::integer()}
 
See external documentation.
insertPage(This, Position, Win, StrText) -> boolean()
 
Types:
This = wxNotebook()
 
Position = integer()
 
Win = wxWindow:wxWindow()
 
StrText = unicode:chardata()
 
Equivalent to insertPage(This, Position, Win, StrText, []).
insertPage(This, Position, Win, StrText, Options::[Option]) -> boolean()
 
Types:
This = wxNotebook()
 
Position = integer()
 
Win = wxWindow:wxWindow()
 
StrText = unicode:chardata()
 
Option = {bSelect, boolean()} | {imageId, integer()}
 
See external documentation.
setImageList(This, ImageList) -> ok
 
Types:
This = wxNotebook()
 
ImageList = wxImageList:wxImageList()
 
See external documentation.
setPadding(This, Padding) -> ok
 
Types:
This = wxNotebook()
 
Padding = {W::integer(), H::integer()}
 
See external documentation.
setPageSize(This, Size) -> ok
 
Types:
This = wxNotebook()
 
Size = {W::integer(), H::integer()}
 
See external documentation.
setPageImage(This, NPage, NImage) -> boolean()
 
Types:
This = wxNotebook()
 
NPage = integer()
 
NImage = integer()
 
See external documentation.
setPageText(This, NPage, StrText) -> boolean()
 
Types:
This = wxNotebook()
 
NPage = integer()
 
StrText = unicode:chardata()
 
See external documentation.
setSelection(This, NPage) -> integer()
 
Types:
This = wxNotebook()
 
NPage = integer()
 
See external documentation.
changeSelection(This, NPage) -> integer()
 
Types:
This = wxNotebook()
 
NPage = integer()
 
See external documentation.
destroy(This::wxNotebook()) -> ok
 
Destroys this object, do not use object again

AUTHORS

<>
wx 1.8