00001 // $Id: helpuser.h 1729 2006-08-30 12:48:48Z luke $ 00002 /* @@tag:xara-cn@@ DO NOT MODIFY THIS LINE 00003 ================================XARAHEADERSTART=========================== 00004 00005 Xara LX, a vector drawing and manipulation program. 00006 Copyright (C) 1993-2006 Xara Group Ltd. 00007 Copyright on certain contributions may be held in joint with their 00008 respective authors. See AUTHORS file for details. 00009 00010 LICENSE TO USE AND MODIFY SOFTWARE 00011 ---------------------------------- 00012 00013 This file is part of Xara LX. 00014 00015 Xara LX is free software; you can redistribute it and/or modify it 00016 under the terms of the GNU General Public License version 2 as published 00017 by the Free Software Foundation. 00018 00019 Xara LX and its component source files are distributed in the hope 00020 that it will be useful, but WITHOUT ANY WARRANTY; without even the 00021 implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 00022 See the GNU General Public License for more details. 00023 00024 You should have received a copy of the GNU General Public License along 00025 with Xara LX (see the file GPL in the root directory of the 00026 distribution); if not, write to the Free Software Foundation, Inc., 51 00027 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 00028 00029 00030 ADDITIONAL RIGHTS 00031 ----------------- 00032 00033 Conditional upon your continuing compliance with the GNU General Public 00034 License described above, Xara Group Ltd grants to you certain additional 00035 rights. 00036 00037 The additional rights are to use, modify, and distribute the software 00038 together with the wxWidgets library, the wxXtra library, and the "CDraw" 00039 library and any other such library that any version of Xara LX relased 00040 by Xara Group Ltd requires in order to compile and execute, including 00041 the static linking of that library to XaraLX. In the case of the 00042 "CDraw" library, you may satisfy obligation under the GNU General Public 00043 License to provide source code by providing a binary copy of the library 00044 concerned and a copy of the license accompanying it. 00045 00046 Nothing in this section restricts any of the rights you have under 00047 the GNU General Public License. 00048 00049 00050 SCOPE OF LICENSE 00051 ---------------- 00052 00053 This license applies to this program (XaraLX) and its constituent source 00054 files only, and does not necessarily apply to other Xara products which may 00055 in part share the same code base, and are subject to their own licensing 00056 terms. 00057 00058 This license does not apply to files in the wxXtra directory, which 00059 are built into a separate library, and are subject to the wxWindows 00060 license contained within that directory in the file "WXXTRA-LICENSE". 00061 00062 This license does not apply to the binary libraries (if any) within 00063 the "libs" directory, which are subject to a separate license contained 00064 within that directory in the file "LIBS-LICENSE". 00065 00066 00067 ARRANGEMENTS FOR CONTRIBUTION OF MODIFICATIONS 00068 ---------------------------------------------- 00069 00070 Subject to the terms of the GNU Public License (see above), you are 00071 free to do whatever you like with your modifications. However, you may 00072 (at your option) wish contribute them to Xara's source tree. You can 00073 find details of how to do this at: 00074 http://www.xaraxtreme.org/developers/ 00075 00076 Prior to contributing your modifications, you will need to complete our 00077 contributor agreement. This can be found at: 00078 http://www.xaraxtreme.org/developers/contribute/ 00079 00080 Please note that Xara will not accept modifications which modify any of 00081 the text between the start and end of this header (marked 00082 XARAHEADERSTART and XARAHEADEREND). 00083 00084 00085 MARKS 00086 ----- 00087 00088 Xara, Xara LX, Xara X, Xara X/Xtreme, Xara Xtreme, the Xtreme and Xara 00089 designs are registered or unregistered trademarks, design-marks, and/or 00090 service marks of Xara Group Ltd. All rights in these marks are reserved. 00091 00092 00093 Xara Group Ltd, Gaddesden Place, Hemel Hempstead, HP2 6EX, UK. 00094 http://www.xara.com/ 00095 00096 =================================XARAHEADEREND============================ 00097 */ 00098 /* 00099 00100 helpuser.h 00101 00102 Routines for running the user help system. 00103 */ 00104 00105 #ifndef HELPUSER_H 00106 #define HELPUSER_H 00107 00108 // Forward references. 00109 class DialogOp; 00110 class CDialog; 00111 class OpDescriptor; 00112 00113 // These overloaded functions are passed various Camelot objects to provide user help on. 00114 // Each version knows how to associate a help topic index with the given object. 00115 BOOL HelpUser(const DialogOp& dlgop); 00116 BOOL HelpUser(const wxDialog& dlg); 00117 BOOL HelpUser(const OpDescriptor& opdesc); 00118 BOOL HelpUser(UINT32 nMessageID); 00119 BOOL HelpUserPropertyPage(UINT32 PageID); 00120 BOOL HelpUserTopic(DWORD dwHelpIndex); 00121 00122 // Unfortunately, there are a few cases where it isn't possible to associate an object type 00123 // with a help topic, such as the Print Setup dialog. We use this bodgy "direct-access" 00124 // function for those tricky cases. 00125 BOOL _HelpUser(LPCTSTR lpcszClassName, UINT32 nSubTopic = 0); 00126 00127 // These functions run the help system and display the appropriate topic. 00128 BOOL HelpContents(); 00129 BOOL HelpUsingHelp(); 00130 BOOL HelpUsingTools(); 00131 BOOL HelpUsingGalleries(); 00132 BOOL HelpOnlineDemos(); 00133 BOOL HelpTechnicalSupport(); 00134 00135 // This displays the special Xara Studio info helpfile in the viewer build. 00136 #ifdef STANDALONE 00137 BOOL ShowHelpSpec(); 00138 #endif 00139 00140 // This function determines if help is available to the user for the given message. 00141 BOOL CanHelpUser(UINT32 nMessageID); 00142 00143 // This is a "bodgy" function called by the String class MakeMsg function. Many error 00144 // and warning boxes require parameter substitution in their message strings. This 00145 // function records the help context of the last string resource passed to MakeMsg, 00146 // usually this will be the key for context-sensitive help. 00147 void SetNextMsgHelpContext(UINT32 nMessageID); 00148 // Andy Hills, 22-11-00 00149 // We also need a 'get' function for a 'bodge-on-top-of-a-bodge' 00150 UINT32 GetNextMsgHelpContext(); 00151 00152 // These are called on program startup and shutdown. You can leave 'em alone, otherwise. 00153 BOOL InitUserHelp(); 00154 BOOL DeInitUserHelp(); 00155 00156 #endif // !HELPUSER_H