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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
|
/*
* This file is part of the KDE project
*
* Copyright (C) 2013 Arjen Hiemstra <ahiemstra@heimr.nl>
*
* 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_COMPONENTS_DOCUMENT_H
#define CALLIGRA_COMPONENTS_DOCUMENT_H
#include <QObject>
#include "Global.h"
class KoDocument;
class KoZoomController;
class KoCanvasController;
class QGraphicsWidget;
class KoFindBase;
namespace Calligra {
namespace Components {
/**
* \brief The Document object provides a loader for Calligra Documents.
*
*/
class Document : public QObject
{
Q_OBJECT
Q_PROPERTY(QUrl source READ source WRITE setSource NOTIFY sourceChanged)
Q_PROPERTY(QObject* document READ document NOTIFY documentChanged)
Q_PROPERTY(QObject* part READ part NOTIFY documentChanged)
Q_PROPERTY(Calligra::Components::DocumentType::Type documentType READ documentType NOTIFY documentTypeChanged)
Q_PROPERTY(Calligra::Components::DocumentStatus::Status status READ status NOTIFY statusChanged)
Q_PROPERTY(QSize documentSize READ documentSize NOTIFY documentSizeChanged)
Q_PROPERTY(bool readOnly READ readOnly WRITE setReadOnly NOTIFY readOnlyChanged)
/**
* \property currentIndex
* \brief The current visible 'index', i.e. page, sheet or slide.
*
* Due to the abstraction of the difference between the three document types
* we need some way to handle the "current visible item" based on an arbitrary
* number.
*
* \default -1 if #source is not set or failed to load. 0 otherwise.
* \get currentIndex() const
* \set setcurrentIndex()
* \notify currentIndexChanged()
*
* \todo This should probably be a property of View, but since DocumentImpl currently
* creates the canvas it is currently pretty much a document property.
*/
Q_PROPERTY(int currentIndex READ currentIndex WRITE setCurrentIndex NOTIFY currentIndexChanged)
/**
* \property indexCount
* \brief The number of "indexes" in the document, i.e. pages, slides, etc.
*
* \default 0
* \get indexCount() const
* \notify indexCountChanged()
*/
Q_PROPERTY(int indexCount READ indexCount NOTIFY indexCountChanged)
/**
* \property textEditor
* \brief The instance of KoTextEditor for the currently selected object in the document, or null
*
* \default null
* \get textEditor() const
* \notify textEditorChanged()
*/
Q_PROPERTY(QObject* textEditor READ textEditor NOTIFY textEditorChanged)
public:
explicit Document(QObject* parent = 0);
~Document() override;
QUrl source() const;
void setSource(const QUrl& value);
bool readOnly() const;
void setReadOnly(bool readOnly);
DocumentType::Type documentType() const;
DocumentStatus::Status status() const;
QSize documentSize() const;
QObject* document() const;
virtual QObject* part() const;
/**
* Getter for property #currentIndex.
*/
int currentIndex() const;
/**
* Setter for property #currentIndex.
*/
void setCurrentIndex(int newValue);
/**
* Getter for property #indexCount.
*/
int indexCount() const;
/**
* \internal
* These methods are used internally by the components and not exposed
* to QML.
* @{
*/
KoFindBase* finder() const;
QGraphicsWidget* canvas() const;
KoCanvasController* canvasController() const;
KoZoomController* zoomController() const;
KoDocument* koDocument() const;
/**
* \return The url of the link at point or an empty url if there is no link at point.
*/
virtual QUrl urlAtPoint( const QPoint& point );
QObject* textEditor();
// Deselects any text selection present in the document, and deselects all shapes
// This is highly useful, as it makes navigation prettier.
Q_INVOKABLE void deselectEverything();
/**
* @}
*/
Q_SIGNALS:
void sourceChanged();
void statusChanged();
void documentChanged();
void readOnlyChanged();
void documentSizeChanged();
void documentTypeChanged();
void textEditorChanged();
/**
* Notify signal for property #currentIndex.
*/
void currentIndexChanged();
/**
* Notify signal for property #indexCount
*/
void indexCountChanged();
/**
* \brief Emitted whenever the backend wants to update the view.
*/
void requestViewUpdate();
private:
class Private;
Private* const d;
};
} // Namespace Components
} // Namespace Calligra
Q_DECLARE_METATYPE(Calligra::Components::Document*)
#endif // CALLIGRA_COMPONENTS_DOCUMENT_H
|
