selstate.h

Go to the documentation of this file.
00001 // $Id: selstate.h 751 2006-03-31 15:43: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 // Declaration of the following classes:
00100 /*
00101     
00102         SelectionState 
00103         SelNdRng
00104         SelNd
00105 */ 
00106 
00107 // Check in comments
00108 /*
00109 */         
00110       
00111 #ifndef INC_SELSTATE
00112 #define INC_SELSTATE
00113 
00114 class Node;
00115 
00116 /********************************************************************************************
00117 
00118 >   class SelNdRng
00119 
00120     Author:     Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com>
00121     Created:    12/10/93
00122     Purpose:    SelNdRng objects are stored in an array within SelectionState objects, they 
00123                 record a range of upto 255 contiguous nodes as being selected.  
00124     SeeAlso:    SelectionState      
00125 
00126 ********************************************************************************************/
00127 
00128 class SelNdRng : public CC_CLASS_MEMDUMP
00129 {
00130 CC_DECLARE_MEMDUMP(SelNdRng);
00131 
00132 public:
00133     Node* FirstNode;        // First selected node in a contiguous range of selected nodes
00134     BYTE NumSelected;        // Number of selected nodes including first (Max 255) 
00135                              // Stored as a byte to minimise space. If there are >  
00136                              // 255 selected nodes then > 1 SelNdRng should be created.     
00137 };        
00138 
00139 /********************************************************************************************
00140 
00141 >   class SelectionState
00142 
00143     Author:     Simon_Maneggio (Xara Group Ltd) <camelotdev@xara.com>
00144     Created:    12/10/93
00145     Purpose:    Used to record and restore all selections in the Camelot tree. 
00146                  
00147     SeeAlso:    -
00148 
00149 ********************************************************************************************/
00150 
00151 class SelectionState : public CC_CLASS_MEMDUMP
00152 {
00153 CC_DECLARE_MEMDUMP(SelectionState);
00154 
00155 public:  
00156     SelectionState(); 
00157     BOOL Record();                               // Records the current selected state
00158     void Restore(BOOL RestoreSelBlobs = FALSE, BOOL RemoveBlobs = TRUE); // Restores the recorded selected state   
00159     ~SelectionState();                           // Deletes lists 
00160     UINT32 GetSize();                            // For finding the size of the Selection
00161                                                  // state in bytes
00162     BOOL operator==(SelectionState& SelState);   // Compares this SelectionState with another to determine
00163                                                  // if they are the same. 
00164 
00165     SelNdRng* GetSelectionList();              // Diccon 9/99 access functions
00166     UINT32 GetNumRanges();
00167     Node** GetNodeList();                       
00168     UINT32 GetNumNodes();                         
00169 private:    
00170     // Funcs called from Restore() to ensure every single node in the selected spread is deselected.
00171     void DeselectAll(BOOL RemoveBlobs = TRUE);
00172     void DeselectAll(Node* pNode);
00173 
00174     // When Record() is invoked all selected nodes will be recorded on either the SelNdRng 
00175     // list, or the SelNdLst. If a node is contiguous with other selected nodes then it 
00176     // will be stored on the SelNdRngList (Therby reducing the amount of storage required for 
00177     // recording selected nodes). Otherwise the node is stored on the SelNdLst. 
00178     
00179     UINT32 NumNdRng;          // The number of SelNdRng items in the SelNdRngList
00180     UINT32 NumNd;             // The number of Node* items in the SelNdList
00181     SelNdRng* SelNdRngList;   // An array of node ranges 
00182     Node** SelNdList;         // An array of pointers to nodes in the selection 
00183 }; 
00184 
00185 
00186 #endif

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