00001 // $Id: collist.h 1282 2006-06-09 09:46: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 // collist.h - the ColourList class 00100 00101 00102 #ifndef INC_COLLIST 00103 #define INC_COLLIST 00104 00105 //#include "errors.h" - in camtypes.h [AUTOMATICALLY REMOVED] 00106 //#include "list.h" - in camtypes.h [AUTOMATICALLY REMOVED] 00107 00108 class BaseDocument; 00109 00110 class IndexedColour; 00111 class Document; 00112 00113 00114 00115 /*********************************************************************************************** 00116 00117 > class ColourList : public List 00118 00119 Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> 00120 Purpose: A colour list is held by each document to store the list of available 00121 IndexedColours for use by that document. (This colour list is displayed 00122 in the ColourBar/ColourGallery via the ColGalDisplayList which references 00123 colours held in the ColourList). 00124 00125 The ColourList also provides a couple of special access methods for 00126 determining the number of visible/undeleted colours in the document 00127 (deleted colours are still held in this list, but are marked deleted 00128 for undo purposes - if scanning the ColourList, remember to check 00129 IndexedColours IsDeleted() flag) -- See the Undeleted list operators 00130 provided by this class to save you loads of effort. 00131 00132 The Colour list also includes another simple List of unnamed colours 00133 which are used for local colour attributes in a document. Unnamed 00134 colours are simply stored in this list, and are simpler than named 00135 colours... 00136 00137 SeeAlso: IndexedColour; ColGalDisplayList; BaseDocument; List 00138 00139 ***********************************************************************************************/ 00140 00141 class ColourList : public List 00142 { 00143 CC_DECLARE_MEMDUMP(ColourList) 00144 00145 public: // Construction/Initialisation 00146 ColourList(); 00147 ~ColourList(); 00148 00149 void Init(BaseDocument *ParentDocument); 00150 00151 public: // Overridden List interface 00152 void AddHead(ListItem *); // Overridden List members: You MUST use AddItem 00153 void AddTail(ListItem *); 00154 00155 BOOL AddItem(IndexedColour *NewColour); // Add a colour, ensuring it has a unique name 00156 00157 00158 // Overrides (well, they would be if the base class had made these virtual!) which call 00159 // the base class after first ensuring the name is unique 00160 LISTPOS InsertBefore(LISTPOS here, ListItem* item); 00161 ListItem *InsertBefore(ListItem* here, ListItem* item); 00162 00163 LISTPOS InsertAfter(LISTPOS here, ListItem* item); 00164 ListItem *InsertAfter(ListItem* here, ListItem* item); 00165 00166 // Override DeleteAll to do safe deletion of linked colours 00167 virtual void DeleteAll(); 00168 00169 00170 public: // Special ColourList listy methods 00171 UINT32 GetUndeletedCount(void); 00172 IndexedColour *FindUndeletedItem(INT32 Index); 00173 IndexedColour *GetUndeletedHead(void); 00174 IndexedColour *GetUndeletedNext(IndexedColour *ThisItem); 00175 // Count/Find/Head/Next functions which ignore 'deleted' IndexedColours 00176 00177 inline BaseDocument *GetParentDocument(void); 00178 // Find the document in which this colour list resides 00179 00180 private: 00181 BaseDocument *ParentDoc; 00182 00183 public: // Special linking inheritance support 00184 IndexedColour **CompileInheritanceArray(IndexedColour *Parent); 00185 // Compiles a NULL-terminated array of pointers to all colours which are linked 00186 // to this, both directly and indirectly (i.e. an array listing the entire 00187 // inheritance 'subtree' from (and including) 'Parent') 00188 00189 void RemoveLinksToColour(IndexedColour *DeadColour); 00190 // Ensures no other colours have this colour as a linked parent 00191 00192 BOOL IsColourInUseInDoc(IndexedColour *TheColour, BOOL IgnoreColourGallery = FALSE); 00193 // Determines if a colour is used in the document either directly (DocColour Ref) 00194 // or indirectly (parent/ancestor of a linked/tint colour which is used in the doc) 00195 00196 void InvalidateInheritanceCache(void); 00197 // Invalidates the cached results of the above function 00198 00199 private: // Private variables for inheritance support 00200 IndexedColour *ArrayParent; // Current parent of the cached array 00201 IndexedColour **InheritanceArray; // Cached array of all offspring of ArrayParent 00202 00203 public: // Named colour support 00204 BOOL NamedColourExists( PCTSTR pName ); 00205 BOOL NamedColourExists(const StringBase *pName); 00206 // Returns TRUE if the given name is in use by any item in this colour list 00207 00208 BOOL GenerateUniqueColourName(const StringBase *pPrefix, String_64 *pResult); 00209 // Outputs a name (Based on pPrefix) that is unique in this ColourList 00210 // Returns TRUE if the output name is different from the pPrefix string 00211 00212 private: // Private data for named colour support 00213 INT32 LastUnnamedColour; // Kept to optimise unnamed colour naming 00214 00215 public: // Unnamed colour storage support 00216 inline List *GetUnnamedColours(void); 00217 00218 private: // Private data for unnamed colours 00219 List UnnamedColours; 00220 }; 00221 00222 00223 00224 /********************************************************************************************** 00225 00226 > inline BaseDocument *ColourList::GetParentDocument(void) 00227 00228 Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> 00229 Created: 7/11/94 00230 Returns: The document in which this colour list resides 00231 Purpose: To find the parent document of this colour list 00232 00233 **********************************************************************************************/ 00234 00235 BaseDocument *ColourList::GetParentDocument(void) 00236 { 00237 ERROR3IF(ParentDoc == NULL, "Uninitialised ColourList detected!"); 00238 return(ParentDoc); 00239 } 00240 00241 00242 00243 /********************************************************************************************** 00244 00245 > inline List *ColourList::GetUnnamedColours(void) 00246 00247 Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> 00248 Created: 7/3/95 00249 Returns: The storage-list containing this document's unnamed colours 00250 Purpose: To find the unnamed colours for this document 00251 00252 **********************************************************************************************/ 00253 00254 List *ColourList::GetUnnamedColours(void) 00255 { 00256 return(&UnnamedColours); 00257 } 00258 00259 00260 #endif 00261