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

akregator

c4_Sequence Class Reference

#include <mk4.h>

Inheritance diagram for c4_Sequence:

Inheritance graph
[legend]

List of all members.


Detailed Description

A sequence is an abstract base class for views on ranges of records.

Definition at line 846 of file mk4.h.


Public Member Functions

virtual int AddHandler (c4_Handler *)=0
void Attach (c4_Sequence *)
c4_Bytes & Buffer ()
 c4_Sequence ()
virtual int Compare (int, c4_Cursor) const
virtual c4_Handler * CreateHandler (const c4_Property &)=0
void DecRef ()
virtual const char * Description ()
void Detach (c4_Sequence *)
virtual bool Get (int, int, c4_Bytes &)
c4_Dependencies * GetDependencies () const
virtual const c4_Sequence * HandlerContext (int) const =0
void IncRef ()
virtual void InsertAt (int, c4_Cursor, int=1)
virtual int ItemSize (int, int)
virtual void Move (int, int)
virtual c4_Handler & NthHandler (int) const =0
int NthPropId (int) const
virtual int NumHandlers () const =0
int NumRefs () const
virtual int NumRows () const =0
virtual c4_Persist * Persist () const
virtual void PostChange (c4_Notifier &)
virtual c4_Notifier * PreChange (c4_Notifier &)
int PropIndex (const c4_Property &)
int PropIndex (int)
virtual int RemapIndex (int, const c4_Sequence *) const
virtual void RemoveAt (int, int=1)
void Resize (int, int=-1)
virtual bool RestrictSearch (c4_Cursor, int &, int &)
virtual void Set (int, const c4_Property &, const c4_Bytes &)
void SetAt (int, c4_Cursor)
virtual void SetNumRows (int)=0
const char * UseTempBuffer (const char *)

Protected Member Functions

void ClearCache ()
virtual ~c4_Sequence ()

Protected Attributes

int _propertyLimit
short * _propertyMap
c4_Bytes * _tempBuf

Constructor & Destructor Documentation

c4_Sequence::c4_Sequence (  ) 

Abstract constructor.

Definition at line 16 of file viewx.cpp.

c4_Sequence::~c4_Sequence (  )  [protected, virtual]

Definition at line 19 of file viewx.cpp.


Member Function Documentation

virtual int c4_Sequence::AddHandler ( c4_Handler *   )  [pure virtual]

Add the specified data handler to this sequence.

Implemented in c4_HandlerSeq, and c4_DerivedSeq.

void c4_Sequence::Attach ( c4_Sequence *  child_  ) 

Register a sequence to receive change notifications.

Definition at line 344 of file viewx.cpp.

c4_Bytes & c4_Sequence::Buffer (  ) 

Gives access to a general purpose temporary buffer.

Definition at line 128 of file viewx.cpp.

void c4_Sequence::ClearCache (  )  [protected]

Definition at line 241 of file viewx.cpp.

int c4_Sequence::Compare ( int  index_,
c4_Cursor  cursor_ 
) const [virtual]

Compare the specified row with another one.

Definition at line 54 of file viewx.cpp.

virtual c4_Handler* c4_Sequence::CreateHandler ( const c4_Property &   )  [pure virtual]

Create a handler of the appropriate type.

Implemented in c4_HandlerSeq, and c4_DerivedSeq.

void c4_Sequence::DecRef (  ) 

Decrement the reference count, delete objects when last.

Definition at line 41 of file viewx.cpp.

const char * c4_Sequence::Description (  )  [virtual]

Reimplemented in c4_HandlerSeq.

Definition at line 305 of file viewx.cpp.

void c4_Sequence::Detach ( c4_Sequence *  child_  ) 

Unregister a sequence which received change notifications.

Definition at line 354 of file viewx.cpp.

bool c4_Sequence::Get ( int  index_,
int  propId_,
c4_Bytes &  buf_ 
) [virtual]

Retrieve one data item from this sequence.

Definition at line 314 of file viewx.cpp.

c4_Dependencies* c4_Sequence::GetDependencies (  )  const

Return a pointer to the dependencies, or null.

virtual const c4_Sequence* c4_Sequence::HandlerContext ( int   )  const [pure virtual]

Return the context of the N-th handler in this sequence.

Implemented in c4_HandlerSeq, and c4_DerivedSeq.

void c4_Sequence::IncRef (  ) 

Increment the reference count of this sequence.

Definition at line 34 of file viewx.cpp.

void c4_Sequence::InsertAt ( int  index_,
c4_Cursor  newElem_,
int  count_ = 1 
) [virtual]

Insert one or more rows into this sequence.

Reimplemented in c4_CustomSeq.

Definition at line 155 of file viewx.cpp.

int c4_Sequence::ItemSize ( int  index_,
int  propId_ 
) [virtual]

Return width of specified data item.

Definition at line 309 of file viewx.cpp.

