ViewInterface.hh 4.17 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
\*===========================================================================*/

42
#pragma once
Jan Möbius's avatar
 
Jan Möbius committed
43

44 45
#include <OpenFlipper/common/Types.hh>
#include <QWidget>
Matthias Möller's avatar
Matthias Möller committed
46

Jan Möbius's avatar
 
Jan Möbius committed
47

Jan Möbius's avatar
 
Jan Möbius committed
48 49 50 51
 /**
   This Interface should be used by plugins which will provide an additional view widget.
 */
class ViewInterface {
Jan Möbius's avatar
 
Jan Möbius committed
52

Jan Möbius's avatar
 
Jan Möbius committed
53
   signals :
Jan Möbius's avatar
 
Jan Möbius committed
54

Jan Möbius's avatar
 
Jan Möbius committed
55
     /** Get a widget form the Stackwidget by Name. The mainwidget is named "3D Examiner Widget".
Jan Möbius's avatar
 
Jan Möbius committed
56
      *
Jan Möbius's avatar
 
Jan Möbius committed
57 58 59
      * @param _name Name of the Widget
      * @param _widget The requested widget or 0 if not found
      */
Jan Möbius's avatar
Jan Möbius committed
60
     virtual void getStackWidget( QString _name, QWidget*& _widget ) {};
Jan Möbius's avatar
 
Jan Möbius committed
61 62

    /** Update a widget form the Stackwidget with Name.       *
Jan Möbius's avatar
 
Jan Möbius committed
63 64 65
      * @param _name Name of the Widget
      * @param _widget The requested widget or 0 if not found
      */
Jan Möbius's avatar
Jan Möbius committed
66
     virtual void updateStackWidget( QString _name, QWidget* _widget ) {};
Jan Möbius's avatar
 
Jan Möbius committed
67

Jan Möbius's avatar
 
Jan Möbius committed
68
    /** Add a widget to the Stackwidget with a Name.
Jan Möbius's avatar
 
Jan Möbius committed
69
      *
Jan Möbius's avatar
 
Jan Möbius committed
70 71 72
      * @param _name Name of the Widget
      * @param _widget The new widget
    */
Jan Möbius's avatar
Jan Möbius committed
73
     virtual void addStackWidget( QString _name, QWidget* _widget ) {};
Jan Möbius's avatar
 
Jan Möbius committed
74 75 76

   public :

Jan Möbius's avatar
 
Jan Möbius committed
77 78 79 80 81
      /// Destructor
      virtual ~ViewInterface() {};
};

Q_DECLARE_INTERFACE(ViewInterface,"OpenFlipper.ViewInterface/1.0")
Jan Möbius's avatar
 
Jan Möbius committed
82