• Skip to content
  • Skip to link menu
KDE 4.3 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

Kate

KateTextLayout Class Reference

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

#include <katetextlayout.h>

List of all members.

Public Member Functions

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
KateLineLayoutPtr kateLineLayout () const
int length () const
int line () const
const QTextLine & lineLayout () 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 ()

Friends

bool operator< (const KateLineLayout &r, const KTextEditor::Cursor &c)
bool operator<= (const KateLineLayout &r, const KTextEditor::Cursor &c)
bool operator> (const KateLineLayout &r, const KTextEditor::Cursor &c)
bool operator>= (const KateLineLayout &r, const KTextEditor::Cursor &c)

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 39 of file katetextlayout.h.


Member Function Documentation

void KateTextLayout::debugOutput (  )  const

Definition at line 63 of file katetextlayout.cpp.

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

Return the end position of this text line.

Parameters:
indicateEOL set 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 152 of file katetextlayout.cpp.

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

Return the end column of this text line.

Parameters:
indicateEOL set 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 140 of file katetextlayout.cpp.

int KateTextLayout::endX (  )  const

Definition at line 194 of file katetextlayout.cpp.

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

Definition at line 50 of file katetextlayout.cpp.

KateTextLayout KateTextLayout::invalid (  )  [static]

Definition at line 210 of file katetextlayout.cpp.

bool KateTextLayout::isDirty (  )  const

Definition at line 34 of file katetextlayout.cpp.

bool KateTextLayout::isEmpty (  )  const

Definition at line 165 of file katetextlayout.cpp.

bool KateTextLayout::isRightToLeft (  )  const

Definition at line 215 of file katetextlayout.cpp.

bool KateTextLayout::isValid (  )  const

Definition at line 88 of file katetextlayout.cpp.

KateLineLayoutPtr KateTextLayout::kateLineLayout (  )  const

Definition at line 122 of file katetextlayout.cpp.

int KateTextLayout::length (  )  const

Definition at line 157 of file katetextlayout.cpp.

int KateTextLayout::line (  )  const

Definition at line 93 of file katetextlayout.cpp.

const QTextLine & KateTextLayout::lineLayout (  )  const

Definition at line 117 of file katetextlayout.cpp.

bool KateTextLayout::setDirty ( bool  dirty = true  ) 

Definition at line 42 of file katetextlayout.cpp.

KTextEditor::Cursor KateTextLayout::start (  )  const

Definition at line 135 of file katetextlayout.cpp.

int KateTextLayout::startCol (  )  const

Definition at line 127 of file katetextlayout.cpp.

int KateTextLayout::startX (  )  const

Definition at line 181 of file katetextlayout.cpp.

int KateTextLayout::viewLine (  )  const

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

Definition at line 109 of file katetextlayout.cpp.

int KateTextLayout::virtualLine (  )  const

Definition at line 101 of file katetextlayout.cpp.

int KateTextLayout::width (  )  const

Definition at line 202 of file katetextlayout.cpp.

bool KateTextLayout::wrap (  )  const

Definition at line 173 of file katetextlayout.cpp.

int KateTextLayout::xOffset (  )  const

Definition at line 55 of file katetextlayout.cpp.


Friends And Related Function Documentation

bool operator< ( const KateLineLayout &  r,
const KTextEditor::Cursor &  c 
) [friend]
bool operator<= ( const KateLineLayout &  r,
const KTextEditor::Cursor &  c 
) [friend]
bool operator> ( const KateLineLayout &  r,
const KTextEditor::Cursor &  c 
) [friend]
bool operator>= ( const KateLineLayout &  r,
const KTextEditor::Cursor &  c 
) [friend]

The documentation for this class was generated from the following files:
  • katetextlayout.h
  • katetextlayout.cpp

Kate

Skip menu "Kate"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.6.1
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal