bfxmngr.h

Go to the documentation of this file.
00001 // $Id: bfxmngr.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 // bfxmngr.h : header file
00100 //
00101 
00102 // This file contains specific BFX plug-in manager related items
00103 // At present this includes:-
00104 
00105 // BfxHandler
00106 // Defines the characteristics of a BFX plug-in and provides a function
00107 // for parsing them.
00108 
00109 #ifndef INC_BFXPLUGINMANAGER
00110 #define INC_BFXPLUGINMANAGER
00111 
00112 #include "plugmngr.h"   // PlugInHandler
00113 
00114 /**************************************************************************************
00115 
00116 >   class BfxHandler : public PlugInHandler
00117 
00118     Author:     Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com>
00119     Created:    4/3/97
00120     Purpose:    Provides BFX plug-in handling characteristics.
00121                 It handles defining what file types BFX plug-ins have and how to
00122                 parse them. As these are the built in filters, they are just added when
00123                 the handler is inited.
00124 
00125 **************************************************************************************/
00126 
00127 class BfxHandler : public PlugInHandler
00128 {
00129     // Declare the class for memory tracking
00130     CC_DECLARE_DYNAMIC(BfxHandler);
00131 
00132 public:
00133     BfxHandler();
00134     ~BfxHandler();
00135 
00136     virtual BOOL Init();
00137 
00138 public:
00139     // Useful helper functions
00140     virtual BOOL AddFixedPlugIns();
00141 
00142     // Add a plug-in to the list in the plug-in manager
00143     virtual BOOL AddPlugIn(PlugInItem * pPlugIn, CCRuntimeClass* pClass = CC_RUNTIME_CLASS(PlugInOp),
00144                            pfnGetState gs = PlugInOp::GetState);
00145 
00146     // go and parse the specified plug-in
00147     virtual BOOL ParsePlugIn(const PathName& Path, const INT32 PathID);
00148 
00149     // go and add in the any main menu items that this handler requires
00150     virtual BOOL CreateMainMenuItems(PlugInManager * pManager, MenuItem * pRootMenu,
00151                                      BOOL AddSeparator = FALSE);
00152     // a handler is asked whether it is going to add menu items so that the manager
00153     // can decide whether to ask the previous handler to add a separator to the end
00154     // of its added menus
00155     // Need to override this if the above function is overriden
00156     virtual BOOL GoingToAddMainMenuItems() { return TRUE; }
00157 
00158 public:
00159     // define this handler's unique characteristics
00160 
00161     // return a string describing a unique identifier for the plug-ins this handler is interested in
00162     virtual String_32 GetUniqueID() const; 
00163     // return a unique type for this kind of plug-in
00164     virtual TypeOfPlugIn GetTypeOfPlugIn() const;
00165     // return a string descibing what filetypes the plug-in handler is interested in
00166     virtual String_32 GetFileTypes() const; 
00167 
00168 public:
00169 };
00170 
00171 #endif // INC_BFXPLUGINMANAGER

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