Qtopia Home - Classes - Hierachy - Annotated - Functions - Licenses - Reference

QToolTipGroup Class Reference

The QToolTipGroup class collects tool tips into natural groups. More...

#include <qtooltip.h>

Inherits QObject.

List of all member functions.

Public Members

QToolTipGroup ( QObject * parent, const char * name = 0 )
~QToolTipGroup ()
bool delay () const
bool enabled () const

Public Slots

void setDelay ( bool enable )
void setEnabled ( bool enable )

Signals

void showTip ( const QString & longText )
void removeTip ()

Properties

bool delay
bool enabled

Detailed Description

The QToolTipGroup class collects tool tips into natural groups.

Tool tips can display two texts, the one in the tip and optionally another one, typically in a status bar. QToolTipGroup provides a way to link tool tips to this status bar.

QToolTipGroup has practically no API, it is only used as an argument to QToolTip's member functions, for example like this:

    QToolTipGroup * g = new QToolTipGroup( this, "tool tip relay" );
    connect( g, SIGNAL(showTip(const QString&)),
             myLabel, SLOT(setText(const QString&)) );
    connect( g, SIGNAL(removeTip()),
             myLabel, SLOT(clear()) );
    QToolTip::add( giraffeButton, "feed giraffe",
                   g, "Give the giraffe a meal" );
    QToolTip::add( gorillaButton, "feed gorilla",
                   g, "Give the gorilla a meal" );

This example makes the object myLabel (which you have to supply) display (one assumes, though you can make myLabel do anything, of course) the strings "Give the giraffe a meal" and "Give the gorilla a meal" while the relevant tool tips are being displayed.

Deleting a tool tip group removes the tool tips in it.

Member Function Documentation

QToolTipGroup::QToolTipGroup ( QObject * parent, const char * name = 0 )

Constructs a tool tip group.

QToolTipGroup::~QToolTipGroup ()

Destroy this tool tip groups and all tool tips in it.

bool QToolTipGroup::delay () const

Returns TRUE if the group text is shown delayed (at the same time as the tip) and FALSE if it is shown immediately.

bool QToolTipGroup::enabled () const

Returns whether tooltips in the group are enabled.

void QToolTipGroup::removeTip () `[signal]`

This signal is emitted when a tool tip in this group is hidden. See the QToolTipGroup documentation for an example of use.

void QToolTipGroup::setDelay ( bool enable ) `[slot]`

Sets the group to show its text immediately if enable is FALSE, and delayed (at the same time as the tip text) if enable is TRUE. The default is TRUE.

void QToolTipGroup::setEnabled ( bool enable ) `[slot]`

Sets the group to be enabled (all tool tips in the group show when activated), or disabled (tool tips in the group are never shown).

See also QToolTip::setEnabled() and enabled().

void QToolTipGroup::showTip ( const QString & longText ) `[signal]`

This signal is emitted when one of the tool tips in the group is displayed. longText is the supplementary text for the displayed tool tip.