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

kmobiletools

KMobileTools::Engine

KMobileTools::Engine Class Reference

#include <engine.h>

Inheritance diagram for KMobileTools::Engine:

Inheritance graph
[legend]

List of all members.

Detailed Description

Author:
Marco Gulino

Author:
Matthias Lechner
Deprecated:
use EngineXP instead of this class

Definition at line 55 of file engine.h.


Public Types

enum  DialActions { DIAL_DIAL = 0x1, DIAL_HANGUP = 0x2 }
enum  ManufacturerEnum {
  Unknown = 0, Motorola = 1, Siemens = 2, SonyEricsson = 3,
  Nokia = 4
}
enum  PhoneBookMemorySlot { PB_SIM = 2, PB_Phone = 1, PB_DataCard = 4 }

Public Slots

virtual void slotAddAddressee (const KABC::Addressee::List &)=0
virtual void slotDelAddressee (const KABC::Addressee::List &)=0
virtual void slotDelSMS (SMS *)=0
virtual void slotDial (DialActions, const QString &=QString())=0
virtual void slotEditAddressee (const KABC::Addressee &, const KABC::Addressee &)=0
virtual void slotFetchCalendar ()=0
virtual void slotFetchInfos ()=0
virtual void slotFetchPhonebook ()=0
virtual void slotFetchSMS ()=0
virtual void slotInitPhone ()=0
virtual void slotPollStatus ()=0
virtual void slotResumeDevice ()
virtual void slotSearchPhone ()=0
virtual void slotSendSMS (SMS *)=0
virtual void slotSendSMS (const QString &number, const QString &text)=0
virtual void slotSendStoredSMS (SMS *)=0
virtual void slotStopDevice ()
virtual void slotStoreSMS (SMS *)=0
virtual void slotStoreSMS (const QString &number, const QString &text)=0
virtual void slotSwitchToFSMode ()
virtual void slotWeaverSuspended ()

Signals

void jobEnqueued (KMobileTools::Job *job)
void jobFinished (KMobileTools::Job::JobType)
void resumed ()
void smsFoldersAdded ()
void suspended ()

Public Member Functions

virtual int availPbSlots ()=0
virtual
KMobileTools::DevicesConfig * 		config (bool forceNew=false, const QString &groupName=QString())=0
virtual QList< QWidget * > configWidgets (QWidget *parentWidget)=0
const KMobileTools::EngineData * constEngineData () const
virtual QString currentDeviceName () const
int currentPBMemSlot ()
virtual QStringList encodings ()=0
 Engine (QObject *parent=0, const QString &name=QString())
virtual QString engineLibName () const =0
void enqueueJob (KMobileTools::Job *job)
virtual QString longDesc ()
virtual QString parseWizardSummary (const QString &strtemplate, const QString &deviceName) const =0
virtual bool pdu ()=0
KPluginInfo pluginInfo ()
virtual void queryClose ()
void setCurrentPBMemSlot (int type)
void setSMSSlot (int slot)
virtual QString shortDesc ()
QStringList smsFolders ()
int smsSlot ()
int statusJobsSuspended () const
void suspendStatusJobs (bool suspend)
KMobileTools::Weaver * ThreadWeaver ()
virtual QList< QWizardPage * > wizardPages (QWidget *parentWidget)=0
virtual ~Engine ()

Static Public Member Functions

static Engine * load (const QString &libname, QObject *parent=0)

Protected Slots

virtual void processSlot (KMobileTools::Job *job)

Protected Member Functions

KMobileTools::EngineData * engineData ()

Member Enumeration Documentation

enum KMobileTools::Engine::DialActions

remove

Enumerator:
DIAL_DIAL 
DIAL_HANGUP 

Definition at line 74 of file engine.h.

enum KMobileTools::Engine::ManufacturerEnum

remove

