kpilot/lib

KPilotUser Class Reference

List of all members.

Detailed Description

Definition at line 40 of file pilotUser.h.


Public Member Functions

 KPilotUser ()
 KPilotUser (const PilotUser *user)
PilotUser * pilotUser ()
const char * getUserName () const
void setUserName (const QString &name)
const int getPasswordLength () const
const char * getPassword () const
void setPassword (const QString &password)
unsigned long getUserID () const
unsigned long getViewerID () const
unsigned long getLastSyncPC () const
void setLastSyncPC (unsigned long pc)
time_t getLastSuccessfulSyncDate ()
void setLastSuccessfulSyncDate (time_t when)
time_t getLastSyncDate ()
void setLastSyncDate (time_t when)

Constructor & Destructor Documentation

KPilotUser::KPilotUser  )  [inline]
 

Constructor.

Create an empty PilotUser structure.

Definition at line 44 of file pilotUser.h.

KPilotUser::KPilotUser const PilotUser *  user  )  [inline]
 

Constructor.

Use the given PilotUser structure. This creates a copy; no ownership is transferred.

Definition at line 51 of file pilotUser.h.


Member Function Documentation

time_t KPilotUser::getLastSuccessfulSyncDate  )  [inline]
 

Returns:
the timestamp that the handheld was last synced successfully.

Definition at line 132 of file pilotUser.h.

time_t KPilotUser::getLastSyncDate  )  [inline]
 

Returns:
the timestamp of the last sync attempt.

Definition at line 143 of file pilotUser.h.

unsigned long KPilotUser::getLastSyncPC  )  const [inline]
 

Returns:
the ID (4 bytes) of the last PC to sync this handheld. This is intended to help identify when the use has changed PCs and needs a new full sync.

Definition at line 116 of file pilotUser.h.

const char* KPilotUser::getPassword  )  const [inline]
 

Returns:
The password on the handheld, NUL terminated.

Definition at line 83 of file pilotUser.h.

const int KPilotUser::getPasswordLength  )  const [inline]
 

Returns:
The length of the password on the handheld, in bytes.

Definition at line 78 of file pilotUser.h.

unsigned long KPilotUser::getUserID  )  const [inline]
 

Accessor for the user ID value; returned as a handheld long value (4 bytes).

Note:
I have no idea what this is for.

Definition at line 99 of file pilotUser.h.

const char* KPilotUser::getUserName  )  const [inline]
 

Returns:
The username set on the handheld.

Definition at line 63 of file pilotUser.h.

unsigned long KPilotUser::getViewerID  )  const [inline]
 

Accessor for the viewer ID value; returned as a handheld long value (4 bytes).

Note:
I have no idea what this is for.

Definition at line 107 of file pilotUser.h.

PilotUser* KPilotUser::pilotUser  )  [inline]
 

Accessor for the whole PilotUser structure.

Definition at line 57 of file pilotUser.h.

void KPilotUser::setLastSuccessfulSyncDate time_t  when  )  [inline]
 

Set the timestamp for a successful sync.

Definition at line 137 of file pilotUser.h.

void KPilotUser::setLastSyncDate time_t  when  )  [inline]
 

Set the timestamp of the sync attempt.

Definition at line 148 of file pilotUser.h.

void KPilotUser::setLastSyncPC unsigned long  pc  )  [inline]
 

Set the ID of the PC syncing the handheld to pc .

This should be unique in some way (perhaps IP addresses can be used this way, or hostnames).

Definition at line 124 of file pilotUser.h.

void KPilotUser::setPassword const QString &  password  )  [inline]
 

Set the password for the user to password , truncated to the size of the field on the handheld if needed.

Definition at line 90 of file pilotUser.h.

void KPilotUser::setUserName const QString &  name  )  [inline]
 

Set the user name to the given name , truncated if necessary to the size of the field on the handheld.

Definition at line 70 of file pilotUser.h.


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