cde/programs/dtprintinfo/libUI/MotifUI/HelpSystem.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 librararies 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: HelpSystem.h /main/3 1995/11/06 09:40:54 rswiston $ */
  24 /*                                                                      *
  25  * (c) Copyright 1993, 1994 Hewlett-Packard Company                     *
  26  * (c) Copyright 1993, 1994 International Business Machines Corp.       *
  27  * (c) Copyright 1993, 1994 Sun Microsystems, Inc.                      *
  28  * (c) Copyright 1993, 1994 Novell, Inc.                                *
  29  */
  30
  31 #ifndef HELP_SYSTEM_H
  32 #define HELP_SYSTEM_H
  33
  34 #include "MotifUI.h"
  35
  36 typedef enum
  37 {
  38    HELP_DIALOG,
  39    QUICK_HELP
  40 } HelpStyle;
  41
  42 class HelpSystem : public MotifUI {
  43
  44    friend void HyperlinkCB(Widget, XtPointer, XtPointer);
  45    friend void CloseCB(Widget, XtPointer, XtPointer);
  46
  47  private:
  48
  49    static void HyperlinkCB(Widget, XtPointer, XtPointer);
  50    static void CloseCB(Widget, XtPointer, XtPointer);
  51    void CreateHelpDialog(MotifUI *, char *, char *, char *, HelpStyle);
  52    boolean SetVisiblity(boolean flag);
  53
  54    HelpStyle _style;
  55
  56  public:
  57
  58    HelpSystem(MotifUI * parent,
  59               char * name,
  60               char * volume = NULL,
  61               char * location_id = "_hometopic",
  62               HelpStyle style = HELP_DIALOG);
  63    HelpSystem(char *category,
  64               MotifUI * parent,
  65               char * name,
  66               char * volume = NULL,
  67               char * location_id = "_hometopic",
  68               HelpStyle style = HELP_DIALOG);
  69
  70    char *HelpVolume();
  71    char *LocationID();
  72    void HelpVolume(char *volume,
  73                    char *location = "_hometopic");
  74    void LocationID(char *location);
  75
  76    const UI_Class UIClass()           { return HELP_SYSTEM; }
  77    const int UISubClass()             { return _style; }
  78    const char *const UIClassName()    { return "HelpSystem"; }
  79
  80 };
  81
  82 #endif // HELP_SYSTEM_H