This enum type defines the phone manufacturers.

  • Unknown : Unknown manufacturer
  • Motorola : Motorola
  • Siemens : Siemens
  • SonyEricsson : Sony Ericcson
  • Nokia : Nokia
Enumerator:
Unknown 
Motorola 
Siemens 
SonyEricsson 
Nokia 

Definition at line 85 of file engine.h.

enum KMobileTools::Engine::PhoneBookMemorySlot

This enum type defines the type of phone book memory slot.

  • PB_SIM : Sim card
  • PB_Phone : Phone
  • PB_DataCard : Data card
Enumerator:
PB_SIM 
PB_Phone 
PB_DataCard 

Definition at line 67 of file engine.h.

Constructor & Destructor Documentation

Engine::Engine ( QObject *  parent = 0,
const QString &  name = QString() 
) [explicit]

remove

Creates a new Engine object.

Parameters:
parent the parent QObject
name the object name

Definition at line 67 of file engine.cpp.

Engine::~Engine (  )  [virtual]

Destroys a Engine object.

Definition at line 93 of file engine.cpp.

Member Function Documentation

virtual int KMobileTools::Engine::availPbSlots (  )  [pure virtual]

remove

Retrieves the numbers of phonebook memory slots.

Returns:
the numbers of phonebook memory slots

Implemented in AT_Engine.

virtual KMobileTools::DevicesConfig* KMobileTools::Engine::config ( bool  forceNew = false,
const QString &  groupName = QString() 
) [pure virtual]

Convenience method returning a specific KMobileTools::DevicesConfig object with the engine specific configuration items.

Calling without parameters return settings for current engine.

Parameters:
forceNew if true, force creating a new KConfigSkeleton::DevicesConfig object instead of searching for an existing one.
groupName specify the group of settings to be loaded. If null, engine->objectName() will be used.
Returns:
A KConfigSkeleton::DevicesConfig with this engine settings, or NULL in case of errors.

Implemented in AT_Engine.

virtual QList<QWidget*> KMobileTools::Engine::configWidgets ( QWidget *  parentWidget  )  [pure virtual]

Setup list of QWidget to be added in a KConfigDialog, handling engine specific configuration options.

Be careful to reimplement this setting these properties:

  • QString itemName
  • QString pixmapName
  • QString header as they will be used as parameters for KConfigDialog::addPage().

Parameters:
parentWidget the parent widget to be used when creating widgets.
Returns:
a QList<QWidget*> object containing configuration pages.

Implemented in AT_Engine.

const KMobileTools::EngineData * Engine::constEngineData (  )  const

Returns a const pointer to the engine's data for read-only access.

Returns:
a const pointer to EngineData

Definition at line 88 of file engine.cpp.

QString Engine::currentDeviceName (  )  const [virtual]

The engine name provided in the .desktop file.

Reimplemented in AT_Engine.

Definition at line 162 of file engine.cpp.

int Engine::currentPBMemSlot (  ) 

remove?! strings should be passed as utf8 and converted by the engine if needed

Definition at line 178 of file engine.cpp.

virtual QStringList KMobileTools::Engine::encodings (  )  [pure virtual]

Implemented in AT_Engine.

KMobileTools::EngineData * Engine::engineData (  )  [protected]

Returns a pointer to the engine's data for read/write access.

Returns:
the engine's data

Definition at line 84 of file engine.cpp.

virtual QString KMobileTools::Engine::engineLibName (  )  const [pure virtual]

Implemented in AT_Engine.

void Engine::enqueueJob ( KMobileTools::Job *  job  ) 

remove

Adds the specified job to the queue

Parameters:
job the job to be added to the queue

Definition at line 145 of file engine.cpp.

void KMobileTools::Engine::jobEnqueued ( KMobileTools::Job *  job  )  [signal]

this signal is needed for dialing only, so probably remove

This signal is emitted when a job is enqueued.

Parameters:
job the job that has been enqueued

void KMobileTools::Engine::jobFinished ( KMobileTools::Job::JobType   )  [signal]

