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

# QDLClient Class Reference

The QDLClient class provides a set of links and communication with a data source. More...

`#include <qtopia/qdl.h>`

Inherited by QDLWidgetClient and QDLWidgetClient.

List of all member functions.

## Public Members

- QDLClient ( QObject * parent, const char * name )
- bool isRequestActive () const
- QDLLink link ( uint lid ) const
- QMap<uint, QDLLink> links () const
- uint count () const
- virtual void addLink ( const QDLLink & newLink )
- virtual void setLink ( uint lid, const QDLLink & newLink )
- virtual void removeLink ( uint lid )
- QString hint () const
- void setHint ( const QString & hint )

## Public Slots

- virtual void clear ()
- virtual void verifyLinks ()
- void requestLink ( QWidget * parent )
- void requestLink ( const QString & channel )

## Detailed Description

The QDLClient class provides a set of links and communication with a data source.

A QDLClient contains a set of links and handles communication with a data source.

A single client can have an unlimited number of links. To load and save links to and from a client you can use the utility functions QDL::loadLinks() and QDL::saveLinks() respectively.

This class operates independently of any other object. The subclass QDLWidgetClient extends this class to operate on a widget and its text dependently.

See also QDLWidgetClient and Qtopia Classes.

## Member Function Documentation

### QDLClient::QDLClient ( QObject * parent, const char * name )

Constructs a QDLClient. parent and name are passed on to QObject.

### void QDLClient::addLink ( const QDLLink & newLink )`[virtual]`

Adds newLink to the client. A new link identifier is generated.

Reimplemented in QDLWidgetClient.

### void QDLClient::clear ()`[virtual slot]`

Clears all links in the client.

### uint QDLClient::count () const

Returns the number of links in the client.

### QString QDLClient::hint () const

Returns the request hint for this client.

Subclasses may override this function if they wish to dynamically determine a hint.

See also QDLWidgetClient::hint().

### bool QDLClient::isRequestActive () const

Returns TRUE if a request for links is active, otherwise returns FALSE.

### QDLLink QDLClient::link ( uint lid ) const

Returns the link specified by the link identifier lid. If no such link exists a null link is returned.

### QMap<uint, QDLLink> QDLClient::links () const

Returns a link identifier to QDLLink map of all links in the client.

### void QDLClient::removeLink ( uint lid )`[virtual]`

Removes the link specified by the link identifier lid.

Reimplemented in QDLWidgetClient.

### void QDLClient::requestLink ( const QString & channel )`[slot]`

Sends a request for links to the data source listening on channel.

### void QDLClient::requestLink ( QWidget * parent )`[slot]`

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

Prompts the user to select a data source application, determines source application's channel based on the user's selection, and then passes it to the above function. parent is the parent of the dialog used.

### void QDLClient::setHint ( const QString & hint )

Sets the request hint for the client to hint. A hint is sent to a data source as part of the request to help it determine pertinent data.

A hint can only be used with a QDLClient by calling setHint() explicitly.

See also QDLWidgetClient.

### void QDLClient::setLink ( uint lid, const QDLLink & newLink )`[virtual]`

Sets the link specified by the link identifier lid to newLink. If no link for lid currently exists, it is created.

Reimplemented in QDLWidgetClient.

### void QDLClient::verifyLinks ()`[virtual slot]`

Verifies that all links in the client are valid. The default implementation does nothing, This function is called from QDL::saveLinks().

Subclasses that wish to perform any verification processing should override this function.

Reimplemented in QDLWidgetClient.

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