• Skip to content
• Skip to link menu

KDE 4.2 API Reference

• KDE API Reference
• kdepim

• Sitemap
• Contact Us

 

kmobiletools

KMobileTools::EngineData Class Reference

#include <enginedata.h>

Inheritance diagram for KMobileTools::EngineData:

[legend]

List of all members.

---

Detailed Description

Author:

Matthias Lechner

Author:

Marco Gulino

Deprecated:

use EngineXP instead of this class

Definition at line 43 of file enginedata.h.

Public Types
enum	ChargeType { Unknown = -1, Battery = 0, ACAdaptor = 1 }
Signals
void	calendarChanged ()
void	chargeChanged (int charge)
void	chargeTypeChanged (ChargeType chargeType)
void	connected ()
void	disconnected ()
void	networkNameChanged (const QString &name)
void	phoneBookChanged ()
void	ringing (bool ringing)
void	signalStrengthChanged (int signalStrength)
void	smsAdded (const QString &sms)
void	smsDeleted (const QString &sms)
void	smsModified (const QString &sms)
Public Member Functions
const KCal::Event::List *	calendar ()
int	charge () const
int	chargeType () const
ContactsList *	contactsList () const
	EngineData (Engine *parentEngine)
QString	imei () const
QString	manufacturer () const
int	manufacturerID () const
QString	model () const
QString	networkName () const
bool	phoneConnected () const
bool	phoneRinging () const
QString	revision () const
void	setCalendar (KCal::Event::List *calendar)
void	setCharge (int charge)
void	setChargeType (ChargeType chargeType)
void	setContactsList (ContactsList *contactsList)
void	setIMEI (const QString &imei)
void	setManufacturer (const QString &manufacturer)
void	setManufacturerID (int manufacturerID)
void	setModel (const QString &model)
void	setNetworkName (const QString &networkName)
void	setPhoneConnected (bool)
void	setPhoneRinging (bool ringing)
void	setRevision (const QString &revision)
void	setSignalStrength (int signalStrength)
void	setSMSCenter (const QString &smsc)
void	setSMSList (SMSList *smsList)
int	signalStrength () const
QString	smsCenter () const
const SMSList *	smsList () const
	~EngineData ()

---

Member Enumeration Documentation

enum KMobileTools::EngineData::ChargeType

Enumerator:

Unknown
Battery
ACAdaptor

Definition at line 47 of file enginedata.h.

---

Constructor & Destructor Documentation

EngineData::EngineData

(

KMobileTools::Engine *

parentEngine

)

remove

Creates a new EngineData object. This class can store data from engines, emit signals when it changes, and act as an interface for the GUI.

Parameters:

parentEngine

the engine providing data to store.

Definition at line 53 of file enginedata.cpp.

EngineData::~EngineData

(

)

Definition at line 68 of file enginedata.cpp.

---

Member Function Documentation

const KCal::Event::List * EngineData::calendar

(

)

Returns the phone's calendar.

Returns:

the phone calendar

Definition at line 133 of file enginedata.cpp.

void KMobileTools::EngineData::calendarChanged

(

)

[signal]

remove

This signal is emitted when calendar is modified.

int EngineData::charge

(

)

const

remove

Returns the phone's charge in percent

Returns:

the phone's charge in percent

Definition at line 178 of file enginedata.cpp.

void KMobileTools::EngineData::chargeChanged

(

int

charge

)

[signal]

remove

This signal is whenever the phone charge changes

Parameters:

charge

the charge level in percent

int EngineData::chargeType

(

)

const

remove

Returns the phone's charge type

Returns:

the phone's charge type

Definition at line 189 of file enginedata.cpp.

void KMobileTools::EngineData::chargeTypeChanged

(

ChargeType

chargeType

)

[signal]

remove

This signal is emitted whenever the phone's charge type changed

Parameters:

chargeType

the charge type

void KMobileTools::EngineData::connected

(

)

[signal]

This signal is emitted when the phone is connected.

ContactsList * EngineData::contactsList

(

)

const

remove

Retrieves the phone contact list.

Returns:

phone contact list

Definition at line 145 of file enginedata.cpp.

void KMobileTools::EngineData::disconnected

(

)

[signal]

This signal is emitted when the phone is disconnected.

QString EngineData::imei

(

)

const

remove

Retrieves the phone raw IMEI. The IMEI is a number unique to every GSM and UMTS mobile phone.

Returns:

the phone raw IMEI

Definition at line 108 of file enginedata.cpp.

QString EngineData::manufacturer

(

)

const

remove

Retrieves the phone manufacturer as returned by the mobile phone.

Returns:

a QString containing the phone manufacturer.

Definition at line 80 of file enginedata.cpp.

int EngineData::manufacturerID

(

)

const

remove

Retrieves the manufacturer ID.

Returns:

the manufacturer ID

Definition at line 92 of file enginedata.cpp.

QString EngineData::model

(

)

const

remove

Retrieves the phone model.

Returns:

the phone model

Definition at line 100 of file enginedata.cpp.

QString EngineData::networkName

(

)

const

remove

Returns the network the phone is currently logged in

Returns:

the network name

Definition at line 211 of file enginedata.cpp.

void KMobileTools::EngineData::networkNameChanged

