wxBookCtrlBase - Functions for wxBookCtrlBase class
Please see following description for synopsis
wxBookCtrlBase(3) Erlang Module Definition wxBookCtrlBase(3)
NAME
wxBookCtrlBase - Functions for wxBookCtrlBase class
DESCRIPTION
A book control is a convenient way of displaying multiple pages of
information, displayed one page at a time. wxWidgets has five variants
of this control:
This abstract class is the parent of all these book controls, and pro-
vides their basic interface. This is a pure virtual class so you cannot
allocate it directly.
See: Overview bookctrl
This class is derived (and can use functions) from: wxControl wxWindow
wxEvtHandler
wxWidgets docs: wxBookCtrlBase
DATA TYPES
wxBookCtrlBase() = wx:wx_object()
EXPORTS
addPage(This, Page, Text) -> boolean()
Types:
This = wxBookCtrlBase()
Page = wxWindow:wxWindow()
Text = unicode:chardata()
addPage(This, Page, Text, Options :: [Option]) -> boolean()
Types:
This = wxBookCtrlBase()
Page = wxWindow:wxWindow()
Text = unicode:chardata()
Option = {bSelect, boolean()} | {imageId, integer()}
Adds a new page.
The page must have the book control itself as the parent and
must not have been added to this control previously.
The call to this function will generate the page changing and
page changed events if select is true, but not when inserting
the very first page (as there is no previous page selection to
switch from in this case and so it wouldn't make sense to e.g.
veto such event).
Return: true if successful, false otherwise.
Remark: Do not delete the page, it will be deleted by the book
control.
See: insertPage/5
insertPage(This, Index, Page, Text) -> boolean()
Types:
This = wxBookCtrlBase()
Index = integer()
Page = wxWindow:wxWindow()
Text = unicode:chardata()
insertPage(This, Index, Page, Text, Options :: [Option]) ->
boolean()
Types:
This = wxBookCtrlBase()
Index = integer()
Page = wxWindow:wxWindow()
Text = unicode:chardata()
Option = {bSelect, boolean()} | {imageId, integer()}
Inserts a new page at the specified position.
Return: true if successful, false otherwise.
Remark: Do not delete the page, it will be deleted by the book
control.
See: addPage/4
deletePage(This, Page) -> boolean()
Types:
This = wxBookCtrlBase()
Page = integer()
Deletes the specified page, and the associated window.
The call to this function generates the page changing events
when deleting the currently selected page or a page preceding it
in the index order, but it does not send any events when delet-
ing the last page: while in this case the selection also
changes, it becomes invalid and for compatibility reasons the
control never generates events with the invalid selection index.
removePage(This, Page) -> boolean()
Types:
This = wxBookCtrlBase()
Page = integer()
Deletes the specified page, without deleting the associated win-
dow.
See deletePage/2 for a note about the events generated by this
function.
deleteAllPages(This) -> boolean()
Types:
This = wxBookCtrlBase()
Deletes all pages.
getPage(This, Page) -> wxWindow:wxWindow()
Types:
This = wxBookCtrlBase()
Page = integer()
Returns the window at the given page position.
getPageCount(This) -> integer()
Types:
This = wxBookCtrlBase()
Returns the number of pages in the control.
getCurrentPage(This) -> wxWindow:wxWindow()
Types:
This = wxBookCtrlBase()
Returns the currently selected page or NULL.
advanceSelection(This) -> ok
Types:
This = wxBookCtrlBase()
advanceSelection(This, Options :: [Option]) -> ok
Types:
This = wxBookCtrlBase()
Option = {forward, boolean()}
Cycles through the tabs.
The call to this function generates the page changing events.
setSelection(This, Page) -> integer()
Types:
This = wxBookCtrlBase()
Page = integer()
Sets the selection to the given page, returning the previous
selection.
Notice that the call to this function generates the page chang-
ing events, use the changeSelection/2 function if you don't want
these events to be generated.
See: getSelection/1
getSelection(This) -> integer()
Types:
This = wxBookCtrlBase()
Returns the currently selected page, or wxNOT_FOUND if none was
selected.
Note that this method may return either the previously or newly
selected page when called from the EVT_BOOKCTRL_PAGE_CHANGED
handler depending on the platform and so wxBookCtrlEvent:getSe-
lection/1 should be used instead in this case.
changeSelection(This, Page) -> integer()
Types:
This = wxBookCtrlBase()
Page = integer()
Changes the selection to the given page, returning the previous
selection.
This function behaves as setSelection/2 but does not generate
the page changing events.
See overview_events_prog for more information.
hitTest(This, Pt) -> Result
Types:
Result = {Res :: integer(), Flags :: integer()}
This = wxBookCtrlBase()
Pt = {X :: integer(), Y :: integer()}
Returns the index of the tab at the specified position or
wxNOT_FOUND if none.
If flags parameter is non-NULL, the position of the point inside
the tab is returned as well.
Return: Returns the zero-based tab index or wxNOT_FOUND if there
is no tab at the specified position.
getPageText(This, NPage) -> unicode:charlist()
Types:
This = wxBookCtrlBase()
NPage = integer()
Returns the string for the given page.
setPageText(This, Page, Text) -> boolean()
Types:
This = wxBookCtrlBase()
Page = integer()
Text = unicode:chardata()
Sets the text for the given page.
wxWidgets team. wx 2.1.1 wxBookCtrlBase(3)