KTextEditor::StyleOptionAnnotationItem

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 (int version, int type)
 
 QStyleOption (const QStyleOption &other)
 
void init (const QWidget *widget)
 
void initFrom (const QWidget *widget)
 
QStyleOptionoperator= (const QStyleOption &other)
 
qstyleoption_cast (QStyleOption *option)
 
qstyleoption_cast (const 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
 SO_Button
 
 SO_ComboBox
 
 SO_Complex
 
 SO_ComplexCustomBase
 
 SO_CustomBase
 
 SO_Default
 
 SO_DockWidget
 
 SO_FocusRect
 
 SO_Frame
 
 SO_GraphicsItem
 
 SO_GroupBox
 
 SO_Header
 
 SO_MenuItem
 
 SO_ProgressBar
 
 SO_RubberBand
 
 SO_SizeGrip
 
 SO_Slider
 
 SO_SpinBox
 
 SO_Tab
 
 SO_TabBarBase
 
 SO_TabWidgetFrame
 
 SO_TitleBar
 
 SO_ToolBar
 
 SO_ToolBox
 
 SO_ToolButton
 
 SO_ViewItem
 
 Type
 
 Version
 

Protected Member Functions

 StyleOptionAnnotationItem (int version)
 

Detailed Description

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

Since
5.53
See also
KTextEditor::AbstractAnnotationItemDelegate

Definition at line 43 of file abstractannotationitemdelegate.h.

Member Typedef Documentation

Member Enumeration Documentation

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
AnnotationItemGroupPositions
Enumerator
InvalidGroupPosition 

Position not specified or not belonging to a group.

InGroup 

Real line belongs to a group.

GroupBegin 

Real line is first of consecutive lines from same group.

GroupEnd 

Real line is last of consecutive lines from same group.

Definition at line 87 of file abstractannotationitemdelegate.h.

Member Data Documentation

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 100 of file abstractannotationitemdelegate.h.

QFontMetricsF KTextEditor::StyleOptionAnnotationItem::contentFontMetrics

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

Definition at line 80 of file abstractannotationitemdelegate.h.

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 76 of file abstractannotationitemdelegate.h.

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

The view where the annotation is shown.

There is always a view set.

Definition at line 70 of file abstractannotationitemdelegate.h.

int KTextEditor::StyleOptionAnnotationItem::visibleWrappedLineInGroup = 0

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

Definition at line 63 of file abstractannotationitemdelegate.h.

int KTextEditor::StyleOptionAnnotationItem::wrappedLine = 0

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

Definition at line 53 of file abstractannotationitemdelegate.h.

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 59 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-2020 The KDE developers.
Generated on Tue Jul 14 2020 22:57:48 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.