wxNotebook(3)

MODULE
wxNotebook - See external documentation: wxNotebook.

DESCRIPTION

See external documentation: wxNotebook <http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html>.

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 <http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebookwxnotebook>.

new(Parent::wxWindow() (see module wxWindow), Winid::integer()) -> wxNotebook()

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

new(Parent::wxWindow() (see module wxWindow), Winid::integer(), Options::[Option]) -> wxNotebook()

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

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebookwxnotebook>.

addPage(This::wxNotebook(), Page::wxWindow() (see module wxWindow), Text::string()) -> bool()

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

addPage(This::wxNotebook(), Page::wxWindow() (see module wxWindow), Text::string(), Options::[Option]) -> bool()

    Types
        Option = {bSelect, bool()} | {imageId, integer()}

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebookaddpage>.

advanceSelection(This::wxNotebook()) -> ok

    Equivalent to advanceSelection(This, []).

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

    Types
        Option = {forward, bool()}

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebookadvanceselection>.

assignImageList(This::wxNotebook(), ImageList::wxImageList() (see module wxImageList)) -> ok

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebookassignimagelist>.

create(This::wxNotebook(), Parent::wxWindow() (see module wxWindow), Id::integer()) -> bool()

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

create(This::wxNotebook(), Parent::wxWindow() (see module wxWindow), Id::integer(), Options::[Option]) -> bool()

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

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebookcreate>.

deleteAllPages(This::wxNotebook()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebookdeleteallpages>.

deletePage(This::wxNotebook(), NPage::integer()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebookdeletepage>.

removePage(This::wxNotebook(), NPage::integer()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebookremovepage>.

getCurrentPage(This::wxNotebook()) -> wxWindow() (see module wxWindow)

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebookgetcurrentpage>.

getImageList(This::wxNotebook()) -> wxImageList() (see module wxImageList)

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebookgetimagelist>.

getPage(This::wxNotebook(), N::integer()) -> wxWindow() (see module wxWindow)

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebookgetpage>.

getPageCount(This::wxNotebook()) -> integer()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebookgetpagecount>.

getPageImage(This::wxNotebook(), NPage::integer()) -> integer()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebookgetpageimage>.

getPageText(This::wxNotebook(), NPage::integer()) -> string()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebookgetpagetext>.

getRowCount(This::wxNotebook()) -> integer()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebookgetrowcount>.

getSelection(This::wxNotebook()) -> integer()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebookgetselection>.

getThemeBackgroundColour(This::wxNotebook()) -> colour() (see module wx)

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebookgetthemebackgroundcolour>.

hitTest(This::wxNotebook(), Pt::{X::integer(), Y::integer()}) -> {integer(), Flags::integer()}

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebookhittest>.

insertPage(This::wxNotebook(), Position::integer(), Win::wxWindow() (see module wxWindow), StrText::string()) -> bool()

    Equivalent to insertPage(This, Position, Win, StrText, []).

insertPage(This::wxNotebook(), Position::integer(), Win::wxWindow() (see module wxWindow), StrText::string(), Options::[Option]) -> bool()

    Types
        Option = {bSelect, bool()} | {imageId, integer()}

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebookinsertpage>.

setImageList(This::wxNotebook(), ImageList::wxImageList() (see module wxImageList)) -> ok

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebooksetimagelist>.

setPadding(This::wxNotebook(), Padding::{W::integer(), H::integer()}) -> ok

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebooksetpadding>.

setPageSize(This::wxNotebook(), Size::{W::integer(), H::integer()}) -> ok

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebooksetpagesize>.

setPageImage(This::wxNotebook(), NPage::integer(), NImage::integer()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebooksetpageimage>.

setPageText(This::wxNotebook(), NPage::integer(), StrText::string()) -> bool()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebooksetpagetext>.

setSelection(This::wxNotebook(), NPage::integer()) -> integer()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebooksetselection>.

changeSelection(This::wxNotebook(), NPage::integer()) -> integer()

    See external documentation <http://www.wxwidgets.org/manuals/stable/wx_wxnotebook.html#wxnotebookchangeselection>.

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

    Destroys this object, do not use object again