View Source wxToolbook (wx v2.4.2)

Functions for wxToolbook class

wxToolbook is a class similar to wxNotebook but which uses a wxToolBar to show the labels instead of the tabs.

There is no documentation for this class yet but its usage is identical to wxNotebook (except for the features clearly related to tabs only), so please refer to that class documentation for now. You can also use the page_samples_notebook to see wxToolbook in action.

One feature of this class not supported by wxBookCtrlBase is the support for disabling some of the pages, see EnablePage() (not implemented in wx).

Styles

This class supports the following styles:

See: Overview bookctrl, wxBookCtrlBase, wxNotebook, Examples

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

wxWidgets docs: wxToolbook

Events

Event types emitted from this class: toolbook_page_changed, toolbook_page_changing

Summary

Functions

Adds a new page.

Cycles through the tabs.

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

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

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

Deletes all pages.

Destroys the object.

Returns the currently selected page or NULL.

Returns the associated image list, may be NULL.

Returns the window at the given page position.

Returns the number of pages in the control.

Returns the image index for the given page.

Returns the string for the given page.

Returns the currently selected page, or wxNOT_FOUND if none was selected.

Returns the index of the tab at the specified position or wxNOT_FOUND if none.

Inserts a new page at the specified position.

Constructs a choicebook control.

Sets the image list to use.

Sets the image index for the given page.

Sets the width and height of the pages.

Sets the text for the given page.

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

Types

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

Functions

Link to this function

addPage(This, Page, Text)

View Source
-spec addPage(This, Page, Text) -> boolean()
           when This :: wxToolbook(), Page :: wxWindow:wxWindow(), Text :: unicode:chardata().
-spec addPage(This, Page, Text, [Option]) -> boolean()
           when
               This :: wxToolbook(),
               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

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

Cycles through the tabs.

The call to this function generates the page changing events.

Link to this function

assignImageList(This, ImageList)

View Source
-spec assignImageList(This, ImageList) -> ok
                   when This :: wxToolbook(), ImageList :: wxImageList:wxImageList().

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

See: wxImageList, setImageList/2

Link to this function

changeSelection(This, Page)

View Source
-spec changeSelection(This, Page) -> integer() when This :: wxToolbook(), 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.

Link to this function

create(This, Parent, Id)

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

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

-spec deleteAllPages(This) -> boolean() when This :: wxToolbook().

Deletes all pages.

-spec destroy(This :: wxToolbook()) -> ok.

Destroys the object.

-spec getCurrentPage(This) -> wxWindow:wxWindow() when This :: wxToolbook().

Returns the currently selected page or NULL.

-spec getImageList(This) -> wxImageList:wxImageList() when This :: wxToolbook().

Returns the associated image list, may be NULL.

See: wxImageList, setImageList/2

-spec getPage(This, Page) -> wxWindow:wxWindow() when This :: wxToolbook(), Page :: integer().

Returns the window at the given page position.

-spec getPageCount(This) -> integer() when This :: wxToolbook().

Returns the number of pages in the control.

Link to this function

getPageImage(This, NPage)

View Source
-spec getPageImage(This, NPage) -> integer() when This :: wxToolbook(), NPage :: integer().

Returns the image index for the given page.

Link to this function

getPageText(This, NPage)

View Source
-spec getPageText(This, NPage) -> unicode:charlist() when This :: wxToolbook(), NPage :: integer().

Returns the string for the given page.

-spec getSelection(This) -> integer() when This :: wxToolbook().

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.

-spec hitTest(This, Pt) -> Result
           when
               Result :: {Res :: integer(), Flags :: integer()},
               This :: wxToolbook(),
               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.

Link to this function

insertPage(This, Index, Page, Text)

View Source
-spec insertPage(This, Index, Page, Text) -> boolean()
              when
                  This :: wxToolbook(),
                  Index :: integer(),
                  Page :: wxWindow:wxWindow(),
                  Text :: unicode:chardata().
-spec insertPage(This, Index, Page, Text, [Option]) -> boolean()
              when
                  This :: wxToolbook(),
                  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

-spec new() -> wxToolbook().

Constructs a choicebook control.

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

setImageList(This, ImageList)

View Source
-spec setImageList(This, ImageList) -> ok
                when This :: wxToolbook(), ImageList :: wxImageList:wxImageList().

Sets the image list to use.

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

See: wxImageList, assignImageList/2

Link to this function

setPageImage(This, Page, Image)

View Source
-spec setPageImage(This, Page, Image) -> boolean()
                when This :: wxToolbook(), Page :: integer(), Image :: integer().

Sets the image index for the given page.

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

-spec setPageSize(This, Size) -> ok when This :: wxToolbook(), Size :: {W :: integer(), H :: integer()}.

Sets the width and height of the pages.

Note: This method is currently not implemented for wxGTK.

Link to this function

setPageText(This, Page, Text)

View Source
-spec setPageText(This, Page, Text) -> boolean()
               when This :: wxToolbook(), Page :: integer(), Text :: unicode:chardata().

Sets the text for the given page.

Link to this function

setSelection(This, Page)

View Source
-spec setSelection(This, Page) -> integer() when This :: wxToolbook(), Page :: 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