include/Xm/Notebook.h

0001 /* $XConsortium: Notebook.h /main/5 1995/07/15 20:53:41 drk $ */
0002 /*
0003  * Motif
0004  *
0005  * Copyright (c) 1987-2012, The Open Group. All rights reserved.
0006  *
0007  * These libraries and programs are free software; you can
0008  * redistribute them and/or modify them under the terms of the GNU
0009  * Lesser General Public License as published by the Free Software
0010  * Foundation; either version 2 of the License, or (at your option)
0011  * any later version.
0012  *
0013  * These libraries and programs are distributed in the hope that
0014  * they will be useful, but WITHOUT ANY WARRANTY; without even the
0015  * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
0016  * PURPOSE. See the GNU Lesser General Public License for more
0017  * details.
0018  *
0019  * You should have received a copy of the GNU Lesser General Public
0020  * License along with these librararies and programs; if not, write
0021  * to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
0022  * Floor, Boston, MA 02110-1301 USA
0023  */
0024 /*
0025  * HISTORY
0026  */
0027
0028 #ifndef _XmNotebook_h
0029 #define _XmNotebook_h
0030
0031 #include <Xm/Xm.h>
0032
0033 #ifdef __cplusplus
0034 extern "C" {
0035 #endif
0036
0037 externalref WidgetClass xmNotebookWidgetClass;
0038
0039 typedef struct _XmNotebookClassRec *XmNotebookWidgetClass;
0040 typedef struct _XmNotebookRec *XmNotebookWidget;
0041
0042
0043 /************************************************************************
0044  *  Notebook Defines
0045  ************************************************************************/
0046
0047 /* XmNotebookPageStatus */
0048 typedef enum
0049 {
0050     XmPAGE_FOUND,       /* page widget found */
0051     XmPAGE_INVALID,     /* page number out of the range */
0052     XmPAGE_EMPTY,       /* no page widget found */
0053     XmPAGE_DUPLICATED       /* there are more than one page widgets */
0054 } XmNotebookPageStatus;
0055
0056 /* Notebook page information structure */
0057 typedef struct
0058 {
0059     int         page_number;
0060     Widget      page_widget;
0061     Widget  status_area_widget;
0062     Widget      major_tab_widget;
0063     Widget  minor_tab_widget;
0064 } XmNotebookPageInfo;
0065
0066
0067 /************************************************************************
0068  *  Public Functions
0069  ************************************************************************/
0070
0071 #ifndef XmIsNotebook
0072 #define XmIsNotebook(w) XtIsSubclass((w), xmNotebookWidgetClass)
0073 #endif
0074
0075 extern Widget XmCreateNotebook(
0076             Widget      parent,
0077             String      name,
0078             ArgList     arglist,
0079             Cardinal    argcount);
0080
0081 extern XmNotebookPageStatus XmNotebookGetPageInfo(
0082             Widget notebook,
0083             int page_number,
0084             XmNotebookPageInfo *page_info) ;
0085
0086 extern Widget XmVaCreateNotebook(
0087                         Widget parent,
0088                         char *name,
0089                         ...);
0090
0091 extern Widget XmVaCreateManagedNotebook(
0092                         Widget parent,
0093                         char *name,
0094                         ...);
0095
0096
0097 #ifdef __cplusplus
0098 }
0099 #endif
0100
0101 #endif /* _XmNotebook_h  */
0102