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

kmobiletools

KMobileTools::JobXP

KMobileTools::JobXP Class Reference

#include <jobxp.h>

Inheritance diagram for KMobileTools::JobXP:

Inheritance graph
[legend]

List of all members.


Detailed Description

This class describes a job that should be used by engines as base class for all jobs they need to perform (e.g.

fetching of address book or sms )

If you want allow your job to be aborted, implement "void requestAbort()" as public slot.

Author:
Matthias Lechner <matths@lmme.de>

Definition at line 40 of file jobxp.h.


Public Types

enum  Type {
  fetchAddressbook = 0, fetchInformation = 1, fetchShortMessages = 2, fetchSMSFolders = 3,
  fetchSMSCenter = 4, fetchStatusInformation = 5, addAddressee = 100, editAddressee = 101,
  removeAddressee = 102, storeSMS = 103, sendSMS = 104, removeSMS = 105,
  addSMSFolder = 106, editSMSFolder = 107, removeSMSFolder = 108, custom = 999
}

Signals

void progressChanged (int percent)

Public Member Functions

bool canBeAborted () const
JobXP::Type jobType () const
 JobXP (JobXP::Type jobType, QObject *parent=0)
int progress () const
 ~JobXP ()

Protected Member Functions

void setProgress (int percent)

Member Enumeration Documentation

enum KMobileTools::JobXP::Type

Enumerator:
fetchAddressbook 
fetchInformation 
fetchShortMessages 
fetchSMSFolders 
fetchSMSCenter 
fetchStatusInformation 
addAddressee 
editAddressee 
removeAddressee 
storeSMS 
sendSMS 
removeSMS 
addSMSFolder 
editSMSFolder 
removeSMSFolder 
custom 

Definition at line 44 of file jobxp.h.


Constructor & Destructor Documentation

KMobileTools::JobXP::JobXP ( JobXP::Type  jobType,
QObject *  parent = 0 
)

Creates a new job of type jobType with parent parent.

Parameters:
jobType the type of the created job
parent the parent

Definition at line 37 of file jobxp.cpp.

KMobileTools::JobXP::~JobXP (  ) 

Definition at line 47 of file jobxp.cpp.


Member Function Documentation

bool KMobileTools::JobXP::canBeAborted (  )  const

Returns whether the job can be aborted by the user.

To make a job abortable you will have to implement a requestAbort() method in your subclass

Definition at line 55 of file jobxp.cpp.

JobXP::Type KMobileTools::JobXP::jobType (  )  const

Returns the type of this job.

Returns:
the job type

Definition at line 51 of file jobxp.cpp.

int KMobileTools::JobXP::progress (  )  const

Returns the job's progress in percent.

Returns:
the progress in percent

Definition at line 83 of file jobxp.cpp.

void KMobileTools::JobXP::progressChanged ( int  percent  )  [signal]

This signal is emitted when the job's progress has changed.

void KMobileTools::JobXP::setProgress ( int  percent  )  [protected]

Sets the job's progress in percent.

Parameters:
percent the progress in percent

Definition at line 76 of file jobxp.cpp.


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

kmobiletools

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

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