This signal is emitted when KMobileTools finishs a task.

Engine * Engine::load ( const QString &  libname,
QObject *  parent = 0 
) [static]

Convenience method to load an engine object through KLibFactory.

Returns:
a KMobileTools::Engine object, or a NULL pointer if something went wrong.

Definition at line 214 of file engine.cpp.

QString Engine::longDesc (  )  [virtual]

Definition at line 172 of file engine.cpp.

virtual QString KMobileTools::Engine::parseWizardSummary ( const QString &  strtemplate,
const QString &  deviceName 
) const [pure virtual]

remove?!

Format a string to be displayed in the final page of the wizard, to show device parameters.

Parameters:
strtemplate The string to be used as template
deviceName the internal name of the device, for grabbing settings
Returns:
A string with the device information, or a null string if an error occurred

Implemented in AT_Engine.

virtual bool KMobileTools::Engine::pdu (  )  [pure virtual]

remove

Shows if mobile phone can encode text in PDU mode.

Returns:
true if mobile phone is PDU able.

Implemented in AT_Engine.

KPluginInfo Engine::pluginInfo (  ) 

Definition at line 157 of file engine.cpp.

void Engine::processSlot ( KMobileTools::Job *  job  )  [protected, virtual, slot]

This slot is called whenever an enqueued job has been finished.

Reimplement this method to further process the data that the job has dealt with.

Parameters:
job the job that has finished

look for namespace

Reimplemented in AT_Engine.

Definition at line 107 of file engine.cpp.

void Engine::queryClose (  )  [virtual]

remove

Ask engine to close before calling the destructor.

Reimplemented in AT_Engine.

Definition at line 134 of file engine.cpp.

void KMobileTools::Engine::resumed (  )  [signal]

this signal is needed for dialing only, so probably remove

This signal is emitted when the engine is resumed.

void Engine::setCurrentPBMemSlot ( int  type  ) 

remove

Definition at line 183 of file engine.cpp.

void Engine::setSMSSlot ( int  slot  ) 

remove

Set the SMS slot (sim, phone, datacard) to be used.

Parameters:
slot the slot that be used

Definition at line 124 of file engine.cpp.

QString Engine::shortDesc (  )  [virtual]

Definition at line 167 of file engine.cpp.

virtual void KMobileTools::Engine::slotAddAddressee ( const KABC::Addressee::List &   )  [pure virtual, slot]

Implemented in AT_Engine.

virtual void KMobileTools::Engine::slotDelAddressee ( const KABC::Addressee::List &   )  [pure virtual, slot]

remove

Implemented in AT_Engine.

virtual void KMobileTools::Engine::slotDelSMS ( SMS *   )  [pure virtual, slot]

remove

Implemented in AT_Engine.

virtual void KMobileTools::Engine::slotDial ( DialActions  ,
const QString &  = QString() 
) [pure virtual, slot]

remove

Implemented in AT_Engine.

virtual void KMobileTools::Engine::slotEditAddressee ( const KABC::Addressee &  ,
const KABC::Addressee &   
) [pure virtual, slot]

remove

Implemented in AT_Engine.

virtual void KMobileTools::Engine::slotFetchCalendar (  )  [pure virtual, slot]

move to protected

Implemented in AT_Engine.

virtual void KMobileTools::Engine::slotFetchInfos (  )  [pure virtual, slot]

remove

Implemented in AT_Engine.

virtual void KMobileTools::Engine::slotFetchPhonebook (  )  [pure virtual, slot]

remove

Implemented in AT_Engine.

virtual void KMobileTools::Engine::slotFetchSMS (  )  [pure virtual, slot]

implement this virtual bool changePhoneBookSlot (PhoneBookMemorySlot slot) = 0; virtual bool changeSMSMemSlot (SMS::MemorySlot slot ) = 0; virtual int parseSMSList() = 0; virtual int parseAddressBook() = 0;

