diff options
Diffstat (limited to 'src/gui/text/qtextoption.cpp')
| -rw-r--r-- | src/gui/text/qtextoption.cpp | 434 |
1 files changed, 434 insertions, 0 deletions
diff --git a/src/gui/text/qtextoption.cpp b/src/gui/text/qtextoption.cpp new file mode 100644 index 0000000000..2b8e735305 --- /dev/null +++ b/src/gui/text/qtextoption.cpp @@ -0,0 +1,434 @@ +/**************************************************************************** +** +** Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies). +** All rights reserved. +** Contact: Nokia Corporation (qt-info@nokia.com) +** +** This file is part of the QtGui module of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL$ +** No Commercial Usage +** This file contains pre-release code and may not be distributed. +** You may use this file in accordance with the terms and conditions +** contained in the Technology Preview License Agreement accompanying +** this package. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Nokia gives you certain additional +** rights. These rights are described in the Nokia Qt LGPL Exception +** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. +** +** If you have questions regarding the use of this file, please contact +** Nokia at qt-info@nokia.com. +** +** +** +** +** +** +** +** +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#include "qtextoption.h" +#include "qapplication.h" +#include "qlist.h" + +QT_BEGIN_NAMESPACE + +struct QTextOptionPrivate +{ + QList<QTextOption::Tab> tabStops; +}; + +/*! + Constructs a text option with default properties for text. + The text alignment property is set to Qt::AlignLeft. The + word wrap property is set to QTextOption::WordWrap. The + using of design metrics flag is set to false. +*/ +QTextOption::QTextOption() + : align(Qt::AlignLeft), + wordWrap(QTextOption::WordWrap), + design(false), + unused(0), + f(0), + tab(-1), + d(0) +{ + direction = Qt::LayoutDirectionAuto; +} + +/*! + Constructs a text option with the given \a alignment for text. + The word wrap property is set to QTextOption::WordWrap. The using + of design metrics flag is set to false. +*/ +QTextOption::QTextOption(Qt::Alignment alignment) + : align(alignment), + wordWrap(QTextOption::WordWrap), + design(false), + unused(0), + f(0), + tab(-1), + d(0) +{ + direction = QApplication::layoutDirection(); +} + +/*! + Destroys the text option. +*/ +QTextOption::~QTextOption() +{ + delete d; +} + +/*! + \fn QTextOption::QTextOption(const QTextOption &other) + + Construct a copy of the \a other text option. +*/ +QTextOption::QTextOption(const QTextOption &o) + : align(o.align), + wordWrap(o.wordWrap), + design(o.design), + direction(o.direction), + unused(o.unused), + f(o.f), + tab(o.tab), + d(0) +{ + if (o.d) + d = new QTextOptionPrivate(*o.d); +} + +/*! + \fn QTextOption &QTextOption::operator=(const QTextOption &other) + + Returns true if the text option is the same as the \a other text option; + otherwise returns false. +*/ +QTextOption &QTextOption::operator=(const QTextOption &o) +{ + if (this == &o) + return *this; + + QTextOptionPrivate* dNew = 0; + if (o.d) + dNew = new QTextOptionPrivate(*o.d); + delete d; + d = dNew; + + align = o.align; + wordWrap = o.wordWrap; + design = o.design; + direction = o.direction; + unused = o.unused; + f = o.f; + tab = o.tab; + return *this; +} + +/*! + Sets the tab positions for the text layout to those specified by + \a tabStops. + + \sa tabArray(), setTabStop(), setTabs() +*/ +void QTextOption::setTabArray(QList<qreal> tabStops) // Qt5: const ref +{ + if (!d) + d = new QTextOptionPrivate; + QList<QTextOption::Tab> tabs; + QTextOption::Tab tab; + foreach (qreal pos, tabStops) { + tab.position = pos; + tabs.append(tab); + } + d->tabStops = tabs; +} + +/*! + \since 4.4 + Sets the tab positions for the text layout to those specified by + \a tabStops. + + \sa tabStops() +*/ +void QTextOption::setTabs(QList<QTextOption::Tab> tabStops) // Qt5: const ref +{ + if (!d) + d = new QTextOptionPrivate; + d->tabStops = tabStops; +} + +/*! + Returns a list of tab positions defined for the text layout. + + \sa setTabArray(), tabStop() +*/ +QList<qreal> QTextOption::tabArray() const +{ + if (!d) + return QList<qreal>(); + + QList<qreal> answer; + QList<QTextOption::Tab>::ConstIterator iter = d->tabStops.constBegin(); + while(iter != d->tabStops.constEnd()) { + answer.append( (*iter).position); + ++iter; + } + return answer; +} + + +QList<QTextOption::Tab> QTextOption::tabs() const +{ + if (!d) + return QList<QTextOption::Tab>(); + return d->tabStops; +} + +/*! + \class QTextOption + \reentrant + + \brief The QTextOption class provides a description of general rich text + properties. + + \ingroup richtext-processing + + QTextOption is used to encapsulate common rich text properties in a single + object. It contains information about text alignment, layout direction, + word wrapping, and other standard properties associated with text rendering + and layout. + + \sa QTextEdit, QTextDocument, QTextCursor +*/ + +/*! + \enum QTextOption::WrapMode + + This enum describes how text is wrapped in a document. + + \value NoWrap Text is not wrapped at all. + \value WordWrap Text is wrapped at word boundaries. + \value ManualWrap Same as QTextOption::NoWrap + \value WrapAnywhere Text can be wrapped at any point on a line, even if + it occurs in the middle of a word. + \value WrapAtWordBoundaryOrAnywhere If possible, wrapping occurs at a word + boundary; otherwise it will occur at the appropriate + point on the line, even in the middle of a word. +*/ + +/*! + \fn void QTextOption::setUseDesignMetrics(bool enable) + + If \a enable is true then the layout will use design metrics; + otherwise it will use the metrics of the paint device (which is + the default behavior). + + \sa useDesignMetrics() +*/ + +/*! + \fn bool QTextOption::useDesignMetrics() const + + Returns true if the layout uses design rather than device metrics; + otherwise returns false. + + \sa setUseDesignMetrics() +*/ + +/*! + \fn Qt::Alignment QTextOption::alignment() const + + Returns the text alignment defined by the option. + + \sa setAlignment() +*/ + +/*! + \fn void QTextOption::setAlignment(Qt::Alignment alignment); + + Sets the option's text alignment to the specified \a alignment. + + \sa alignment() +*/ + +/*! + \fn Qt::LayoutDirection QTextOption::textDirection() const + + Returns the direction of the text layout defined by the option. + + \sa setTextDirection() +*/ + +/*! + \fn void QTextOption::setTextDirection(Qt::LayoutDirection direction) + + Sets the direction of the text layout defined by the option to the + given \a direction. + + \sa textDirection() +*/ + +/*! + \fn WrapMode QTextOption::wrapMode() const + + Returns the text wrap mode defined by the option. + + \sa setWrapMode() +*/ + +/*! + \fn void QTextOption::setWrapMode(WrapMode mode) + + Sets the option's text wrap mode to the given \a mode. +*/ + +/*! + \enum QTextOption::Flag + + \value IncludeTrailingSpaces When this option is set, QTextLine::naturalTextWidth() and naturalTextRect() will + return a value that includes the width of trailing spaces in the text; otherwise + this width is excluded. + \value ShowTabsAndSpaces Visualize spaces with little dots, and tabs with little arrows. + \value ShowLineAndParagraphSeparators Visualize line and paragraph separators with appropriate symbol characters. + \value AddSpaceForLineAndParagraphSeparators While determining the line-break positions take into account the + space added for drawing a separator character. + \value SuppressColors Suppress all color changes in the character formats (except the main selection). +*/ + +/*! + \fn Flags QTextOption::flags() const + + Returns the flags associated with the option. + + \sa setFlags() +*/ + +/*! + \fn void QTextOption::setFlags(Flags flags) + + Sets the flags associated with the option to the given \a flags. + + \sa flags() +*/ + +/*! + \fn qreal QTextOption::tabStop() const + + Returns the distance in device units between tab stops. + Convenient function for the above method + + \sa setTabStop(), tabArray(), setTabs(), tabs() +*/ + +/*! + \fn void QTextOption::setTabStop(qreal tabStop) + + Sets the default distance in device units between tab stops to the value specified + by \a tabStop. + + \sa tabStop(), setTabArray(), setTabs(), tabs() +*/ + +/*! + \enum QTextOption::TabType + \since 4.4 + + This enum holds the different types of tabulator + + \value LeftTab A left-tab + \value RightTab A right-tab + \value CenterTab A centered-tab + \value DelimiterTab A tab stopping at a certain delimiter-character +*/ + +/*! + \class QTextOption::Tab + \since 4.4 + Each tab definition is represented by this struct. +*/ + +/*! + \variable Tab::position + Distance from the start of the paragraph. + The position of a tab is from the start of the paragraph which implies that when + the alignment of the paragraph is set to centered, the tab is interpreted to be + moved the same distance as the left ege of the paragraph does. + In case the paragraph is set to have a layoutDirection() RightToLeft the position + is interpreted to be from the right side of the paragraph with higher numbers moving + the tab to the left. +*/ + +/*! + \variable Tab::type + Determine which type is used. + In a paragraph that has layoutDirection() RightToLeft the type LeftTab will + be interpreted to be a RightTab and vice versa. +*/ + +/*! + \variable Tab::delimiter + If type is DelimitorTab; tab until this char is found in the text. +*/ + +/*! + \fn Tab::Tab() + Creates a default left tab with position 80. +*/ + +/*! + \fn Tab::Tab(qreal pos, TabType tabType, QChar delim = QChar()) + + Creates a tab with the given position, tab type, and delimiter + (\a pos, \a tabType, \a delim). + + \note \a delim is only used when \a tabType is DelimiterTab. + + \since 4.7 +*/ + +/*! + \fn bool Tab::operator==(const Tab &other) const + + Returns true if tab \a other is equal to this tab; + otherwise returns false. +*/ + +/*! + \fn bool Tab::operator!=(const Tab &other) const + + Returns true if tab \a other is not equal to this tab; + otherwise returns false. +*/ + +/*! + \fn void setTabs(QList<Tab> tabStops) + Set the Tab properties to \a tabStops. + + \sa tabStop(), tabs() +*/ + +/*! + \since 4.4 + \fn QList<QTextOption::Tab> QTextOption::tabs() const + Returns a list of tab positions defined for the text layout. + + \sa tabStop(), setTabs(), setTabStop() +*/ + + +QT_END_NAMESPACE |