wxTreebook(3)

📦
version 29.0.6 · 3 versions
, in ubuntu stonking

💖 wxTreebook 💖

okay so bestie, this is wxTreebook(3) from the Erlang module definitions, and it's genuinely one of the cuter widgets out there — it's a tree. but make it a notebook. obsessed. 🎀

✨ NAME ✨

wxTreebook — this class is an extension of the wxNotebook class that allows a tree structured set of pages to be shown in a control. 🌳📓

🦋 DESCRIPTION 🦋

A classic example is a netscape preferences dialog that shows a tree of preference sections on the left and select section page on the right. like, you know that sidebar? that's the vibe. iconic behaviour. 💅

To use the class simply create it and populate with pages using insertPage/5, insertSubPage/5, addPage/4, AddSubPage() (not implemented in wx).

If your tree is no more than 1 level in depth then you could simply use addPage/4 and AddSubPage() (not implemented in wx) to sequentially populate your tree by adding at every step a page or a subpage to the end of the tree. (yes, AddSubPage() shows up twice in this paragraph and it's not implemented in wx both times. we don't make the rules. 😭)

See:

  • ?wxBookCtrl
  • wxBookCtrlEvent
  • wxNotebook
  • wxTreeCtrl
  • wxImageList
  • Overview bookctrl
  • Examples

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

  • wxBookCtrlBase
  • wxControl
  • wxWindow
  • wxEvtHandler

wxWidgets docs: wxTreebook

🌸 Events 🌸

Event types emitted from this class:

  • treebook_page_changed
  • treebook_page_changing

🎀 DATA TYPES 🎀

wxTreebook() :: wx:wx_object().

yes bestie, it's just a wx_object(). no cap. 🫶

👑 FUNCTIONS 👑

💜 addPage

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

Adds a new page. ✨

The page is placed at the topmost level after all other pages. NULL could be specified for page to create an empty page.

💜 advanceSelection

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

Cycles through the tabs. 🔄

The call to this function generates the page changing events. (so like, heads up, it's not a quiet lil move.)

💜 assignImageList

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

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

See:

  • wxImageList
  • setImageList/2

💜 changeSelection

changeSelection(This, Page) -> integer()
                         when This :: wxTreebook(), 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. so quiet. so demure. 🙈

See overview_events_prog for more information.

💜 create

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

Creates a treebook control. 🛠️

See new/3 for the description of the parameters.

💜 deleteAllPages

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

Deletes all pages. every single one. gone. 💀

💜 destroy

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

Destroys the object. 🧚

💜 expandNode

expandNode(This, PageId, [Option]) -> boolean()
                    when
                        This :: wxTreebook(),
                        PageId :: integer(),
                        Option :: {expand, boolean()}.

Expands (collapses) the pageId node. 🌳

Returns the previous state. May generate page changing events (if selected page is under the collapsed branch, then its parent is autoselected). so like… your selection might jump. that's not a bug, that's the autoselect.

💜 getCurrentPage

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

Returns the currently selected page or NULL.

💜 getImageList

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

Returns the associated image list, may be NULL.

See:

  • wxImageList
  • setImageList/2

💜 getPage

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

Returns the window at the given page position.

💜 getPageCount

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

Returns the number of pages in the control. count 'em. 🔢

💜 getPageImage

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

Returns the image index for the given page.

💜 getPageText

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

Returns the string for the given page.

💜 getSelection

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

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

Note: This method may return either the previously or newly selected page when called from the EVT_TREEBOOK_PAGE_CHANGED() handler depending on the platform and so wxBookCtrlEvent:getSelection/1 should be used instead in this case. ⚠️

💜 hitTest

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

💜 insertPage

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

Inserts a new page just before the page indicated by pagePos.

The new page is placed before pagePos page and on the same level. NULL could be specified for page to create an empty page.

💜 insertSubPage

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

Inserts a sub page under the specified page. 🪆 (nesting! we love nesting.)

NULL could be specified for page to create an empty page.

💜 isNodeExpanded

isNodeExpanded(This, PageId) -> boolean()
                        when This :: wxTreebook(), PageId :: integer().

Returns true if the page represented by pageId is expanded. ✅

💜 new

new() -> wxTreebook().

Default constructor.

💜 new

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

Creates an empty wxTreebook. 🐣

💜 setImageList

setImageList(This, ImageList) -> ok
                      when
                          This :: wxTreebook(),
                          ImageList :: wxImageList:wxImageList().

Sets the image list to use.

It does not take ownership of the image list, you must delete it yourself. yes bestie, that's on you. 🫵

See:

  • wxImageList
  • assignImageList/2

💜 setPageImage

setPageImage(This, Page, Image) -> boolean()
                      when
                          This :: wxTreebook(),
                          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 :: wxTreebook(),
                         Size :: {W :: integer(), H :: integer()}.

Sets the width and height of the pages.

Note: This method is currently not implemented for wxGTK. 😭

💜 setPageText

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

Sets the text for the given page. ✍️

💜 setSelection

setSelection(This, Page) -> integer()
                      when This :: wxTreebook(), 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: wxBookCtrlBase:getSelection/1

and that's the whole page bestie, you ate it up, every flag and every when-clause intact, not a single detail left behind 💅✨

this one came to you from Ericsson AB, version wx 2.6, and it's the wxTreebook(3) page — slay, goodbye, go build a tree notebook 🦋

📦 where this page comes from