Home · All Namespaces · All Classes · Grouped Classes · Modules · Functions

QVibrateAccessory Class Reference
[QtBaseModule]

The QVibrateAccessory class provides access to the vibrate device on a phone. More...

    #include <QVibrateAccessory>

Inherits QHardwareInterface.

Inherited by QVibrateAccessoryProvider.

• List of all members, including inherited members

Public Functions

• QVibrateAccessory ( const QString & id = QString(), QObject * parent = 0, QAbstractIpcInterface::Mode mode = Client )
• ~QVibrateAccessory ()
• bool supportsVibrateNow () const
• bool supportsVibrateOnRing () const
• bool vibrateNow () const
• bool vibrateOnRing () const

• 4 public functions inherited from QAbstractIpcInterface
• 29 public functions inherited from QObject

Public Slots

• virtual void setVibrateNow ( const bool value )
• virtual void setVibrateOnRing ( const bool value )

• 1 public slot inherited from QObject

Signals

• void vibrateNowModified ()
• void vibrateOnRingModified ()

• 1 signal inherited from QAbstractIpcInterface
• 1 signal inherited from QObject

Additional Inherited Members

• 1 property inherited from QObject
• 1 public type inherited from QObject
• 4 static public members inherited from QObject
• 14 protected functions inherited from QAbstractIpcInterface
• 7 protected functions inherited from QObject
• 2 protected variables inherited from QObject

Detailed Description

The QVibrateAccessory class provides access to the vibrate device on a phone.

QVibrateAccessory can be used to control when the vibrate device activates with vibrateOnRing() and vibrateNow(). The usual way to turn on the vibrate device within a client application is as follows:

    QVibrateAccessory vib;
    vib.setVibrateNow( true );

Vibrate device implementations should inherit from QVibrateAccessoryProvider.

See also QVibrateAccessoryProvider and QHardwareInterface.

Member Function Documentation

QVibrateAccessory::QVibrateAccessory ( const QString & id = QString(), QObject * parent = 0, QAbstractIpcInterface::Mode mode = Client )

Construct a new vibrate abstraction object for provider id and attaches it to parent. The object will be created in client mode if mode is Client, or server mode otherwise.

If id is empty, this class will use the first available provider that supports the vibrate interface. If there is more than one service that supports the vibrate interface, the caller should enumerate them with QHardwareManager::providers() and create separate QVibrateAccessory objects for each.

See also QHardwareManager::providers().

QVibrateAccessory::~QVibrateAccessory ()

Destroys the vibrate accessory.

void QVibrateAccessory::setVibrateNow ( const bool value )   [virtual slot]

Turns the vibrate device on if value is true; otherwise it is turned off.

See also vibrateNow().

void QVibrateAccessory::setVibrateOnRing ( const bool value )   [virtual slot]

Sets the vibrateOnRing() attribute to value.

See also vibrateOnRing().

bool QVibrateAccessory::supportsVibrateNow () const

Returns true if the vibrate device supports the vibrateNow() feature; otherwise returns false.

bool QVibrateAccessory::supportsVibrateOnRing () const

Returns true if the vibrate device supports the vibrateOnRing() feature; otherwise returns false.

bool QVibrateAccessory::vibrateNow () const

Returns true if the vibrate device is currently vibrating; otherwise returns false.

See also setVibrateNow().

void QVibrateAccessory::vibrateNowModified ()   [signal]

Signal that is emitted when vibrateNow() is modified.

bool QVibrateAccessory::vibrateOnRing () const

Returns true if the vibrate device will vibrate when an incoming call is detected; otherwise returns false.

See also setVibrateOnRing().

void QVibrateAccessory::vibrateOnRingModified ()   [signal]

Signal that is emitted when vibrateOnRing() is modified.