<!-- $XConsortium: NotebG.sgm /main/7 1996/08/30 15:51:06 rws $ -->
<!-- (c) Copyright 1995 Digital Equipment Corporation. -->
<!-- (c) Copyright 1995 Hewlett-Packard Company. -->
<!-- (c) Copyright 1995 International Business Machines Corp. -->
<!-- (c) Copyright 1995 Sun Microsystems, Inc. -->
<!-- (c) Copyright 1995 Novell, Inc. -->
<!-- (c) Copyright 1995 FUJITSU LIMITED. -->
<!-- (c) Copyright 1995 Hitachi. -->

<RefEntry Id="CDEMMA.MAN331.rsml.1">
<RefMeta>
<RefEntryTitle>XmNotebookGetPageInfo</RefEntryTitle>
<ManVolNum>library call</ManVolNum>
</RefMeta>
<RefNameDiv>
<RefName><Function>XmNotebookGetPageInfo</Function></RefName>
<RefPurpose>A Notebook function that returns page information
<IndexTerm>
<Primary>XmNotebookGetPageInfo</Primary>
</IndexTerm><IndexTerm>
<Primary>Notebook functions</Primary>
<Secondary>XmNotebookGetPageInfo</Secondary>
</IndexTerm></RefPurpose>
</RefNameDiv>
<!-- @OSF_COPYRIGHT@-->
<!-- COPYRIGHT NOTICE-->
<!-- Copyright (c) 1990, 1991, 1992, 1993 Open Software Foundation, Inc.-->
<!-- ALL RIGHTS RESERVED (MOTIF). See the file named COPY.MOTIF.DOC for-->
<!-- the full copyright text.-->
<!-- -->
<!-- HISTORY-->
<!-- **-->
<!-- **  (c) Copyright 1993 by International Business Machines Corporation-->
<!-- **      All Rights Reserved.-->
<!-- **-->
<RefSynopsisDiv>
<FuncSynopsis>
<FuncSynopsisInfo>#include &lt;Xm/Notebook.h>
</FuncSynopsisInfo>
<FuncDef>XmNotebookPageStatus <Function>XmNotebookGetPageInfo</Function></FuncDef>
<!--<ParamDef><Replaceable>notebook, page_number, page_info</Replaceable></ParamDef>-->
<ParamDef>Widget <Parameter>notebook</Parameter></ParamDef>
<ParamDef>int <Parameter>page_number</Parameter></ParamDef>
<ParamDef>XmNotebookPageInfo <Parameter>*page_info</Parameter></ParamDef>
</FuncSynopsis>
</RefSynopsisDiv>
<RefSect1>
<Title>DESCRIPTION</Title>
<Para><Function>XmNotebookGetPageInfo</Function> returns status information for the specified
Notebook page.
</Para>
<VariableList>
<VarListEntry>
<Term><Symbol Role="Variable">notebook</Symbol></Term>
<ListItem>
<Para>Specifies the Notebook widget.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">page_number</Symbol></Term>
<ListItem>
<Para>Specifies the page number to be queried.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">page_info</Symbol></Term>
<ListItem>
<Para>Points to the structure containing the page information. The structure
has the following form:
</Para>
<FuncSynopsis>
<FuncSynopsisInfo>typedef struct
{
        int     <Replaceable>page_number</Replaceable>;
        Widget  <Replaceable>page_widget</Replaceable>;
        Widget  <Replaceable>status_area_widget</Replaceable>;
        Widget  <Replaceable>major_tab_widget</Replaceable>;
        Widget  <Replaceable>minor_tab_widget</Replaceable>;
} XmNotebookPageInfo;
</FuncSynopsisInfo>
<FuncDef></FuncDef>
<void>
</FuncSynopsis>
<VariableList>
<VarListEntry>
<Term><Symbol Role="Variable">page_number</Symbol></Term>
<ListItem>
<Para>Specifies the <Symbol Role="Variable">page_number</Symbol> passed to the function.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">page_widget</Symbol></Term>
<ListItem>
<Para>Specifies a child widget of the Notebook with a <SystemItem Class="Resource">XmNchildType</SystemItem> of
<SystemItem Class="Constant">XmPAGE</SystemItem> and a <SystemItem Class="Resource">XmNpageNumber</SystemItem> equal to <Symbol Role="Variable">page_number</Symbol> if one
exists; otherwise set to NULL.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">status_area_widget</Symbol></Term>
<ListItem>
<Para>Specifies a child widget of the Notebook with a <SystemItem Class="Resource">XmNchildType</SystemItem> of
<SystemItem Class="Constant">XmSTATUS_AREA</SystemItem> and a <SystemItem Class="Resource">XmNpageNumber</SystemItem> equal to <Symbol Role="Variable">page_number</Symbol> if one
exists; otherwise set to NULL.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">major_tab_widget</Symbol></Term>
<ListItem>
<Para>Specifies a child widget of the Notebook with a <SystemItem Class="Resource">XmNchildType</SystemItem> of
<SystemItem Class="Constant">XmMAJOR_TAB</SystemItem> and the nearest <SystemItem Class="Resource">XmNpageNumber</SystemItem>
equal to or less than <Symbol Role="Variable">page_number</Symbol> if one
exists; otherwise set to NULL.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><Symbol Role="Variable">minor_tab_widget</Symbol></Term>
<ListItem>
<Para>Specifies a child widget of the Notebook with a <SystemItem Class="Resource">XmNchildType</SystemItem> of
<SystemItem Class="Constant">XmMINOR_TAB</SystemItem> and the nearest <SystemItem Class="Resource">XmNpageNumber</SystemItem>
equal to or less than <Symbol Role="Variable">page_number</Symbol> if one
exists; otherwise set to NULL.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</ListItem>
</VarListEntry>
</VariableList>
<Para>For a complete definition of Notebook and its associated resources, see
&cdeman.XmNotebook;.
</Para>
</RefSect1>
<RefSect1>
<Title>RETURN</Title>
<Para>Returns one of the following page status values:
</Para>
<VariableList>
<VarListEntry>
<Term><SystemItem Class="Constant">XmPAGE_FOUND</SystemItem></Term>
<ListItem>
<Para>The specified page was found.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="Constant">XmPAGE_INVALID</SystemItem></Term>
<ListItem>
<Para>The specified page number is out of the page number range.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="Constant">XmPAGE_EMPTY</SystemItem></Term>
<ListItem>
<Para>The specified page does not have a page widget.
</Para>
</ListItem>
</VarListEntry>
<VarListEntry>
<Term><SystemItem Class="Constant">XmPAGE_DUPLICATED</SystemItem></Term>
<ListItem>
<Para>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.
</Para>
</ListItem>
</VarListEntry>
</VariableList>
</RefSect1>
<RefSect1>
<Title>RELATED</Title>
<Para>&cdeman.XmNotebook;.
</Para>
</RefSect1>
</RefEntry>
<!--fickle 1.09 7/2/95-->