Implemented in AT_Engine.

virtual void KMobileTools::Engine::slotInitPhone (  )  [pure virtual, slot]

remove

This slot is called when slotSearchPhone has finished probing devices. It will establish a link to the found device, and properly initialize engine communication. Reimplement to correctly initialize engines.

Implemented in AT_Engine.

virtual void KMobileTools::Engine::slotPollStatus (  )  [pure virtual, slot]

remove

Implemented in AT_Engine.

void Engine::slotResumeDevice (  )  [virtual, slot]

remove?! method is not actively used anyway

Reimplemented in AT_Engine.

Definition at line 193 of file engine.cpp.

virtual void KMobileTools::Engine::slotSearchPhone (  )  [pure virtual, slot]

Start searching for our mobile phone.

It's the first method to be called when initializing the engine. The slot will look the phone configuraton, searching for the correct device to be initialized. This has to be reimplemented in each engine.

Implemented in AT_Engine.

virtual void KMobileTools::Engine::slotSendSMS ( SMS *   )  [pure virtual, slot]

remove

Implemented in AT_Engine.

virtual void KMobileTools::Engine::slotSendSMS ( const QString &  number,
const QString &  text 
) [pure virtual, slot]

remove

Implemented in AT_Engine.

virtual void KMobileTools::Engine::slotSendStoredSMS ( SMS *   )  [pure virtual, slot]

remove

Implemented in AT_Engine.

void Engine::slotStopDevice (  )  [virtual, slot]

remove

Reimplemented in AT_Engine.

Definition at line 188 of file engine.cpp.

virtual void KMobileTools::Engine::slotStoreSMS ( SMS *   )  [pure virtual, slot]

remove

Implemented in AT_Engine.

virtual void KMobileTools::Engine::slotStoreSMS ( const QString &  number,
const QString &  text 
) [pure virtual, slot]

remove

Implemented in AT_Engine.

void Engine::slotSwitchToFSMode (  )  [virtual, slot]

Reimplemented in AT_Engine.

Definition at line 151 of file engine.cpp.

void Engine::slotWeaverSuspended (  )  [virtual, slot]

remove?! method is not actively used anyway

Reimplemented in AT_Engine.

Definition at line 199 of file engine.cpp.

QStringList Engine::smsFolders (  ) 

move to protected

Retrieves the phone SMS folders.

Returns:
the phone SMS folders

Definition at line 119 of file engine.cpp.

void KMobileTools::Engine::smsFoldersAdded (  )  [signal]

This signal is emitted when a SMS folder is added.

move this signal to engineData (and add a method to explicitly add and remove sms folders so the signal gets emitted automatically)

int Engine::smsSlot (  ) 

remove

Retrieves the SMS slot used.

Returns:
the sms slot used.

Definition at line 129 of file engine.cpp.

int Engine::statusJobsSuspended (  )  const

move to protected

Definition at line 209 of file engine.cpp.

void KMobileTools::Engine::suspended (  )  [signal]

This signal is emitted when the engine is suspended.

void Engine::suspendStatusJobs ( bool  suspend  ) 

move to protected (wizard class can be a friend)

Definition at line 204 of file engine.cpp.

KMobileTools::Weaver * Engine::ThreadWeaver (  ) 

Returns the engine's ThreadWeaver instance.

Returns:
the thread weaver instance

Definition at line 114 of file engine.cpp.

virtual QList<QWizardPage*> KMobileTools::Engine::wizardPages ( QWidget *  parentWidget  )  [pure virtual]

Returns a list of QWizardPage objects to be used in the New Phone Wizard.

Each engine should reimplement this to provide different wizard pages depending on the engine settings.

Returns:
a QList<QWizardPage*> with the engine wizard pages, or NULL if the engine does not provide wizard pages.

Implemented in AT_Engine.

The documentation for this class was generated from the following files:
  • engine.h
  • engine.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