Skip to content

PythonQt.QtGui.QTextBlockFormat · declarations 004

Back to PythonQt.QtGui.QTextBlockFormat

isCharFormat

isCharFormat() -> bool

X.isCharFormat() -> bool

isFrameFormat

isFrameFormat() -> bool

X.isFrameFormat() -> bool

isImageFormat

isImageFormat() -> bool

X.isImageFormat() -> bool

isListFormat

isListFormat() -> bool

X.isListFormat() -> bool

isTableCellFormat

isTableCellFormat() -> bool

X.isTableCellFormat() -> bool

isTableFormat

isTableFormat() -> bool

X.isTableFormat() -> bool

isValid

isValid() -> bool

X.isValid() -> bool

Supplemental documentation: Qt 5 reference:

bool QTextBlockFormat::isValid() const

Returns true if this block format is valid; otherwise returns false.

Upstream PySide2 reference signatures (binding differences may apply):

isValid(self) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qtextblockformat.html#isValid

leftMargin

leftMargin() -> float

X.leftMargin() -> float

Supplemental documentation: Qt 5 reference:

qreal QTextBlockFormat::leftMargin() const

Returns the paragraph's left margin.

See also setLeftMargin(), rightMargin(), and indent().

Upstream PySide2 reference signatures (binding differences may apply):

leftMargin(self) -> float

Source: https://doc.qt.io/archives/qt-5.15/qtextblockformat.html#leftMargin

lengthProperty

lengthProperty(propertyId: Any) -> Any

X.lengthProperty(propertyId) -> PythonQt.QtGui.QTextLength

lengthVectorProperty

lengthVectorProperty(propertyId: Any) -> tuple

X.lengthVectorProperty(propertyId) -> tuple

lineHeight

lineHeight(scriptLineHeight: Any, scaling: Any) -> float

X.lineHeight(scriptLineHeight, scaling) -> float

Supplemental documentation: Qt 5 reference:

qreal QTextBlockFormat::lineHeight(qreal scriptLineHeight, qreal scaling \= 1.0) const

Returns the height of the lines in the paragraph based on the height of the script line given by scriptLineHeight and the specified scaling factor.

The value that is returned is also dependent on the given LineHeightType of the paragraph as well as the LineHeight setting that has been set for the paragraph.

The scaling is needed for heights that include a fixed number of pixels, to scale them appropriately for printing.

This function was introduced in Qt 4.8.

See also LineHeightTypes, setLineHeight(), and lineHeightType().

qreal QTextBlockFormat::lineHeight() const

This returns the LineHeight property for the paragraph.

This function was introduced in Qt 4.8.

See also LineHeightTypes, setLineHeight(), and lineHeightType().

Upstream PySide2 reference signatures (binding differences may apply):

lineHeight(self) -> float
lineHeight(self, scriptLineHeight: float, scaling: float) -> float

Source: https://doc.qt.io/archives/qt-5.15/qtextblockformat.html#lineHeight

lineHeightType

lineHeightType() -> int

X.lineHeightType() -> int

Supplemental documentation: Qt 5 reference:

int QTextBlockFormat::lineHeightType() const

This returns the LineHeightType property of the paragraph.

This function was introduced in Qt 4.8.

See also LineHeightTypes, setLineHeight(), and lineHeight().

Upstream PySide2 reference signatures (binding differences may apply):

lineHeightType(self) -> int

Source: https://doc.qt.io/archives/qt-5.15/qtextblockformat.html#lineHeightType

merge

merge(other: Any) -> Any

X.merge(other)

nonBreakableLines

nonBreakableLines() -> bool

X.nonBreakableLines() -> bool

Supplemental documentation: Qt 5 reference:

bool QTextBlockFormat::nonBreakableLines() const

Returns true if the lines in the paragraph are non-breakable; otherwise returns false.

See also setNonBreakableLines().

Upstream PySide2 reference signatures (binding differences may apply):

nonBreakableLines(self) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qtextblockformat.html#nonBreakableLines

objectIndex

objectIndex() -> int

X.objectIndex() -> int

objectType

objectType() -> int

X.objectType() -> int

pageBreakPolicy

pageBreakPolicy() -> Any

X.pageBreakPolicy()

Supplemental documentation: Qt 5 reference:

