Home · All Namespaces · All Classes
Public Member Functions

NGFAdapter Class Reference

#include <ngfadapter.h>

List of all members.

Public Member Functions

 NGFAdapter ()
 ~NGFAdapter ()
uint play (const QString &id)
void stop (uint eventId)
bool isValid ()

Detailed Description

A class that provides a simple QT'ified API to the plain C API provided by the libngf0.

This adapter class will request the libngf daemon to play a non-graphical feedback when instructed to do so. Please note that this adapter will not perform any error checking if the feedback was played or not as the notification framework, the sole user of this class, really can not do anything sensible with the error.


Constructor & Destructor Documentation

NGFAdapter::NGFAdapter (  ) 

Creates the adapter to the non-graphical feedback framework client

NGFAdapter::~NGFAdapter (  ) 

Destructs the adapter


Member Function Documentation

bool NGFAdapter::isValid (  ) 

This method can be used to check if the adapter has managed to get to create the low-level client and can play feedbacks

Returns:
true if this adapter can be used correctly, false otherwise.
uint NGFAdapter::play ( const QString &  id  ) 

Requests play from the non-graphical feedback daemon. It is not always guaranteed that the tune will play.

NOTE: The id will be converted to a const char* via QString::toUtf8().constData()

Parameters:
id The id to play
Returns:
eventId indicating the identifier of play request
void NGFAdapter::stop ( uint  eventId  ) 

Requests a stop from the non-graphical feedback daemon. If the play has already finished this may not do anything.

Parameters:
eventId identifier given by play

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

Copyright © 2011 Nokia Corporation Generated on Tue Aug 30 2011 16:38:13
Doxygen 1.7.1
MeeGo Touch