wxChoicebook (wx v2.5.4)

wxChoicebook is a class similar to wxNotebook, but uses a wxChoice control to show the labels instead of the tabs.

For usage documentation of this class, please refer to the base abstract class wxBookCtrl. You can also use the page_samples_notebook to see wxChoicebook in action.

wxChoicebook allows the use of wxBookCtrlBase::GetControlSizer(), allowing a program to add other controls next to the choice control. This is particularly useful when screen space is restricted, as it often is when wxChoicebook is being employed.

Styles

This class supports the following styles:

wxCHB_DEFAULT: Choose the default location for the labels depending on the current platform (but currently it's the same everywhere, namely wxCHB_TOP).
wxCHB_TOP: Place labels above the page area.
wxCHB_LEFT: Place labels on the left side.
wxCHB_RIGHT: Place labels on the right side.
wxCHB_BOTTOM: Place labels below the page area.

See:

This class is derived, and can use functions, from:

wxWidgets docs: wxChoicebook

Events

Event types emitted from this class:

Summary

Types

wxChoicebook()

Functions

addPage(This, Page, Text)

addPage/4

Adds a new page.

advanceSelection(This)

advanceSelection/2

Cycles through the tabs.

assignImageList(This, ImageList)

Sets the image list for the page control and takes ownership of the list.

changeSelection(This, Page)

Changes the selection to the given page, returning the previous selection.

create(This, Parent, Id)

create/4

Create the choicebook control that has already been constructed with the default constructor.

deleteAllPages(This)

Deletes all pages.

destroy(This)

Destroys the object

getCurrentPage(This)

Returns the currently selected page or NULL.

getImageList(This)

Returns the associated image list, may be NULL.

getPage(This, Page)

Returns the window at the given page position.

getPageCount(This)

Returns the number of pages in the control.

getPageImage(This, NPage)

Returns the image index for the given page.

getPageText(This, NPage)

Returns the string for the given page.

getSelection(This)

Returns the currently selected page, or wxNOT\_FOUND if none was selected.

hitTest(This, Pt)

Returns the index of the tab at the specified position or wxNOT\_FOUND if none.

insertPage(This, Index, Page, Text)

insertPage/5

Inserts a new page at the specified position.

new()

Constructs a choicebook control.

new(Parent, Id)

new/3

setImageList(This, ImageList)

Sets the image list to use.

setPageImage(This, Page, Image)

Sets the image index for the given page.

setPageSize(This, Size)

Sets the width and height of the pages.

setPageText(This, Page, Text)

Sets the text for the given page.

setSelection(This, Page)

Sets the selection to the given page, returning the previous selection.

Types

wxChoicebook()

-type wxChoicebook() :: wx:wx_object().

Functions

addPage(This, Page, Text) ≡ addPage(This, Page, Text, [])

addPage/4

-spec addPage(This, Page, Text) -> boolean()
                 when This :: wxChoicebook(), Page :: wxWindow:wxWindow(), Text :: unicode:chardata().

-spec addPage(This, Page, Text, [Option]) -> boolean()
                 when
                     This :: wxChoicebook(),
                     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

advanceSelection(This) ≡ advanceSelection(This, [])

advanceSelection/2

-spec advanceSelection(This) -> ok when This :: wxChoicebook().

-spec advanceSelection(This, [Option]) -> ok when This :: wxChoicebook(), Option :: {forward, boolean()}.

Cycles through the tabs.

The call to this function generates the page changing events.

assignImageList(This, ImageList) -> ok

Types

This = wxChoicebook()

ImageList = wxImageList:wxImageList()

Sets the image list for the page control and takes ownership of the list.

See:

changeSelection(This :: wxChoicebook(), Page :: integer()) -> 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.

create(This, Parent, Id) ≡ create(This, Parent, Id, [])

create/4

-spec create(This, Parent, Id) -> boolean()
                when This :: wxChoicebook(), Parent :: wxWindow:wxWindow(), Id :: integer().

-spec create(This, Parent, Id, [Option]) -> boolean()
                when
                    This :: wxChoicebook(),
                    Parent :: wxWindow:wxWindow(),
                    Id :: integer(),
                    Option ::
                        {pos, {X :: integer(), Y :: integer()}} |
                        {size, {W :: integer(), H :: integer()}} |
                        {style, integer()}.

Create the choicebook control that has already been constructed with the default constructor.

deleteAllPages(This :: wxChoicebook()) -> boolean()

Deletes all pages.

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

Destroys the object

getCurrentPage(This :: wxChoicebook()) -> wxWindow:wxWindow()

Returns the currently selected page or NULL.

getImageList(This :: wxChoicebook()) -> Result

Types

Result = wxImageList:wxImageList()

Returns the associated image list, may be NULL.

See:

getPage(This :: wxChoicebook(), Page :: integer()) -> wxWindow:wxWindow()

Returns the window at the given page position.

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

Returns the number of pages in the control.

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

Returns the image index for the given page.

getPageText(This :: wxChoicebook(), NPage :: integer()) -> unicode:charlist()

Returns the string for the given page.

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

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:getSelection/1 should be used instead in this case.

hitTest(This, Pt) -> Result

Types

This = wxChoicebook()

Pt = {X :: integer(), Y :: integer()}

Result = {Res :: integer(), Flags :: 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.

insertPage(This, Index, Page, Text) ≡ insertPage(This, Index, Page, Text, [])

insertPage/5

-spec insertPage(This, Index, Page, Text) -> boolean()
                    when
                        This :: wxChoicebook(),
                        Index :: integer(),
                        Page :: wxWindow:wxWindow(),
                        Text :: unicode:chardata().

-spec insertPage(This, Index, Page, Text, [Option]) -> boolean()
                    when
                        This :: wxChoicebook(),
                        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

new() -> wxChoicebook()

Constructs a choicebook control.

new(Parent, Id) ≡ new(Parent, Id, [])

new/3

-spec new(Parent, Id) -> wxChoicebook() when Parent :: wxWindow:wxWindow(), Id :: integer().

-spec new(Parent, Id, [Option]) -> wxChoicebook()
             when
                 Parent :: wxWindow:wxWindow(),
                 Id :: integer(),
                 Option ::
                     {pos, {X :: integer(), Y :: integer()}} |
                     {size, {W :: integer(), H :: integer()}} |
                     {style, integer()}.

setImageList(This, ImageList) -> ok

Types

This = wxChoicebook()

ImageList = wxImageList:wxImageList()

Sets the image list to use.

It does not take ownership of the image list, you must delete it yourself.

See:

setPageImage(This, Page, Image) -> boolean()

Types

This = wxChoicebook()

Page = Image = integer()

Sets the image index for the given page.

image is an index into the image list which was set with setImageList/2.

setPageSize(This, Size) -> ok

Types

This = wxChoicebook()

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

Sets the width and height of the pages.

Note: This method is currently not implemented for wxGTK.

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

Types

This = wxChoicebook()

Page = integer()

Text = unicode:chardata()

Sets the text for the given page.

setSelection(This :: wxChoicebook(), Page :: integer()) -> integer()

Sets the selection to the given page, returning the previous selection.

Notice that the call to this function generates the page changing events, use the changeSelection/2 function if you don't want these events to be generated.

See: getSelection/1