home *** CD-ROM | disk | FTP | other *** search
/ PC World Komputer 1999 mARCH / PCWK3A99.iso / Linux / DDD331 / DDD-3_1_.000 / DDD-3_1_ / ddd-3.1.1 / ddd / HelpCB.h < prev    next >
C/C++ Source or Header  |  1998-04-16  |  6KB  |  172 lines
  1. // $Id: HelpCB.h,v 1.25 1998/04/16 13:43:10 zeller Exp $  -*- C++ -*-
  2. // Interactive Help Callbacks
  3.  
  4. // Copyright (C) 1995 Technische Universitaet Braunschweig, Germany.
  5. // Written by Andreas Zeller <zeller@ips.cs.tu-bs.de>.
  6. // 
  7. // This file is part of DDD.
  8. // 
  9. // DDD is free software; you can redistribute it and/or
  10. // modify it under the terms of the GNU General Public
  11. // License as published by the Free Software Foundation; either
  12. // version 2 of the License, or (at your option) any later version.
  13. // 
  14. // DDD is distributed in the hope that it will be useful,
  15. // but WITHOUT ANY WARRANTY; without even the implied warranty of
  16. // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  17. // See the GNU General Public License for more details.
  18. // 
  19. // You should have received a copy of the GNU General Public
  20. // License along with DDD -- see the file COPYING.
  21. // If not, write to the Free Software Foundation, Inc.,
  22. // 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  23. // 
  24. // DDD is the data display debugger.
  25. // For details, see the DDD World-Wide-Web page, 
  26. // `http://www.cs.tu-bs.de/softech/ddd/',
  27. // or send a mail to the DDD developers <ddd@ips.cs.tu-bs.de>.
  28.  
  29. #ifndef _DDD_HelpCB_h
  30. #define _DDD_HelpCB_h
  31.  
  32. #include <X11/Intrinsic.h>
  33. #include <Xm/Text.h>
  34. #include "MString.h"
  35. #include "bool.h"
  36.  
  37. // Resources
  38. // Text to be displayed in context-sensitive help (via HelpOnContextCB)
  39. #define XtNhelpString "helpString"
  40. #define XtCHelpString "HelpString"
  41.  
  42. // Text to be displayed in `Help On Version'
  43. #define XtNhelpOnVersionString "helpOnVersionString"
  44. #define XtCHelpOnVersionString "HelpOnVersionString"
  45.  
  46. // Text to be displayed in button tips (via InstallTips)
  47. #define XtNtipString  "tipString"
  48. #define XtCTipString  "TipString"
  49.  
  50. // Text to be displayed in the status line (via DisplayDocumentation)
  51. #define XtNdocumentationString  "documentationString"
  52. #define XtCDocumentationString  "DocumentationString"
  53.  
  54. // If true, give widget names in context-sensitive help
  55. #define XtNhelpShowTitle "helpShowTitle"
  56. #define XtCHelpShowTitle "HelpShowTitle"
  57.  
  58.  
  59. // Select widget and call help on context.
  60. // May be used in a menu entry "Help On Context".
  61. extern void HelpOnContextCB(Widget widget, XtPointer client_data, 
  62.                 XtPointer call_data);
  63.  
  64. // Call help on context on the widget that got the help key.
  65. // May be used in a menu entry "Help On Item".
  66. extern void HelpOnItemCB(Widget widget, XtPointer client_data, 
  67.              XtPointer call_data);
  68.  
  69. // Call help on current shell window.
  70. // May be used in a menu entry "Help On Window".
  71. extern void HelpOnWindowCB(Widget widget, XtPointer client_data, 
  72.                XtPointer call_data);
  73.  
  74. // Call help on the top-level window.
  75. // May be used in a menu entry "Help On Version".
  76. extern void HelpOnVersionCB(Widget widget, XtPointer client_data, 
  77.                 XtPointer call_data);
  78.  
  79. // Call help on help.
  80. // May be used in a menu entry "Help On Help".
  81. extern void HelpOnHelpCB(Widget widget, XtPointer client_data, 
  82.              XtPointer call_data);
  83.  
  84. // Call help for associated widget.
  85. // May be used as help callback for any primitive widget.
  86. extern void ImmediateHelpCB(Widget widget, XtPointer client_data, 
  87.                 XtPointer call_data);
  88.  
  89. // Call help for widget given in "Widget w = (Widget)client_data".
  90. extern void HelpOnThisCB(Widget widget, XtPointer client_data, 
  91.              XtPointer call_data);
  92.  
  93. // Call help with "XmString s = (XmString)client_data" as text.
  94. // May be used for unchanged text display.
  95. extern void MStringHelpCB(Widget widget, XtPointer client_data, 
  96.               XtPointer call_data);
  97.  
  98. // Call help with "String s = (String)client_data" as text.
  99. // May be used for unchanged text display.
  100. extern void StringHelpCB(Widget widget, XtPointer client_data, 
  101.              XtPointer call_data);
  102.  
  103. // Call help with "String s = (String)client_data" as text.
  104. // May be used for unchanged text display.
  105. extern void TextHelpCB(Widget widget, XtPointer client_data, 
  106.                XtPointer call_data);
  107.  
  108. // Call help with a built-in formatted manual page "String s =
  109. // (String)client_data".
  110. extern void ManualStringHelpCB(Widget widget, XtPointer client_data, 
  111.                    XtPointer call_data);
  112. extern void ManualStringHelpCB(Widget widget, const MString& title,
  113.                    const string& text);
  114.  
  115. // (Un)install button tips on W.
  116. extern void InstallButtonTips(Widget w, bool install = true);
  117.  
  118. // (Un)install text tips on W.
  119. extern void InstallTextTips(Widget w, bool install = true);
  120.  
  121. // Enable or disable all installed button tips.
  122. extern void EnableButtonTips(bool enable = true);
  123.  
  124. // Enable or disable all installed text tips.
  125. extern void EnableTextTips(bool enable = true);
  126.  
  127. // Enable or disable all installed button docs.
  128. extern void EnableButtonDocs(bool enable = true);
  129.  
  130. // Enable or disable all installed text docs.
  131. extern void EnableTextDocs(bool enable = true);
  132.  
  133.  
  134. // Data
  135.  
  136. // Create a help text if the `help' resource is empty
  137. extern MString (*DefaultHelpText)(Widget widget);
  138.  
  139. // Create a help text if the `tipString' resource is empty
  140. extern MString (*DefaultTipText)(Widget widget, XEvent *event);
  141.  
  142. // Create a help text for the documentation if the `documentationString'
  143. // resource is empty
  144. extern MString (*DefaultDocumentationText)(Widget widget, XEvent *event);
  145.  
  146. // Return a text position associated with this event
  147. extern XmTextPosition (*TextPosOfEvent)(Widget widget, XEvent *event);
  148.  
  149. // Hook for displaying documentation
  150. extern void (*DisplayDocumentation)(const MString& doc);
  151.  
  152. // Hook before help on context
  153. extern void (*PreHelpOnContextHook)(Widget w, XtPointer client_data, 
  154.                     XtPointer call_data);
  155.  
  156. // Hook after help on item
  157. extern void (*PostHelpOnItemHook)(Widget item);
  158.  
  159. // Additional text to display at ``help on version''
  160. extern MString helpOnVersionExtraText;
  161.  
  162. // Delay times (in ms)
  163. extern int help_button_tip_delay; // delay before raising button tip
  164. extern int help_value_tip_delay;  // delay before raising value tip
  165. extern int help_button_doc_delay; // delay before showing button doc
  166. extern int help_value_doc_delay;  // delay before showing value doc
  167. extern int help_clear_doc_delay;  // delay before clearing doc
  168. extern int help_clear_tip_delay;  // delay before clearing tip
  169.  
  170. #endif // _DDD_HelpCB_h
  171. // DON'T ADD ANYTHING BEHIND THIS #endif
  172.