00001 // $Id: menuitem.h 751 2006-03-31 15:43:49Z alex $ 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 * */ 00101 00102 #ifndef INC_MENUITEM 00103 #define INC_MENUITEM 00104 00105 #include "cmdctrl.h" 00106 00107 /******************************************************************************************** 00108 > class OpMenuParam 00109 00110 Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> 00111 Created: 11/20/2004 00112 00113 Purpose: Contain all the info transferred from the menu UI to Ops 00114 00115 SeeAlso: Operation::DoWithParam 00116 00117 ********************************************************************************************/ 00118 00119 class OpMenuParam : public OpParam 00120 { 00121 CC_DECLARE_DYNAMIC(OpMenuParam) 00122 00123 public: 00124 OpMenuParam() : OpParam() 00125 { 00126 strOpUnique = String( _T("") ); 00127 strMenuText = String( _T("") ); 00128 strMenuPath = String( _T("") ); 00129 } 00130 00131 // Properties 00132 public: 00133 String_256 strOpUnique; 00134 String_64 strMenuText; 00135 String_256 strMenuPath; 00136 00137 // Working vars 00138 private: 00139 }; 00140 00141 00142 00143 00144 /******************************************************************************************** 00145 00146 > Class MenuItem : public Control 00147 00148 Author: Mario_Shamtani (Xara Group Ltd) <camelotdev@xara.com> 00149 Created: 16/6/93 00150 Purpose: 00151 MenuItems are the things that appear in menus, but in camelot they are also the menus 00152 themselves. The idea is that the menu system is a dynamically growing, living-thing 00153 where all the elements are connected in a tree like structure. The elements of the 00154 menu system or the nodes in the tree are MenuItems. MenuItems can therefore be 00155 simple or composite i.e. a menu option or a sub menu. In windows there is a third 00156 type of MenuItem: the separator, in our new improved menuing system separators will 00157 not be modelled as MenuItems. Instead a MenuItem may be specified as having a menu 00158 separator following it. 00159 Errors: None yet. 00160 SeeAlso: Control 00161 00162 ********************************************************************************************/ 00163 00164 class CCAPI MenuItem : public CmdControl 00165 { 00166 00167 friend void UpdateWinMenu( CNativeMenu* pMenu, MenuItem* kernelMenu ); 00168 00169 CC_DECLARE_MEMDUMP(MenuItem); 00170 00171 public: 00172 virtual void PerformAction(); 00173 00174 private: 00175 00176 UINT32 ParentMenuId; 00177 List* SubMenuItems; 00178 String_256 Description; 00179 BOOL FollowedBySeparator; 00180 UINT32 m_nSelectedBitmapID; 00181 UINT32 m_nUnselectedBitmapID; 00182 OpMenuParam* pMenuParam; 00183 00184 public: 00185 00186 MenuItem() 00187 : ParentMenuId(0), SubMenuItems(0), FollowedBySeparator(FALSE), 00188 m_nSelectedBitmapID(0), m_nUnselectedBitmapID(0), pMenuParam(0) 00189 { /* empty */ } 00190 00191 // new prototype, requires OpDescriptor only (almost) 00192 MenuItem( 00193 UINT32 parentMenuID, 00194 OpDescriptor* Owner, 00195 BOOL separator = FALSE 00196 ); 00197 00198 // new prototype for group MenuItem 00199 MenuItem( const String_256& description, 00200 UINT32 parentMenuID = 0, 00201 BOOL separator = FALSE 00202 ); 00203 00204 ~MenuItem(); 00205 00206 BOOL IsMenuItemGroup(); 00207 BOOL IsFollowedBySeparator(); 00208 BOOL IsCheckable(); 00209 BOOL SetIsFollowedBySeparator(BOOL NewValue); 00210 00211 BOOL UpdateControlState(BOOL AppendHotKeyName = TRUE); 00212 BOOL UpdateMenuState(BOOL AppendHotKeyNames = TRUE); 00213 00214 UINT32 GetMenuId(); 00215 UINT32 GetMenuItemParentId(); 00216 UINT32 GetHelpId(); 00217 String_256 GetMenuText(); 00218 String_256* GetMenuDesc(); 00219 String_32* GetOpToken(); 00220 void SetMenuText(const String_256& strNewText) {Description=strNewText;} 00221 void SetMenuParam(OpMenuParam* pNewParam) {pMenuParam=pNewParam;} 00222 00223 UINT32 GetMenuSelectedBitmapID(); 00224 UINT32 GetMenuUnselectedBitmapID(); 00225 00226 MenuItem* GetFirstMenuItem(); 00227 MenuItem* GetNextMenuItem(MenuItem* curItem); 00228 00229 BOOL AddMenuItem(MenuItem *newItem); 00230 MenuItem* RemoveMenuItem(MenuItem* Item); 00231 00232 static UINT32 AutomaticMenuID; 00233 static UINT32 GetNextAutomaticMenuID(); 00234 static UINT32 GetAutomaticIDState(); 00235 static BOOL SetAutomaticIDState(UINT32 newvalue); 00236 00237 static const OpState DefaultMenuState; 00238 00239 private: 00240 void PopulateMenuParam(); 00241 00242 }; 00243 00244 #endif