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

# QDL Class Reference

The QDL class provides general utility functions for use with Qtopia Data Linking. More...

`#include <qtopia/qdl.h>`

List of all member functions.

## Static Public Members

- QList<QDLClient> clients ( QObject * parent )
- void sendHeartBeat ( const QString & clientID )
- void loadLinks ( const QString & str, QDLClient * client )
- void loadLinks ( const QString & str, QList<QDLClient> clientList )
- void saveLinks ( QString & str, QDLClient * client )
- void saveLinks ( QString & str, QList<QDLClient> clientList )
- void activateLink ( const QString & ahref, const QList<QDLClient> & clientList )
- QString encodeAhref ( const QString & ahref )
- QString decodeAhref ( const QString & ahref )
- QString lidsToAnchors ( const QString & lidText, const QDLClient * client, bool withIcons = TRUE )
- QString removeLids ( const QString & lidText )
- uint lidToUInt ( const QString & lid )
- QString lidFromUInt ( uint lid )

## Detailed Description

The QDL class provides general utility functions for use with Qtopia Data Linking.

Qtopia Data Linking (QDL) enables a client to link to data in a source. A client may be a stand-alone object (QDLClient) or attached to a widget (QDLWidgetClient). A source can be any application which acts as a container for useful data and provides the QDL Service.

This class provides useful functions for loading and saving links and dealing with general QDL usage.

First availability: Qtopia 2.0

See also Qtopia Classes.

## Member Function Documentation

### void QDL::activateLink ( const QString & ahref, const QList<QDLClient> & clientList )`[static]`

Activates the QDL link specified by ahref. ahref should be in the form

     qdl://<clientName>:<lid>

. Rich text links are usually generated by QDL::lidsToAnchors.

What 'activate' actually means is dependent on the source application. As an example, if `the` QDLLink points to a contact, the Contacts application might display that particular contact.

See also QDL::lidsToAnchors.

### QList<QDLClient> QDL::clients ( QObject * parent )`[static]`

Returns all QDLClient objects that are children of parent. This is useful for automatically loading links into a bunch of clients eg.

        QDL::loadLinks( rec, QDL::clients( this ) );

### QString QDL::decodeAhref ( const QString & ahref )`[static]`

Decodes the string ahref that was encoded as part of a QDL link.

### QString QDL::encodeAhref ( const QString & ahref )`[static]`

Encodes the string ahref so that it may be included as part of a QDL link.

### QString QDL::lidFromUInt ( uint lid )`[static]`

Converts the unsigned integer link identifier lid into an equivalent unicode superscript link identifier.

### uint QDL::lidToUInt ( const QString & lid )`[static]`

Converts the unicode superscript link identifier lid into an equivalent unsigned integer link identifier.

See also lidFromUInt().

### QString QDL::lidsToAnchors ( const QString & lidText, const QDLClient * client, bool withIcons = TRUE )`[static]`

Converts the unicode superscript link identifiers in lidText to rich text anchors based on the links in client.

If withIcons is TRUE (the default), icons are included as part of the rich text links.

### void QDL::loadLinks ( const QString & str, QList<QDLClient> clientList )`[static]`

Loads the links stored in str into the clients in clientList. str is the base64 encoded binary data of the links.

### void QDL::loadLinks ( const QString & str, QDLClient * client )`[static]`

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Loads the links stored in str into a single client.

### QString QDL::removeLids ( const QString & lidText )`[static]`

Removes the unicode superscript link identifiers in lidText.

### void QDL::saveLinks ( QString & str, QList<QDLClient> clientList )`[static]`

Saves the links from clientList into str. str will be the base64 encoded binary link data.

### void QDL::saveLinks ( QString & str, QDLClient * client )`[static]`

This is an overloaded member function, provided for convenience. It behaves essentially like the above function.

Saves the links from the single client to str.

### void QDL::sendHeartBeat ( const QString & clientID )`[static]`

Sends a heart beat to the client with the specified clientID. A heart beat is used by a source to let clients know that their request is still being actively processed. A client will stop waiting for a response if their request times out so this function should be called periodically to keep the request alive.

Normally you don't want to use this function directly, but the abstraction class QDLHeartBeat.

See also QDLHeartBeat.

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