expcol.h

Go to the documentation of this file.
00001 // $Id: expcol.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 // Encapsulates a set of colours exported from a file.
00100 
00101 #ifndef INC_EXPCOL
00102 #define INC_EXPCOL
00103 
00104 //#include "list.h" - in camtypes.h [AUTOMATICALLY REMOVED]
00105 //#include "listitem.h" - in camtypes.h [AUTOMATICALLY REMOVED]
00106 //#include "colmodel.h" // PColourRGBT - in camtypes.h [AUTOMATICALLY REMOVED]
00107 
00108 class ColourListComponent;
00109 class IndexedColour;
00110 
00111 /********************************************************************************************
00112 
00113 >   class ExportColour : public ListItem
00114 
00115     Author:     Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>
00116     Created:    23/5/96
00117     Purpose:    Represents a colour object that has been saved out into the file already.
00118                 This enables any other references to the colour to be output as we have a
00119                 mechanism to remember that a colour definition has already been saved into
00120                 the file and the record number it was saved under.
00121     SeeAlso:    ColourListComponent;
00122 
00123 ********************************************************************************************/
00124 
00125 class ExportColour : public ListItem
00126 {
00127     CC_DECLARE_MEMDUMP(ExportColour)
00128 
00129 public:
00130     // Adds a newly saved colour to the list
00131     ExportColour( IndexedColour *pNewCol,  INT32 NewRecordNumber);
00132 
00133     // Adds a newly exported simple colour to the list.
00134     ExportColour( PColourRGBT *pNewRGBCol,  INT32 NewRecordNumber);
00135 
00136     // Pointer to the colour that has been exported.
00137     IndexedColour *pCol;
00138 
00139     // If it is a simple colour then pCol will be NULL and we will need to save out the RGB
00140     // colour. This will be saved in a *packed* (8-bit components) colour structure
00141     PColourRGBT SimpleRGBColour;
00142 
00143     // If saved     - this will be the record number that the colour definition is saved in
00144     // If unsaved   - this will be zero to indicate this fact
00145     INT32 RecordNumber;
00146 };
00147 
00148 /********************************************************************************************
00149 
00150 >   class ExportColourList : public List
00151 
00152     Author:     Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>
00153     Created:    23/5/96
00154     Purpose:    Holds a list of colours that have been exported when we are saving a Version
00155                 2 Native Camelot document out to file.
00156     SeeAlso:    ExportColour; 
00157 
00158 ********************************************************************************************/
00159 
00160 class ExportColourList : public List
00161 {
00162     CC_DECLARE_MEMDUMP(ExportColourList)
00163 
00164 public:
00165     ~ExportColourList();
00166 
00167 public:
00168     ExportColour *AddColour( IndexedColour *pCol,  INT32 RecordNumber); 
00169     ExportColour *AddColour( PColourRGBT *pNewRGBCol,  INT32 RecordNumber); 
00170 };
00171 
00172 /********************************************************************************************
00173 
00174 >   class ExportedColours : public CCObject
00175 
00176     Author:     Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>
00177     Created:    23/5/96
00178     Purpose:    Encapsulate the process of maintaining an list of colours already exported 
00179                 from the current document out to file.
00180     SeeAlso:    NewExportColour; ExportColourList
00181 
00182 ********************************************************************************************/
00183 
00184 class ExportedColours : public CCObject
00185 {
00186     CC_DECLARE_MEMDUMP(ExportedColours)
00187 
00188 public:
00189     ExportedColours();
00190     ~ExportedColours();
00191 
00192     // Functions to add a newly exported colour to the list.
00193     BOOL AddColour( IndexedColour *pNewCol,  INT32 RecordNumber);
00194 
00195     // Functions to add a newly exported simple colour to the list.
00196     BOOL AddColour( PColourRGBT *pNewRGBCol,  INT32 RecordNumber);
00197 
00198     // Finds if we already have this colour in the list
00199     ExportColour *GetColour( IndexedColour *pSearchCol);
00200 
00201     // Finds if we already have this simple RGB colour in the list
00202     ExportColour *GetColour( PColourRGBT *pNewRGBCol);
00203 
00204 protected:
00205     // The list of colours to add
00206     ExportColourList Colours;
00207 };
00208 
00209 
00210 #endif  // INC_EXPCOL
00211 
00212 

Generated on Sat Nov 10 03:45:07 2007 for Camelot by  doxygen 1.4.4