plugopun.h

Go to the documentation of this file.
00001 // $Id: plugopun.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 // OpDescriptor, Operations and Context sensitive menu for plug-ins
00100 
00101 #ifndef INC_PLUGINUNDOOP
00102 #define INC_PLUGINUNDOOP
00103 
00104 //#include "selop.h" - in camtypes.h [AUTOMATICALLY REMOVED]
00105 
00106 class KernelBitmapRef;
00107 class NodeBitmap;
00108 class AttrFillGeometry;
00109 
00110 /********************************************************************************************
00111 
00112 >   class PlugInUndoOp : public SelOperation
00113 
00114     Author:     Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>
00115     Created:    21/1/97
00116     Purpose:    Undoable Operation so that a plug-ins can be invoked and used.  
00117 
00118 ********************************************************************************************/               
00119 
00120 class PlugInUndoOp : public SelOperation
00121 {
00122     CC_DECLARE_DYNCREATE( PlugInUndoOp );
00123 
00124 public:
00125 
00126     PlugInUndoOp();
00127 
00128     virtual void Do(OpDescriptor*);
00129 
00130     static BOOL Init();
00131     static BOOL RegisterOpToken(TCHAR *OpToken, const String_64& NewMenuText,
00132                                 CCRuntimeClass* pClass = CC_RUNTIME_CLASS(PlugInUndoOp),
00133                                 pfnGetState gs = GetState);
00134     static BOOL RegisterOpToken(TCHAR *OpToken, UINT32 MenuTextID,
00135                                 CCRuntimeClass* pClass = CC_RUNTIME_CLASS(PlugInUndoOp),
00136                                 pfnGetState gs = GetState);
00137     static OpState GetState(String_256*, OpDescriptor*);    
00138 
00139 public:
00140     // Search the selection for a bitmap
00141 //  static BOOL FindBitmapInSelection(KernelBitmap ** ppFoundBitmap = NULL,
00142 //                                    KernelBitmapRef ** ppFoundBitmapRef = NULL,
00143 //                                    NodeBitmap ** ppFoundNode = NULL,
00144 //                                    AttrFillGeometry ** ppFoundFillAttribute = NULL);
00145 
00146     // Overloaded so that we can use our stored copy of the OpDescriptor to get the undo text.  
00147     virtual void GetOpName(String_256* OpName);
00148 
00149 protected:
00150     // cannot find any stored OpDescriptor in the current operation and so
00151     // we must store our own 
00152     OpDescriptor* m_pOpDesc;
00153 };
00154 /********************************************************************************************
00155 
00156 >   class ActionApplyPlugInToBitmap : public Action
00157 
00158     Author:     Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>
00159     Created:    21/1/97
00160     Purpose:    When executed, this sets up an action to redo/undo an apply a plug-in to 
00161                 a bitmap.
00162     
00163     SeeAlso:    PlugInUndoOp
00164 
00165 ********************************************************************************************/
00166 
00167 class CCAPI ActionApplyPlugInToBitmap : public Action
00168 {
00169     CC_DECLARE_DYNCREATE( ActionApplyPlugInToBitmap )
00170 
00171 public:
00172     ActionApplyPlugInToBitmap();
00173     ~ActionApplyPlugInToBitmap();
00174     virtual ActionCode Execute();
00175     static ActionCode Init(Operation* const pOp,
00176                             ActionList *pActionList,
00177                             UINT32 ActionSize,
00178                             Document *pDocument,
00179                             KernelBitmap * pBitmap,
00180                             KernelBitmapRef * pBitmapRef,
00181                             NodeBitmap * pFoundNode,
00182                             AttrFillGeometry * pFoundFillAttribute,
00183                             Action **NewAction,
00184                             BOOL bUpdateAspect = FALSE);
00185 
00186 protected:
00187 
00188 private:
00189     Document * m_pDocument;
00190     KernelBitmap * m_pBitmap;
00191     KernelBitmapRef * m_pBitmapRef;
00192     NodeBitmap * m_pFoundNode;
00193     AttrFillGeometry * m_pFoundFillAttribute;
00194     BOOL m_bUpdateAspect;
00195 };
00196 
00197 #endif // INC_PLUGINUNDOOP

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