XMNOTEBOOKGETPAGEINFO(3)

πŸ“¦
version 2.5.2 Β· 2 versions
, in alpine 3.24, arch rolling, centos-stream 9, epel 10, fedora 43, fedora 44, nixos 26.05, nixpkgs unstable, opensuse-leap 16.0

✨ XmNotebookGetPageInfo β€” the Notebook glow-up that spills the tea on your pages ✨

okay bestie, so this one lives in the library call manual (section 3, we love a classic), and it's literally the function you call when you wanna know what's actually going on with a page in your Notebook widget. no cap. πŸ’…


πŸ¦‹ NAME πŸ¦‹

XmNotebookGetPageInfo β€” a Notebook function that returns page information πŸŽ€


🌸 SYNOPSIS 🌸

#include <Xm/Notebook.h>
XmNotebookPageStatus XmNotebookGetPageInfo(
        Widget notebook,
        int page_number,
        XmNotebookPageInfo *page_info);

πŸ’– DESCRIPTION πŸ’–

XmNotebookGetPageInfo returns status information for the specified Notebook page. that's it, that's the vibe. it's giving lookup service. πŸ”

Here's who's who in the group chat:

  • notebook β€” Specifies the Notebook widget. πŸ‘‘
  • page_number β€” Specifies the page number to be queried. πŸ”’
  • page_info β€” Points to the structure containing the page information. πŸ“¦

The structure has the following form:

typedef struct
{
        int     page_number;
        Widget  page_widget;
        Widget  status_area_widget;
        Widget  major_tab_widget;
        Widget  minor_tab_widget;
} XmNotebookPageInfo;

(void) β€” yes that's literally what it says, no notes πŸ’€

and inside that struct, bestie, every field is a whole personality:

  • page_number β€” Specifies the page_number passed to the function. it's literally echoing back what you told it. πŸ™ˆ
  • page_widget β€” Specifies a child widget of the Notebook with a XmNchildType of XmPAGE and a XmNpageNumber equal to page_number if one exists; otherwise set to NULL. so if it's not there, you get NULL, not a sad little ghost. πŸ‘»
  • status_area_widget β€” Specifies a child widget of the Notebook with a XmNchildType of XmSTATUS_AREA and a XmNpageNumber equal to page_number if one exists; otherwise set to NULL. ✨
  • major_tab_widget β€” Specifies a child widget of the Notebook with a XmNchildType of XmMAJOR_TAB and the nearest XmNpageNumber equal to or less than page_number if one exists; otherwise set to NULL. she'll take the closest one at or below, she's not picky πŸ’…
  • minor_tab_widget β€” Specifies a child widget of the Notebook with a XmNchildType of XmMINOR_TAB and the nearest XmNpageNumber equal to or less than page_number if one exists; otherwise set to NULL. same energy, different tab. πŸŽ€

For a complete definition of Notebook and its associated resources, see XmNotebook(3). go read it, it's the lore. πŸ“–


πŸ”₯ RETURN πŸ”₯

Returns one of the following page status values β€” aka the vibe check results:

  • XmPAGE_FOUND β€” The specified page was found. ate and left no crumbs. πŸ‘‘
  • XmPAGE_INVALID β€” The specified page number is out of the page number range. she's not even in the building. πŸ’€
  • XmPAGE_EMPTY β€” The specified page does not have a page widget. page exists, widget does not. it's giving empty plate 🍽️
  • XmPAGE_DUPLICATED β€” There is more than one page widget with the specified page number. The more recently managed page widget is used for the page information structure. so when there's drama, the newest one wins. 🫢


and that's the whole page, bestie!! this one was filed under XmNotebookGetPageInfo(library call) in the library call manual, and honestly the footer didn't even bring a version or date stamp along β€” no receipts, just the title. iconic behaviour, honestly. πŸ’œβœ¨πŸŽ€πŸ¦‹