Toolbox interface documentation

git-svn-id: http://www.openflipper.org/svnrepo/OpenFlipper/branches/Free@10945 383ad7c9-94d9-4d36-a494-682f7c89f535

BasePlugin/LoggingInterface.hh

@@ -51,7 +51,7 @@
 */
 
 /** \page loggingInterfacePage Logging Interface
-\image html logWindow.png
+\image html LoggingInterface.png
 The Logging interface can be used by plugins to print messages in OpenFlippers log widget below 
 the gl viewer (See image). The log widget can apply filters to visualize only the messages
 of a certain importance. The widget has 3 different modes, which can be toggled by pressing Ctrl + L:
@@ -74,7 +74,7 @@ To use the LoggingInterface:
 <ul>
 <li> include LoggingInterface.hh in your plugins header file
 <li> derive your plugin from the class LoggingInterface
-<li> add Q_INTERFACES(LoggingInterface) to your class 
+<li> add Q_INTERFACES(LoggingInterface) to your plugin class 
 <li> And add the signals or slots you want to use to your plugin class (You don't need to implement all of them)
 </ul>
 

BasePlugin/ToolboxInterface.hh

@@ -40,35 +40,72 @@
 *                                                                            *
 \*===========================================================================*/
 
+#ifndef TOOLBOXINTERFACE_HH
+#define TOOLBOXINTERFACE_HH
 
+#include <QtGui>
+#include <QMenuBar>
+#include <QStringList>
+#include <OpenFlipper/common/Types.hh>
 
+/** \file ToolboxInterface.hh
+*
+* Interface for adding per plugin toolboxes to OpenFlippers UI.\ref toolboxInterfacePage
+*/
 
-//
-// C++ Interface: BasePlugin
-//
-// Description:
-//
-//
-// Author: Jan Moebius <jan_moebius@web.de>, (C) 2007
-//
+/** \page toolboxInterfacePage Toolbox Interface
+\image html ToolboxInterface.png
+
+The ToolboxInterface can be used by plugins to add widgets to the list of toolboxes in OpenFlippers
+UI. The toolboxes are located left or right of the gl viewer (See image). 
+
+The list can be hidden by pressing Ctrl + t.
+
+To use the ToolboxInterface:
+<ul>
+<li> include ToolboxInterface.hh in your plugins header file
+<li> derive your plugin from the class ToolboxInterface
+<li> add Q_INTERFACES(ToolboxInterface) to your plugin class 
+<li> And add the signals or slots you want to use to your plugin class (You don't need to implement all of them)
+</ul>
+
+Usually you should implement the initializePlugin() function from BaseInterface. In this function you can setup
+your toolbox ( some kind of QWidget, can also be any widget created with qt-designer). Optionally you can also 
+add an icon to the toolbox. 
+
+The following code shows a simple example to create an empty toolbox.
+\code 
+void SmootherPlugin::initializePlugin()
+{
+  // Create the Toolbox Widget
+  QWidget* toolBox = new QWidget();
+  
+  // Create an icon which is shown along with the toolbox
+  QIcon* toolIcon = new QIcon(OpenFlipper::Options::iconDirStr()+OpenFlipper::Options::dirSeparator()+"smoother1.png");
+  
+  // Tell the core to include the new toolbox widget with the name Simple Smoother, a pointer to the widget and a pointer to the icon
+  emit addToolbox( tr("Simple Smoother") , toolBox, toolIcon );
+}
+\endcode
+
+Signals and slots of your toolbox (e.g. from a QPushButton inside it) can be directly connected to signals and slots in
+your plugin. Therefore the embedding of the widget into the toolbox list is fully transparent.
+
+*/
 
-#ifndef TOOLBOXINTERFACE_HH
-#define TOOLBOXINTERFACE_HH
 
- #include <QtGui>
- #include <QMenuBar>
- #include <QStringList>
- #include <OpenFlipper/common/Types.hh>
 
  /**
   * \brief Plugins can add its own toolbox to the main widget's toolbox area by using this interface.
   *
-  * This Interface should be used by plugins which will provide a toolbox widget.
+  * \ref toolboxInterfacePage "Detailed description" 
+  * \n
+  *
+  * This Interface can be used by plugins which will provide a toolbox widget.
   * 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.
-  * 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
+  * to the user interface. You can create extra signals and slots in your Plugin.
+  * These can be connected between your toolbox and your plugin.\n
   *
   * See our tutorials \ref ex2 and \ref ex3 for an example of to add custom toolboxes to
   * OpenFlipper.

Documentation/DeveloperHelpSources/Interfaces.docu

@@ -48,9 +48,9 @@
  * Provides a function to create an entry in the menubar ( MenuInterface ).
  *
  *
- * \section ToolboxPlugin Toolbox Interface
+ * \section ToolboxInterface Toolbox Interface
  * \image html ToolboxInterface.png
- * Provides functions to create a separate widget in the toolbox on the right ( ToolboxInterface ).
+ * Provides functions to create a separate widget in the toolbox on the right ( \subpage toolboxInterfacePage ).
  *
  *
  * \section LoggingInterface Logging Interface