Qtopia Home - Classes - Hierachy - Annotated - Functions - Qt Embedded

CenterInterface Class Reference

The CenterInterface class provides an interface for plugins inheriting the PluginInterface to the Qtopia Desktop shell. More...

#include <interfaces/center.h>

List of all member functions.

Public Members

• virtual void displayStatusMessage ( const QString & text, bool temp = false ) = 0
• virtual void displayProgress ( int done, int total ) = 0
• virtual FileSystemOperator & fileSystemOperator () = 0
• virtual void sendQCopMessage ( const QString & channel, const QString & message, const QStringList & args ) = 0
• virtual bool sendDcopCommand ( QString destination, QString message ) = 0
• virtual void onDcopCommand ( QString sender, QString event ) = 0
• virtual QString applicationDataPath () = 0
• virtual bool isConnected () const = 0
• virtual void setCategories ( const Categories & ) = 0
• virtual const Categories & categories () const = 0
• virtual EditCategoriesDialog & categoriesEditor () = 0
• virtual void syncCategories () = 0
• enum TimeoutOptions { NormalTimeout = 0, LongTimeout, NoTimeout }
• virtual void setConnectionTimeout ( TimeoutOptions t ) = 0
• virtual TimeoutOptions connectionTimeout () const = 0
• virtual DeviceConnectionInterface * connection () const = 0
• virtual DeviceConnectionInterface * getDevice ( const QString & ) const = 0
• virtual void showManual ( const QString & ) = 0

Detailed Description

A pointer to the CenterInterface instance in Qtopia Desktop is exported to all Qtopia Desktop plugins inheriting from PluginInterface. The interface is used to access shared resources in the Qtopia Desktop shell and to communicate with the Qtopia device.

The displayStatusText() and displayProgressInfo() methods are used to display status information in the Qtopia Desktop status bar.

The pdaMinorVersion() and pdaMajorVersion() methods are used to retrieve version information from the Qtopia device.

The categories(), categoriesEditor() and syncCategories() methods are used to list and modify Qtopia data categories.

The fileSystemOperator() method is used to retrieve a pointer to a the shared file system operator instance used to transfer files between the Qtopia device and Qtopia desktop.

The sendQCopMessage method is used to send QCop messages to QCop channels on the Qtopia device. QCop is a RPC mechanism.

The isConnected() method is used to retrieve the Qtopia device connection status.

The applicationDataPath() method is used to retrieve the base directory path used to store Qtopia Desktop application data.

See also PluginInterface, MergeInterface, SyncAppInterface, ImportInterface, ExportInterface, and Qtopia Desktop Classes.

Member Type Documentation

CenterInterface::TimeoutOptions

This enum type defines the length of the timeout value before connection is determined to be lost. Some operations cause the embedded device to lock up for a period of time and this call changes this timeout.

The policy can be:

• CenterInterface::NormalTimeout - a few second timeout; should be in this state most of the time
• CenterInterface::LongTimeout - a long timeout (up to a minute); this is important for long file transfers
• CenterInterface::NoTimeout - disable timeout

Member Function Documentation

QString CenterInterface::applicationDataPath () [pure virtual]

Returns the base directory used for Qtopia Desktop data files. Qtopia Desktop plugins should create a subdirectory below this path to store their application data.

const Categories & CenterInterface::categories () const [pure virtual]

Returns a list of data categories shared by all Qtopia Desktop components.

See also Categories.

EditCategoriesDialog & CenterInterface::categoriesEditor () [pure virtual]

Returns a reference to a dialog used to edit Qtopia data categories. Use this method in Qtopia Desktop plugins to show a dialog to create/edit/remove Qtopia data categories.

See also EditCategoriesDialog.

TimeoutOptions CenterInterface::connectionTimeout () const [pure virtual]

Returns the currently set TimeoutOptions.

void CenterInterface::displayProgress ( int done, int total ) [pure virtual]

Use this function to display progress information in the Qtopia Desktop GUI shell status bar. The progress percentage is calculated from done and total. The progress will be displayed in a small progress bar in the Qtopia Desktop GUI shell status bar.

void CenterInterface::displayStatusMessage ( const QString & text, bool temp = false ) [pure virtual]

Use this function to display a status text message in the Qtopia Desktop GUI shell status bar. This function is called with a message text and a boolean temp selecting temporary or static message display.

FileSystemOperator & CenterInterface::fileSystemOperator () [pure virtual]

Returns a pointer to a FileSystemOperator instance shared by all Qtopia Desktop components. Do not delete this pointer.

See also FileSystemOperator.

bool CenterInterface::isConnected () const [pure virtual]

Returns TRUE if the Qtopia device is connected to Qtopia Desktop.

void CenterInterface::sendQCopMessage ( const QString & channel, const QString & message, const QStringList & args ) [pure virtual]

This method is used to send QCop messages to QCop channels on the Qtopia device connected to Qtopia Desktop. It is called with the QCOP channel channel, a message message and message arguments args.

void CenterInterface::setCategories ( const Categories & ) [pure virtual]

Sets the list of categories shared by all Qtopia Desktop components.

See also Categories.

void CenterInterface::setConnectionTimeout ( TimeoutOptions t ) [pure virtual]

Qtopia Desktop maintains a IP connection to the Qtopia device. This method is used to set the connection status update rate to t. This method is internal. Use it only if you encounter connection failures during high bandwidth data transfers.

void CenterInterface::syncCategories () [pure virtual]

This method is internal. It is used to sync all categories with the Qtopia device. A Qtopia Desktop plugin does not need to do this explicitely.

This file is part of the Qtopia platform, copyright © 1995-2005 Trolltech, all rights reserved.