Developer Documentation
type.hh
1 /*===========================================================================*\
2 * *
3 * OpenFlipper *
4  * Copyright (c) 2001-2015, RWTH-Aachen University *
5  * Department of Computer Graphics and Multimedia *
6  * All rights reserved. *
7  * www.openflipper.org *
8  * *
9  *---------------------------------------------------------------------------*
10  * This file is part of OpenFlipper. *
11  *---------------------------------------------------------------------------*
12  * *
13  * Redistribution and use in source and binary forms, with or without *
14  * modification, are permitted provided that the following conditions *
15  * are met: *
16  * *
17  * 1. Redistributions of source code must retain the above copyright notice, *
18  * this list of conditions and the following disclaimer. *
19  * *
20  * 2. Redistributions in binary form must reproduce the above copyright *
21  * notice, this list of conditions and the following disclaimer in the *
22  * documentation and/or other materials provided with the distribution. *
23  * *
24  * 3. Neither the name of the copyright holder nor the names of its *
25  * contributors may be used to endorse or promote products derived from *
26  * this software without specific prior written permission. *
27  * *
28  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *
29  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
30  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A *
31  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
32  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, *
33  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, *
34  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR *
35  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF *
36  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING *
37  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS *
38  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
39 * *
40 \*===========================================================================*/
41 
42 
43 
44 #ifndef VSI_TYPE_HH
45 #define VSI_TYPE_HH
46 
47 //== INCLUDES =================================================================
48 #include <QStringList>
49 #include <QMap>
50 #include <QWidget>
51 
52 //== NAMESPACES ===============================================================
53 namespace VSI {
54 
55 //== FORWARDDECLARATIONS ======================================================
56 class TypeWidget;
57 
58 //== CLASS DEFINITION =========================================================
59 
65 class Type {
66  public:
67 
69  Type ();
70 
72  virtual ~Type ();
73 
75  virtual QStringList supportedTypes ();
76 
78  virtual QStringList supportedHints ();
79 
81  virtual bool canConvertTo (QString _type);
82 
84  virtual bool hasWidget () { return false; };
85 
87  virtual TypeWidget *widget (QMap<QString, QString> /*_hints*/, QString /*_typeName*/, QWidget * /*_parent*/ = NULL) { return 0; };
88 
89  protected:
90  QStringList types_;
91  QStringList hints_;
92 
93  QStringList convertTypes_;
94 };
95 
96 //=============================================================================
97 }
98 //=============================================================================
99 
100 #endif
virtual ~Type()
Destructor.
Definition: type.cc:64
virtual bool hasWidget()
Does this type has a configuration widget.
Definition: type.hh:84
virtual TypeWidget * widget(QMap< QString, QString >, QString, QWidget *=NULL)
Returns the configuration widget.
Definition: type.hh:87
virtual bool canConvertTo(QString _type)
Can this type be converted to the given type?
Definition: type.cc:87
virtual QStringList supportedHints()
Hints that may be stored for this type in the xml metadata.
Definition: type.cc:79
Type()
Constructor.
Definition: type.cc:57
virtual QStringList supportedTypes()
Names of Types.
Definition: type.cc:71