overlist.h

Go to the documentation of this file.
00001 // $Id: overlist.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 // Merge list item
00099 
00100 #ifndef OVERRIDELIST
00101 #define OVERRIDELIST
00102 
00103 //#include "list.h" - in camtypes.h [AUTOMATICALLY REMOVED]
00104 #include "overitem.h"   //OverrideListItem
00105 
00106 /***********************************************************************************************
00107 
00108 >   class OverrideList
00109 
00110   Author:   Graham_Walmsley (Xara Group Ltd) <camelotdev@xara.com>
00111   Created:  21/4/97
00112   Purpose:  An override list contains items that can override each other.
00113 
00114             For example, imagine we are building a list of clickable areas in
00115             an imagemap. Our list of clickable areas already contains
00116             a rectangle with bottom left corner (0,0) and top right corner (200, 200),
00117             that links to the URL "http://www.xara.com".
00118 
00119             Now we add another clickable rectangle to the imagemap. This rectangle
00120             has bottom left corner (50,50) and top right corner (100,100) and also
00121             links to "http://www.xara.com".
00122 
00123             But our first rectangle is contained within our second rectangle! There
00124             is no need for the second rectangle at all.
00125             
00126             It is clear that the first rectangle overrides the second, so the 
00127             second rectangle should not be added to the list.
00128 
00129             Now imagine the small rectangle is already in the list and the large
00130             rectangle is added.
00131 
00132             Again, the large rectangle overrides the small one. So the large 
00133             rectangle should be added to the list and the smaller rectangle
00134             should be deleted.
00135 
00136             So, this class works as follows.
00137 
00138             When an OverrideListItem is added to this list, this function compares
00139             the item with every other item in the list. 
00140             
00141             It does this by calling either the function
00142             OverrideListItem::OverrideFromAbove (if the item in the list is before
00143             the item being added) or OverrideListItem::OverrideFromBelow(if the
00144             item in the list is below the item being added).
00145 
00146             Then:
00147 
00148             a. If an item in the list overrides the item being added, then the
00149                 new item is not added to the list.
00150 
00151             b. If the item being added overrides an item in the list, then the
00152                 new item is added and the item in the list is deleted.
00153 
00154 ***********************************************************************************************/
00155 
00156 class OverrideList : public List
00157 {   
00158     CC_DECLARE_DYNAMIC( OverrideList )
00159 
00160     //Constructor
00161 public:
00162     OverrideList();
00163 
00164     //Overridden functions
00165 public:
00166     virtual void AddHead( OverrideListItem* );  
00167     virtual void AddTail( OverrideListItem* );
00168 
00169     virtual LISTPOS InsertBefore(LISTPOS here, OverrideListItem* item);
00170     virtual ListItem *InsertBefore(OverrideListItem* here, OverrideListItem* item);
00171 
00172     virtual LISTPOS InsertAfter(LISTPOS here, OverrideListItem* item);
00173     virtual ListItem *InsertAfter(OverrideListItem* here, OverrideListItem* item);
00174 
00175     //Toolkit functions
00176 protected:
00177     virtual BOOL CompareWithItemsAbove(OverrideListItem* pliStartPos, OverrideListItem* pliToInsert);
00178     virtual BOOL CompareWithItemsBelow(OverrideListItem* pliStartPos, OverrideListItem* pliToInsert);
00179 
00180 
00181 
00182 };
00183 
00184 
00185 
00186 #endif // OVERRIDELIST
00187 

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