bfxop.h

Go to the documentation of this file.
00001 // $Id: bfxop.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 // Operations and Context sensitive menu for BFX plug-ins
00100 
00101 #ifndef INC_BFXPLUGINOP
00102 #define INC_BFXPLUGINOP
00103 
00104 #include "plugop.h"
00105 
00106 #define OPTOKEN_BFX_SPECIALEFFECTS _T("BfxSpecialEffects");
00107 
00108 /********************************************************************************************
00109 
00110 >   class BfxPlugInOp : public PlugInOp
00111 
00112     Author:     Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>
00113     Created:    4/3/97
00114     Purpose:    Operation so that a BFX plug-ins can be invoked and used.  
00115 
00116 ********************************************************************************************/               
00117 
00118 class BfxPlugInOp : public PlugInOp
00119 {
00120     CC_DECLARE_DYNCREATE( BfxPlugInOp );
00121 
00122 public:
00123 
00124     BfxPlugInOp();
00125 
00126     virtual void Do(OpDescriptor*);
00127 
00128     static BOOL Init();
00129     static OpState GetState(String_256*, OpDescriptor*);    
00130 
00131     // Useful function to ask a plug-in to see whether it likes the selected bitmap
00132     static BOOL CheckBitmapWithPlugIn(const String_256& OpName, BOOL IncludeUniqueName = TRUE,
00133                                       BOOL IncludeUndoAbleSig = FALSE);
00134 
00135     static BOOL SetBitmapAndDocument(KernelBitmap* pBitmap, Document * pDocument);
00136 
00137 private:
00138     // As we are invoked from a menu item, we need to be told what bitmap we are
00139     // working on, so these need to be set up before the operation is invoked.
00140     static KernelBitmap * m_pBitmap;
00141     static Document * m_pDocument;
00142 };
00143 
00144 /********************************************************************************************
00145 
00146 >   class BfxPlugInContextMenu : public PlugInsContextMenu
00147 
00148     Author:     Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>
00149     Created:    4/3/97
00150     Purpose:    Implements the Bfx plug-ins context sensitive menus
00151     SeeAlso:    ContextMenu
00152 
00153 ********************************************************************************************/
00154 
00155 class BfxPlugInContextMenu : public PlugInsContextMenu
00156 {
00157     CC_DECLARE_MEMDUMP(BfxPlugInContextMenu);
00158 
00159 public:
00160     //  DO NOT CALL the constructor Default constructor - use the one below
00161     BfxPlugInContextMenu(KernelBitmap* pBitmap, Document * pDocument);
00162 
00163     virtual BOOL Build();
00164 
00165     static BOOL BuildMenu(KernelBitmap * pBitmap, Document * pDocument,
00166                           ContextMenu * pContextMenu, MenuItem* pMainRoot = NULL,
00167                           BOOL AddSeparator = FALSE, BOOL UseUndoable = FALSE);
00168 
00169 protected:
00170     // As we are invoked from a menu item, we need to be told what bitmap we are
00171     // working on, so these need to be set up before the operation is invoked.
00172     KernelBitmap * m_pBitmap;
00173     Document * m_pDocument;
00174 };
00175 
00176 #endif // INC_BFXPLUGINOP

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