OptionsInterface.hh 5.91 KB
Newer Older
1
/*===========================================================================*\
Jan Möbius's avatar
Jan Möbius committed
2 3
*                                                                            *
*                              OpenFlipper                                   *
Martin Schultz's avatar
Martin Schultz committed
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 33 34 35 36 37 38
 *           Copyright (c) 2001-2015, RWTH-Aachen University                 *
 *           Department of Computer Graphics and Multimedia                  *
 *                          All rights reserved.                             *
 *                            www.openflipper.org                            *
 *                                                                           *
 *---------------------------------------------------------------------------*
 * This file is part of OpenFlipper.                                         *
 *---------------------------------------------------------------------------*
 *                                                                           *
 * Redistribution and use in source and binary forms, with or without        *
 * modification, are permitted provided that the following conditions        *
 * are met:                                                                  *
 *                                                                           *
 * 1. Redistributions of source code must retain the above copyright notice, *
 *    this list of conditions and the following disclaimer.                  *
 *                                                                           *
 * 2. Redistributions in binary form must reproduce the above copyright      *
 *    notice, this list of conditions and the following disclaimer in the    *
 *    documentation and/or other materials provided with the distribution.   *
 *                                                                           *
 * 3. Neither the name of the copyright holder nor the names of its          *
 *    contributors may be used to endorse or promote products derived from   *
 *    this software without specific prior written permission.               *
 *                                                                           *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS       *
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A           *
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,  *
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,       *
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR        *
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF    *
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING      *
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS        *
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.              *
Jan Möbius's avatar
Jan Möbius committed
39
*                                                                            *
40 41
\*===========================================================================*/

Matthias Möller's avatar
Matthias Möller committed
42

43
#include <QWidget>
Dirk Wilden's avatar
Dirk Wilden committed
44

Jan Möbius's avatar
Jan Möbius committed
45 46 47 48 49 50 51 52 53 54 55 56

/** \file OptionsInterface.hh
*
* Interface for adding a widget to OpenFlippers Options dialog .\ref optionsInterfacePage
*/

/** \brief Options Dialog interface
 *
 * \ref optionsInterfacePage "Detailed description"
 * \n
 *
 * This interface can be used to by plugins to add their own widget to OpenFlippers Options Dialog.
Dirk Wilden's avatar
Dirk Wilden committed
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
 */
class OptionsInterface {

   public :

      /// Destructor
      virtual ~OptionsInterface() {};

      /**   \brief Initialize the Options Widget
       *
       *  Initialize the options widget (create a widget and return a pointer to it ) \n
       * \n
       *   Example : \n
       *  _widget = new QWidget();  \n
       * \n
       * In the widget you can add anything you want.\n
       * \n 
       * use the slot applyOptions() to save the values of options currently entered
       * in your widget.
       * \n
       * @param _widget Pointer to the new Widget
       * @return Return true if a widget has been created
      */
80
      virtual bool initializeOptionsWidget(QWidget*& _widget) = 0;
Dirk Wilden's avatar
Dirk Wilden committed
81 82 83 84 85 86 87 88 89 90 91 92 93

       /** \brief Apply changes to options
       *
       * Called, when the user hits the apply/ok button in the options window
       * of Openflipper.\n
       * 
       * use this slot to save the values of options currently entered
       * in your options widget.
       */
      virtual void applyOptions() = 0;

};

Jan Möbius's avatar
Jan Möbius committed
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109

/** \page optionsInterfacePage Options Widget Interface
\image html OptionsInterface.png
\n
The OptionsInterface can be used by plugins to add an own widget to OpenFlippers
Options dialog.

This Interface should be used by plugins which will provide their own options widget in OpenFlippers Options Dialog.
For your options to show up in OpenFlippers Options window implement the initializeOptionsWidget() function.

The widget you return with this slot will be integrated into the options window and when
the user hits the apply- or ok-button in the options window the slot applyOptions() is called and
thus enables you to store the changes in your options.

To use the OptionsInterface:
<ul>
110
<li> include OptionsInterface.hh in your plugins header file
Jan Möbius's avatar
Jan Möbius committed
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
<li> derive your plugin from the class OptionsInterface
<li> add Q_INTERFACES(OptionsInterface) to your plugin class
<li> Implement all functions from this interface
</ul>

\code
bool ExamplePlugin::initializeOptionsWidget(QWidget*& _widget){

  // Global variable .. in header file: QWidget* optionswidget_;
  optionsWidget_ = new QWidget();

  // Setup widget here

  //connect the signals
  connect(optionsWidget_->setA,      SIGNAL( clicked() ), this, SLOT( slotSetA() ) );

  _widget = optionsWidget_;

  return true;
}

void ExamplePlugin::applyOptions(){

  // Get some value from the widget
  int value = optionsWidget_->getValue();

  //
  ...

}

\endcode

*/

Dirk Wilden's avatar
Dirk Wilden committed
146 147
Q_DECLARE_INTERFACE(OptionsInterface,"OpenFlipper.OptionsInterface/1.0")