void c4_Sequence::Move ( int  from_,
int  to_ 
) [virtual]

Move a row to another position.

careful, this does no index remapping, wrong for derived seq's

Reimplemented in c4_CustomSeq.

Definition at line 226 of file viewx.cpp.

virtual c4_Handler& c4_Sequence::NthHandler ( int   )  const [pure virtual]

Return a reference to the N-th handler in this sequence.

Implemented in c4_HandlerSeq, and c4_DerivedSeq.

int c4_Sequence::NthPropId ( int  index_  )  const

Return the id of the N-th property.

Definition at line 237 of file viewx.cpp.

virtual int c4_Sequence::NumHandlers (  )  const [pure virtual]

Return the number of data handlers in this sequence.

Implemented in c4_HandlerSeq, and c4_DerivedSeq.

int c4_Sequence::NumRefs (  )  const

Return the current reference count.

Definition at line 49 of file viewx.cpp.

virtual int c4_Sequence::NumRows (  )  const [pure virtual]

Return the current number of rows.

Implemented in c4_CustomSeq, c4_HandlerSeq, and c4_DerivedSeq.

c4_Persist * c4_Sequence::Persist (  )  const [virtual]

Reimplemented in c4_HandlerSeq.

Definition at line 29 of file viewx.cpp.

void c4_Sequence::PostChange ( c4_Notifier &   )  [virtual]

Called after changes have been made to the sequence.

Definition at line 372 of file viewx.cpp.

c4_Notifier * c4_Sequence::PreChange ( c4_Notifier &   )  [virtual]

Called just before a change is made to the sequence.

Reimplemented in c4_DerivedSeq.

Definition at line 366 of file viewx.cpp.

int c4_Sequence::PropIndex ( const c4_Property &  prop_  ) 

Find the index of a property, or create a new entry.

Definition at line 285 of file viewx.cpp.

int c4_Sequence::PropIndex ( int  propId_  ) 

Find the index of a property by its id.

CACHING NOTE: derived views will fail if underlying view is restructured

Definition at line 249 of file viewx.cpp.

int c4_Sequence::RemapIndex ( int  index_,
const c4_Sequence *  seq_ 
) const [virtual]

Remap the index to an underlying view.

Reimplemented in c4_DerivedSeq.

Definition at line 123 of file viewx.cpp.

void c4_Sequence::RemoveAt ( int  index_,
int  count_ = 1 
) [virtual]

Remove one or more rows from this sequence.

careful, this does no index remapping, wrong for derived seq's

Reimplemented in c4_CustomSeq.

Definition at line 213 of file viewx.cpp.

void c4_Sequence::Resize ( int  newSize_,
int  = -1 
)

Change number of rows, either by inserting or removing them.

Definition at line 140 of file viewx.cpp.

bool c4_Sequence::RestrictSearch ( c4_Cursor  ,
int &  ,
int &   
) [virtual]

Restrict the search range for rows.

Reimplemented in c4_CustomSeq.

Definition at line 77 of file viewx.cpp.

void c4_Sequence::Set ( int  index_,
const c4_Property &  prop_,
const c4_Bytes &  buf_ 
) [virtual]

Store a data item into this sequence.

Definition at line 323 of file viewx.cpp.

void c4_Sequence::SetAt ( int  index_,
c4_Cursor  newElem_ 
)

Replace the contents of a specified row.

Definition at line 82 of file viewx.cpp.

virtual void c4_Sequence::SetNumRows ( int   )  [pure virtual]

for c4_Table::Sequence setup

Implemented in c4_HandlerSeq, and c4_DerivedSeq.

const char * c4_Sequence::UseTempBuffer ( const char *  str_  ) 

Definition at line 135 of file viewx.cpp.


Member Data Documentation

int c4_Sequence::_propertyLimit [protected]

Optimization: cached property index.

Definition at line 855 of file mk4.h.

short* c4_Sequence::_propertyMap [protected]

Optimization: property map for faster access.

Definition at line 857 of file mk4.h.

c4_Bytes* c4_Sequence::_tempBuf [protected]

allocated on first use by c4_Sequence::Buffer()

Definition at line 859 of file mk4.h.


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

akregator

Skip menu "akregator"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members

kdepim

Skip menu "kdepim"
  • akonadi
  •   clients
  •   kabc
  •   kcal
  •   kcm
  • akregator
  • console
  •   kabcclient
  •   konsolekalendar
  • kaddressbook
  • kalarm
  •   lib
  • kdgantt
  • kdgantt1
  • kjots
  • kleopatra
  • kmail
  • kmobiletools
  • knode
  • knotes
  • kontact
  • kontactinterfaces
  • korganizer
  •   korgac
  • kpilot
  • ktimetracker
  •   doc
  • libkdepim
  • libkholidays
  • libkleo
  • libkpgp
  • maildir
Generated for kdepim 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