wxToolbook(3)

📦
version 29.0.6 · 3 versions
, in ubuntu stonking

💖 wxToolbook 💖

okay bestie, so this whole thing is the manual page for wxToolbook, straight out of the Erlang module definitions (that's the manual name, in case you were wondering where the header went 🫶). It's giving very "I'm a notebook but make it fashion" energy and honestly? obsessed.

✨ NAME ✨

wxToolbook — it's a class similar to wxNotebook, except instead of tabs it uses a wxToolBar to show the labels. yes, a whole toolbar. iconic behavior honestly. 💅

🦋 DESCRIPTION 🦋

okay so lowkey there is no documentation for this class yet, but the usage is identical to wxNotebook except for the stuff that is clearly tab-only, so for now please go read that class's docs. no cap. you can also use page_samples_notebook to see wxToolbook in action, which is the cute little "go look at it with your own eyes" option. 🎀

One feature of this class that's not supported by wxBookCtrlBase is the support for disabling some of the pages — see EnablePage() (which is not implemented in wx, so don't get your hopes up bestie 💀).

🌈 Styles 🌈

This class supports the following styles:

  • wxTBK_BUTTONBAR — uses a wxButtonToolBar-based implementation under macOS (and is ignored under every other platform, so it's giving platform-exclusive 🙈).
  • wxTBK_HORZ_LAYOUT — shows the text and the icons alongside each other, not vertically stacked (only implemented under Windows and GTK 2 platforms, because it relies on wxTB_HORZ_LAYOUT flag support). Also, the common wxBookCtrl styles described in overview_bookctrl are supported too. ✨

👀 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

🧁 DATA TYPES 🧁

wxToolbook() :: wx:wx_object().

🌟 FUNCTIONS 🌟

💅 addPage

addPage(This, Page, Text, [Option]) -> boolean()
                 when
                     This :: wxToolbook(),
                     Page :: wxWindow:wxWindow(),
                     Text :: unicode:chardata(),
                     Option ::
                         {bSelect, boolean()} | {imageId, integer()}.

Adds a new page, slay. 🫶

The page must have the book control itself as the parent, and must not have been added to this control previously — no double-dipping bestie.

The call to this function will generate the page changing and page changed events if select is true, but not when you're inserting the very first page (because there's no previous page selection to switch from in that case, so it wouldn't make sense to e.g. veto such an event — it's giving "nothing to compare against").

Return: true if it worked, false otherwise.

Remark: Do not delete the page. It will be deleted by the book control. Let the book control have this one, okay? 😭

See: insertPage/5

💅 advanceSelection

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

Cycles through the tabs. 🌀

The call to this function generates the page changing events.

💅 assignImageList

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

Sets the image list for the page control and takes ownership of the list (so it's yours now, the control is the main character of that list 😌).

See:

  • wxImageList
  • setImageList/2

💅 changeSelection

changeSelection(This, Page) -> integer()
                         when This :: wxToolbook(), Page :: integer().

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

This function behaves like setSelection/2 but does not generate the page changing events — quiet mode fr fr.

See overview_events_prog for more information.

💅 create

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. ✨

💅 deleteAllPages

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

Deletes all pages. all of them. every last one. 💀

💅 destroy

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

Destroys the object. rip bozo 🪦

💅 getCurrentPage

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

Returns the currently selected page, or NULL. 🙈

💅 getImageList

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

Returns the associated image list — may be NULL, so maybe don't assume bestie.

See:

  • wxImageList
  • setImageList/2

💅 getPage

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

Returns the window at the given page position. 🪟

💅 getPageCount

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

Returns the number of pages in the control. counting is self care ✨

💅 getPageImage

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

Returns the image index for the given page. 🖼️

💅 getPageText

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

Returns the string for the given page. 🎀

💅 getSelection

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

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

Note: this method may return either the previously or the newly selected page when it's called from the EVT_BOOKCTRL_PAGE_CHANGED handler, depending on the platform. so honestly, in that case use wxBookCtrlEvent:getSelection/1 instead. iykyk. 😭

💅 hitTest

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 there isn't one. 🎯

If the flags parameter is non-NULL, the position of the point inside the tab is returned as well.

Return: the zero-based tab index, or wxNOT_FOUND if there's no tab at the specified position.

💅 insertPage

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. placement is everything bestie ✨

Return: true if it worked, false otherwise.

Remark: Do not delete the page, it will be deleted by the book control. 🫶

See: addPage/4

💅 new

new() -> wxToolbook().

Constructs a choicebook control. (yes it literally says choicebook, we are not editing the source material, we simply report it 💀)

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

💅 setImageList

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. so that's on you, bestie, no pressure 🙈

See:

  • wxImageList
  • assignImageList/2

💅 setPageImage

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.

💅 setPageSize

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. so if that's your platform, that's a no from her 😭

💅 setPageText

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

Sets the text for the given page. 💖

💅 setSelection

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 — so if you don't want those events to be generated, use the changeSelection/2 function instead. periodt.

See: getSelection/1

and that's the whole page bestie, you ate that 💅✨

this lil' manual came to you from Ericsson AB, version wx 2.6, and it's the wxToolbook page, mwah 🎀💖 night night, go build something cute 🦋

📦 where this page comes from