kate Library API Documentation

KateSuperRangeList Class Reference

Inheritance diagram for KateSuperRangeList:

QObject QPtrList< KateSuperRange > List of all members.

Signals

void rangeEliminated (KateSuperRange *range)
void listEmpty ()
void tagRange (KateSuperRange *range)

Public Member Functions

 KateSuperRangeList (bool autoManage=true, QObject *parent=0L, const char *name=0L)
 KateSuperRangeList (const QPtrList< KateSuperRange > &rangeList, QObject *parent=0L, const char *name=0L)
virtual ~KateSuperRangeList ()
void appendList (const QPtrList< KateSuperRange > &rangeList)
void connectAll ()
virtual void clear ()
bool autoManage () const
void setAutoManage (bool autoManage)
QPtrList< KateSuperRangerangesIncluding (const KateTextCursor &cursor)
QPtrList< KateSuperRangerangesIncluding (uint line)
bool rangesInclude (const KateTextCursor &cursor)
KateSuperCursorfirstBoundary (const KateTextCursor *start=0L)
KateSuperCursornextBoundary ()
KateSuperCursorcurrentBoundary ()

Protected Member Functions

virtual int compareItems (QPtrCollection::Item item1, QPtrCollection::Item item2)
virtual QPtrCollection::Item newItem (QPtrCollection::Item d)

Detailed Description

Definition at line 339 of file katesupercursor.h.


Constructor & Destructor Documentation

KateSuperRangeList::KateSuperRangeList bool  autoManage = true,
QObject parent = 0L,
const char *  name = 0L
 

See also:
autoManage()

Definition at line 542 of file katesupercursor.cpp.

References setAutoManage().

KateSuperRangeList::KateSuperRangeList const QPtrList< KateSuperRange > &  rangeList,
QObject parent = 0L,
const char *  name = 0L
 

Semi-copy constructor.

Does not copy auto-manage value, as that would make it too easy to perform double-deletions.

Also, does not connect signals and slots to save time, as this is mainly used by the document itself while drawing (call connectAll() to re-constitute)

Definition at line 551 of file katesupercursor.cpp.

References appendList().


Member Function Documentation

void KateSuperRangeList::appendList const QPtrList< KateSuperRange > &  rangeList  ) 
 

Append another list.

If this object was created by the semi-copy constructor, it may not connect items (unless connectAll() has already been called), call connectAll().

Definition at line 560 of file katesupercursor.cpp.

References QPtrList< KateSuperRange >::append().

Referenced by KateSuperRangeList(), and KateArbitraryHighlight::rangesIncluding().

void KateSuperRangeList::connectAll  ) 
 

Connect items that are not connected.

This only needs to be called once, and only if this was created with the semi-copy constructor.

Definition at line 574 of file katesupercursor.cpp.

References QObject::connect(), QObject::destroyed(), QPtrList< KateSuperRange >::first(), and QPtrList< KateSuperRange >::next().

void KateSuperRangeList::clear  )  [virtual]
 

Override to emit rangeEliminated() signals.

Reimplemented from QPtrList< KateSuperRange >.

Definition at line 566 of file katesupercursor.cpp.

References QPtrList::clear(), QPtrList< KateSuperRange >::first(), QPtrList< KateSuperRange >::next(), and rangeEliminated().

Referenced by KateArbitraryHighlight::rangesIncluding(), and KateTemplateHandler::~KateTemplateHandler().

bool KateSuperRangeList::autoManage  )  const
 

Automanage is a combination of autodeleting of the objects and removing of any eliminated() ranges.

Definition at line 585 of file katesupercursor.cpp.

void KateSuperRangeList::setAutoManage bool  autoManage  ) 
 

See also:
autoManage()

Definition at line 590 of file katesupercursor.cpp.

References QPtrList< KateSuperRange >::setAutoDelete().

Referenced by KateSuperRangeList(), and KateTemplateHandler::~KateTemplateHandler().

QPtrList< KateSuperRange > KateSuperRangeList::rangesIncluding const KateTextCursor cursor  ) 
 

This is just a straight-forward list so that there is no confusion about whether this list should be auto-managed (ie.

it shouldn't, to avoid double deletions).

Definition at line 596 of file katesupercursor.cpp.

References QPtrList::append(), QPtrList< KateSuperRange >::first(), QPtrList< KateSuperRange >::next(), and QPtrList< KateSuperRange >::sort().

Referenced by KateRenderer::paintTextLine().

bool KateSuperRangeList::rangesInclude const KateTextCursor cursor  ) 
 

Return values:
true if one of the ranges in the list includes cursor
false otherwise

Definition at line 622 of file katesupercursor.cpp.

References QPtrList< KateSuperRange >::first(), and QPtrList< KateSuperRange >::next().

KateSuperCursor * KateSuperRangeList::firstBoundary const KateTextCursor start = 0L  ) 
 

Construct a list of boundaries, and return the first, or 0L if there are none.

If start is defined, the first boundary returned will be at or after start.

Returns:
the first boundary location

Definition at line 669 of file katesupercursor.cpp.

References QPtrList::append(), QPtrList::current(), QPtrList::first(), QPtrList< KateSuperRange >::first(), QPtrList::next(), QPtrList< KateSuperRange >::next(), QPtrList::sort(), KateSuperRange::superEnd(), and KateSuperRange::superStart().

Referenced by KateRenderer::paintTextLine().

KateSuperCursor * KateSuperRangeList::nextBoundary  ) 
 

Returns:
the next boundary, or 0L if there are no more.

Definition at line 691 of file katesupercursor.cpp.

References QPtrList::current(), QPtrList< KateSuperRange >::current(), and QPtrList::next().

Referenced by KateRenderer::paintTextLine().

KateSuperCursor * KateSuperRangeList::currentBoundary  ) 
 

Returns:
the current boundary

Definition at line 704 of file katesupercursor.cpp.

References QPtrList::current().

Referenced by KateRenderer::paintTextLine().

void KateSuperRangeList::rangeEliminated KateSuperRange range  )  [signal]
 

The range now contains no characters (ie.

the start and end cursors are the same). If autoManage() is true, the range will be deleted after the signal has processed.

Referenced by clear().

void KateSuperRangeList::listEmpty  )  [signal]
 

There are no ranges left.

void KateSuperRangeList::tagRange KateSuperRange range  )  [signal]
 

Connected to all ranges if connect()ed.

Referenced by newItem().

int KateSuperRangeList::compareItems QPtrCollection::Item  item1,
QPtrCollection::Item  item2
[protected, virtual]
 

internal reimplementation

Reimplemented from QPtrList< KateSuperRange >.

Definition at line 709 of file katesupercursor.cpp.

QPtrCollection::Item KateSuperRangeList::newItem QPtrCollection::Item  d  )  [protected, virtual]
 

internal reimplementation

Definition at line 722 of file katesupercursor.cpp.

References QPtrList::append(), QObject::connect(), QObject::destroyed(), and tagRange().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kate Library Version 3.4.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Mon Jun 12 11:50:56 2006 by doxygen 1.4.4 written by Dimitri van Heesch, © 1997-2003