1XmNotebookGetPageInfo(library call)        XmNotebookGetPageInfo(library call)
2
3
4

NAME

6       XmNotebookGetPageInfo  — A Notebook function that returns page informa‐
7       tion
8

SYNOPSIS

10       #include <Xm/Notebook.h>
11       XmNotebookPageStatus XmNotebookGetPageInfo(
12       Widget notebook,
13       int page_number,
14       XmNotebookPageInfo *page_info);
15

DESCRIPTION

17       XmNotebookGetPageInfo returns  status  information  for  the  specified
18       Notebook page.
19
20       notebook  Specifies the Notebook widget.
21
22       page_number
23                 Specifies the page number to be queried.
24
25       page_info Points  to the structure containing the page information. The
26                 structure has the following form:
27
28       typedef struct
29       {
30               int     page_number;
31               Widget  page_widget;
32               Widget  status_area_widget;
33               Widget  major_tab_widget;
34               Widget  minor_tab_widget;
35       } XmNotebookPageInfo;
36       (void)
37
38              page_number
39                        Specifies the page_number passed to the function.
40
41              page_widget
42                        Specifies a child widget of the Notebook with  a  XmN‐
43                        childType  of  XmPAGE  and  a  XmNpageNumber  equal to
44                        page_number if one exists; otherwise set to NULL.
45
46              status_area_widget
47                        Specifies a child widget of the Notebook with  a  XmN‐
48                        childType  of  XmSTATUS_AREA and a XmNpageNumber equal
49                        to page_number if one exists; otherwise set to NULL.
50
51              major_tab_widget
52                        Specifies a child widget of the Notebook with  a  XmN‐
53                        childType of XmMAJOR_TAB and the nearest XmNpageNumber
54                        equal to or less than page_number if one exists;  oth‐
55                        erwise set to NULL.
56
57              minor_tab_widget
58                        Specifies  a  child widget of the Notebook with a XmN‐
59                        childType of XmMINOR_TAB and the nearest XmNpageNumber
60                        equal  to or less than page_number if one exists; oth‐
61                        erwise set to NULL.
62
63       For a complete definition of Notebook and its associated resources, see
64       XmNotebook(3).
65

RETURN

67       Returns one of the following page status values:
68
69       XmPAGE_FOUND
70                 The specified page was found.
71
72       XmPAGE_INVALID
73                 The specified page number is out of the page number range.
74
75       XmPAGE_EMPTY
76                 The specified page does not have a page widget.
77
78       XmPAGE_DUPLICATED
79                 There  is  more  than one page widget with the specified page
80                 number. The more recently managed page widget is used for the
81                 page information structure.
82

84       XmNotebook(3).
85
86
87
88                                           XmNotebookGetPageInfo(library call)
Impressum