1
2
3
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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
|
/* This file is part of the KDE project
Copyright 1999-2006 The KSpread Team <calligra-devel@kde.org>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef CALLIGRA_SHEETS_FUNCTION_COMPLETION
#define CALLIGRA_SHEETS_FUNCTION_COMPLETION
#include <QObject>
#include "sheets_common_export.h"
class QListWidgetItem;
namespace Calligra
{
namespace Sheets
{
class CellEditor;
/**
* Provides autocompletion facilities in formula editors.
* When the user types in the first few characters of a
* function name in a CellEditor which has a FunctionCompletion
* object installed on it, the FunctionCompletion object
* creates and displays a list of possible names which the user
* can select from. If the user selects a function name from the list,
* the @ref FunctionCompletion::selectedCompletion() signal is emitted
*/
class FunctionCompletion : public QObject
{
Q_OBJECT
public:
explicit FunctionCompletion(CellEditor *editor);
~FunctionCompletion() override;
/**
* Handles various keyboard and mouse actions which may occur on the autocompletion popup list
*/
bool eventFilter(QObject *o, QEvent *e) override;
/**
* Populates the autocompletion list box with the specified choices and shows it so that the user can view and select a function name.
* @param choices A list of possible function names which match the characters that the user has already entered.
*/
void showCompletion(const QStringList &choices);
public Q_SLOTS:
/**
* Hides the autocompletion list box if it is visible and emits the @ref selectedCompletion signal.
*/
void doneCompletion();
private Q_SLOTS:
void itemSelected(QListWidgetItem* item = 0);
Q_SIGNALS:
/**
* Emitted, if the user selects a function name from the list.
*/
void selectedCompletion(const QString& item);
private:
class Private;
Private * const d;
FunctionCompletion(const FunctionCompletion&);
FunctionCompletion& operator=(const FunctionCompletion&);
};
} // namespace Sheets
} // namespace Calligra
#endif // CALLIGRA_SHEETS_FUNCTION_COMPLETION
|
