page.h

Go to the documentation of this file.
00001 // $Id: page.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 #ifndef INC_PAGE
00100 #define INC_PAGE
00101 
00102 //#include "npaper.h" - in camtypes.h [AUTOMATICALLY REMOVED]
00103 //#include "doccolor.h" - in camtypes.h [AUTOMATICALLY REMOVED]
00104 
00105 class RenderRegion;
00106 
00107 // The LinkDirection type specifies a direction in which one page is linked to another                                
00108 enum LinkDirection { LEFT, RIGHT, TOP, BOTTOM }; 
00109 
00110 /***********************************************************************************************
00111 
00112 >   class Page : public NodeRenderablePaper
00113 
00114     Author:     Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com>
00115     Created:    25/4/93
00116     Purpose:    Represents the actual bits of paper on which the document will be printed. 
00117     SeeAlso:    NodeRenderablePaper   
00118     SeeAlso:    Chapter
00119     SeeAlso:    Spread
00120     SeeAlso:    Layer
00121     
00122 
00123 ***********************************************************************************************/
00124 
00125 class Page: public NodeRenderablePaper
00126 {   
00127     CC_DECLARE_DYNAMIC( Page ) 
00128 
00129 public:  
00130     Page(); 
00131     
00132     Page(Node* ContextNode,  
00133          AttachNodeDirection Direction,
00134          const DocRect& NewPageRect, 
00135          BOOL Locked=FALSE, 
00136          BOOL Mangled=FALSE,  
00137          BOOL Marked=FALSE, 
00138          BOOL Selected=FALSE 
00139         );   
00140               
00141     String Describe(BOOL Plural, BOOL Verbose);             
00142                    
00143     void Render( RenderRegion* pRender );
00144     
00145     const DocRect& GetPageRect(void) const; 
00146     BOOL SetPageRect(DocRect NewPageRect);      // set new size of page
00147     
00148     Page* FindNextPage(void); 
00149     Page* FindRightPage(void); 
00150     Page* FindBottomPage(void);     
00151     void CopyIntoSpread(Page* pContextPage, LinkDirection ld);      
00152     
00153     #ifdef _DEBUG                         
00154     void ShowDebugTreeDetails() const;   
00155     #endif
00156     
00157     static void SetPageColour(DocColour &NewColour); 
00158     static DocColour &GetPageColour(void);  
00159 
00160     virtual UINT32 GetNodeSize() const;             // Returns size of node in bytes
00161 
00162     
00163     virtual void GetDebugDetails(StringBase* Str);   // This is used by the Debug Tree dialog
00164                                                      // It will probably be deleted when we ship !. 
00165     
00166     // Snapping functions
00167     virtual BOOL Snap(DocCoord* pDocCoord);
00168     virtual BOOL Snap(DocRect* pDocRect,const DocCoord& PrevCoord,const DocCoord& CurCoord);
00169 
00170     // Version 2 file format functions
00171     virtual BOOL WritePreChildrenWeb(BaseCamelotFilter* pFilter);
00172     virtual BOOL WritePreChildrenNative(BaseCamelotFilter* pFilter);
00173 
00174     static DocColour PageColour; 
00175 
00176     virtual void PolyCopyNodeContents(NodeRenderable* pNodeCopy);
00177 
00178 protected:
00179     DocRect PageRect; // Pages document rectangle   
00180     virtual Node* SimpleCopy();   
00181     void CopyNodeContents(Page* NodeCopy); 
00182 
00183 private:
00184     INT32 SnapOrdinate(INT32 Lo, INT32 Hi,INT32 Src,INT32 SnapDist);
00185 
00186 };
00187 #endif
00188 

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