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
|
/* This file is part of the KDE project
* Copyright (C) 2006, 2010 Thomas Zander <zander@kde.org>
* Copyright (C) 2008 Girish Ramakrishnan <girish@forwardbias.in>
* Copyright (C) 2011 Pierre Ducroquet <pinaraf@pinaraf.info>
*
* 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 KOTEXT_H
#define KOTEXT_H
#include "kotext_export.h"
#include <KoDocumentResourceManager.h>
#include <styles/KoCharacterStyle.h>
#include <QChar>
#include <QMetaType>
#include <QTextOption>
class QStringList;
/**
* Generic namespace of the Calligra Text library for helper methods and data.
*/
namespace KoText
{
KOTEXT_EXPORT QStringList underlineTypeList();
KOTEXT_EXPORT QStringList underlineStyleList();
KOTEXT_EXPORT Qt::Alignment alignmentFromString(const QString &align);
KOTEXT_EXPORT QString alignmentToString(Qt::Alignment align);
KOTEXT_EXPORT Qt::Alignment valignmentFromString(const QString &align);
KOTEXT_EXPORT QString valignmentToString(Qt::Alignment align);
/// This enum contains values to be used as keys in KoCanvasResourceManager
enum CanvasResource {
CurrentTextDocument = 382490375, ///< set by the text plugin whenever the document is changed
CurrentTextPosition = 183523, ///< used by the text plugin whenever the position is changed
CurrentTextAnchor = 341899485, ///< used by the text plugin whenever the anchor-position is changed
SelectedTextPosition = 21314576, ///< used by the text plugin whenever the alternative selection is changed
/// used by the text plugin whenever the alternative selection anchor-position is changed
SelectedTextAnchor = 3344189
};
/// For paragraphs each tab definition is represented by this struct.
struct KOTEXT_EXPORT Tab {
Tab();
qreal position; ///< distance in ps-points from the edge of the text-shape
QTextOption::TabType type; ///< Determine which type is used.
QChar delimiter; ///< If type is DelimitorTab; tab until this char was found in the text.
KoCharacterStyle::LineType leaderType; // none/single/double
KoCharacterStyle::LineStyle leaderStyle; // solid/dotted/dash/...
KoCharacterStyle::LineWeight leaderWeight; // auto/bold/thin/length/percentage/...
qreal leaderWidth; // the width value if length/percentage
QColor leaderColor; ///< if color is valid, then use this instead of the (current) text color
QString leaderText; ///< character to print as the leader (filler of the tabbed space)
bool operator==(const Tab &tab) const;
};
/**
* Text resources per calligra-document.
* \sa KoDocumentResourceManager KoShapeController::resourceManager()
*/
enum DocumentResource {
ChangeTracker = KoDocumentResourceManager::KoTextStart + 1, ///< KoChangeTracker
InlineTextObjectManager, ///< The KoText inline-text-object manager. KoInlineTextObjectManager
TextRangeManager, ///< The KoText inline-text-object manager. KoInlineTextObjectManager
StyleManager, ///< The KoStyleManager
PageProvider, ///< The KoPageProvider
/** The KoDocumentRdf for the document,
this will be a KoDocumentRdfBase when Soprano support is not compiled in. */
DocumentRdf
};
enum KoTextFrameProperty {
SubFrameType = QTextFormat::UserProperty + 1
};
enum KoSubFrameType {
AuxillaryFrameType = 1,
NoteFrameType
};
/// Text in the objects will be positioned according to the direction.
enum Direction {
AutoDirection, ///< Take the direction from the text.
LeftRightTopBottom, ///< Text layout for most western languages
RightLeftTopBottom, ///< Text layout for languages like Hebrew
TopBottomRightLeft, ///< Vertical text layout.
TopBottomLeftRight, ///< Vertical text layout. ?
InheritDirection ///< Direction is unspecified and should come from the container
};
/// convert the string version of directions (as specified in XSL and ODF) to the Direction enum
KOTEXT_EXPORT Direction directionFromString(const QString &direction);
/// convert the Direction enum to the string version of directions (as specified in XSL and ODF)
KOTEXT_EXPORT QString directionToString(Direction direction);
/// There are several possible text breaks
enum KoTextBreakProperty {
NoBreak = 0, ///< No text break
ColumnBreak, ///< Column break
PageBreak ///< Page break
};
/// convert the string version of text break (as specified in ODF) to the KoTextBreakProperty enum
KOTEXT_EXPORT KoTextBreakProperty textBreakFromString(const QString &textBreak);
/// convert the KoTextBreakProperty enum to the string version of text break (as specified in ODF)
KOTEXT_EXPORT QString textBreakToString (KoTextBreakProperty textBreak);
///TODO: move to KoUnit ?
KOTEXT_EXPORT QTextLength parseLength (const QString &length);
}
Q_DECLARE_TYPEINFO(KoText::Tab, Q_MOVABLE_TYPE);
Q_DECLARE_METATYPE(KoText::Tab)
#endif
|
