Scroll to navigation

wxAuiNotebook(3erl) Erlang Module Definition wxAuiNotebook(3erl)

NAME

wxAuiNotebook - See external documentation: wxAuiNotebook.

DESCRIPTION

See external documentation: wxAuiNotebook.

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

DATA TYPES

wxAuiNotebook():

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

See external documentation.

new(Parent) -> wxAuiNotebook()

Types:

Parent = wxWindow:wxWindow()

Equivalent to new(Parent, []).

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

Types:

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

See external documentation.

addPage(This, Page, Caption) -> boolean()

Types:

This = wxAuiNotebook()
Page = wxWindow:wxWindow()
Caption = unicode:chardata()

Equivalent to addPage(This, Page, Caption, []).

addPage(This, Page, Caption, Options::[Option]) -> boolean()

Types:

This = wxAuiNotebook()
Page = wxWindow:wxWindow()
Caption = unicode:chardata()
Option = {select, boolean()} | {bitmap, wxBitmap:wxBitmap()}

See external documentation.

create(This, Parent) -> boolean()

Types:

This = wxAuiNotebook()
Parent = wxWindow:wxWindow()

Equivalent to create(This, Parent, []).

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

Types:

This = wxAuiNotebook()
Parent = wxWindow:wxWindow()
Option = {id, integer()} | {pos, {X::integer(), Y::integer()}} | {size, {W::integer(), H::integer()}} | {style, integer()}

See external documentation.

deletePage(This, Page) -> boolean()

Types:

This = wxAuiNotebook()
Page = integer()

See external documentation.

getArtProvider(This) -> wxAuiTabArt:wxAuiTabArt()

Types:

This = wxAuiNotebook()

See external documentation.

getPage(This, Page_idx) -> wxWindow:wxWindow()

Types:

This = wxAuiNotebook()
Page_idx = integer()

See external documentation.

getPageBitmap(This, Page_idx) -> wxBitmap:wxBitmap()

Types:

This = wxAuiNotebook()
Page_idx = integer()

See external documentation.

getPageCount(This) -> integer()

Types:

This = wxAuiNotebook()

See external documentation.

getPageIndex(This, Page_wnd) -> integer()

Types:

This = wxAuiNotebook()
Page_wnd = wxWindow:wxWindow()

See external documentation.

getPageText(This, Page_idx) -> unicode:charlist()

Types:

This = wxAuiNotebook()
Page_idx = integer()

See external documentation.

getSelection(This) -> integer()

Types:

This = wxAuiNotebook()

See external documentation.

insertPage(This, Page_idx, Page, Caption) -> boolean()

Types:

This = wxAuiNotebook()
Page_idx = integer()
Page = wxWindow:wxWindow()
Caption = unicode:chardata()

Equivalent to insertPage(This, Page_idx, Page, Caption, []).

insertPage(This, Page_idx, Page, Caption, Options::[Option]) -> boolean()

Types:

This = wxAuiNotebook()
Page_idx = integer()
Page = wxWindow:wxWindow()
Caption = unicode:chardata()
Option = {select, boolean()} | {bitmap, wxBitmap:wxBitmap()}

See external documentation.

removePage(This, Page) -> boolean()

Types:

This = wxAuiNotebook()
Page = integer()

See external documentation.

setArtProvider(This, Art) -> ok

Types:

This = wxAuiNotebook()
Art = wxAuiTabArt:wxAuiTabArt()

See external documentation.

setFont(This, Font) -> boolean()

Types:

This = wxAuiNotebook()
Font = wxFont:wxFont()

See external documentation.

setPageBitmap(This, Page, Bitmap) -> boolean()

Types:

This = wxAuiNotebook()
Page = integer()
Bitmap = wxBitmap:wxBitmap()

See external documentation.

setPageText(This, Page, Text) -> boolean()

Types:

This = wxAuiNotebook()
Page = integer()
Text = unicode:chardata()

See external documentation.

setSelection(This, New_page) -> integer()

Types:

This = wxAuiNotebook()
New_page = integer()

See external documentation.

setTabCtrlHeight(This, Height) -> ok

Types:

This = wxAuiNotebook()
Height = integer()

See external documentation.

setUniformBitmapSize(This, Size) -> ok

Types:

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

See external documentation.

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

Destroys this object, do not use object again

AUTHORS

<>
wx 1.8