qtooltipgroup.3qt

Trolltech公司发布的基于C++图形开发环境

'\" t
.TH QToolTipGroup 3qt "24 January 2005" "Trolltech AS" \" -*- nroff -*-
.\" Copyright 1992-2001 Trolltech AS.  All rights reserved.  See the
.\" license file included in the distribution for a complete license
.\" statement.
.\"
.ad l
.nh
.SH NAME
QToolTipGroup \- Collects tool tips into natural groups
.br
.PP
\fC#include <qtooltip.h>\fR
.PP
Inherits QObject.
.PP
.SS "Public Members"
.in +1c
.ti -1c
.BI "\fBQToolTipGroup\fR ( QObject * " "parent" ", const char * " "name" " = 0 ) "
.br
.ti -1c
.BI "\fB~QToolTipGroup\fR () "
.br
.ti -1c
.BI "bool \fBdelay\fR () const"
.br
.ti -1c
.BI "bool \fBenabled\fR () const"
.br
.in -1c
.SS "Public Slots"
.in +1c
.ti -1c
.BI "void \fBsetDelay\fR ( bool ) "
.br
.ti -1c
.BI "void \fBsetEnabled\fR ( bool ) "
.br
.in -1c
.SS "Signals"
.in +1c
.ti -1c
.BI "void \fBshowTip\fR ( const QString & ) "
.br
.ti -1c
.BI "void \fBremoveTip\fR () "
.br
.in -1c
.SS "Properties"
.nf
.TS
l l l l l
- - - - -
l l l l l.
Type	Name	READ	WRITE	Options
bool	delay	delay	setDelay
bool	enabled	enabled	setEnabled
.TE
.fi

.SH DESCRIPTION
The QToolTipGroup class collects tool tips into natural groups.
.PP
Tool tips can display \fItwo\fR 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.
.PP
QToolTipGroup has practically no API, it is only used as an argument to QToolTip's member functions, for example like this:
.PP
.nf
.br
    QToolTipGroup * g = new QToolTipGroup( this, "tool tip relay" );
.br
    connect( g, SIGNAL(showTip(const QString&)),
.br
             myLabel, SLOT(setText(const QString&)) );
.br
    connect( g, SIGNAL(removeTip()),
.br
             myLabel, SLOT(clear()) );
.br
    QToolTip::add( giraffeButton, "feed giraffe",
.br
                   g, "Give the giraffe a meal" );
.br
    QToolTip::add( gorillaButton, "feed gorilla",
.br
                   g, "Give the gorilla a meal" );
.fi
.PP
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.
.PP
Deleting a tool tip group removes the tool tips in it.
.SH MEMBER FUNCTION DOCUMENTATION
.SH "QToolTipGroup::QToolTipGroup ( QObject * parent, const char * name = 0 )"
Constructs a tool tip group.
.SH "QToolTipGroup::~QToolTipGroup ()"
Destroy this tool tip groups and all tool tips in it.
.SH "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.
.PP
See also setDelay().
.SH "bool QToolTipGroup::enabled () const"
Returns whether tooltips in the group are enabled.
.PP
See also setEnabled().
.SH "void QToolTipGroup::removeTip () \fC[signal]\fR"
This signal is emitted when a tool tip in this group is hidden. See the QToolTipGroup documentation for an example of use.
.PP
See also showTip().
.SH "void QToolTipGroup::setDelay ( bool enable ) \fC[slot]\fR"
Sets the group to show its text immediately if \fIenable\fR is FALSE, and delayed (at the same time as the tip text) if \fIenable\fR is TRUE. The default is TRUE.
.PP
See also delay().
.SH "void QToolTipGroup::setEnabled ( bool enable ) \fC[slot]\fR"
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).
.PP
See also QToolTip::setEnabled() and enabled().
.SH "void QToolTipGroup::showTip ( const QString & longText ) \fC[signal]\fR"
This signal is emitted when one of the tool tips in the group is displayed. \fIlongText\fR is the supplementary text for the displayed tool tip.
.PP
See also  removeTip().
.SH "SEE ALSO"
.BR http://doc.trolltech.com/qtooltipgroup.html
.BR http://www.trolltech.com/faq/tech.html
.SH COPYRIGHT
Copyright 1992-2001 Trolltech AS, http://www.trolltech.com.  See the
license file included in the distribution for a complete license
statement.
.SH AUTHOR
Generated automatically from the source code.
.SH BUGS
If you find a bug in Qt, please report it as described in
.BR http://doc.trolltech.com/bughowto.html .
Good bug reports make our job much simpler. Thank you.
.P
In case of content or formattting problems with this manual page, please
report them to
.BR [e-mail] .
Please include the name of the manual page (qtooltipgroup.3qt) and the Qt
version (2.3.10).