AboutInfoInterface.hh 5.3 KB
Newer Older
Jan Möbius's avatar
Jan Möbius committed
1 2 3
/*===========================================================================*\
*                                                                            *
*                              OpenFlipper                                   *
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 42 43 44 45 46 47 48 49 50 51 52
*                                                                            *
\*===========================================================================*/

/*===========================================================================*\
*                                                                            *
*   $Revision: 11127 $                                                       *
*   $LastChangedBy: moebius $                                                *
*   $Date: 2011-03-15 16:18:28 +0100 (Di, 15 Mär 2011) $                     *
*                                                                            *
\*===========================================================================*/


#pragma once

53 54 55 56 57 58

#if QT_VERSION >= 0x050000 
  #include <QtWidgets>
#else
  #include <QtGui>
#endif
Jan Möbius's avatar
Jan Möbius committed
59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116


/** \file AboutInfoInterface.hh
*
* Interface for adding a widget to OpenFlippers About dialog .\ref AboutInfoInterfacePage
*/

/** \brief About Info interface
 *
 * \ref AboutInfoInterfacePage "Detailed description"
 * \n
 *
 * This interface can be used to add a widget to OpenFlippers About dialog to display license Information or other data.
 */
class AboutInfoInterface {

public:
  /// Destructor
  virtual ~AboutInfoInterface() {};

signals :
  /**   \brief Adds a widget to OpenFlippers about dialog
   *
   *
   * @param _text    Text for the tab (Supports html tags)
   * @param _tabName Name of the tab to be added
   */
   virtual void addAboutInfo(QString _text, QString _tabName ) {};
};


/** \page AboutInfoInterfacePage About Info interface
\image html AboutInfoInterface.png
\n
The AboutInfoInterface can be used by plugins to add an additional tab to OpenFlippers about dialog.
This is especially useful, if you use an external library which requires you to publish the license information
in the application.

You can add multiple tabs by additional calls to this interface

To use the AboutInfoInterface:
<ul>
<li> include AboutInfoInterface.hh in your plugins header file
<li> derive your plugin from the class AboutInfoInterface
<li> add Q_INTERFACES(AboutInfoInterface) to your plugin class
<li> Implement the signal of this interface
</ul>

\code
void ExamplePlugin::pluginsInitialized(){
  // Simply emit the signal with the text
  emit addAboutInfo("Info Text","Example Plugin License");
}
\endcode
*/

Q_DECLARE_INTERFACE(AboutInfoInterface,"OpenFlipper.AboutInfoInterface/1.0")