KDE PIM / Developers / API Docs / kpilot

PilotDatabase Class Reference

Methods to access a database on the pilot. More...

#include <pilotDatabase.h>

Inherited by PilotLocalDatabase, and PilotSerialDatabase.

List of all members.

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions


Detailed Description

Methods to access a database on the pilot.

NOTE: It is the users responsibility to delete PilotRecords returned by PilotDatabase methods when finished with them!!


Member Enumeration Documentation

enum PilotDatabase::DBType
 

Use this instead of RTTI to determine the type of a PilotDatabase, for those cases where it's important.


Member Function Documentation

int PilotDatabase::count  )  [static]
 

Debugging information: tally how many databases are created or destroyed.

Returns the count of currently existing databases.

virtual bool PilotDatabase::createDatabase long  creator = 0,
long  type = 0,
int  cardno = 0,
int  flags = 0,
int  version = 0
[pure virtual]
 

Creates the database with the given creator, type and flags on the given card (default is RAM).

If the database already exists, this function does nothing.

virtual int PilotDatabase::deleteDatabase  )  [pure virtual]
 

Deletes the database (by name, as given in the constructor, the database name is stored depending on the implementation of PilotLocalDatabase and PilotSerialDatabas).

virtual int PilotDatabase::readAppBlock unsigned char *  buffer,
int  maxLen
[pure virtual]
 

Reads the application block info, returns size.

virtual int PilotDatabase::writeAppBlock unsigned char *  buffer,
int  len
[pure virtual]
 

Writes the application block info.

virtual int PilotDatabase::recordCount  )  [pure virtual]
 

returns the number of records in the database

RecordIDList PilotDatabase::idList  )  [virtual]
 

Returns a QValueList of all record ids in the database.

This implementation is really bad.

RecordIDList PilotDatabase::modifiedIDList  )  [virtual]
 

Returns a list of all record ids that have been modified in the database.

This implementation is really bad.

virtual PilotRecord* PilotDatabase::readRecordById recordid_t  id  )  [pure virtual]
 

Reads a record from database by id, returns record length.

virtual PilotRecord* PilotDatabase::readRecordByIndex int  index  )  [pure virtual]
 

Reads a record from database, returns the record length.

virtual PilotRecord* PilotDatabase::readNextRecInCategory int  category  )  [pure virtual]
 

Reads the next record from database in category 'category'.

virtual PilotRecord* PilotDatabase::readNextModifiedRec int *  ind = NULL  )  [pure virtual]
 

Reads the next record from database that has the dirty flag set.

If ind is non-NULL, *ind is set to the index of the current record (i.e. before the record pointer moves to the next modified record).

virtual recordid_t PilotDatabase::writeRecord PilotRecord newRecord  )  [pure virtual]
 

Writes a new record to database (if 'id' == 0, one will be assigned to newRecord).

virtual int PilotDatabase::deleteRecord recordid_t  id,
bool  all = false
[pure virtual]
 

Deletes a record with the given recordid_t from the database, or all records, if all is set to true.

The recordid_t will be ignored in this case.

Return value is negative on error, 0 otherwise.

virtual int PilotDatabase::resetSyncFlags  )  [pure virtual]
 

Resets all records in the database to not dirty.

virtual int PilotDatabase::resetDBIndex  )  [pure virtual]
 

Resets next record index to beginning.

virtual int PilotDatabase::cleanup  )  [pure virtual]
 

Purges all Archived/Deleted records from Palm Pilot database.

virtual QString PilotDatabase::dbPathName  )  const [pure virtual]
 

Returns some sensible human-readable identifier for the database.

Serial databases get Pilot:, local databases return the full path.


The documentation for this class was generated from the following files: