KateRenderer

KateRenderer Class Reference

#include <katerenderer.h>

Public Types

enum  caretStyles { Line, Block, Underline, Half }
 
enum  PaintTextLineFlag { SkipDrawFirstInvisibleLineUnderlined = 0x1 }
 
typedef QFlags< PaintTextLineFlagPaintTextLineFlags
 

Public Member Functions

 KateRenderer (KTextEditor::DocumentPrivate *doc, Kate::TextFolding &folding, KTextEditor::ViewPrivate *view=nullptr)
 
 KateRenderer (const KateRenderer &)=delete
 
 ~KateRenderer ()
 
KTextEditor::Attribute::Ptr attribute (uint pos) const
 
KateRenderer::caretStyles caretStyle () const
 
KateRendererConfig * config () const
 
const QFontcurrentFont () const
 
const QFontMetricsFcurrentFontMetrics () const
 
int cursorToX (const KateTextLayout &range, int col, bool returnPastLine=false) const
 
int cursorToX (const KateTextLayout &range, const KTextEditor::Cursor &pos, bool returnPastLine=false) const
 
QVector< QTextLayout::FormatRangedecorationsForLine (const Kate::TextLine &textLine, int line, bool selectionsOnly=false, bool completionHighlight=false, bool completionSelected=false) const
 
void decreaseFontSizes (qreal step=1.0)
 
KTextEditor::DocumentPrivate * doc () const
 
uint documentHeight () const
 
bool drawCaret () const
 
Kate::TextFoldingfolding () const
 
uint fontHeight () const
 
bool getSelectionBounds (int line, int lineLength, int &start, int &end) const
 
void increaseFontSizes (qreal step=1.0)
 
bool isLineRightToLeft (KateLineLayoutPtr lineLayout) const
 
bool isPrinterFriendly () const
 
void layoutLine (KateLineLayoutPtr line, int maxwidth=-1, bool cacheLayout=false) const
 
int lineHeight () const
 
KateRendereroperator= (const KateRenderer &)=delete
 
void paintTextLine (QPainter &paint, KateLineLayoutPtr range, int xStart, int xEnd, const KTextEditor::Cursor *cursor=nullptr, PaintTextLineFlags flags=PaintTextLineFlags())
 
void paintTextLineBackground (QPainter &paint, KateLineLayoutPtr layout, int currentViewLine, int xStart, int xEnd)
 
void resetFontSizes ()
 
void setCaretOverrideColor (const QColor &color)
 
void setCaretStyle (KateRenderer::caretStyles style)
 
void setDrawCaret (bool drawCaret)
 
void setIndentWidth (int indentWidth)
 
void setPrinterFriendly (bool printerFriendly)
 
void setShowIndentLines (bool showLines)
 
void setShowNonPrintableSpaces (const bool showNonPrintableSpaces)
 
void setShowSelections (bool showSelections)
 
void setShowSpaces (KateDocumentConfig::WhitespaceRendering showSpaces)
 
void setShowTabs (bool showTabs)
 
void setTabWidth (int tabWidth)
 
bool showIndentLines () const
 
bool showNonPrintableSpaces () const
 
bool showSelections () const
 
KateDocumentConfig::WhitespaceRendering showSpaces () const
 
bool showTabs () const
 
qreal spaceWidth () const
 
KTextEditor::Attribute::Ptr specificAttribute (int context) const
 
void updateAttributes ()
 
void updateConfig ()
 
void updateMarkerSize ()
 
KTextEditor::ViewPrivate * view () const
 
KTextEditor::Cursor xToCursor (const KateTextLayout &range, int x, bool returnPastLine=false) const
 

Detailed Description

Handles all of the work of rendering the text (used for the views and printing)

Definition at line 56 of file katerenderer.h.

Member Enumeration Documentation

Style of Caret.

The caret is displayed as a vertical bar (Line), a filled box (Block), a horizontal bar (Underline), or a half-height filled box (Half). The default is Line.

Line           Block          Underline           Half

_ ######### _ _

__| | #####| |# __| | __| |

/ _' | ##/ _' |# / _' | / _' |

