Home · All Classes · Annotated · Functions

QDLClient Class Reference

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

#include <QDLClient>

Inherits QObject.

Inherited by QDLWidgetClient.

• List of all members, including inherited members

Public Functions

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

• 36 public functions inherited from QObject

Public Slots

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

• 1 public slot inherited from QObject

Additional Inherited Members

• 1 property inherited from QObject
• 1 signal inherited from QObject
• 4 static public members inherited from QObject
• 8 protected functions inherited from QObject
• 2 protected variables inherited from QObject
• 1 static protected member inherited from QObject

Detailed Description

The QDLClient class provides a set of links and communications 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 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.

Member Function Documentation

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

Constructs a QDLClient. parent is passed on to QObject and name is the name specified for the QDL client.

QDLClient::~QDLClient ()

Destroys a QDLClient.

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

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

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 setHint() and 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.

See also setLink().

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.

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.

Prompts the user to select a data source application and determines the source application channel based on the user selection and 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 hint() and 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.

See also link().

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.