wxListbook(3erl)

💅 wxListbook, bestie 💅

okay so this is the wxListbook(3erl) page from the Erlang Module Definition manual, and it is lowkey giving “book control but make it a list” main character energy. let’s get into it 🫶

🎀 NAME 🎀

wxListbook — Functions for wxListbook class. periodt.

✨ DESCRIPTION ✨

wxListbook is a class similar to wxNotebook but which uses a wxListCtrl to show the labels instead of the tabs. no cap, that’s the whole vibe.

The underlying wxListCtrl displays page labels in a one-column report view by default. Calling wxBookCtrl::SetImageList will implicitly switch the control to use an icon view. slay.

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

Styles

This class supports the following styles:

See: ?wxBookCtrl, wxNotebook, Examples

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

wxWidgets docs: wxListbook

🌈 EVENTS 🌈

Event types emitted from this class: listbook_page_changed, listbook_page_changing. those are the two, bestie 💖

🦋 DATA TYPES 🦋

wxListbook() = wx:wx_object()

👑 EXPORTS 👑

new() -> wxListbook()

Default ctor. simple, clean, ate.

new(Parent, Id) -> wxListbook()

Types:

• Parent = wxWindow:wxWindow()
• Id = integer()

new(Parent, Id, Options :: [Option]) -> wxListbook()

Types:

• Parent = wxWindow:wxWindow()
• Id = integer()

Option =
    {pos, {X :: integer(), Y :: integer()}} |
    {size, {W :: integer(), H :: integer()}} |
    {style, integer()}

Constructs a listbook control. yes bestie, it’s built 💅

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

Types:

• This = wxListbook()
• Page = wxWindow:wxWindow()
• Text = unicode:chardata()

addPage(This, Page, Text, Options :: [Option]) -> boolean()

Types:

• This = wxListbook()
• Page = wxWindow:wxWindow()
• Text = unicode:chardata()
• Option = {bSelect, boolean()} | {imageId, integer()}

Adds a new page. okay so here’s the important part:

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. seriously, don’t do it 🙈

See: insertPage/5

advanceSelection(This) -> ok

Types:

• This = wxListbook()

advanceSelection(This, Options :: [Option]) -> ok

Types:

• This = wxListbook()
• Option = {forward, boolean()}

Cycles through the tabs. The call to this function generates the page changing events. so it’s not just a quiet little vibe check, it fires events 🔥

assignImageList(This, ImageList) -> ok

Types:

• This = wxListbook()
• ImageList = wxImageList:wxImageList()

Sets the image list for the page control and takes ownership of the list. she owns it now, no take-backs 💅

See: wxImageList, setImageList/2

create(This, Parent, Id) -> boolean()

Types:

• This = wxListbook()
• Parent = wxWindow:wxWindow()
• Id = integer()

create(This, Parent, Id, Options :: [Option]) -> boolean()

Types:

• This = wxListbook()
• Parent = wxWindow:wxWindow()
• Id = integer()

Option =
    {pos, {X :: integer(), Y :: integer()}} |
    {size, {W :: integer(), H :: integer()}} |
    {style, integer()}

Create the list book control that has already been constructed with the default constructor. it’s giving “finish the setup” energy ✨

deleteAllPages(This) -> boolean()

Types:

• This = wxListbook()

Deletes all pages. all of them. gone. bye 👋

getCurrentPage(This) -> wxWindow:wxWindow()

Types:

• This = wxListbook()

Returns the currently selected page or NULL.

getImageList(This) -> wxImageList:wxImageList()

Types:

• This = wxListbook()

Returns the associated image list, may be NULL.

See: wxImageList, setImageList/2

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

Types:

• This = wxListbook()
• Page = integer()

Returns the window at the given page position.

getPageCount(This) -> integer()

Types:

• This = wxListbook()

Returns the number of pages in the control. a little headcount, but make it pages 🎀

getPageImage(This, NPage) -> integer()

Types:

• This = wxListbook()
• NPage = integer()

Returns the image index for the given page.

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

Types:

• This = wxListbook()
• NPage = integer()

Returns the string for the given page.

getSelection(This) -> integer()

Types:

• This = wxListbook()

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. bestie, platform-dependent behavior is giving chaos 😭

hitTest(This, Pt) -> Result

Types:

• Result = {Res :: integer(), Flags :: integer()}
• This = wxListbook()
• 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. iykyk, it’s a hit test, not a miss test 💅

insertPage(This, Index, Page, Text) -> boolean()

Types:

• This = wxListbook()
• Index = integer()
• Page = wxWindow:wxWindow()
• Text = unicode:chardata()

insertPage(This, Index, Page, Text, Options :: [Option]) -> boolean()

Types:

• This = wxListbook()
• Index = integer()
• Page = wxWindow:wxWindow()
• Text = unicode:chardata()
• Option = {bSelect, boolean()} | {imageId, integer()}

Inserts a new page at the specified position. very “make room, she’s arriving” energy 👑

Return: true if successful, false otherwise.

Remark: Do not delete the page, it will be deleted by the book control. same rule as before, bestie: hands off the page 🫶

See: addPage/4

setImageList(This, ImageList) -> ok

Types:

• This = wxListbook()
• ImageList = wxImageList:wxImageList()

Sets the image list to use.

It does not take ownership of the image list, you must delete it yourself. important: unlike assignImageList, this one is not keeping the list. you clean it up, bestie 💀

See: wxImageList, assignImageList/2

setPageSize(This, Size) -> ok

Types:

• This = wxListbook()
• Size = {W :: integer(), H :: integer()}

Sets the width and height of the pages.

Note: This method is currently not implemented for wxGTK. so on GTK this is giving “not today” 😭

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

Types:

• This = wxListbook()
• 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.

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

Types:

• This = wxListbook()
• Page = integer()
• Text = unicode:chardata()

Sets the text for the given page. new label, new era ✨

setSelection(This, Page) -> integer()

Types:

• This = wxListbook()
• 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

changeSelection(This, Page) -> integer()

Types:

• This = wxListbook()
• 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. quiet mode, no event drama 💅

See overview_events_prog for more information.

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

Types:

• This = wxListbook()

Destroys the object. okay bye, icon 🦋

---

that’s the whole page, bestie. cute little sign-off from the wxWidgets team for version wx 2.2.2.1 — and the footer doesn’t list a date, so I’m not inventing one 💀. this was wxListbook(3erl), and you ate. 💅✨