SYNOPSIS

#include <qtooltip.h>

Inherits QObject.

Public Members

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

~QToolTipGroup ()

bool delay () const

bool enabled () const

Public Slots

void setDelay ( bool )

void setEnabled ( bool )

Signals

void showTip ( const QString & longText )

void removeTip ()

Properties

bool delay - whether the display of the group text is delayed

bool enabled - whether tool tips in the group are enabled

DESCRIPTION

The QToolTipGroup class collects tool tips into related groups.

Tool tips can display two texts: one in the tip and (optionally) one that is 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 * grp = new QToolTipGroup( this, "tool tip relay" );


        connect( grp, SIGNAL(showTip(const QString&)),


                 myLabel, SLOT(setText(const QString&)) );


        connect( grp, SIGNAL(removeTip()),


                 myLabel, SLOT(clear()) );


        QToolTip::add( giraffeButton, "feed giraffe",


                       grp, "Give the giraffe a meal" );


        QToolTip::add( gorillaButton, "feed gorilla",


                       grp, "Give the gorilla a meal" );

This example makes the object myLabel (which you must 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.

See also Help System.

MEMBER FUNCTION DOCUMENTATION

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

Constructs a tool tip group called name, with parent parent.

QToolTipGroup::~QToolTipGroup ()

Destroys this tool tip group and all tool tips in it.

bool QToolTipGroup::delay () const

Returns TRUE if the display of the group text is delayed; otherwise returns FALSE. See the "delay" property for details.

bool QToolTipGroup::enabled () const

Returns TRUE if tool tips in the group are enabled; otherwise returns FALSE. See the "enabled" property for details.

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.

See also showTip().

Example: helpsystem/mainwindow.cpp.

void QToolTipGroup::setDelay ( bool ) [slot]

Sets whether the display of the group text is delayed. See the "delay" property for details.

void QToolTipGroup::setEnabled ( bool ) [slot]

Sets whether tool tips in the group are enabled. See the "enabled" property for details.

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 extra text for the displayed tool tip.

See also removeTip().

Example: helpsystem/mainwindow.cpp.

Property Documentation

bool delay

This property holds whether the display of the group text is delayed.

If set to TRUE (the default), the group text is displayed at the same time as the tool tip. Otherwise, the group text is displayed immediately when the cursor enters the widget.

Set this property's value with setDelay() and get this property's value with delay().

bool enabled

This property holds whether tool tips in the group are enabled.

This property's default is TRUE.

Set this property's value with setEnabled() and get this property's value with enabled().

COPYRIGHT

Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com. See the license file included in the distribution for a complete license statement.

AUTHOR

Generated automatically from the source code.