00001 // $Id: exagal.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 // Header file for example galleries 00099 00100 #ifndef INC_EXAGAL 00101 #define INC_EXAGAL 00102 00103 #if FALSE 00104 #include "gallery.h" 00105 00106 00107 /******************************************************************************************** 00108 00109 > class ExampleGallery : public Gallery 00110 00111 Author: Alex_Bligh (Xara Group Ltd) <camelotdev@xara.com> 00112 Created: 22/06/1994 00113 Purpose: Class for handling an example GalleryBarOp 00114 00115 Notes: This provides a very basic example to get you started on galleries. 00116 However, it is recommended that you use the colour gallery as a more 00117 advanced example, and if you are basing your code on anything, then 00118 it is probably easier to rip functionality out of a cloned ColourGallery 00119 than to add the desired functionality to the ExampleGallery. 00120 00121 ********************************************************************************************/ 00122 00123 class ExampleGallery : public Gallery 00124 { 00125 CC_DECLARE_DYNCREATE( ExampleGallery ) 00126 00127 public: 00128 ExampleGallery(); 00129 00130 MsgResult Message(Msg* Message); 00131 00132 00133 protected: // Base<->Derived class interface 00134 BOOL PreCreate(void); 00135 BOOL PostCreate(void); 00136 // Initialise display-related stuff before/after the window is created 00137 00138 BOOL DoRedrawAnItem(ListItem *Item, BOOL Large, UINT32 DisplayMode); 00139 // Redraws the given item appropriately for large/small mode, and 00140 // using the given derived class DisplayMode (see DoDisplayMode... below) 00141 // returns TRUE if it redrew successfully 00142 00143 BOOL PrepareToDelete(void); 00144 // returns TRUE if the selection can be deleted, or FALSE if not 00145 // May alter the selection as appropriate (after getting user confirmation) 00146 00147 BOOL DoDeleteSelection(void); 00148 // Force-deletes anything still remaining in the selection 00149 // returns TRUE if successful 00150 00151 ListItem *DoCreateNewItem(ListItem *BasedOn); 00152 // Applies the appropriate action to create a new item, based upon 00153 // the 'BasedOn' item or the attribs of the document selection in some way 00154 // Returns NULL, or the new item 00155 00156 void DoApplyItem(ListItem *ItemToApply); 00157 // Applies the appropriate action to apply the given item to the document 00158 00159 BOOL DoRedefineItem(ListItem *ItemToRedefine); 00160 // Redefines the given item (allow the user to edit it for example) 00161 // Returns FALSE if the value of the item definitely has not changed 00162 // Returns TRUE if the item has changed, or if it is unknown whether it was changed 00163 00164 StringBase *GetItemText(ListItem *TheItem); 00165 // Returns NULL, or a pointer to the text to use in the listbox. 00166 // This is an early development aid while we're waiting for the advent 00167 // of proper user-redraw. 00168 00169 void SortModeHasBeenChanged(BOOL SetDerivedSortsToo); 00170 // Called when the display dialogue has set a new sort mode, to make the 00171 // Gallery (and related entities) redisplay its list in the new order. 00172 // Note that the base class method for this MUST be calleded in derivations 00173 00174 BOOL DoSetDisplayModes(GalleryDisplayDlg *TheDialogue); 00175 // Called to set up the display mode combo box (large icons, full info etc) 00176 // This will call TheDialogue->SetDisplayModeName repeatedly to set all 00177 // available modes. Returns FALSE if there are no display modes. 00178 00179 void DoDisplayModeChange(UINT32 NewDisplayMode); 00180 // Called when the user has chosen a display mode, with the index of the 00181 // mode in the given list. You should not need to take action here, as 00182 // the display mode is passed through to RedrawAnItem, but this is called 00183 // in case you wish to cache values before redraw... 00184 00185 void DoShowMenu(void); 00186 // Pops up the Gallery menu 00187 // Menu choices will be handled by the derived class through the Ops system 00188 // or message handlers - the base class knows nothing of this process. 00189 00190 BOOL SetAlsoButton(String_64 *TextToPutIn); 00191 // Called to set up the generic Gallery Display dialogue 00192 // Returns FALSE if no 'also set the sort mode for the xxxx' button is wanted 00193 // Returns TRUE, and fills in the text with an appropriate string if 00194 // a button is wanted. See the ColourGallery for an example. 00195 }; 00196 00197 00198 00199 /******************************************************************************************** 00200 00201 > class ExampleGalleryBarOpCreate : public BarCreate 00202 00203 Author: Alex_Bligh (Xara Group Ltd) <camelotdev@xara.com> 00204 Created: 22/06/1994 00205 Purpose: Class for creating ExampleGalleryBarOps. 00206 00207 ********************************************************************************************/ 00208 00209 class ExampleGalleryCreate : public BarCreate 00210 { 00211 public: 00212 DialogBarOp* Create() { return (new ExampleGallery); } 00213 }; 00214 00215 #endif 00216 00217 #endif // INC_EXAGAL 00218 00219