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

Kate

KateSuperRangeList Class Reference

#include <katesupercursor.h>

Inheritance diagram for KateSuperRangeList:

Inheritance graph
[legend]

List of all members.


Signals

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

Public Member Functions

void appendList (const QPtrList< KateSuperRange > &rangeList)
bool autoManage () const
virtual void clear ()
void connectAll ()
KateSuperCursor * currentBoundary ()
KateSuperCursor * firstBoundary (const KateTextCursor *start=0L)
 KateSuperRangeList (const QPtrList< KateSuperRange > &rangeList, QObject *parent=0L, const char *name=0L)
 KateSuperRangeList (bool autoManage=true, QObject *parent=0L, const char *name=0L)
KateSuperCursor * nextBoundary ()
bool rangesInclude (const KateTextCursor &cursor)
QPtrList< KateSuperRange > rangesIncluding (uint line)
QPtrList< KateSuperRange > rangesIncluding (const KateTextCursor &cursor)
void setAutoManage (bool autoManage)
virtual ~KateSuperRangeList ()

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 547 of file katesupercursor.cpp.

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 556 of file katesupercursor.cpp.

virtual KateSuperRangeList::~KateSuperRangeList (  )  [inline, virtual]

Definition at line 360 of file katesupercursor.h.


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 565 of file katesupercursor.cpp.

bool KateSuperRangeList::autoManage (  )  const

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

Definition at line 590 of file katesupercursor.cpp.

void KateSuperRangeList::clear (  )  [virtual]

Override to emit rangeEliminated() signals.

Reimplemented from QPtrList< KateSuperRange >.

Definition at line 571 of file katesupercursor.cpp.

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

internal reimplementation

Reimplemented from QPtrList< KateSuperRange >.

Definition at line 714 of file katesupercursor.cpp.

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 579 of file katesupercursor.cpp.

KateSuperCursor * KateSuperRangeList::currentBoundary (  ) 

Returns:
the current boundary

Definition at line 709 of file katesupercursor.cpp.

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 674 of file katesupercursor.cpp.

void KateSuperRangeList::listEmpty (  )  [signal]

There are no ranges left.

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

internal reimplementation

Definition at line 727 of file katesupercursor.cpp.

KateSuperCursor * KateSuperRangeList::nextBoundary (  ) 

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

Definition at line 696 of file katesupercursor.cpp.

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.

bool KateSuperRangeList::rangesInclude ( const KateTextCursor &  cursor  ) 

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

Definition at line 627 of file katesupercursor.cpp.

QPtrList< KateSuperRange > KateSuperRangeList::rangesIncluding ( uint  line  ) 

Definition at line 614 of file katesupercursor.cpp.

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 601 of file katesupercursor.cpp.

void KateSuperRangeList::setAutoManage ( bool  autoManage  ) 

See also:
autoManage()

Definition at line 595 of file katesupercursor.cpp.

void KateSuperRangeList::tagRange ( KateSuperRange *  range  )  [signal]

Connected to all ranges if connect()ed.


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

Kate

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

API Reference

Skip menu "API Reference"
  • dcop
  • DNSSD
  • interfaces
  • Kate
  • kconf_update
  • KDECore
  • KDED
  • kdefx
  • KDEsu
  • kdeui
  • KDocTools
  • KHTML
  • KImgIO
  • KInit
  • kio
  • kioslave
  • KJS
  • KNewStuff
  • KParts
  • KUtils
Generated for API Reference by doxygen 1.5.9
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