HelpAccessI.h 5.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164
  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: HelpAccessI.h /main/4 1995/10/26 12:23:38 rswiston $ */
  24. /*************************************<+>*************************************
  25. *****************************************************************************
  26. **
  27. ** File: HelpAccessI.h
  28. **
  29. ** Project: Cache Creek (Rivers) Project:
  30. **
  31. ** Description: Internal header file for HelpAccess.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. #ifndef _HelpAccessI_h
  44. #define _HelpAccessI_h
  45. /* The following Defines are for all the F1 key help requests */
  46. /* Help Dialog */
  47. #define DtHELP_dialogShell_STR "_HOMETOPIC"
  48. /* Menubar help access */
  49. #define DtHELP_onHelpMenu_STR "_HOMETOPIC"
  50. #define DtHELP_onTableOfContenseMenu_STR "TABLE-OF-CONTENTS"
  51. #define DtHELP_onTasksMenu_STR "TASKS"
  52. #define DtHELP_onReferenceMenu_STR "REFERENCE"
  53. #define DtHELP_onMouseAndKeysMenu_STR "MOUSE-AND-KEYBOARD"
  54. #define DtHELP_onVersionMenu_STR "_COPYRIGHT"
  55. #define DtHELP_ExecutionPolicy_STR "EXECUTION-POLICY"
  56. /* Menu Item Id's (F1 Key) */
  57. #define DtHELP_FileMenu_STR "HELP-FILE-MENU"
  58. #define DtHELP_EditMenu_STR "HELP-EDIT-MENU"
  59. #define DtHELP_SearchMenu_STR "HELP-SEARCH-MENU"
  60. #define DtHELP_NavigateMenu_STR "HELP-NAVIGATE-MENU"
  61. #define DtHELP_HelpMenu_STR "HELP-HELP-MENU"
  62. #define DtHELP_PopupMenu_STR "HELP-POPUP-MENU"
  63. /* Quick Help Dialog help access defines */
  64. #define DtHELP_quickHelpShell_STR "QUICK-HELP"
  65. #define DtHELP_quickHelpBtn_STR "QUICK-HELP"
  66. /* History Dialog help access defines */
  67. #define DtHELP_historyShell_STR "HISTORY"
  68. #define DtHELP_historyHelpBtn_STR "HISTORY"
  69. /* Printing Dialog help access defines */
  70. #define DtHELP_printShell_STR "PRINTING"
  71. #define DtHELP_printHelpBtn_STR "PRINTING"
  72. /* Index Search Dialog help access defines */
  73. #define DtHELP_srchIndexShell_STR "INDEX-SEARCH"
  74. #define DtHELP_srchIndexHelpBtn_STR "INDEX-SEARCH"
  75. /* Volume Selection Dialog help access defines */
  76. #define DtHELP_volSelectShell_STR "VOLUME-SELECT"
  77. #define DtHELP_volSelectHelpBtn_STR "VOLUME-SELECT"
  78. /****************************************************************************
  79. * Function: void _DtHelpCB (widget, clientData, callData)
  80. * Widget widget;
  81. * XtPointer clientData;
  82. * XtPointer callData;
  83. *
  84. * Parameters: widget
  85. * clientData
  86. * callData
  87. *
  88. *
  89. * Return Value: Void.
  90. *
  91. * Purpose: Catches any "F1" key presses in a help dialog widget, or
  92. * selects any of the help buttons in any of the help dialogs
  93. * dialogs.
  94. *
  95. ***************************************************************************/
  96. extern void _DtHelpCB(
  97. Widget widget,
  98. XtPointer clientData,
  99. XtPointer callData);
  100. /*****************************************************************************
  101. * Function: void _DtHelpListFree (DtHelpListStruct *pHead);
  102. *
  103. *
  104. * Parameters: pHead Specifies the head pointer to the help list.
  105. *
  106. * Return Value: Void.
  107. *
  108. * Purpose: Frees all elements in a Help List.
  109. *
  110. *****************************************************************************/
  111. extern void _DtHelpListFree(
  112. DtHelpListStruct * * pHead);
  113. /*****************************************************************************
  114. * Function: DtHelpListStruct * _DtHelpListAdd(
  115. * char *locationId,
  116. * Widget widget,
  117. * int widgetType,
  118. * DtHelpListStruct *pHead)
  119. *
  120. *
  121. * Parameters:
  122. *
  123. * Return Value: Void.
  124. *
  125. * Purpose: Adds an element to the top of the given topicList.
  126. *
  127. *****************************************************************************/
  128. extern DtHelpListStruct * _DtHelpListAdd(
  129. char *locationId,
  130. Widget widget,
  131. _DtHelpCommonHelpStuff * help,
  132. DtHelpListStruct **pHead);
  133. #endif /* _HelpAccessI_h */
  134. /* Do not add anything after this endif. */