linecomp.h

Go to the documentation of this file.
00001 // $Id: linecomp.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 // Line Component class implementation - abstract sort-of base class from 
00100 // which to derive line components like strokes, brushes.
00101 
00102 #ifndef INC_LINECOMP
00103 #define INC_LINECOMP
00104 
00105 
00106 //#include "doccomp.h" - in camtypes.h [AUTOMATICALLY REMOVED]
00107 //#include "camfiltr.h" - in camtypes.h [AUTOMATICALLY REMOVED]
00108 #include "linedef.h"
00109 class LineDefinition;
00110 class BaseCamelotFilter;
00111 class CXaraFileRecord;
00112 class CamelotRecordHandler;
00113 class Node;
00114 
00115 
00116 /* NOTES:
00117 This superclass was created so that both the old vector stroking system and the new brush system
00118 could be stored and retrieved in an identical manner.  Unfortunately the StrokeComponent class
00119 was written making extensive use of friend classes calling static functions, this did not lend 
00120 itself particularly well to inheritance so what we currently have is a load of functions in the 
00121 LineComponent class which are ripped from StrokeComponent, however the Brush component is the only
00122 one that makes use of them as all the stroke code is in place with these static functions.
00123 If I have time to rework the stroke component code then I will try to sort this out. */
00124 
00125 /********************************************************************************************
00126 
00127 >   typedef UINT32 LineHandle;
00128 
00129     Author:     Diccon_Yamanaka (Xara Group Ltd) <camelotdev@xara.com>
00130     Created:    13/12/99
00131 
00132     Purpose:    A LineHandle is an ID that is used to identify each line in the m_pLineArray.
00133                 This saves having lots of pointers hanging around.
00134 
00135     SeeAlso:    BrushComponent; BrushDefinition
00136 
00137 ********************************************************************************************/
00138 
00139 typedef UINT32 LineHandle;
00140 
00141 const LineHandle LineHandle_NoLine = 0xffffffff;
00142 
00143 
00144 /********************************************************************************************
00145 
00146 >   class LineComponent : public DocComponent
00147 
00148     Author:     Jason_Williams (Xara Group Ltd) <camelotdev@xara.com>
00149     Created:    22/2/97
00150 
00151     Purpose:    A document component for handling Line definitions.
00152 
00153                 LineComponents share a global cache of available Line types.
00154                 Individual instances serve as managers for the list, mainly providing
00155                 import/export facilities for Line definitions.
00156 
00157     SeeAlso:    DocComponent
00158 
00159 ********************************************************************************************/
00160 
00161 class LineComponent : public DocComponent
00162 {
00163     CC_DECLARE_DYNAMIC(LineComponent)
00164 
00165 public:
00166     LineComponent();
00167     virtual ~LineComponent();
00168 
00169     // must be static as it is called after all the documents are deleted
00170     static void DeleteList(void) { DeleteLineList();}   
00171 protected:      // Internal functions 
00172     static void DeleteLineList(void);
00173                 // One-time deinitialisation, called on exit
00174 
00175 public:
00176     virtual LineHandle AddNewItem(LineDefinition *pLine, BOOL AskName = FALSE);
00177                 // Add a new Line definition to the global list
00178 
00179     virtual LineDefinition *FindDefinition(UINT32 Handle, BOOL Dummy = FALSE);
00180                 // Finds the definition of a given Line
00181 
00182     UINT32    GetNumberOfLines() { return m_Used;}
00183 public:         // External V2 native file import/export handlers
00184     virtual BOOL StartImport(BaseCamelotFilter *pFilter);
00185     virtual BOOL EndImport(BaseCamelotFilter *pFilter, BOOL Success);
00186     
00187     // Start export must be overridden in the base class as it needs to
00188     // write out the TAG specific to the line being exported
00189     virtual BOOL StartExport(BaseCamelotFilter *pFilter) = 0;
00190     
00191     virtual BOOL EndExport(BaseCamelotFilter *pFilter, BOOL Success);
00192 
00193 
00194 public:         // Internal file format handlers - called from our RecordHandler in strkattr.cpp
00195     
00196     // Start import line is provided here as it is merely concerned with setting up the spread 
00197     //to house the ink objects
00198     static BOOL StartImportLine(CamelotRecordHandler *pHandler, CXaraFileRecord *pRecord);
00199 
00200     // End import line must be overriden as it must create an instance of the line definition
00201     BOOL EndImportLine(CamelotRecordHandler *pHandler) {return TRUE;}
00202     
00203 
00204     LineHandle FindImportedLine(UINT32 ImportedHandle);
00205                 // Finds the internal handle of the Line definition with the given imported handle
00206 
00207     virtual BOOL ExportLine(BaseCamelotFilter *pFilter, LineHandle Handle) = 0;
00208                 // Exports a Line definition (if necessary) - must be overridden
00209 
00210     virtual BOOL        NameIsUnique(const String_32& NameString);
00211                 // checks the definitions to see if this name is unique
00212 
00213     virtual String_32   GetUniqueName(String_32* pName = NULL) = 0;  
00214 
00215 protected:          // Global Line list & management functions, must be overridden
00216     virtual BOOL ExpandArray(void) = 0;
00217 
00218 protected:
00219     static LineDefinition ** m_pLineArray;  // Global array of available Line definitions
00220     static UINT32 m_CurrentSize;                // Number of entries allocated to the array
00221     static UINT32 m_Used;                       // Number of entries used in the array (index of 1st free slot)
00222 
00223 protected:          // Import records
00224     static UINT32 m_ImportHandle;               // Record the data associated with the record currently 
00225     static UINT32 m_ImportFlags;                // being imported
00226     static UINT32 m_ImportData1;
00227     static UINT32 m_ImportData2;
00228     static InsertTreeContext *m_pImportPreviousContext;
00229     static Node  *m_pImportNewLine;
00230     static String_32 m_ImportedName;
00231 };
00232 
00233 
00234 #endif

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