KLayout Manual: Main Index » Class Index » API reference - Class QTextOption

API reference - Class QTextOption

Notation used in Ruby API documentation

Description: Binding of QTextOption

Public constructors

new QTextOptionnewConstructor QTextOption::QTextOption()
new QTextOptionnew(const Qt_QFlags_AlignmentFlag alignment)Constructor QTextOption::QTextOption(QFlags<Qt::AlignmentFlag> alignment)
new QTextOptionnew(const QTextOption o)Constructor QTextOption::QTextOption(const QTextOption &o)

Public methods

[const]Qt_QFlags_AlignmentFlagalignmentMethod QFlags<Qt::AlignmentFlag> QTextOption::alignment()
voidalignment=(const Qt_QFlags_AlignmentFlag alignment)Method void QTextOption::setAlignment(QFlags<Qt::AlignmentFlag> alignment)
QTextOptionassign(const QTextOption o)Method QTextOption &QTextOption::operator=(const QTextOption &o)
[const]voidassign(const QTextOption other)Assign the contents of another object to self
voidcreateEnsures the C++ object is created
voiddestroyExplicitly destroy the object
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
[const]QTextOptiondupCreates a copy of self
[const]QTextOption_QFlags_FlagflagsMethod QFlags<QTextOption::Flag> QTextOption::flags()
voidflags=(const QTextOption_QFlags_Flag flags)Method void QTextOption::setFlags(QFlags<QTextOption::Flag> flags)
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
voidsetAlignment(const Qt_QFlags_AlignmentFlag alignment)Method void QTextOption::setAlignment(QFlags<Qt::AlignmentFlag> alignment)
voidsetFlags(const QTextOption_QFlags_Flag flags)Method void QTextOption::setFlags(QFlags<QTextOption::Flag> flags)
voidsetTabArray(double[] tabStops)Method void QTextOption::setTabArray(QList<double> tabStops)
voidsetTabStop(double tabStop)Method void QTextOption::setTabStop(double tabStop)
voidsetTabs(QTextOption_Tab[] tabStops)Method void QTextOption::setTabs(QList<QTextOption::Tab> tabStops)
voidsetTextDirection(const Qt_LayoutDirection aDirection)Method void QTextOption::setTextDirection(Qt::LayoutDirection aDirection)
voidsetUseDesignMetrics(bool b)Method void QTextOption::setUseDesignMetrics(bool b)
voidsetWrapMode(const QTextOption_WrapMode wrap)Method void QTextOption::setWrapMode(QTextOption::WrapMode wrap)
[const]double[]tabArrayMethod QList<double> QTextOption::tabArray()
voidtabArray=(double[] tabStops)Method void QTextOption::setTabArray(QList<double> tabStops)
[const]doubletabStopMethod double QTextOption::tabStop()
voidtabStop=(double tabStop)Method void QTextOption::setTabStop(double tabStop)
[const]QTextOption_Tab[]tabsMethod QList<QTextOption::Tab> QTextOption::tabs()
voidtabs=(QTextOption_Tab[] tabStops)Method void QTextOption::setTabs(QList<QTextOption::Tab> tabStops)
[const]Qt_LayoutDirectiontextDirectionMethod Qt::LayoutDirection QTextOption::textDirection()
voidtextDirection=(const Qt_LayoutDirection aDirection)Method void QTextOption::setTextDirection(Qt::LayoutDirection aDirection)
[const]booluseDesignMetricsMethod bool QTextOption::useDesignMetrics()
voiduseDesignMetrics=(bool b)Method void QTextOption::setUseDesignMetrics(bool b)
[const]QTextOption_WrapModewrapModeMethod QTextOption::WrapMode QTextOption::wrapMode()
voidwrapMode=(const QTextOption_WrapMode wrap)Method void QTextOption::setWrapMode(QTextOption::WrapMode wrap)

Public static methods and constants

QTextOption_FlagAddSpaceForLineAndParagraphSeparatorsEnum constant QTextOption::AddSpaceForLineAndParagraphSeparators
QTextOption_FlagIncludeTrailingSpacesEnum constant QTextOption::IncludeTrailingSpaces
QTextOption_WrapModeManualWrapEnum constant QTextOption::ManualWrap
QTextOption_WrapModeNoWrapEnum constant QTextOption::NoWrap
QTextOption_FlagShowLineAndParagraphSeparatorsEnum constant QTextOption::ShowLineAndParagraphSeparators
QTextOption_FlagShowTabsAndSpacesEnum constant QTextOption::ShowTabsAndSpaces
QTextOption_FlagSuppressColorsEnum constant QTextOption::SuppressColors
QTextOption_WrapModeWordWrapEnum constant QTextOption::WordWrap
QTextOption_WrapModeWrapAnywhereEnum constant QTextOption::WrapAnywhere
QTextOption_WrapModeWrapAtWordBoundaryOrAnywhereEnum constant QTextOption::WrapAtWordBoundaryOrAnywhere

Detailed description

[static] QTextOption_Flag AddSpaceForLineAndParagraphSeparators

Description: Enum constant QTextOption::AddSpaceForLineAndParagraphSeparators

[static] QTextOption_Flag IncludeTrailingSpaces

