Search for usage in LXR

KTextEditor::StyleOptionAnnotationItem Class Reference

#include <abstractannotationitemdelegate.h>

Inheritance diagram for KTextEditor::StyleOptionAnnotationItem:

Public Types

enum  AnnotationItemGroupPosition { InvalidGroupPosition = 0 , InGroup = 0x1 << 0 , GroupBegin = 0x1 << 1 , GroupEnd = 0x1 << 2 }
typedef QFlags< AnnotationItemGroupPositionAnnotationItemGroupPositions
enum  StyleOptionType { Type = SO_Default }
enum  StyleOptionVersion { Version = 1 }
- Public Types inherited from QStyleOption
enum  OptionType
enum  StyleOptionType
enum  StyleOptionVersion

Public Member Functions

 StyleOptionAnnotationItem (const StyleOptionAnnotationItem &other)
StyleOptionAnnotationItemoperator= (const StyleOptionAnnotationItem &)=default
- Public Member Functions inherited from QStyleOption
 QStyleOption (const QStyleOption &other)
 QStyleOption (int version, int type)
void initFrom (const QWidget *widget)
QStyleOptionoperator= (const QStyleOption &other)
qstyleoption_cast (const QStyleOption *option)
qstyleoption_cast (QStyleOption *option)

Public Attributes

AnnotationItemGroupPositions annotationItemGroupingPosition = InvalidGroupPosition
QFontMetricsF contentFontMetrics
QSize decorationSize
KTextEditor::Viewview = nullptr
int visibleWrappedLineInGroup = 0
int wrappedLine = 0
int wrappedLineCount = 1
- Public Attributes inherited from QStyleOption

Protected Member Functions

 StyleOptionAnnotationItem (int version)

Detailed Description

The style option set for an annotation item, as painted by AbstractAnnotationItemDelegate.

See also

Definition at line 29 of file abstractannotationitemdelegate.h.

Member Typedef Documentation

◆ AnnotationItemGroupPositions

Member Enumeration Documentation

◆ AnnotationItemGroupPosition

Enum for describing the relative position of a real line in the row of consecutive displayed lines which belong to the same group of annotation items.

See also

Position not specified or not belonging to a group.


Real line belongs to a group.


Real line is first of consecutive lines from same group.


Real line is last of consecutive lines from same group.

Definition at line 73 of file abstractannotationitemdelegate.h.

◆ StyleOptionType

enum KTextEditor::StyleOptionAnnotationItem::StyleOptionType

Definition at line 33 of file abstractannotationitemdelegate.h.

◆ StyleOptionVersion

enum KTextEditor::StyleOptionAnnotationItem::StyleOptionVersion

Definition at line 34 of file abstractannotationitemdelegate.h.

Constructor & Destructor Documentation

◆ StyleOptionAnnotationItem() [1/3]

StyleOptionAnnotationItem::StyleOptionAnnotationItem ( )

Definition at line 413 of file ktexteditor.cpp.

◆ StyleOptionAnnotationItem() [2/3]

StyleOptionAnnotationItem::StyleOptionAnnotationItem ( const StyleOptionAnnotationItem & other)

Definition at line 418 of file ktexteditor.cpp.

◆ StyleOptionAnnotationItem() [3/3]

StyleOptionAnnotationItem::StyleOptionAnnotationItem ( int version)

Definition at line 425 of file ktexteditor.cpp.

Member Data Documentation

◆ annotationItemGroupingPosition

AnnotationItemGroupPositions KTextEditor::StyleOptionAnnotationItem::annotationItemGroupingPosition = InvalidGroupPosition

Relative position of the real line in the row of consecutive displayed lines which belong to the same group of annotation items.

Definition at line 86 of file abstractannotationitemdelegate.h.

◆ contentFontMetrics

QFontMetricsF KTextEditor::StyleOptionAnnotationItem::contentFontMetrics

The metrics of the font used for rendering the text document.

Definition at line 66 of file abstractannotationitemdelegate.h.

◆ decorationSize

QSize KTextEditor::StyleOptionAnnotationItem::decorationSize

Recommended size for icons or other symbols that will be rendered by the delegate.

The default value is QSize(-1, -1).

Definition at line 62 of file abstractannotationitemdelegate.h.

◆ view

KTextEditor::View* KTextEditor::StyleOptionAnnotationItem::view = nullptr

The view where the annotation is shown.

There is always a view set.

Definition at line 56 of file abstractannotationitemdelegate.h.

◆ visibleWrappedLineInGroup

int KTextEditor::StyleOptionAnnotationItem::visibleWrappedLineInGroup = 0

Index of the displayed line in the displayed lines for the same group.

Definition at line 49 of file abstractannotationitemdelegate.h.

◆ wrappedLine

int KTextEditor::StyleOptionAnnotationItem::wrappedLine = 0

Index of the displayed line in the wrapped lines for the given real line.

Definition at line 39 of file abstractannotationitemdelegate.h.

◆ wrappedLineCount

int KTextEditor::StyleOptionAnnotationItem::wrappedLineCount = 1

Number of wrapped lines for the given real line.

A value of 1 means no wrapping has happened and the real line is displayed as one line.

Definition at line 45 of file abstractannotationitemdelegate.h.

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Tue Mar 26 2024 11:15:44 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.