cde/lib/DtHelp/HelpQuickDP.h

   1 /*
   2  * CDE - Common Desktop Environment
   3  *
   4  * Copyright (c) 1993-2012, The Open Group. All rights reserved.
   5  *
   6  * These libraries and programs are free software; you can
   7  * redistribute them and/or modify them under the terms of the GNU
   8  * Lesser General Public License as published by the Free Software
   9  * Foundation; either version 2 of the License, or (at your option)
  10  * any later version.
  11  *
  12  * These libraries and programs are distributed in the hope that
  13  * they will be useful, but WITHOUT ANY WARRANTY; without even the
  14  * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE. See the GNU Lesser General Public License for more
  16  * details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with these libraries and programs; if not, write
  20  * to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
  21  * Floor, Boston, MA 02110-1301 USA
  22  */
  23 /* $XConsortium: HelpQuickDP.h /main/6 1996/04/05 14:41:19 mgreess $ */
  24 /*************************************<+>*************************************
  25  *****************************************************************************
  26  **
  27  **  File:   HelpQuickDP.h
  28  **
  29  **  Project:  CDE 1.0 Common Desktop Environment
  30  **
  31  **  Description:  Privite Header file for HelpQuickD.c
  32  **  -----------
  33  **
  34  **  (c) Copyright 1987, 1988, 1989, 1990, 1991, 1992 Hewlett-Packard Company
  35  **
  36  **  (c) Copyright 1993, 1994 Hewlett-Packard Company
  37  **  (c) Copyright 1993, 1994 International Business Machines Corp.
  38  **  (c) Copyright 1993, 1994 Sun Microsystems, Inc.
  39  **  (c) Copyright 1993, 1994 Novell, Inc.
  40  **
  41  *******************************************************************
  42  *************************************<+>*************************************/
  43
  44 #ifndef _DtHelpQuickDP_h
  45 #define _DtHelpQuickDP_h
  46
  47 #include <Xm/BulletinBP.h>
  48
  49 #include <Dt/HelpQuickD.h>
  50
  51 #include "HelpQuickDI.h"
  52 #include "HelpDialogP.h"
  53
  54
  55 #define DtNO_JUMP_UPDATE          1
  56 #define DtJUMP_UPDATE             2
  57
  58
  59 #define XmDIALOG_SUFFIX            "_popup"
  60 #define XmDIALOG_SUFFIX_SIZE       6
  61
  62
  63 /* Defines for use in allocation geometry matrix. */
  64 #define TB_MAX_WIDGETS_VERT     7
  65 #define TB_MAX_NUM_WIDGETS      12
  66
  67
  68
  69 /* Class Part Structure Definition */
  70
  71 typedef struct
  72 {
  73         XtPointer               extension;      /* Pointer to extension record */
  74 } DtHelpQuickDialogWidgetClassPart;
  75
  76
  77
  78
  79 /* Full class record declaration */
  80
  81 typedef struct _DtHelpQuickDialogWidgetClassRec
  82 {
  83         CoreClassPart                      core_class;
  84         CompositeClassPart                 composite_class;
  85         ConstraintClassPart                constraint_class;
  86         XmManagerClassPart                 manager_class;
  87         XmBulletinBoardClassPart           bulletin_board_class;
  88         DtHelpQuickDialogWidgetClassPart  selection_box_class;
  89 } DtHelpQuickDialogWidgetClassRec;
  90
  91 externalref DtHelpQuickDialogWidgetClassRec dtHelpQuickDialogWidgetClassRec;
  92
  93
  94 /* fields for the Quick Help widget record */
  95
  96 /* reuse the CommonHelpStuff structure from HelpDialogP.h */
  97 /* reuse the BacktrackStuff structure from HelpDialogP.h */
  98 /* reuse the PrintStuff structure from HelpDialogP.h */
  99
 100 typedef struct _DtHelpQuickHelpStuff
 101 {
 102         int             pad;
 103         Widget          definitionBox;
 104         Boolean         minimize_buttons;
 105
 106         /* Help Dialog Widgets */
 107
 108         Widget          displayAreaFrame;
 109         Widget          separator;
 110
 111         Widget          closeButton;            /*  close button  */
 112         XmString        closeLabelString;
 113         XtCallbackList  closeCallback;
 114
 115         Widget          moreButton;             /* Application button */
 116         XmString        moreLabelString;
 117
 118         Widget          backButton;             /* Backtrack button */
 119         XmString        backLabelString;
 120
 121         Widget          printButton;            /*  print  button */
 122         XmString        printLabelString;
 123
 124         Widget          helpButton;             /*  help button  */
 125         XmString        helpLabelString;
 126 } _DtHelpQuickHelpStuff;
 127
 128 typedef struct
 129 {
 130        _DtHelpDisplayWidgetStuff        display;
 131        _DtHelpCommonHelpStuff   help;
 132        _DtHelpQuickHelpStuff    qhelp;
 133        _DtHelpBacktrackStuff    backtr;
 134        _DtHelpPrintStuff                print;
 135 } _DtHelpQuickDialogWidgetPart;
 136
 137
 138 /****************************************************************
 139  *
 140  * Full instance record declaration
 141  *
 142  ****************************************************************/
 143
 144 typedef struct _DtHelpQuickDialogWidgetRec
 145 {
 146         CorePart                        core;
 147         CompositePart                   composite;
 148         ConstraintPart                  constraint;
 149         XmManagerPart                   manager;
 150         XmBulletinBoardPart             bulletin_board;
 151         _DtHelpQuickDialogWidgetPart    qhelp_dialog;
 152 } DtHelpQuickDialogWidgetRec;
 153
 154
 155
 156 /********    Private Function Declarations    ********/
 157 extern XmGeoMatrix _DtHelpQuickDialogWidgetGeoMatrixCreate(
 158                         Widget wid,
 159                         Widget instigator,
 160                         XtWidgetGeometry *desired) ;
 161 extern Boolean _DtHelpQuickDialogWidgetNoGeoRequest(
 162                         XmGeoMatrix geoSpec) ;
 163 extern void _DtHelpQuickDialogGetCloseLabelString(
 164                         Widget wid,
 165                         int resource_offset,
 166                         XtArgVal *value );
 167 extern void _DtHelpQuickDialogGetHelpLabelString(
 168                         Widget wid,
 169                         int resource_offset,
 170                         XtArgVal *value );
 171
 172 /********    End Private Function Declarations    ********/
 173
 174
 175
 176 #endif /* _DtHelpDialogP_h */
 177 /* DON'T ADD ANYTHING AFTER THIS #endif */