Maliit Plugins  0.92.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator
key.h
Go to the documentation of this file.
1 /*
2  * This file is part of Maliit Plugins
3  *
4  * Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies). All rights reserved.
5  *
6  * Contact: Mohammad Anwari <Mohammad.Anwari@nokia.com>
7  *
8  * Redistribution and use in source and binary forms, with or without modification,
9  * are permitted provided that the following conditions are met:
10  *
11  * Redistributions of source code must retain the above copyright notice, this list
12  * of conditions and the following disclaimer.
13  * Redistributions in binary form must reproduce the above copyright notice, this list
14  * of conditions and the following disclaimer in the documentation and/or other materials
15  * provided with the distribution.
16  * Neither the name of Nokia Corporation nor the names of its contributors may be
17  * used to endorse or promote products derived from this software without specific
18  * prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
21  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
22  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
23  * THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
27  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
28  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  *
30  */
31 
32 #ifndef MALIIT_KEYBOARD_KEY_H
33 #define MALIIT_KEYBOARD_KEY_H
34 
35 #include "models/area.h"
36 #include "models/label.h"
37 
38 #include <QtCore>
39 
40 namespace MaliitKeyboard {
41 
42 class Key
43 {
44 public:
45  enum Action {
51 
52 
58 
71  };
72 
73 private:
74  QPoint m_origin;
78  QMargins m_margins;
79  QByteArray m_icon;
82 
83 public:
84  explicit Key();
85 
86  // read-only properties:
87  bool valid() const;
88  QRect rect() const;
89 
90  QPoint origin() const;
91  void setOrigin(const QPoint &origin);
92 
93  Area area() const;
94  Area & rArea();
95  void setArea(const Area &area);
96 
97  Label label() const;
98  Label & rLabel();
99  void setLabel(const Label &label);
100 
101  Action action() const;
102  void setAction(Action action);
103 
104  QMargins margins() const;
105  void setMargins(const QMargins &margins);
106 
107  QByteArray icon() const;
108  void setIcon(const QByteArray &icon);
109 
110  bool hasExtendedKeys() const;
111  void setExtendedKeysEnabled(bool enable);
112 };
113 
114 bool operator==(const Key &lhs,
115  const Key &rhs);
116 
117 bool operator!=(const Key &lhs,
118  const Key &rhs);
119 
120 } // namespace MaliitKeyboard
121 
122 Q_DECLARE_METATYPE(MaliitKeyboard::Key)
123 
124 #endif // MALIIT_KEYBOARD_KEY_H