KateTextLayout

Search for usage in LXR

#include <katetextlayout.h>

Public Member Functions

 KateTextLayout (KateLineLayout *line=nullptr, int viewLine=0)
 
void debugOutput () const
 
KTextEditor::Cursor end (bool indicateEOL=false) const
 
int endCol (bool indicateEOL=false) const
 
int endX () const
 
bool includesCursor (const KTextEditor::Cursor realCursor) const
 
bool isDirty () const
 
bool isEmpty () const
 
bool isRightToLeft () const
 
bool isValid () const
 
KateLineLayout * kateLineLayout () const
 
int length () const
 
int line () const
 
const QTextLinelineLayout () const
 
bool setDirty (bool dirty=true)
 
KTextEditor::Cursor start () const
 
int startCol () const
 
int startX () const
 
int viewLine () const
 
int virtualLine () const
 
int width () const
 
bool wrap () const
 
int xOffset () const
 

Static Public Member Functions

static KateTextLayout invalid ()
 

Detailed Description

This class represents one visible line of text; with dynamic wrapping, many KateTextLayouts can be needed to represent one actual line of text (ie.

one KateLineLayout)

Definition at line 20 of file katetextlayout.h.

Constructor & Destructor Documentation

◆ KateTextLayout()

KateTextLayout::KateTextLayout ( KateLineLayout * line = nullptr,
int viewLine = 0 )
explicit

Definition at line 12 of file katetextlayout.cpp.

Member Function Documentation

◆ debugOutput()

void KateTextLayout::debugOutput ( ) const

Definition at line 54 of file katetextlayout.cpp.

◆ end()

KTextEditor::Cursor KateTextLayout::end ( bool indicateEOL = false) const

Return the end position of this text line.

Parameters
indicateEOLset to true to return -1 if this layout is the end of the line, otherwise false to return the end column number

Definition at line 151 of file katetextlayout.cpp.

◆ endCol()

int KateTextLayout::endCol ( bool indicateEOL = false) const

Return the end column of this text line.

Parameters
indicateEOLset to true to return -1 if this layout is the end of the line, otherwise false to return the end column number

Definition at line 136 of file katetextlayout.cpp.

◆ endX()

int KateTextLayout::endX ( ) const

Definition at line 199 of file katetextlayout.cpp.

◆ includesCursor()

bool KateTextLayout::includesCursor ( const KTextEditor::Cursor realCursor) const

Definition at line 40 of file katetextlayout.cpp.

◆ invalid()

KateTextLayout KateTextLayout::invalid ( )
static

Definition at line 217 of file katetextlayout.cpp.

◆ isDirty()

bool KateTextLayout::isDirty ( ) const

Definition at line 22 of file katetextlayout.cpp.

◆ isEmpty()

bool KateTextLayout::isEmpty ( ) const

Definition at line 165 of file katetextlayout.cpp.

◆ isRightToLeft()

bool KateTextLayout::isRightToLeft ( ) const

Definition at line 222 of file katetextlayout.cpp.

◆ isValid()

bool KateTextLayout::isValid ( ) const

Definition at line 80 of file katetextlayout.cpp.

◆ kateLineLayout()

KateLineLayout * KateTextLayout::kateLineLayout ( ) const

Definition at line 117 of file katetextlayout.cpp.

◆ length()

int KateTextLayout::length ( ) const

Definition at line 156 of file katetextlayout.cpp.

◆ line()

int KateTextLayout::line ( ) const

Definition at line 85 of file katetextlayout.cpp.

◆ lineLayout()

const QTextLine & KateTextLayout::lineLayout ( ) const

Definition at line 112 of file katetextlayout.cpp.

◆ setDirty()

bool KateTextLayout::setDirty ( bool dirty = true)

Definition at line 31 of file katetextlayout.cpp.

◆ start()

KTextEditor::Cursor KateTextLayout::start ( ) const

Definition at line 131 of file katetextlayout.cpp.

◆ startCol()

int KateTextLayout::startCol ( ) const

Definition at line 122 of file katetextlayout.cpp.

◆ startX()

int KateTextLayout::startX ( ) const

Definition at line 183 of file katetextlayout.cpp.

◆ viewLine()

int KateTextLayout::viewLine ( ) const

Return the index of this visual line inside the document line (KateLineLayout).


Definition at line 103 of file katetextlayout.cpp.

◆ virtualLine()

int KateTextLayout::virtualLine ( ) const

Definition at line 94 of file katetextlayout.cpp.

◆ width()

int KateTextLayout::width ( ) const

Definition at line 208 of file katetextlayout.cpp.

◆ wrap()

bool KateTextLayout::wrap ( ) const

Definition at line 174 of file katetextlayout.cpp.

◆ xOffset()

int KateTextLayout::xOffset ( ) const

Definition at line 45 of file katetextlayout.cpp.


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 Fri May 24 2024 12:01:52 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.