ToolboxInterface.hh 4.51 KB
 Jan Möbius committed Aug 05, 2009 1 /*===========================================================================*\  Jan Möbius committed Nov 25, 2010 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 * * * OpenFlipper * * Copyright (C) 2001-2010 by Computer Graphics Group, RWTH Aachen * * www.openflipper.org * * * *--------------------------------------------------------------------------- * * This file is part of OpenFlipper. * * * * OpenFlipper is free software: you can redistribute it and/or modify * * it under the terms of the GNU Lesser General Public License as * * published by the Free Software Foundation, either version 3 of * * the License, or (at your option) any later version with the * * following exceptions: * * * * If other files instantiate templates or use macros * * or inline functions from this file, or you compile this file and * * link it with other files to produce an executable, this file does * * not by itself cause the resulting executable to be covered by the * * GNU Lesser General Public License. This exception does not however * * invalidate any other reasons why the executable file might be * * covered by the GNU Lesser General Public License. * * * * OpenFlipper is distributed in the hope that it will be useful, * * but WITHOUT ANY WARRANTY; without even the implied warranty of * * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * * GNU Lesser General Public License for more details. * * * * You should have received a copy of the GNU LesserGeneral Public * * License along with OpenFlipper. If not, * * see . * * *  Jan Möbius committed Aug 05, 2009 33 34 35 \*===========================================================================*/ /*===========================================================================*\  Jan Möbius committed Nov 25, 2010 36 37 38 39 40 * * * $Revision$ * * $LastChangedBy$ * * $Date$ * * *  Jan Möbius committed Aug 05, 2009 41 \*===========================================================================*/  Jan Möbius committed Aug 29, 2008 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63  // // C++ Interface: BasePlugin // // Description: // // // Author: Jan Moebius , (C) 2007 // #ifndef TOOLBOXINTERFACE_HH #define TOOLBOXINTERFACE_HH #include #include #include #include /**  Mike Kremer committed Feb 04, 2009 64  * \brief Plugins can add its own toolbox to the main widget's toolbox area by using this interface.  Jan Möbius committed Mar 06, 2009 65  *  Mike Kremer committed Feb 04, 2009 66  * This Interface should be used by plugins which will provide a toolbox widget.  Jan Möbius committed Oct 01, 2009 67 68 69  * Each Plugin can create own Widgets in the Toolbox area. Just create your widget and then add it with \n * emit addToolbox( QString _name , QWidget* _widget ) \n * to the user interface. You can create extra Signals and slots in your Plugin.  Mike Kremer committed Feb 04, 2009 70 71  * These can be connected between your toolbox and your plugin. Signals and slots across plugins are currently * not available but may be possible via an internal message system later.\n  Mike Kremer committed Mar 26, 2009 72 73 74  * * See our tutorials \ref ex2 and \ref ex3 for an example of to add custom toolboxes to * OpenFlipper.  Mike Kremer committed Feb 04, 2009 75  */  Jan Möbius committed Aug 29, 2008 76 77 78 79 80 81 82 83 84 85 class ToolboxInterface { private slots : public : /// Destructor virtual ~ToolboxInterface() {}; signals :  Jan Möbius committed Sep 30, 2009 86   Jan Möbius committed Mar 06, 2009 87 88 89 90  /** \brief Add a toolbox widget to the gui with the given name * * This signal adds a toolbox widget to the toolbar on the right. */  Jan Möbius committed Mar 06, 2009 91  virtual void addToolbox( QString /* _name */ , QWidget* /*_widget*/ ) {};  Jan Möbius committed Mar 06, 2009 92   Jan Möbius committed Aug 29, 2008 93 94 };  Dirk Wilden committed Feb 25, 2009 95 Q_DECLARE_INTERFACE(ToolboxInterface,"OpenFlipper.ToolboxInterface/1.1")  Jan Möbius committed Aug 29, 2008 96 97  #endif // TOOLBOXINTERFACE_HH