Maliit Plugins  0.92.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator
abstracttexteditor.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_TEXTEDITOR_H
33 #define MALIIT_KEYBOARD_TEXTEDITOR_H
34 
35 #include "models/key.h"
36 #include "models/wordcandidate.h"
37 #include "models/text.h"
38 
39 #include <QtCore>
40 #include <QtGui/QKeyEvent>
41 
42 namespace MaliitKeyboard {
43 
45 {
46  EditorOptions();
47  // all delays are in milliseconds
48  int backspace_auto_repeat_delay; // delay before first automatically repeated key
49  int backspace_auto_repeat_interval; // interval between automatically repeated keys
50 };
51 
52 class AbstractTextEditorPrivate;
53 
55  : public QObject
56 {
57  Q_OBJECT
58  Q_DISABLE_COPY(AbstractTextEditor)
59  Q_DECLARE_PRIVATE(AbstractTextEditor)
60 
61 public:
63  ReplaceAndCommit, // Will replace, add space & commit
65  };
66 
67  Q_ENUMS(ReplacementPolicy)
68 
69  explicit AbstractTextEditor(const EditorOptions &options,
70  const Model::SharedText &text,
71  QObject *parent = 0);
72  virtual ~AbstractTextEditor() = 0;
73 
74  Model::SharedText text() const;
75 
76  Q_SLOT void onKeyPressed(const Key &key);
77  Q_SLOT void onKeyReleased(const Key &key);
78  Q_SLOT void onKeyEntered(const Key &key);
79  Q_SLOT void onKeyExited(const Key &key);
80  Q_SLOT void replacePreedit(const QString &replacement,
82  Q_SLOT void clearPreedit();
83 
84  Q_SIGNAL void textChanged(const Model::SharedText &text);
85  Q_SIGNAL void keyboardClosed();
86 
87 private:
88  const QScopedPointer<AbstractTextEditorPrivate> d_ptr;
89 
90  virtual void sendPreeditString(const QString &preedit) = 0;
91  virtual void sendCommitString(const QString &commit) = 0;
92  virtual void sendKeyEvent(const QKeyEvent &ev) = 0;
93 
94  void commitPreedit();
95  Q_SLOT void autoRepeatBackspace();
96 };
97 
98 } // namespace MaliitKeyboard
99 
100 #endif // MALIIT_KEYBOARD_ABSTRACTTEXTEDITOR_H