TextDocumentLayout Class | Extending Qt Creator Manual

Extending Qt Creator Manual | TextDocumentLayout

Extending Qt Creator Manual 4.6.0

# TextDocumentLayout Class

(TextEditor::TextDocumentLayout)

- List of all members, including inherited members

## Public Types

class | FoldValidator

## Public Functions

| TextDocumentLayout(QTextDocument *doc)
| ~TextDocumentLayout()
QRectF | blockBoundingRect(const QTextBlock &block) const override
TextMarks | documentClosing()
void | documentReloaded(TextMarks marks, TextDocument *baseextDocument)
QSizeF | documentSize() const override
void | emitDocumentSizeChanged()
void | requestExtraAreaUpdate()
void | setRequiredWidth(int width)
void | updateMarksBlock(const QTextBlock &block)
void | updateMarksLineNumber()

## Signals

void | foldChanged(const int blockNumber, bool folded)
void | updateExtraArea()

## Static Public Members

int | braceDepth(const QTextBlock &block)
int | braceDepthDelta(const QTextBlock &block)
bool | canFold(const QTextBlock &block)
void | changeBraceDepth(QTextBlock &block, int delta)
void | changeFoldingIndent(QTextBlock &block, int delta)
bool | clearIfdefedOut(const QTextBlock &block)
void | clearParentheses(const QTextBlock &block)
void | doFoldOrUnfold(const QTextBlock &block, bool unfold)
int | foldingIndent(const QTextBlock &block)
bool | hasParentheses(const QTextBlock &block)
bool | ifdefedOut(const QTextBlock &block)
bool | isFolded(const QTextBlock &block)
int | lexerState(const QTextBlock &block)
Parentheses | parentheses(const QTextBlock &block)
void | setBraceDepth(QTextBlock &block, int depth)
void | setFolded(const QTextBlock &block, bool folded)
void | setFoldingIndent(const QTextBlock &block, int indent)
bool | setIfdefedOut(const QTextBlock &block)
void | setLexerState(const QTextBlock &block, int state)
void | setParentheses(const QTextBlock &block, const Parentheses &parentheses)
TextBlockUserData * | testUserData(const QTextBlock &block)
TextBlockUserData * | userData(const QTextBlock &block)

## Member Function Documentation

### TextDocumentLayout::TextDocumentLayout(QTextDocument *doc)

Default constructs an instance of TextDocumentLayout.

### TextDocumentLayout::~TextDocumentLayout()

Destroys the instance of TextDocumentLayout.

### QRectF TextDocumentLayout::blockBoundingRect(const QTextBlock &block) const

### `[static]` int TextDocumentLayout::braceDepth(const QTextBlock &block)

See also setBraceDepth().

### `[static]` int TextDocumentLayout::braceDepthDelta(const QTextBlock &block)

### `[static]` bool TextDocumentLayout::canFold(const QTextBlock &block)

### `[static]` void TextDocumentLayout::changeBraceDepth(QTextBlock &block, int delta)

### `[static]` void TextDocumentLayout::changeFoldingIndent(QTextBlock &block, int delta)

### `[static]` bool TextDocumentLayout::clearIfdefedOut(const QTextBlock &block)

### `[static]` void TextDocumentLayout::clearParentheses(const QTextBlock &block)

### `[static]` void TextDocumentLayout::doFoldOrUnfold(const QTextBlock &block, bool unfold)

### TextMarks TextDocumentLayout::documentClosing()

### void TextDocumentLayout::documentReloaded(TextMarks marks, TextDocument *baseextDocument)

### QSizeF TextDocumentLayout::documentSize() const

### void TextDocumentLayout::emitDocumentSizeChanged()

### `[signal]` void TextDocumentLayout::foldChanged(const int blockNumber, bool folded)

### `[static]` int TextDocumentLayout::foldingIndent(const QTextBlock &block)

See also setFoldingIndent().

### `[static]` bool TextDocumentLayout::hasParentheses(const QTextBlock &block)

### `[static]` bool TextDocumentLayout::ifdefedOut(const QTextBlock &block)

See also setIfdefedOut().

### `[static]` bool TextDocumentLayout::isFolded(const QTextBlock &block)

### `[static]` int TextDocumentLayout::lexerState(const QTextBlock &block)

See also setLexerState().

### `[static]` Parentheses TextDocumentLayout::parentheses(const QTextBlock &block)

See also setParentheses().

### void TextDocumentLayout::requestExtraAreaUpdate()

### `[static]` void TextDocumentLayout::setBraceDepth(QTextBlock &block, int depth)

See also braceDepth().

### `[static]` void TextDocumentLayout::setFolded(const QTextBlock &block, bool folded)

See also isFolded().

### `[static]` void TextDocumentLayout::setFoldingIndent(const QTextBlock &block, int indent)

See also foldingIndent().

### `[static]` bool TextDocumentLayout::setIfdefedOut(const QTextBlock &block)

See also ifdefedOut().

### `[static]` void TextDocumentLayout::setLexerState(const QTextBlock &block, int state)

See also lexerState().

### `[static]` void TextDocumentLayout::setParentheses(const QTextBlock &block, const Parentheses &parentheses)

See also parentheses().

### void TextDocumentLayout::setRequiredWidth(int width)

### `[static]` TextBlockUserData *TextDocumentLayout::testUserData(const QTextBlock &block)

### `[signal]` void TextDocumentLayout::updateExtraArea()

### void TextDocumentLayout::updateMarksBlock(const QTextBlock &block)

### void TextDocumentLayout::updateMarksLineNumber()

### `[static]` TextBlockUserData *TextDocumentLayout::userData(const QTextBlock &block)