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

Kate

KateEditInfo Class Reference

#include <kateedit.h>

List of all members.


Detailed Description

Represents a single edit to a KateDocument.

Author:
Hamish Rodda

Definition at line 37 of file kateedit.h.


Public Member Functions

void dereferenceRevision ()
KateDocument * document () const
Kate::EditSource editSource () const
bool isEditBoundary () const
bool isInsert () const
bool isModification () const
bool isReferenced () const
bool isRemoval () const
 KateEditInfo (KateDocument *doc, Kate::EditSource source, const KTextEditor::Range &oldRange, const QStringList &oldText, const KTextEditor::Range &newRange, const QStringList &newText)
const KTextEditor::Range & newRange () const
const QStringList & newText () const
virtual QStringList newText (const KTextEditor::Range &range) const
virtual QString newTextString (const KTextEditor::Range &range) const
const KTextEditor::Range & oldRange () const
const QStringList & oldText () const
virtual QStringList oldText (const KTextEditor::Range &range) const
virtual QString oldTextString (const KTextEditor::Range &range) const
void referenceRevision ()
void setEditBoundary (bool boundary)
const KTextEditor::Cursor & start () const
const KTextEditor::Cursor & translate () const
virtual ~KateEditInfo ()

Constructor & Destructor Documentation

KateEditInfo::KateEditInfo ( KateDocument *  doc,
Kate::EditSource  source,
const KTextEditor::Range &  oldRange,
const QStringList &  oldText,
const KTextEditor::Range &  newRange,
const QStringList &  newText 
)

Definition at line 22 of file kateedit.cpp.

KateEditInfo::~KateEditInfo (  )  [virtual]

Definition at line 34 of file kateedit.cpp.


Member Function Documentation

void KateEditInfo::dereferenceRevision (  ) 

Definition at line 200 of file kateedit.cpp.

KateDocument* KateEditInfo::document (  )  const

Kate::EditSource KateEditInfo::editSource (  )  const

Returns how this edit was generated.

See also:
Kate::EditSource

Definition at line 38 of file kateedit.cpp.

bool KateEditInfo::isEditBoundary (  )  const

Indicate that this edit is completed and should not be merged with another edit should the opportunity arise.

Returns:
true if this edit is completed

bool KateEditInfo::isInsert (  )  const

Returns true if this edit is a pure insertion of text.

bool KateEditInfo::isModification (  )  const

Returns true if text is being inserted and removed.

bool KateEditInfo::isReferenced (  )  const

Definition at line 195 of file kateedit.cpp.

bool KateEditInfo::isRemoval (  )  const

Returns true if this edit is a pure removal of text.

Definition at line 215 of file kateedit.cpp.

const KTextEditor::Range & KateEditInfo::newRange (  )  const

Returns the range of text occupied by the edit region after the edit took place.

Definition at line 78 of file kateedit.cpp.

const QStringList & KateEditInfo::newText (  )  const

Returns the text which occupies the edit region now that the edit has taken place.

See also:
newText(const KTextEditor::Range&) const

newTextString(const KTextEditor::Range&) const

Definition at line 210 of file kateedit.cpp.

QStringList KateEditInfo::newText ( const KTextEditor::Range &  range  )  const [virtual]

Returns the text which occupies range after this edit took place.

See also:
newText()

newTextString(const KTextEditor::Range&) const

Definition at line 91 of file kateedit.cpp.

QString KateEditInfo::newTextString ( const KTextEditor::Range &  range  )  const [virtual]

Returns the text which occupies range after this edit took place.

range must start and end on the same line for all relevant text to be returned.

See also:
newText()

newText(const KTextEditor::Range&) const

Definition at line 83 of file kateedit.cpp.

const KTextEditor::Range & KateEditInfo::oldRange (  )  const

Returns the range of text occupied by the edit region before the edit took place.

Definition at line 43 of file kateedit.cpp.

const QStringList & KateEditInfo::oldText (  )  const

Returns all of the text that was in place before the edit occurred.

See also:
oldText(const KTextEditor::Range&) const

oldTextString(const KTextEditor::Range&) const

Definition at line 73 of file kateedit.cpp.

QStringList KateEditInfo::oldText ( const KTextEditor::Range &  range  )  const [virtual]

Returns the text which occupied range before this edit took place.

See also:
oldText()

Definition at line 56 of file kateedit.cpp.

QString KateEditInfo::oldTextString ( const KTextEditor::Range &  range  )  const [virtual]

Returns the text which occupied range before this edit took place.

Note:
range must start and end on the same line for all relevant text to be returned.
See also:
oldText()

Definition at line 48 of file kateedit.cpp.

void KateEditInfo::referenceRevision (  ) 

Definition at line 205 of file kateedit.cpp.

void KateEditInfo::setEditBoundary ( bool  boundary  ) 

Set the status of this edit.

Parameters:
boundary If the edit is complete, the value should be true, otherwise it should be false

const KTextEditor::Cursor& KateEditInfo::start (  )  const [inline]

Returns the starting location of the text occupied by the edit region before the edit took place.

Returns:
a KTextEditor::Cursor indicating the start location of the edit

Definition at line 84 of file kateedit.h.

const KTextEditor::Cursor& KateEditInfo::translate (  )  const [inline]

Definition at line 140 of file kateedit.h.


The documentation for this class was generated from the following files:
  • kateedit.h
  • kateedit.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
  • Kross
  • KUtils
  • Nepomuk
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.5.4
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