src/gui/text/qtextoption.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the QtGui module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** GNU Lesser General Public License Usage
  10 ** This file may be used under the terms of the GNU Lesser General Public
  11 ** License version 2.1 as published by the Free Software Foundation and
  12 ** appearing in the file LICENSE.LGPL included in the packaging of this
  13 ** file. Please review the following information to ensure the GNU Lesser
  14 ** General Public License version 2.1 requirements will be met:
  15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  16 **
  17 ** In addition, as a special exception, Nokia gives you certain additional
  18 ** rights. These rights are described in the Nokia Qt LGPL Exception
  19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  20 **
  21 ** GNU General Public License Usage
  22 ** Alternatively, this file may be used under the terms of the GNU General
  23 ** Public License version 3.0 as published by the Free Software Foundation
  24 ** and appearing in the file LICENSE.GPL included in the packaging of this
  25 ** file. Please review the following information to ensure the GNU General
  26 ** Public License version 3.0 requirements will be met:
  27 ** http://www.gnu.org/copyleft/gpl.html.
  28 **
  29 ** Other Usage
  30 ** Alternatively, this file may be used in accordance with the terms and
  31 ** conditions contained in a signed written agreement between you and Nokia.
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QTEXTOPTION_H
  43 #define QTEXTOPTION_H
  44
  45 #include <QtCore/qnamespace.h>
  46 #include <QtCore/qchar.h>
  47 #include <QtCore/qmetatype.h>
  48
  49
  50 QT_BEGIN_HEADER
  51
  52 QT_BEGIN_NAMESPACE
  53
  54
  55 template <typename T> class QList;
  56 struct QTextOptionPrivate;
  57
  58 class Q_GUI_EXPORT QTextOption
  59 {
  60 public:
  61     enum TabType {
  62         LeftTab,
  63         RightTab,
  64         CenterTab,
  65         DelimiterTab
  66     };
  67
  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) {}
  72
  73         inline bool operator==(const Tab &other) const {
  74             return type == other.type
  75                    && qFuzzyCompare(position, other.position)
  76                    && delimiter == other.delimiter;
  77         }
  78
  79         inline bool operator!=(const Tab &other) const {
  80             return !operator==(other);
  81         }
  82
  83         qreal position;
  84         TabType type;
  85         QChar delimiter;
  86     };
  87
  88     QTextOption();
  89     /*implicit*/ QTextOption(Qt::Alignment alignment);
  90     ~QTextOption();
  91
  92     QTextOption(const QTextOption &o);
  93     QTextOption &operator=(const QTextOption &o);
  94
  95     inline void setAlignment(Qt::Alignment alignment);
  96     inline Qt::Alignment alignment() const { return Qt::Alignment(align); }
  97
  98     inline void setTextDirection(Qt::LayoutDirection aDirection) { this->direction = aDirection; }
  99     inline Qt::LayoutDirection textDirection() const { return Qt::LayoutDirection(direction); }
 100
 101     enum WrapMode {
 102         NoWrap,
 103         WordWrap,
 104         ManualWrap,
 105         WrapAnywhere,
 106         WrapAtWordBoundaryOrAnywhere
 107     };
 108     inline void setWrapMode(WrapMode wrap) { wordWrap = wrap; }
 109     inline WrapMode wrapMode() const { return static_cast<WrapMode>(wordWrap); }
 110
 111     enum Flag {
 112         ShowTabsAndSpaces = 0x1,
 113         ShowLineAndParagraphSeparators = 0x2,
 114         AddSpaceForLineAndParagraphSeparators = 0x4,
 115         SuppressColors = 0x8,
 116         IncludeTrailingSpaces = 0x80000000
 117     };
 118     Q_DECLARE_FLAGS(Flags, Flag)
 119     inline void setFlags(Flags flags);
 120     inline Flags flags() const { return Flags(f); }
 121
 122     inline void setTabStop(qreal tabStop);
 123     inline qreal tabStop() const { return tab; }
 124
 125     void setTabArray(const QList<qreal> &tabStops);
 126     QList<qreal> tabArray() const;
 127
 128     void setTabs(const QList<Tab> &tabStops);
 129     QList<Tab> tabs() const;
 130
 131     void setUseDesignMetrics(bool b) { design = b; }
 132     bool useDesignMetrics() const { return design; }
 133
 134 private:
 135     uint align : 8;
 136     uint wordWrap : 4;
 137     uint design : 1;
 138     uint direction : 2;
 139     uint unused : 18;
 140     uint f;
 141     qreal tab;
 142     QTextOptionPrivate *d;
 143 };
 144
 145 Q_DECLARE_OPERATORS_FOR_FLAGS(QTextOption::Flags)
 146
 147 inline void QTextOption::setAlignment(Qt::Alignment aalignment)
 148 { align = aalignment; }
 149
 150 inline void QTextOption::setFlags(Flags aflags)
 151 { f = aflags; }
 152
 153 inline void QTextOption::setTabStop(qreal atabStop)
 154 { tab = atabStop; }
 155
 156 QT_END_NAMESPACE
 157
 158 Q_DECLARE_METATYPE( QTextOption::Tab )
 159
 160 QT_END_HEADER
 161
 162 #endif // QTEXTOPTION_H