| (_| | #| (#| |# | (_| | #| (#| |

__,_| ##__,_|# __,_| ##__,_|

Definition at line 75 of file katerenderer.h.

Flags to customize the paintTextLine function behavior.

Enumerator
SkipDrawFirstInvisibleLineUnderlined 

Skip drawing the dashed underline at the start of a folded block of text?

Definition at line 340 of file katerenderer.h.

Constructor & Destructor Documentation

KateRenderer::KateRenderer ( KTextEditor::DocumentPrivate *  doc,
Kate::TextFolding folding,
KTextEditor::ViewPrivate *  view = nullptr 
)
explicit

Constructor.

Parameters
docdocument to render
foldingfolding information
viewview which is output (0 for example for rendering to print)

Definition at line 52 of file katerenderer.cpp.

KateRenderer::~KateRenderer ( )

Destructor.

Definition at line 78 of file katerenderer.cpp.

Member Function Documentation

KTextEditor::Attribute::Ptr KateRenderer::attribute ( uint  pos) const

This takes an in index, and returns all the attributes for it.

For example, if you have a ktextline, and want the KTextEditor::Attribute for a given position, do:

attribute(myktextline->attribute(position));

Definition at line 88 of file katerenderer.cpp.

KateRenderer::caretStyles KateRenderer::caretStyle ( ) const
inline

The style of the caret (text cursor) to be painted.

Returns
caretStyle

Definition at line 143 of file katerenderer.h.

KateRendererConfig* KateRenderer::config ( ) const
inline

Configuration.

Definition at line 444 of file katerenderer.h.

const QFont& KateRenderer::currentFont ( ) const
inline

Access currently used font.

Returns
current font

Definition at line 257 of file katerenderer.h.

const QFontMetricsF& KateRenderer::currentFontMetrics ( ) const
inline

Access currently used font metrics.

Returns
current font metrics

Definition at line 266 of file katerenderer.h.

int KateRenderer::cursorToX ( const KateTextLayout range,
int  col,
bool  returnPastLine = false 
) const

Returns the x position of cursor col on the line range.

Definition at line 1168 of file katerenderer.cpp.

int KateRenderer::cursorToX ( const KateTextLayout range,
const KTextEditor::Cursor pos,
bool  returnPastLine = false 
) const

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 1173 of file katerenderer.cpp.

QVector< QTextLayout::FormatRange > KateRenderer::decorationsForLine ( const Kate::TextLine textLine,
int  line,
bool  selectionsOnly = false,
bool  completionHighlight = false,
bool  completionSelected = false 
) const

The ultimate decoration creation function.

Parameters
selectionsOnlyreturn decorations for selections and/or dynamic highlighting.

Definition at line 377 of file katerenderer.cpp.

KTextEditor::DocumentPrivate* KateRenderer::doc ( ) const
inline

Returns the document to which this renderer is bound.

Definition at line 96 of file katerenderer.h.

bool KateRenderer::drawCaret ( ) const
inline

Determine whether the caret (text cursor) will be drawn.

Returns
should it be drawn?

Definition at line 128 of file katerenderer.h.

Kate::TextFolding& KateRenderer::folding ( ) const
inline

Returns the folding info to which this renderer is bound.

Returns
folding info

Definition at line 105 of file katerenderer.h.

void KateRenderer::increaseFontSizes ( qreal  step = 1.0)

Change to a different font (soon to be font set?)

Definition at line 156 of file katerenderer.cpp.

bool KateRenderer::isLineRightToLeft ( KateLineLayoutPtr  lineLayout) const

This is a smaller QString::isRightToLeft().

It's also marked as internal to kate instead of internal to Qt, so we can modify. This method searches for the first strong character in the paragraph and then returns its direction. In case of a line without any strong characters, the direction is forced to be LTR.

Back in KDE 4.1 this method counted chars, which lead to unwanted side effects. (see https://bugs.kde.org/show_bug.cgi?id=178594). As this function is internal the way it work will probably change between releases. Be warned!

Definition at line 1130 of file katerenderer.cpp.

bool KateRenderer::isPrinterFriendly ( ) const
Returns
whether the renderer is configured to paint in a printer-friendly fashion.

Definition at line 178 of file katerenderer.cpp.

void KateRenderer::layoutLine ( KateLineLayoutPtr  line,
int  maxwidth = -1,
bool  cacheLayout = false 
) const

Text width & height calculation functions...

Definition at line 999 of file katerenderer.cpp.

void KateRenderer::paintTextLine ( QPainter paint,
KateLineLayoutPtr  range,
int  xStart,
int  xEnd,
const KTextEditor::Cursor cursor = nullptr,
PaintTextLineFlags  flags = PaintTextLineFlags() 
)

This is the ultimate function to perform painting of a text line.

The text line is painted from the upper limit of (0,0). To move that, apply a transform to your painter.

Parameters
paintpainter to use
rangelayout to use in painting this line
xStartstarting width in pixels.
xEndending width in pixels.
cursorposition of the caret, if placed on the current line.
flagsflags for customizing the drawing of the line

Definition at line 539 of file katerenderer.cpp.

void KateRenderer::paintTextLineBackground ( QPainter paint,
KateLineLayoutPtr  layout,
int  currentViewLine,
int  xStart,
int  xEnd 
)

Paint the background of a line.

Split off from the main paintTextLine method to make it smaller. As it's being called only once per line it shouldn't noticably affect performance and it helps readability a LOT.

Parameters
paintpainter to use
layoutlayout to use in painting this line
currentViewLineif one of the view lines is the current line, set this to the index; otherwise -1.
xStartstarting width in pixels.
xEndending width in pixels.

Definition at line 192 of file katerenderer.cpp.

void KateRenderer::setCaretOverrideColor ( const QColor color)

Set a brush with which to override drawing of the caret.

Set to QColor() to clear.

Definition at line 1205 of file katerenderer.cpp.

void KateRenderer::setCaretStyle ( KateRenderer::caretStyles  style)

Set the style of caret to be painted.

Parameters
stylestyle to set

Definition at line 111 of file katerenderer.cpp.

void KateRenderer::setDrawCaret ( bool  drawCaret)

Set whether the caret (text cursor) will be drawn.

Parameters
drawCaretshould caret be drawn?

Definition at line 106 of file katerenderer.cpp.

void KateRenderer::setIndentWidth ( int  indentWidth)

Sets the width of the tab.

Helps performance.

Parameters
indentWidthnew indent width

Definition at line 146 of file katerenderer.cpp.

void KateRenderer::setPrinterFriendly ( bool  printerFriendly)

Configure this renderer to paint in a printer-friendly fashion.

Sets the other options appropriately if true.

Definition at line 183 of file katerenderer.cpp.

void KateRenderer::setShowIndentLines ( bool  showLines)

Set whether a guide should be painted to help identifying indent lines.

Parameters
showLinesshow the indent lines?

Definition at line 141 of file katerenderer.cpp.

void KateRenderer::setShowNonPrintableSpaces ( const bool  showNonPrintableSpaces)

Set whether box should be drawn around non-printable spaces.

Definition at line 126 of file katerenderer.cpp.

void KateRenderer::setShowSelections ( bool  showSelections)

Set whether the view's selections should be shown.

The default is true.

Parameters
showSelectionsshow the selections?

Definition at line 151 of file katerenderer.cpp.

void KateRenderer::setShowSpaces ( KateDocumentConfig::WhitespaceRendering  showSpaces)

Set which spaces should be rendered.

Definition at line 121 of file katerenderer.cpp.

void KateRenderer::setShowTabs ( bool  showTabs)

Set whether a mark should be painted to help identifying tabs.

Parameters
showTabsshow the tabs?

Definition at line 116 of file katerenderer.cpp.

void KateRenderer::setTabWidth ( int  tabWidth)

Sets the width of the tab.

Helps performance.

Parameters
tabWidthnew tab width

Definition at line 131 of file katerenderer.cpp.

bool KateRenderer::showIndentLines ( ) const
Returns
whether indent lines should be shown
indent lines should be shown

Definition at line 136 of file katerenderer.cpp.

bool KateRenderer::showNonPrintableSpaces ( ) const
inline
Returns
whether non-printable spaces should be shown

Definition at line 196 of file katerenderer.h.

bool KateRenderer::showSelections ( ) const
inline

Show the view's selection?

Returns
show sels?

Definition at line 234 of file katerenderer.h.

KateDocumentConfig::WhitespaceRendering KateRenderer::showSpaces ( ) const
inline
Returns
whether which spaces should be rendered

Definition at line 183 of file katerenderer.h.

bool KateRenderer::showTabs ( ) const
inline
Returns
whether tabs should be shown (ie. a small mark drawn to identify a tab)
tabs should be shown

Definition at line 164 of file katerenderer.h.

void KateRenderer::updateAttributes ( )

update the highlighting attributes (for example after an hl change or after hl config changed)

Definition at line 83 of file katerenderer.cpp.

void KateRenderer::updateMarkerSize ( )

Update marker size shown.

Definition at line 986 of file katerenderer.cpp.

KTextEditor::ViewPrivate* KateRenderer::view ( ) const
inline

Returns the view to which this renderer is bound.

Definition at line 113 of file katerenderer.h.

KTextEditor::Cursor KateRenderer::xToCursor ( const KateTextLayout range,
int  x,
bool  returnPastLine = false 
) const

Returns the real cursor which is occupied by the specified x value, or that closest to it.

If returnPastLine is true, the column will be extrapolated out with the assumption that the extra characters are spaces.

Definition at line 1192 of file katerenderer.cpp.


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 Mon Jul 13 2020 22:57:40 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.