Description: Enum constant QTextOption::IncludeTrailingSpaces

[static] QTextOption_WrapMode ManualWrap

Description: Enum constant QTextOption::ManualWrap

[static] QTextOption_WrapMode NoWrap

Description: Enum constant QTextOption::NoWrap

[static] QTextOption_Flag ShowLineAndParagraphSeparators

Description: Enum constant QTextOption::ShowLineAndParagraphSeparators

[static] QTextOption_Flag ShowTabsAndSpaces

Description: Enum constant QTextOption::ShowTabsAndSpaces

[static] QTextOption_Flag SuppressColors

Description: Enum constant QTextOption::SuppressColors

[static] QTextOption_WrapMode WordWrap

Description: Enum constant QTextOption::WordWrap

[static] QTextOption_WrapMode WrapAnywhere

Description: Enum constant QTextOption::WrapAnywhere

[static] QTextOption_WrapMode WrapAtWordBoundaryOrAnywhere

Description: Enum constant QTextOption::WrapAtWordBoundaryOrAnywhere

[const] Qt_QFlags_AlignmentFlag alignment

Description: Method QFlags<Qt::AlignmentFlag> QTextOption::alignment()

void alignment=(const Qt_QFlags_AlignmentFlag alignment)

Description: Method void QTextOption::setAlignment(QFlags<Qt::AlignmentFlag> alignment)

QTextOption assign(const QTextOption o)

Description: Method QTextOption &QTextOption::operator=(const QTextOption &o)

[const] void assign(const QTextOption other)

Description: Assign the contents of another object to self

This method assigns the contents of another object to self. This is a deep copy that does not only copy the reference but the actual content.

void create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

void destroy

Description: Explicitly destroy the object

Explicitly destroy the object on C++ side if it was owned by the Ruby interpreter. Subsequent access to this object will throw an exception. If the object is not owned by Ruby, this method will do nothing.

[const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

[const] QTextOption dup

Description: Creates a copy of self

[const] QTextOption_QFlags_Flag flags

Description: Method QFlags<QTextOption::Flag> QTextOption::flags()

void flags=(const QTextOption_QFlags_Flag flags)

Description: Method void QTextOption::setFlags(QFlags<QTextOption::Flag> flags)

[const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

[static] new QTextOption new

Description: Constructor QTextOption::QTextOption()

This method creates an object of class QTextOption.

[static] new QTextOption new(const Qt_QFlags_AlignmentFlag alignment)

Description: Constructor QTextOption::QTextOption(QFlags<Qt::AlignmentFlag> alignment)

This method creates an object of class QTextOption.

[static] new QTextOption new(const QTextOption o)

Description: Constructor QTextOption::QTextOption(const QTextOption &o)

This method creates an object of class QTextOption.

void setAlignment(const Qt_QFlags_AlignmentFlag alignment)

Description: Method void QTextOption::setAlignment(QFlags<Qt::AlignmentFlag> alignment)

void setFlags(const QTextOption_QFlags_Flag flags)

Description: Method void QTextOption::setFlags(QFlags<QTextOption::Flag> flags)

void setTabArray(double[] tabStops)

Description: Method void QTextOption::setTabArray(QList<double> tabStops)

void setTabStop(double tabStop)

Description: Method void QTextOption::setTabStop(double tabStop)

void setTabs(QTextOption_Tab[] tabStops)

Description: Method void QTextOption::setTabs(QList<QTextOption::Tab> tabStops)

void setTextDirection(const Qt_LayoutDirection aDirection)

Description: Method void QTextOption::setTextDirection(Qt::LayoutDirection aDirection)

void setUseDesignMetrics(bool b)

Description: Method void QTextOption::setUseDesignMetrics(bool b)

void setWrapMode(const QTextOption_WrapMode wrap)

Description: Method void QTextOption::setWrapMode(QTextOption::WrapMode wrap)

[const] double[] tabArray

Description: Method QList<double> QTextOption::tabArray()

void tabArray=(double[] tabStops)

Description: Method void QTextOption::setTabArray(QList<double> tabStops)

[const] double tabStop

Description: Method double QTextOption::tabStop()

void tabStop=(double tabStop)

Description: Method void QTextOption::setTabStop(double tabStop)

[const] QTextOption_Tab[] tabs

Description: Method QList<QTextOption::Tab> QTextOption::tabs()

void tabs=(QTextOption_Tab[] tabStops)

Description: Method void QTextOption::setTabs(QList<QTextOption::Tab> tabStops)

[const] Qt_LayoutDirection textDirection

Description: Method Qt::LayoutDirection QTextOption::textDirection()

void textDirection=(const Qt_LayoutDirection aDirection)

Description: Method void QTextOption::setTextDirection(Qt::LayoutDirection aDirection)

[const] bool useDesignMetrics

Description: Method bool QTextOption::useDesignMetrics()

void useDesignMetrics=(bool b)

Description: Method void QTextOption::setUseDesignMetrics(bool b)

[const] QTextOption_WrapMode wrapMode

Description: Method QTextOption::WrapMode QTextOption::wrapMode()

void wrapMode=(const QTextOption_WrapMode wrap)

Description: Method void QTextOption::setWrapMode(QTextOption::WrapMode wrap)