Developer Documentation
input.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_INPUT_HH
45 #define VSI_INPUT_HH
46 
47 //== INCLUDES =================================================================
48 #include <QString>
49 #include <QVariant>
50 
51 #include "inout.hh"
52 
53 //== NAMESPACES ===============================================================
54 namespace VSI {
55 
56 //== CLASS DEFINITION =========================================================
57 
60 class Input : public InOut {
61 
62  public:
63 
65  enum State {
66  NoExternalInput = 0x1,
67  NoUserInput = 0x2,
68  NoRuntimeUserInput = 0x4,
69  Optional = 0x8
70  };
71 
73  explicit Input (Element *_f);
74 
76  unsigned int state ();
77 
79  void setState (unsigned int _state) { state_ = _state; };
80 
81  friend class Context;
82 
83  private:
84 
85  unsigned int state_;
86 
87 };
88 
89 //=============================================================================
90 }
91 //=============================================================================
92 
93 #endif
unsigned int state()
Current state.
Definition: input.cc:69
Input(Element *_f)
Constructor.
Definition: input.cc:60
State
Input states.
Definition: input.hh:65
void setState(unsigned int _state)
Sets the state.
Definition: input.hh:79