Erlang logo
User's Guide
Reference Manual
Release Notes
PDF
Top

wxErlang
Reference Manual
Version 1.3


Expand All
Contract All

Table of Contents

wxNotebook

MODULE

wxNotebook

MODULE SUMMARY

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

new(Parent, Winid) -> wxNotebook()

Types:

Parent = wxWindow() (see module wxWindow)
Winid = integer()

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

new(Parent, Winid, Option::[Option]) -> wxNotebook()

Types:

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

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

Types:

This = wxNotebook()
Page = wxWindow() (see module wxWindow)
Text = chardata() (see module unicode)

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

Types:

This = wxNotebook()
Page = wxWindow() (see module wxWindow)
Text = chardata() (see module unicode)
Option = {bSelect, boolean()} | {imageId, integer()}

advanceSelection(This) -> ok

Types:

This = wxNotebook()

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

Types:

This = wxNotebook()
Option = {forward, boolean()}

assignImageList(This, ImageList) -> ok

Types:

This = wxNotebook()
ImageList = wxImageList() (see module wxImageList)

create(This, Parent, Id) -> boolean()

Types:

This = wxNotebook()
Parent = wxWindow() (see module wxWindow)
Id = integer()

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

Types:

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

deleteAllPages(This) -> boolean()

Types:

This = wxNotebook()

deletePage(This, NPage) -> boolean()

Types:

This = wxNotebook()
NPage = integer()

removePage(This, NPage) -> boolean()

Types:

This = wxNotebook()
NPage = integer()

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

Types:

This = wxNotebook()

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

Types:

This = wxNotebook()

getPage(This, N) -> wxWindow() (see module wxWindow)

Types:

This = wxNotebook()
N = integer()

getPageCount(This) -> integer()

Types:

This = wxNotebook()

getPageImage(This, NPage) -> integer()

Types:

This = wxNotebook()
NPage = integer()

getPageText(This, NPage) -> charlist() (see module unicode)

Types:

This = wxNotebook()
NPage = integer()

getRowCount(This) -> integer()

Types:

This = wxNotebook()

getSelection(This) -> integer()

Types:

This = wxNotebook()

getThemeBackgroundColour(This) -> wx_colour4() (see module wx)

Types:

This = wxNotebook()

hitTest(This, Pt) -> Result

Types:

Result = {Res::integer(), Flags::integer()}
This = wxNotebook()
Pt = {X::integer(), Y::integer()}

insertPage(This, Position, Win, StrText) -> boolean()

Types:

This = wxNotebook()
Position = integer()
Win = wxWindow() (see module wxWindow)
StrText = chardata() (see module unicode)

insertPage(This, Position, Win, StrText, Option::[Option]) -> boolean()

Types:

This = wxNotebook()
Position = integer()
Win = wxWindow() (see module wxWindow)
StrText = chardata() (see module unicode)
Option = {bSelect, boolean()} | {imageId, integer()}

setImageList(This, ImageList) -> ok

Types:

This = wxNotebook()
ImageList = wxImageList() (see module wxImageList)

setPadding(This, Padding) -> ok

Types:

This = wxNotebook()
Padding = {W::integer(), H::integer()}

setPageSize(This, Size) -> ok

Types:

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

setPageImage(This, NPage, NImage) -> boolean()

Types:

This = wxNotebook()
NPage = integer()
NImage = integer()

setPageText(This, NPage, StrText) -> boolean()

Types:

This = wxNotebook()
NPage = integer()
StrText = chardata() (see module unicode)

setSelection(This, NPage) -> integer()

Types:

This = wxNotebook()
NPage = integer()

changeSelection(This, NPage) -> integer()

Types:

This = wxNotebook()
NPage = integer()

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

Destroys this object, do not use object again