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

QtopiaDocumentServer Class Reference
[QtBaseModule]

The QtopiaDocumentServer class provides an instance of the Qt Extended Document Server. More...

    #include <QtopiaDocumentServer>

Inherits QObject.

• List of all members, including inherited members

Public Functions

• QtopiaDocumentServer ( QObject * parent = 0 )
• virtual ~QtopiaDocumentServer ()
• void shutdown ()

• 29 public functions inherited from QObject

Signals

• void shutdownComplete ()

• 1 signal inherited from QObject

Additional Inherited Members

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

Detailed Description

The QtopiaDocumentServer class provides an instance of the Qt Extended Document Server.

The Qt Extended Document Server provides applications with a mechanism to interact with the Qt Extended Document System without having direct access to the document databases or even the file system. A single instance of the document server runs in a server process, and client applications connect to this server in order to gain access to the functionality provided by the document system API.

The document server runs multiple threads and should be shut down before being destroyed in order to allow the threads to exit cleanly. A shut down can be initiated with the shutdown() slot, and the shutdownComplete() signal will be emitted when this is complete.

Member Function Documentation

QtopiaDocumentServer::QtopiaDocumentServer ( QObject * parent = 0 )

Constructs a new Qt Extended document server with the parent parent.

Only one instance of the document server should ever exist at once across all Qt Extended applications.

QtopiaDocumentServer::~QtopiaDocumentServer ()   [virtual]

Destroys the document server object.

void QtopiaDocumentServer::shutdown ()

Initiates a shutdown of the document server. The shutdownComplete() signal will be emitted when all the document server threads have exited.

See also shutdownComplete().

void QtopiaDocumentServer::shutdownComplete ()   [signal]

Emitted by the server when the server has successfully been shutdown in response to a call to shutdown().

See also shutdown().