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

API reference - Class QTextBlockFormat

Notation used in Ruby API documentation

Description: Binding of QTextBlockFormat

Class hierarchy: QTextBlockFormat » QTextFormat

Public constructors

new QTextBlockFormatnewConstructor QTextBlockFormat::QTextBlockFormat()

Public methods

[const]intalignmentMethod QFlags<enum Qt::AlignmentFlag> QTextBlockFormat::alignment()
voidalignment=(int alignment)Method void QTextBlockFormat::setAlignment(QFlags<enum Qt::AlignmentFlag> alignment)
[const]voidassign(const QTextBlockFormat other)Assign the contents of another object to self
[const]doublebottomMarginMethod double QTextBlockFormat::bottomMargin()
voidbottomMargin=(double margin)Method void QTextBlockFormat::setBottomMargin(double margin)
voidcreateEnsures the C++ object is created
voiddestroyExplicitly destroy the object
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
[const]QTextBlockFormatdupCreates a copy of self
[const]intindentMethod int QTextBlockFormat::indent()
voidindent=(int indent)Method void QTextBlockFormat::setIndent(int indent)
[const]boolisValidMethod bool QTextBlockFormat::isValid()
[const]boolisValid?Method bool QTextBlockFormat::isValid()
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
[const]doubleleftMarginMethod double QTextBlockFormat::leftMargin()
voidleftMargin=(double margin)Method void QTextBlockFormat::setLeftMargin(double margin)
[const]boolnonBreakableLinesMethod bool QTextBlockFormat::nonBreakableLines()
voidnonBreakableLines=(bool b)Method void QTextBlockFormat::setNonBreakableLines(bool b)
[const]intpageBreakPolicyMethod QFlags<enum QTextFormat::PageBreakFlag> QTextBlockFormat::pageBreakPolicy()
voidpageBreakPolicy=(int flags)Method void QTextBlockFormat::setPageBreakPolicy(QFlags<enum QTextFormat::PageBreakFlag> flags)
[const]doublerightMarginMethod double QTextBlockFormat::rightMargin()
voidrightMargin=(double margin)Method void QTextBlockFormat::setRightMargin(double margin)
voidsetAlignment(int alignment)Method void QTextBlockFormat::setAlignment(QFlags<enum Qt::AlignmentFlag> alignment)
voidsetBottomMargin(double margin)Method void QTextBlockFormat::setBottomMargin(double margin)
voidsetIndent(int indent)Method void QTextBlockFormat::setIndent(int indent)
voidsetLeftMargin(double margin)Method void QTextBlockFormat::setLeftMargin(double margin)
voidsetNonBreakableLines(bool b)Method void QTextBlockFormat::setNonBreakableLines(bool b)
voidsetPageBreakPolicy(int flags)Method void QTextBlockFormat::setPageBreakPolicy(QFlags<enum QTextFormat::PageBreakFlag> flags)
voidsetRightMargin(double margin)Method void QTextBlockFormat::setRightMargin(double margin)
voidsetTabPositions(QTextOption_Tab[] tabs)Method void QTextBlockFormat::setTabPositions(const QList<struct QTextOption::Tab> &tabs)
voidsetTextIndent(double aindent)Method void QTextBlockFormat::setTextIndent(double aindent)
voidsetTopMargin(double margin)Method void QTextBlockFormat::setTopMargin(double margin)
[const]QTextOption_Tab[]tabPositionsMethod QList<struct QTextOption::Tab> QTextBlockFormat::tabPositions()
voidtabPositions=(QTextOption_Tab[] tabs)Method void QTextBlockFormat::setTabPositions(const QList<struct QTextOption::Tab> &tabs)
[const]doubletextIndentMethod double QTextBlockFormat::textIndent()
voidtextIndent=(double aindent)Method void QTextBlockFormat::setTextIndent(double aindent)
[const]doubletopMarginMethod double QTextBlockFormat::topMargin()
voidtopMargin=(double margin)Method void QTextBlockFormat::setTopMargin(double margin)

Detailed description

[const] int alignment

Description: Method QFlags<enum Qt::AlignmentFlag> QTextBlockFormat::alignment()

void alignment=(int alignment)

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

[const] void assign(const QTextBlockFormat 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.

[const] double bottomMargin

Description: Method double QTextBlockFormat::bottomMargin()

void bottomMargin=(double margin)

Description: Method void QTextBlockFormat::setBottomMargin(double margin)

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] QTextBlockFormat dup

Description: Creates a copy of self

[const] int indent

Description: Method int QTextBlockFormat::indent()

void indent=(int indent)

Description: Method void QTextBlockFormat::setIndent(int indent)

[const] bool isValid

Description: Method bool QTextBlockFormat::isValid()

[const] bool isValid?

Description: Method bool QTextBlockFormat::isValid()

[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.

[const] double leftMargin

Description: Method double QTextBlockFormat::leftMargin()

void leftMargin=(double margin)

Description: Method void QTextBlockFormat::setLeftMargin(double margin)

[static] new QTextBlockFormat new

Description: Constructor QTextBlockFormat::QTextBlockFormat()

This method creates an object of class QTextBlockFormat.

[const] bool nonBreakableLines

Description: Method bool QTextBlockFormat::nonBreakableLines()

void nonBreakableLines=(bool b)

Description: Method void QTextBlockFormat::setNonBreakableLines(bool b)

[const] int pageBreakPolicy

Description: Method QFlags<enum QTextFormat::PageBreakFlag> QTextBlockFormat::pageBreakPolicy()

void pageBreakPolicy=(int flags)

Description: Method void QTextBlockFormat::setPageBreakPolicy(QFlags<enum QTextFormat::PageBreakFlag> flags)

[const] double rightMargin

Description: Method double QTextBlockFormat::rightMargin()

void rightMargin=(double margin)

Description: Method void QTextBlockFormat::setRightMargin(double margin)

void setAlignment(int alignment)

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

void setBottomMargin(double margin)

Description: Method void QTextBlockFormat::setBottomMargin(double margin)

void setIndent(int indent)

Description: Method void QTextBlockFormat::setIndent(int indent)

void setLeftMargin(double margin)

Description: Method void QTextBlockFormat::setLeftMargin(double margin)

void setNonBreakableLines(bool b)

Description: Method void QTextBlockFormat::setNonBreakableLines(bool b)

void setPageBreakPolicy(int flags)

Description: Method void QTextBlockFormat::setPageBreakPolicy(QFlags<enum QTextFormat::PageBreakFlag> flags)

void setRightMargin(double margin)

Description: Method void QTextBlockFormat::setRightMargin(double margin)

void setTabPositions(QTextOption_Tab[] tabs)

Description: Method void QTextBlockFormat::setTabPositions(const QList<struct QTextOption::Tab> &tabs)

void setTextIndent(double aindent)

Description: Method void QTextBlockFormat::setTextIndent(double aindent)

void setTopMargin(double margin)

Description: Method void QTextBlockFormat::setTopMargin(double margin)

[const] QTextOption_Tab[] tabPositions

Description: Method QList<struct QTextOption::Tab> QTextBlockFormat::tabPositions()

void tabPositions=(QTextOption_Tab[] tabs)

Description: Method void QTextBlockFormat::setTabPositions(const QList<struct QTextOption::Tab> &tabs)

[const] double textIndent

Description: Method double QTextBlockFormat::textIndent()

void textIndent=(double aindent)

Description: Method void QTextBlockFormat::setTextIndent(double aindent)

[const] double topMargin

Description: Method double QTextBlockFormat::topMargin()

void topMargin=(double margin)

Description: Method void QTextBlockFormat::setTopMargin(double margin)