QTextFormat::PageBreakFlags QTextBlockFormat::pageBreakPolicy() const

Returns the currently set page break policy for the paragraph. The default is QTextFormat::PageBreak_Auto.

This function was introduced in Qt 4.2.

See also setPageBreakPolicy().

Upstream PySide2 reference signatures (binding differences may apply):

pageBreakPolicy(self) -> PySide2.QtGui.QTextFormat.PageBreakFlags

Source: https://doc.qt.io/archives/qt-5.15/qtextblockformat.html#pageBreakPolicy

penProperty

penProperty(propertyId: Any) -> Any

X.penProperty(propertyId) -> PythonQt.QtGui.QPen

properties

properties() -> dict

X.properties() -> dict

property

property(propertyId: Any) -> Any

X.property(propertyId) -> object

propertyCount

propertyCount() -> int

X.propertyCount() -> int

rightMargin

rightMargin() -> float

X.rightMargin() -> float

Supplemental documentation: Qt 5 reference:

qreal QTextBlockFormat::rightMargin() const

Returns the paragraph's right margin.

See also setRightMargin() and leftMargin().

Upstream PySide2 reference signatures (binding differences may apply):

rightMargin(self) -> float

Source: https://doc.qt.io/archives/qt-5.15/qtextblockformat.html#rightMargin

setAlignment

setAlignment(alignment: Any) -> None

X.setAlignment(alignment)

Supplemental documentation: Qt 5 reference:

void QTextBlockFormat::setAlignment(Qt::Alignment alignment)

Sets the paragraph's alignment.

See also alignment().

Upstream PySide2 reference signatures (binding differences may apply):

setAlignment(self, alignment: PySide2.QtCore.Qt.Alignment) -> None

Source: https://doc.qt.io/archives/qt-5.15/qtextblockformat.html#setAlignment

setBackground

setBackground(brush: Any) -> Any

X.setBackground(brush)

setBottomMargin

setBottomMargin(margin: float) -> None

X.setBottomMargin(margin)

Supplemental documentation: Qt 5 reference:

void QTextBlockFormat::setBottomMargin(qreal margin)

Sets the paragraph's bottom margin.

See also bottomMargin(), setTopMargin(), setLeftMargin(), and setRightMargin().

Upstream PySide2 reference signatures (binding differences may apply):

setBottomMargin(self, margin: float) -> None

Source: https://doc.qt.io/archives/qt-5.15/qtextblockformat.html#setBottomMargin

setForeground

setForeground(brush: Any) -> Any

X.setForeground(brush)

setIndent

setIndent(indent: int) -> None

X.setIndent(indent)

Supplemental documentation: Qt 5 reference:

void QTextBlockFormat::setIndent(int indentation)

Sets the paragraph's indentation. Margins are set independently of indentation with setLeftMargin() and setTextIndent(). The indentation is an integer that is multiplied with the document-wide standard indent, resulting in the actual indent of the paragraph.

See also indent() and QTextDocument::indentWidth().

Upstream PySide2 reference signatures (binding differences may apply):

setIndent(self, indent: int) -> None

Source: https://doc.qt.io/archives/qt-5.15/qtextblockformat.html#setIndent

setLeftMargin

setLeftMargin(margin: float) -> None

X.setLeftMargin(margin)

Supplemental documentation: Qt 5 reference:

void QTextBlockFormat::setLeftMargin(qreal margin)

Sets the paragraph's left margin. Indentation can be applied separately with setIndent().

See also leftMargin(), setRightMargin(), setTopMargin(), and setBottomMargin().

Upstream PySide2 reference signatures (binding differences may apply):

setLeftMargin(self, margin: float) -> None

Source: https://doc.qt.io/archives/qt-5.15/qtextblockformat.html#setLeftMargin

setLineHeight

setLineHeight(height: float, heightType: int) -> None

X.setLineHeight(height, heightType)

Supplemental documentation: Qt 5 reference:

void QTextBlockFormat::setLineHeight(qreal height, int heightType)

Sets the line height for the paragraph to the value given by height which is dependent on heightType in the way described by the LineHeightTypes enum.

This function was introduced in Qt 4.8.

See also LineHeightTypes, lineHeight(), and lineHeightType().