(

const QString &

name

)

[signal]

remove

This signal is emitted whenever the current network changes

Parameters:

name

the name of the network.

void KMobileTools::EngineData::phoneBookChanged

(

)

[signal]

remove

This signal is emitted when the mobile's phone book has been changed.

bool EngineData::phoneConnected

(

)

const

Retrieves if phone is connected.

Returns:

true if phone is connected.

Definition at line 163 of file enginedata.cpp.

bool EngineData::phoneRinging

(

)

const

remove

Returns whether the phone is ringing

Returns:

true if the phone is ringing

Definition at line 200 of file enginedata.cpp.

QString EngineData::revision

(

)

const

remove

Retrieves the phone firmware revision.

Returns:

the phone firmware revision

Definition at line 124 of file enginedata.cpp.

void KMobileTools::EngineData::ringing

(

bool

ringing

)

[signal]

remove

This signal whenever the phone is ringing

Parameters:

ringing

true if phone is ringing

void EngineData::setCalendar

(

KCal::Event::List *

calendar

)

remove

Sets the phone calendar

Parameters:

calendar

the phone calendar

Definition at line 128 of file enginedata.cpp.

void EngineData::setCharge

(

int

charge

)

remove

Sets the phone's charge in percent

charge the phone's charge in percent

Definition at line 182 of file enginedata.cpp.

void EngineData::setChargeType

(

ChargeType

chargeType

)

remove

Sets the phone's charge type

chargeType the phone's charge type

Definition at line 193 of file enginedata.cpp.

void EngineData::setContactsList

(

ContactsList *

contactsList

)

remove

Sets the phone contact list.

Returns:

phone contact list

Definition at line 147 of file enginedata.cpp.

void EngineData::setIMEI

(

const QString &

imei

)

remove

Sets the phone raw IMEI. The IMEI is a number unique to every GSM and UMTS mobile phone.

Parameters:

imei

the phone's imei

Definition at line 104 of file enginedata.cpp.

void EngineData::setManufacturer

(

const QString &

manufacturer

)

remove

Sets phone manufacturer as returned by the mobile phone.

Parameters:

manufacturer

the manufacturer string.

Definition at line 84 of file enginedata.cpp.

void EngineData::setManufacturerID

(

int

manufacturerID

)

remove

Sets the manufacturer ID.

Parameters:

manufacturerID

the manufacturer id

Definition at line 88 of file enginedata.cpp.

void EngineData::setModel

(

const QString &

model

)

remove

Sets the phone model

Parameters:

model

the phone model

Definition at line 96 of file enginedata.cpp.

void EngineData::setNetworkName

(

const QString &

networkName

)

remove

Sets the network name the phone is currently logged in

Parameters:

networkName

the network name

Definition at line 215 of file enginedata.cpp.

void EngineData::setPhoneConnected

(

bool

b

)

Sets if phone is connected.

Returns:

true if phone is connected.

Definition at line 152 of file enginedata.cpp.

void EngineData::setPhoneRinging

(

bool

ringing

)

remove

Sets whether the phone is ringing

chargeType true if the phone is ringing

Definition at line 204 of file enginedata.cpp.

void EngineData::setRevision

(

const QString &

revision

)

remove

Sets the phone firmware revision.

Parameters:

revision

the phone's firmware revision

Definition at line 120 of file enginedata.cpp.

void EngineData::setSignalStrength

(

int

signalStrength

)

remove

Sets the phone's signal strength

signalStrength the signal strength in percent

Definition at line 171 of file enginedata.cpp.

void EngineData::setSMSCenter

(

const QString &

smsc

)

remove

Sets the SMS center number.

Parameters:

smsc

the SMS center number

Definition at line 112 of file enginedata.cpp.

void EngineData::setSMSList

(

SMSList *

smsList

)

remove

Sets the current list of sms

Parameters:

smsList

the current list of sms

Definition at line 141 of file enginedata.cpp.

int EngineData::signalStrength

(

)

const

Returns the phone's signal strength.

Returns:

the signal strength in percent

Definition at line 167 of file enginedata.cpp.

void KMobileTools::EngineData::signalStrengthChanged

(

int

signalStrength

)

[signal]

This signal is emitted whenever the signal strength has changed.

Parameters:

signalStrength

the signal level in percent

void KMobileTools::EngineData::smsAdded

(

const QString &

sms

)

[signal]

remove

This signal is emitted when a SMS is added.

Parameters:

sms

the sms that is added

QString EngineData::smsCenter

(

)

const

remove

Retrieves the SMS center number.

Returns:

the SMS center number

Definition at line 116 of file enginedata.cpp.

void KMobileTools::EngineData::smsDeleted

(

const QString &

sms

)

[signal]

remove

This signal is emitted when a SMS is deleted.

Parameters:

sms

the sms that is deleted

const SMSList * EngineData::smsList

(

)

const

remove

Returns the fetched sms list for reading

Returns:

a SMSList object containing all fetched SMS.

Definition at line 137 of file enginedata.cpp.

void KMobileTools::EngineData::smsModified

(

const QString &

sms

)

[signal]

remove

This signal is emitted when a SMS is modified.

Parameters:

sms

the sms that is modified

---

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

• enginedata.h
• enginedata.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