TextMark Class | Extending Qt Creator Manual

Extending Qt Creator Manual | TextMark

Extending Qt Creator Manual 4.4.1

# TextMark Class

(TextEditor::TextMark)

- List of all members, including inherited members

## Public Types

class | AnnotationRects
enum | Priority { LowPriority, NormalPriority, HighPriority }

## Public Functions

| TextMark(const QString &fileName, int lineNumber, Core::Id category, double widthFactor = 1.0)
| TextMark() = delete
virtual | ~TextMark()
void | addToToolTipLayout(QGridLayout *target) const
virtual bool | addToolTipContent(QLayout *target) const
AnnotationRects | annotationRects(const QRectF &boundingRect, const QFontMetrics &fm, const qreal fadeInOffset, const qreal fadeOutOffset) const
TextDocument * | baseTextDocument() const
Core::Id | category() const
virtual void | clicked()
Utils::Theme::Color | color() const
QString | defaultToolTip() const
virtual void | dragToLine(int lineNumber)
QString | fileName() const
bool | hasColor() const
const QIcon & | icon() const
virtual bool | isClickable() const
virtual bool | isDraggable() const
bool | isVisible() const
QString | lineAnnotation() const
int | lineNumber() const
virtual void | move(int line)
virtual void | paintAnnotation(QPainter &painter, QRectF *annotationRect, const qreal fadeInOffset, const qreal fadeOutOffset) const
virtual void | paintIcon(QPainter *painter, const QRect &rect) const
Priority | priority() const
virtual void | removedFromEditor()
void | setBaseTextDocument(TextDocument *baseTextDocument)
void | setColor(const Utils::Theme::Color &color)
void | setDefaultToolTip(const QString &toolTip)
void | setIcon(const QIcon &icon)
void | setLineAnnotation(const QString &lineAnnotation)
void | setPriority(Priority prioriy)
void | setToolTip(const QString &toolTip)
void | setVisible(bool isVisible)
void | setWidthFactor(double factor)
QString | toolTip() const
virtual void | updateBlock(const QTextBlock &block)
virtual void | updateFileName(const QString &fileName)
virtual void | updateLineNumber(int lineNumber)
void | updateMarker()
double | widthFactor() const

## Member Type Documentation

### enum TextMark::Priority

## Member Function Documentation

### TextMark::TextMark(const QString &fileName, int lineNumber, Core::Id category, double widthFactor = 1.0)

Default constructs an instance of TextMark.

### `[delete]` TextMark::TextMark()

Default constructs an instance of TextMark.

### `[virtual]` TextMark::~TextMark()

Destroys the instance of TextMark. The destructor is virtual.

### void TextMark::addToToolTipLayout(QGridLayout *target) const

### `[virtual]` bool TextMark::addToolTipContent(QLayout *target) const

### AnnotationRects TextMark::annotationRects(const QRectF &boundingRect, const QFontMetrics &fm, const qreal fadeInOffset, const qreal fadeOutOffset) const

### TextDocument *TextMark::baseTextDocument() const

See also setBaseTextDocument().

### Core::Id TextMark::category() const

### `[virtual]` void TextMark::clicked()

### Utils::Theme::Color TextMark::color() const

See also setColor().

### QString TextMark::defaultToolTip() const

See also setDefaultToolTip().

### `[virtual]` void TextMark::dragToLine(int lineNumber)

### QString TextMark::fileName() const

### bool TextMark::hasColor() const

### const QIcon &TextMark::icon() const

See also setIcon().

### `[virtual]` bool TextMark::isClickable() const

### `[virtual]` bool TextMark::isDraggable() const

### bool TextMark::isVisible() const

### QString TextMark::lineAnnotation() const

See also setLineAnnotation().

### int TextMark::lineNumber() const

### `[virtual]` void TextMark::move(int line)

### `[virtual]` void TextMark::paintAnnotation(QPainter &painter, QRectF *annotationRect, const qreal fadeInOffset, const qreal fadeOutOffset) const

### `[virtual]` void TextMark::paintIcon(QPainter *painter, const QRect &rect) const

### Priority TextMark::priority() const

See also setPriority().

### `[virtual]` void TextMark::removedFromEditor()

### void TextMark::setBaseTextDocument(TextDocument *baseTextDocument)

See also baseTextDocument().

### void TextMark::setColor(const Utils::Theme::Color &color)

See also color().

### void TextMark::setDefaultToolTip(const QString &toolTip)

See also defaultToolTip().

### void TextMark::setIcon(const QIcon &icon)

See also icon().

### void TextMark::setLineAnnotation(const QString &lineAnnotation)

See also lineAnnotation().

### void TextMark::setPriority(Priority prioriy)

See also priority().

### void TextMark::setToolTip(const QString &toolTip)

See also toolTip().

### void TextMark::setVisible(bool isVisible)

See also isVisible().

### void TextMark::setWidthFactor(double factor)

See also widthFactor().

### QString TextMark::toolTip() const

See also setToolTip().

### `[virtual]` void TextMark::updateBlock(const QTextBlock &block)

### `[virtual]` void TextMark::updateFileName(const QString &fileName)

### `[virtual]` void TextMark::updateLineNumber(int lineNumber)

### void TextMark::updateMarker()

### double TextMark::widthFactor() const

See also setWidthFactor().