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
179
180
181
182
183
184
185
186
187
188
|
/*
This file is part of kdepim.
Copyright (c) 2004 Cornelius Schumacher <schumacher@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 KODE_CODE_H
#define KODE_CODE_H
#include <kode_export.h>
#include <QtCore/QString>
namespace KODE {
/**
* This class encapsulates a code block.
*/
class KODE_EXPORT Code
{
public:
/**
* Creates a new code block.
*/
Code();
/**
* Creates a new code block from @param other.
*/
Code(const Code &other);
/**
* Creates a new code block with the given @param indent.
*/
Code(int indent);
/**
* Destroys the code block.
*/
~Code();
/**
* Assignment operator.
*/
Code &operator=(const Code &other);
/**
* Clears all lines from the code block.
*/
void clear();
/**
* Returns whether the code block is empty.
*/
bool isEmpty() const;
/**
* Sets the @param indent of the code block.
*/
void setIndent(int indent);
/**
* Indents the code block by one level.
*/
void indent();
/**
* Unindents the code block by one level.
*/
void unindent();
/**
* Returns the textual presentation of the code block.
*/
QString text() const;
/**
* Adds the given @param line to the code block.
*/
void addLine(const QString &line);
/**
* Adds the given @param line to the code block.
*/
void addLine(const char line);
/**
* Adds the given @param block to the code block.
* The current indent will be prepended before every line of the block.
*/
void addBlock(const Code &block);
/**
* Adds the given @param block to the code block.
* The current indent will be prepended before every line of the block.
*/
void addBlock(const QString &block);
/**
* Adds the given @param block with the given indent
* to the code block.
*/
void addBlock(const QString &block, int indent);
/**
* Adds the given @param text to the code block and wrapps
* it if it's too long.
*/
void addWrappedText(const QString &text);
/**
* Adds the given @param text to the code block and wrapps
* it at word boundaries if it's too long.
*/
void addFormattedText(const QString &text);
/**
* Adds a new line to the code block.
*/
void newLine();
/**
* Adds the given @param line to the code block
* and appends a '\r\n' automatically.
*/
Code &operator+=(const QString &line);
/**
* Adds the given @param line to the code block
* and appends a '\r\n' automatically.
*/
Code &operator+=(const QByteArray &line);
/**
* Adds the given @param line to the code block
* and appends a '\r\n' automatically.
*/
Code &operator+=(const char *line);
/**
* Adds the given @param line to the code block
* and appends a '\r\n' automatically.
*/
Code &operator+=(const char line);
/**
* Adds the given @param block to the code block.
* @param block is supposed to be fully indented already
* (otherwise, use addBlock)
*/
Code &operator+=(const Code &block);
/**
* Returns a string filled up with spaces, depending on
* the level @param count and the indent value.
*/
static QString spaces(int count);
/**
* Sets the default indentation used by indent().
*/
static void setDefaultIndentation(int indent);
/**
* Returns the default indentation used by indent().
*/
static int defaultIndentation();
private:
class Private;
Private *d;
};
}
#endif
|
