bmplist.h

Go to the documentation of this file.
00001 // $Id: bmplist.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 // kernel class to encompass bitmaps lists
00100 
00101 #ifndef INC_BMPLIST
00102 #define INC_BMPLIST
00103 
00104 #include "list.h"
00105 #include "msg.h"
00106 #include "ops.h"
00107 
00108 class OILBitmap;
00109 class BitmapList;
00110 class Document;
00111 class KernelBitmap;
00112 class KernelBitmapRef;
00113 class Node;
00114 class Operation;
00115 class Action;
00116 
00117 /***********************************************************************************************
00118 
00119 >   class GreyscaleBitmapList : public List
00120 
00121     Author:     Will_Cowling (Xara Group Ltd) <camelotdev@xara.com>
00122     Purpose:    A list of Greyscale bitmaps
00123     SeeAlso:    -
00124 
00125 ***********************************************************************************************/
00126 
00127 /*class GreyscaleBitmapList : public List
00128 {
00129     CC_DECLARE_MEMDUMP(GreyscaleBitmapList)
00130 
00131 public:
00132     GreyscaleBitmapList();
00133     ~GreyscaleBitmapList();
00134 
00135     static BOOL Init();
00136     static BOOL DeInit();
00137 
00138     BOOL AddItem(OILBitmap *NewBitmap);
00139 
00140     virtual void AddHead( ListItem* );  
00141     virtual void AddTail( ListItem* );
00142 
00143     virtual ListItem* RemoveHead();                         
00144     virtual ListItem* RemoveTail(); 
00145     
00146     virtual ListItem* RemoveItem(ListItem* Item);
00147 
00148     virtual LISTPOS InsertBefore(LISTPOS here, ListItem* item);
00149     virtual ListItem *InsertBefore(ListItem* here, ListItem* item);
00150 
00151     virtual LISTPOS InsertAfter(LISTPOS here, ListItem* item);
00152     virtual ListItem *InsertAfter(ListItem* here, ListItem* item);
00153 
00154     INT32 GetCurrentGreyscaleSize();
00155 
00156     void SetMaxGreyscaleSize(INT32);
00157     INT32 GetMaxGreyscaleSize();
00158 
00159 #ifdef _DEBUG
00160     void DumpGreyscaleBitmapListToTrace();
00161 #endif
00162 
00163 protected:
00164     void CheckSizeIsOk();
00165 
00166 protected:
00167     static INT32 m_lMaxSize;
00168 
00169 private:
00170     INT32 m_CurrentSize;
00171 
00172 };
00173 */
00174 
00175 /***********************************************************************************************
00176 
00177 >   class GlobalBitmapList : public List
00178 
00179     Author:     Will_Cowling (Xara Group Ltd) <camelotdev@xara.com>
00180     Purpose:    A list of all the OIL Bitmaps available in the application
00181     SeeAlso:    -
00182 
00183 ***********************************************************************************************/
00184 
00185 class GlobalBitmapList : public List
00186 {
00187     CC_DECLARE_MEMDUMP(GlobalBitmapList)
00188 
00189 public:
00190     GlobalBitmapList();
00191     ~GlobalBitmapList();
00192 
00193     static BOOL Init();
00194     static BOOL DeInit();
00195 
00196 public:
00197     BOOL AddItem(OILBitmap *NewBitmap);
00198 
00199     void MakeNameUnique(String_256*);
00200 
00201     // Functions to iterate through the bitmaps
00202     ListItem* GetFirstBitmapName(String_256*);
00203     ListItem* GetNextBitmapName(ListItem*, String_256*);
00204 
00205     // Find a bitmap with a given name
00206     OILBitmap* GetBitmapFromName(String_256*);
00207 
00208     // Check to see if the bitmap exists already
00209     OILBitmap* FindDuplicateBitmap(OILBitmap* pBitmap);
00210 
00211     void DeleteAllUnusedBitmaps();
00212     BOOL IsBitmapOnClipBoard(OILBitmap* pOILBmp);
00213     BOOL IsUsedInDocument(Document * pDoc, OILBitmap* pOILBmp);
00214 
00215     // Functions to find statistics about the bitmap system
00216     INT32 GetDocumentBitmapCount(Document* pDoc);
00217     INT32 GetDocumentBitmapSize(Document* pDoc);
00218 
00219 //  GreyscaleBitmapList* GetGreyscaleBitmapList();
00220 
00221 #ifdef _DEBUG
00222     void DumpGlobalBitmapListToTrace();
00223 #endif
00224 
00225 protected:
00226 //  GreyscaleBitmapList GreyscaleBitmaps;
00227 };
00228 
00229 
00230 /********************************************************************************************
00231 
00232 >   class BitmapListChangedMsg: public Msg
00233 
00234     Author:     Will_Cowling (Xara Group Ltd) <camelotdev@xara.com>
00235     Created:    8/8/94
00236     Purpose:    This message is sent whenever the document bitmap list changes in some way.
00237     SeeAlso:    -
00238 
00239 ********************************************************************************************/
00240 
00241 class BitmapListChangedMsg: public Msg
00242 {
00243     CC_DECLARE_DYNAMIC(BitmapListChangedMsg);
00244 
00245 public:
00246     // BitmapList changing messages are sent on these events.
00247     enum BitmapListState
00248     {
00249         SELECTNEWBITMAP,            // Sent when a new bitmap has been added to the list and
00250                                     // this new bitmap should be the new selection in the
00251                                     // bitmap gallery.
00252         LISTCHANGED,                // Sent when the list has changed. This is the default message.
00253     };
00254 
00255     BitmapList* pChangedBmpList;    // The bitmap list being changed
00256     KernelBitmap* pNewBitmap;       // The new bitmap added
00257     BitmapListState  State;         // The message specifics, as enumerated above
00258 
00259     // Default message, just saying the bitmap list has changed and so update anything that
00260     // relies on it
00261     BitmapListChangedMsg(BitmapList* pList):
00262         pChangedBmpList(pList), pNewBitmap(NULL), State(LISTCHANGED)    { } 
00263     
00264     // New message where a new bitmap has been added and this should become the new selection.
00265     // At present, just used by the PhotoShop plug-ins so that this bitmap can become selected
00266     // in the gallery.
00267     BitmapListChangedMsg(BitmapList* pList, KernelBitmap *pBitmap):
00268         pChangedBmpList(pList), pNewBitmap(pBitmap), State(SELECTNEWBITMAP) { } 
00269 };
00270 
00271 
00272 // Optoken for the delete bitmap operation
00273 #define OPTOKEN_DELETEBITMAP _T("DeleteBitmap") 
00274 
00275 /********************************************************************************************
00276 
00277 >   class OpDeleteBitmap: public Operation
00278 
00279     Author:     Will_Cowling (Xara Group Ltd) <camelotdev@xara.com>
00280     Created:    16/2/95
00281     Purpose:    Removes all references to a bitmap, and deletes it from memory.
00282     SeeAlso:    -
00283 
00284 ********************************************************************************************/
00285 
00286 class CCAPI OpDeleteBitmap: public Operation
00287 {         
00288     CC_DECLARE_DYNCREATE( OpDeleteBitmap );
00289 
00290 public:
00291     static BOOL     Init();             
00292     static OpState  GetState(String_256*, OpDescriptor*);       
00293 
00294     // The 'do' function
00295     void DoDelete(OILBitmap*);
00296 
00297 protected:
00298     void ForceRedrawOfNode(Document*, Node*, ObjChangeParam*);
00299 };  
00300 
00301 #endif

Generated on Sat Nov 10 03:44:28 2007 for Camelot by  doxygen 1.4.4