1 /****************************************************************************
3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/legal
6 ** This file is part of the QtGui module of the Qt Toolkit.
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and Digia. For licensing terms and
14 ** conditions see http://qt.digia.com/licensing. For further information
15 ** use the contact form at http://qt.digia.com/contact-us.
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 2.1 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 2.1 requirements
23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25 ** In addition, as a special exception, Digia gives you certain additional
26 ** rights. These rights are described in the Digia Qt LGPL Exception
27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29 ** GNU General Public License Usage
30 ** Alternatively, this file may be used under the terms of the GNU
31 ** General Public License version 3.0 as published by the Free Software
32 ** Foundation and appearing in the file LICENSE.GPL included in the
33 ** packaging of this file. Please review the following information to
34 ** ensure the GNU General Public License version 3.0 requirements will be
35 ** met: http://www.gnu.org/copyleft/gpl.html.
40 ****************************************************************************/
45 #include <QtCore/qnamespace.h>
46 #include <QtCore/qchar.h>
47 #include <QtCore/qmetatype.h>
55 template <typename T> class QList;
56 struct QTextOptionPrivate;
58 class Q_GUI_EXPORT QTextOption
68 struct Q_GUI_EXPORT Tab {
69 inline Tab() : position(80), type(QTextOption::LeftTab) { }
70 inline Tab(qreal pos, TabType tabType, QChar delim = QChar())
71 : position(pos), type(tabType), delimiter(delim) {}
73 inline bool operator==(const Tab &other) const {
74 return type == other.type
75 && qFuzzyCompare(position, other.position)
76 && delimiter == other.delimiter;
79 inline bool operator!=(const Tab &other) const {
80 return !operator==(other);
89 /*implicit*/ QTextOption(Qt::Alignment alignment);
92 QTextOption(const QTextOption &o);
93 QTextOption &operator=(const QTextOption &o);
95 inline void setAlignment(Qt::Alignment alignment);
96 inline Qt::Alignment alignment() const { return Qt::Alignment(align); }
98 inline void setTextDirection(Qt::LayoutDirection aDirection) { this->direction = aDirection; }
99 inline Qt::LayoutDirection textDirection() const { return Qt::LayoutDirection(direction); }
106 WrapAtWordBoundaryOrAnywhere
108 inline void setWrapMode(WrapMode wrap) { wordWrap = wrap; }
109 inline WrapMode wrapMode() const { return static_cast<WrapMode>(wordWrap); }
112 ShowTabsAndSpaces = 0x1,
113 ShowLineAndParagraphSeparators = 0x2,
114 AddSpaceForLineAndParagraphSeparators = 0x4,
115 SuppressColors = 0x8,
116 IncludeTrailingSpaces = 0x80000000
118 Q_DECLARE_FLAGS(Flags, Flag)
119 inline void setFlags(Flags flags);
120 inline Flags flags() const { return Flags(f); }
122 inline void setTabStop(qreal tabStop);
123 inline qreal tabStop() const { return tab; }
125 void setTabArray(const QList<qreal> &tabStops);
126 QList<qreal> tabArray() const;
128 void setTabs(const QList<Tab> &tabStops);
129 QList<Tab> tabs() const;
131 void setUseDesignMetrics(bool b) { design = b; }
132 bool useDesignMetrics() const { return design; }
142 QTextOptionPrivate *d;
145 Q_DECLARE_OPERATORS_FOR_FLAGS(QTextOption::Flags)
147 inline void QTextOption::setAlignment(Qt::Alignment aalignment)
148 { align = aalignment; }
150 inline void QTextOption::setFlags(Flags aflags)
153 inline void QTextOption::setTabStop(qreal atabStop)
158 Q_DECLARE_METATYPE( QTextOption::Tab )
162 #endif // QTEXTOPTION_H