kpilot/lib

PilotRecordBase Class Reference

#include <pilotRecord.h>

Inheritance diagram for PilotRecordBase:

PilotAppCategory PilotRecord PilotAddress PilotDateEntry PilotMemo PilotTodoEntry List of all members.

Detailed Description

All entries in the Handheld -- whether interpreted or binary blobs -- have some common characteristics, viz.

an ID number, a category, and some attributes defined by the handheld. PilotRecordBase is a common base class collecting methods to manipulate those common characteristics.

Definition at line 59 of file pilotRecord.h.


Public Member Functions

 PilotRecordBase (int attrib=0, int cat=0, recordid_t id=0)
int attributes () const
void setAttributes (int attrib)
int KDE_DEPRECATED getAttrib () const
void KDE_DEPRECATED setAttrib (int attrib)
int category () const
void setCategory (int cat)
int KDE_DEPRECATED getCat () const
void KDE_DEPRECATED setCat (int cat)
recordid_t id () const
void setID (recordid_t id)
recordid_t KDE_DEPRECATED getID () const
bool isDeleted () const
bool isSecret () const
bool isArchived () const
bool isModified () const
bool KDE_DEPRECATED isDirty () const
void setDeleted (bool d=true) SETTER(dlpRecAttrDeleted) inline void setSecret(bool d

Public Attributes

recordid_t fID

Constructor & Destructor Documentation

PilotRecordBase::PilotRecordBase ( int  attrib = 0,
int  cat = 0,
recordid_t  id = 0 
) [inline]

Constructor.

Initialize the characteristics to the given values.

Parameters:
attrib Attributes (bitfield) for this entry.
cat Category for this entry. Should be in the range 0 <= cat < PILOT_CATEGORY_MAX . Using an invalid category means 0 (unfiled) is used.
id Unique ID for this entry. May be 0 (non-unique) as well.

Definition at line 70 of file pilotRecord.h.


Member Function Documentation

int PilotRecordBase::attributes (  )  const [inline]

Attributes of this record (deleted, secret, .

..); it's a bitfield.

Definition at line 77 of file pilotRecord.h.

int PilotRecordBase::category (  )  const [inline]

Returns the category number 0 <= < PILOT_CATEGORY_MAX of this record.

Definition at line 84 of file pilotRecord.h.

recordid_t PilotRecordBase::id (  )  const [inline]

Returns the record ID for this record.

Record IDs are unique for a given handheld and database.

Definition at line 96 of file pilotRecord.h.

bool PilotRecordBase::isArchived (  )  const [inline]

Accessor for one bit of the record's attributes.

Is this record a to-be-archived record? When a record is deleted, it may be marked as "archive on PC" which means the PC should keep a copy. The PC data correspondng to an archived-but-deleted record must not be deleted.

Definition at line 119 of file pilotRecord.h.

bool PilotRecordBase::isDeleted (  )  const [inline]

Accessor for one bit of the record's attributes.

Is this record marked deleted (on the handheld) ? Deleted records are not removed from the database until a HotSync is done (which normally calls purge deleted or so to really get rid of the records from storage.

Definition at line 108 of file pilotRecord.h.

bool PilotRecordBase::isModified (  )  const [inline]

Accessor for one bit of the record's attributes.

Is this record modified? Modified records are those that have been modified since the last HotSync.

Definition at line 123 of file pilotRecord.h.

bool PilotRecordBase::isSecret (  )  const [inline]

Accessor for one bit of the record's attributes.

Is this record secret? Secret records are not displayed on the desktop by default.

Definition at line 112 of file pilotRecord.h.

void PilotRecordBase::setAttributes ( int  attrib  )  [inline]

Set the attributes of this record.

Definition at line 79 of file pilotRecord.h.

void PilotRecordBase::setCategory ( int  cat  )  [inline]

Sets the category number 0 <= < PILOT_CATEGORY_MAX of this record.

Trying to set an illegal category number files this one under "Unfiled" (which is 0).

Reimplemented in PilotAppCategory.

Definition at line 89 of file pilotRecord.h.

void PilotRecordBase::setDeleted ( bool  d = true  )  [inline]

Mark a record as secret (or not).

void PilotRecordBase::setID ( recordid_t  id  )  [inline]

Sets the record ID for this record.

Use with caution -- you ca confuse the handheld by doing weird things here.

Definition at line 100 of file pilotRecord.h.


The documentation for this class was generated from the following file:
KDE Home | KDE Accessibility Home | Description of Access Keys