prnmkcom.h

Go to the documentation of this file.
00001 // $Id: prnmkcom.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 // Header file for Camelots Print Marks Doc component classes
00099 
00100 /*
00101 */
00102 
00103 #ifndef INC_DOCPRINTMARKS
00104 #define INC_DOCPRINTMARKS
00105 
00106 //#include "list.h" - in camtypes.h [AUTOMATICALLY REMOVED]
00107 //#include "listitem.h" - in camtypes.h [AUTOMATICALLY REMOVED]
00108 //#include "doccomp.h" - in camtypes.h [AUTOMATICALLY REMOVED]
00109 
00110 class BaseCamelotFilter;
00111 class CXaraFileRecord;
00112 class CamelotRecordHandler;
00113 class PrintMarkItem;
00114 
00115 
00116 /********************************************************************************************
00117 
00118 >   class DocPrintMark : public ListItem
00119 
00120     Author:     Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com>
00121     Created:    31/07/96
00122     Purpose:    A document print mark item. This item references a cached print mark held
00123                 by the print mark manager
00124     SeeAlso:    PrintMarksMan, ListItem
00125 
00126 ********************************************************************************************/
00127 
00128 class DocPrintMark : public ListItem
00129 {
00130     CC_DECLARE_DYNCREATE(DocPrintMark);
00131     
00132     public:
00133          DocPrintMark();
00134          DocPrintMark(UINT32 hndle);
00135         ~DocPrintMark();
00136 
00137         inline UINT32 GetHandle() const { return Handle; }
00138 
00139     private:
00140         UINT32  Handle;     // That is all!
00141 };
00142 
00143 
00144 /********************************************************************************************
00145 
00146 >   class DocPrintMarkList : public List
00147 
00148     Author:     Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com>
00149     Created:    31/07/96
00150     Purpose:    Provide a class that will add Print mark components to new documents.
00151     SeeAlso:    DocComponentClass
00152 
00153 ********************************************************************************************/
00154 
00155 class DocPrintMarkList : public List
00156 {
00157     CC_DECLARE_DYNAMIC(DocPrintMarkList)
00158     
00159     public:
00160          DocPrintMarkList();
00161         ~DocPrintMarkList();
00162 
00163         BOOL AddMark(UINT32 handle);
00164         void RemoveMark(UINT32 handle);
00165         void RemoveAllMarks();
00166         BOOL IsVirgin() const { return Virgin; }
00167 
00168         inline DocPrintMark* GetFirstMark() const;
00169         inline DocPrintMark* GetNextMark(DocPrintMark* pItem) const;
00170 
00171         DocPrintMark* FindMark(UINT32 SearchHandle) const;
00172 
00173     private:
00174         BOOL Virgin;
00175 };
00176 
00177 
00178 /********************************************************************************************
00179 >   inline DocPrintMark* DocPrintMarkList::GetFirstMark() const
00180     inline DocPrintMark* DocPrintMarkList::GetNextMark(DocPrintMark* pItem) const
00181     Purpose - Quick inline mark access functions.
00182 ********************************************************************************************/
00183 
00184 inline DocPrintMark* DocPrintMarkList::GetFirstMark() const
00185 {
00186     return ((DocPrintMark*)GetHead());
00187 }
00188         
00189 inline DocPrintMark* DocPrintMarkList::GetNextMark(DocPrintMark* pItem) const
00190 {
00191     return ((DocPrintMark*)GetNext(pItem));
00192 }
00193 
00194 
00195 
00196 /********************************************************************************************
00197 
00198 >   class PrintMarkComponentClass : public DocComponentClass
00199 
00200     Author:     Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com>
00201     Created:    31/07/96
00202     Purpose:    The class that gets a print mark doc component going on start up
00203                 We need to register our class as a document component and this is where
00204                 we do it all.
00205     SeeAlso:    DocComponentClass
00206 
00207 ********************************************************************************************/
00208 
00209 class PrintMarkComponentClass : public DocComponentClass
00210 {
00211     CC_DECLARE_DYNAMIC(PrintMarkComponentClass)
00212 
00213     public:
00214         static BOOL Init();
00215 
00216         BOOL AddComponent(BaseDocument *);
00217 };
00218 
00219 
00220 
00221 /********************************************************************************************
00222 
00223 >   class PrintMarksComponent : public DocComponent
00224 
00225     Author:     Mike_Kenny (Xara Group Ltd) <camelotdev@xara.com>
00226     Created:    31/07/96
00227     Purpose:    An actual print mark document component. This component contains a list of
00228                 handles which refer to print marks cached by the print marks manager. On
00229                 saving, the mark handles will be resolved into physical marks which will be
00230                 exported and subsequently imported and registered.
00231     SeeAlso:    DocComponent
00232 
00233 ********************************************************************************************/
00234 
00235 class PrintMarksComponent : public DocComponent
00236 {
00237     CC_DECLARE_DYNAMIC(PrintMarksComponent)
00238 
00239     public:
00240         PrintMarksComponent();
00241         virtual ~PrintMarksComponent();
00242 
00243         BOOL AddMark(UINT32 handle);
00244         void RemoveMark(UINT32 handle);
00245         void RemoveAllMarks();
00246         BOOL IsVirgin() const;
00247         
00248                DocPrintMark* FindMark(UINT32 SearchHandle) const;
00249         inline DocPrintMark* GetFirstMark() const;
00250         inline DocPrintMark* GetNextMark(DocPrintMark* pItem) const;
00251 
00252     public:         // External V2 native file import/export handlers
00253         virtual BOOL StartImport(BaseCamelotFilter *pFilter);
00254         virtual BOOL EndImport(BaseCamelotFilter *pFilter, BOOL Success);
00255         virtual BOOL StartExport(BaseCamelotFilter *pFilter);
00256         virtual BOOL EndExport(BaseCamelotFilter *pFilter, BOOL Success);
00257 
00258         void ImportDefaultPrintMark(CXaraFileRecord* Rec);
00259         void StartImportCustomPrintMark(CamelotRecordHandler *pHandler, CXaraFileRecord* Rec);
00260         void EndImportCustomPrintMark(CamelotRecordHandler *pHandler);
00261 
00262     private:
00263         Node *CustomPreviousContext;
00264         Node *CustomCurrentContext;
00265         PrintMarkItem *pNewMark;
00266 
00267     private:        // Internal native file handlers
00268         BOOL ExportPrintMark(BaseCamelotFilter *pFilter, PrintMarkItem *pMarkItem);
00269 
00270     private:
00271         DocPrintMarkList DocMarks;
00272 };
00273 
00274 
00275 /********************************************************************************************
00276 >   inline DocPrintMark* PrintMarksComponent::GetFirstMark() const
00277     inline DocPrintMark* PrintMarksComponent::GetNextMark(DocPrintMark* pItem) const
00278     Purpose - Quick inline mark access functions.
00279 ********************************************************************************************/
00280 
00281 inline DocPrintMark* PrintMarksComponent::GetFirstMark() const
00282 {
00283     return DocMarks.GetFirstMark();
00284 }
00285 
00286 inline DocPrintMark* PrintMarksComponent::GetNextMark(DocPrintMark* pItem) const
00287 {
00288     return DocMarks.GetNextMark(pItem);
00289 }
00290 
00291 #endif

Generated on Sat Nov 10 03:46:36 2007 for Camelot by  doxygen 1.4.4