Upstream PySide2 reference signatures (binding differences may apply):

setLineHeight(self, height: float, heightType: int) -> None

Source: https://doc.qt.io/archives/qt-5.15/qtextblockformat.html#setLineHeight

setNonBreakableLines

setNonBreakableLines(b: bool) -> None

X.setNonBreakableLines(b)

Supplemental documentation: Qt 5 reference:

void QTextBlockFormat::setNonBreakableLines(bool b)

If b is true, the lines in the paragraph are treated as non-breakable; otherwise they are breakable.

See also nonBreakableLines().

Upstream PySide2 reference signatures (binding differences may apply):

setNonBreakableLines(self, b: bool) -> None

Source: https://doc.qt.io/archives/qt-5.15/qtextblockformat.html#setNonBreakableLines

setObjectIndex

setObjectIndex(object: Any) -> Any

X.setObjectIndex(object)

setObjectType

setObjectType(type: Any) -> Any

X.setObjectType(type)

setPageBreakPolicy

setPageBreakPolicy(arg0: flags) -> None

X.setPageBreakPolicy(flags)

Supplemental documentation: Qt 5 reference:

void QTextBlockFormat::setPageBreakPolicy(QTextFormat::PageBreakFlags policy)

Sets the page break policy for the paragraph to policy.

This function was introduced in Qt 4.2.

See also pageBreakPolicy().

Upstream PySide2 reference signatures (binding differences may apply):

setPageBreakPolicy(self, flags: PySide2.QtGui.QTextFormat.PageBreakFlags) -> None

Source: https://doc.qt.io/archives/qt-5.15/qtextblockformat.html#setPageBreakPolicy

setProperty

setProperty(propertyId: Any, value: Any) -> Any

X.setProperty(propertyId, value)

setRightMargin

setRightMargin(margin: float) -> None

X.setRightMargin(margin)

Supplemental documentation: Qt 5 reference:

void QTextBlockFormat::setRightMargin(qreal margin)

Sets the paragraph's right margin.

See also rightMargin(), setLeftMargin(), setTopMargin(), and setBottomMargin().

Upstream PySide2 reference signatures (binding differences may apply):

setRightMargin(self, margin: float) -> None

Source: https://doc.qt.io/archives/qt-5.15/qtextblockformat.html#setRightMargin

setTabPositions

setTabPositions(tabs: Any) -> None

X.setTabPositions(tabs)

Supplemental documentation: Qt 5 reference:

void QTextBlockFormat::setTabPositions(const QList\<QTextOption::Tab> \&tabs)

Sets the tab positions for the text block to those specified by tabs.

This function was introduced in Qt 4.4.

See also tabPositions().

Upstream PySide2 reference signatures (binding differences may apply):

setTabPositions(self, tabs: typing.Sequence[PySide2.QtGui.QTextOption.Tab]) -> None

Source: https://doc.qt.io/archives/qt-5.15/qtextblockformat.html#setTabPositions

setTextIndent

setTextIndent(aindent: float) -> None

X.setTextIndent(aindent)

Supplemental documentation: Qt 5 reference:

void QTextBlockFormat::setTextIndent(qreal indent)

Sets the indent for the first line in the block. This allows the first line of a paragraph to be indented differently to the other lines, enhancing the readability of the text.

See also textIndent(), setLeftMargin(), setRightMargin(), setTopMargin(), and setBottomMargin().

Upstream PySide2 reference signatures (binding differences may apply):

setTextIndent(self, aindent: float) -> None

Source: https://doc.qt.io/archives/qt-5.15/qtextblockformat.html#setTextIndent

setTopMargin

setTopMargin(margin: float) -> None

X.setTopMargin(margin)

Supplemental documentation: Qt 5 reference:

void QTextBlockFormat::setTopMargin(qreal margin)

Sets the paragraph's top margin.

See also topMargin(), setBottomMargin(), setLeftMargin(), and setRightMargin().

Upstream PySide2 reference signatures (binding differences may apply):

setTopMargin(self, margin: float) -> None

Source: https://doc.qt.io/archives/qt-5.15/qtextblockformat.html#setTopMargin

stringProperty

stringProperty(propertyId: Any) -> str

X.stringProperty(propertyId) -> str

swap

swap(other: Any) -> Any

X.swap(other)