1QToolTipGroup(3qt)                                          QToolTipGroup(3qt)
2
3
4

NAME

6       QToolTipGroup - Collects tool tips into related groups
7

SYNOPSIS

9       #include <qtooltip.h>
10
11       Inherits QObject.
12
13   Public Members
14       QToolTipGroup ( QObject * parent, const char * name = 0 )
15       ~QToolTipGroup ()
16       bool delay () const
17       bool enabled () const
18
19   Public Slots
20       void setDelay ( bool )
21       void setEnabled ( bool )
22
23   Signals
24       void showTip ( const QString & longText )
25       void removeTip ()
26
27   Properties
28       bool delay - whether the display of the group text is delayed
29       bool enabled - whether tool tips in the group are enabled
30

DESCRIPTION

32       The QToolTipGroup class collects tool tips into related groups.
33
34       Tool tips can display two texts: one in the tip and (optionally) one
35       that is typically in a status bar. QToolTipGroup provides a way to link
36       tool tips to this status bar.
37
38       QToolTipGroup has practically no API; it is only used as an argument to
39       QToolTip's member functions, for example like this:
40
41               QToolTipGroup * grp = new QToolTipGroup( this, "tool tip relay" );
42               connect( grp, SIGNAL(showTip(const QString&)),
43                        myLabel, SLOT(setText(const QString&)) );
44               connect( grp, SIGNAL(removeTip()),
45                        myLabel, SLOT(clear()) );
46               QToolTip::add( giraffeButton, "feed giraffe",
47                              grp, "Give the giraffe a meal" );
48               QToolTip::add( gorillaButton, "feed gorilla",
49                              grp, "Give the gorilla a meal" );
50
51       This example makes the object myLabel (which you must supply) display
52       (one assumes, though you can make myLabel do anything, of course) the
53       strings "Give the giraffe a meal" and "Give the gorilla a meal" while
54       the relevant tool tips are being displayed.
55
56       Deleting a tool tip group removes the tool tips in it.
57
58       See also Help System.
59

MEMBER FUNCTION DOCUMENTATION

QToolTipGroup::QToolTipGroup ( QObject * parent, const char * name = 0 )
62       Constructs a tool tip group called name, with parent parent.
63

QToolTipGroup::~QToolTipGroup ()
65       Destroys this tool tip group and all tool tips in it.
66

bool QToolTipGroup::delay () const
68       Returns TRUE if the display of the group text is delayed; otherwise
69       returns FALSE. See the "delay" property for details.
70

bool QToolTipGroup::enabled () const
72       Returns TRUE if tool tips in the group are enabled; otherwise returns
73       FALSE. See the "enabled" property for details.
74

void QToolTipGroup::removeTip () [signal]
76       This signal is emitted when a tool tip in this group is hidden. See the
77       QToolTipGroup documentation for an example of use.
78
79       See also showTip().
80
81       Example: helpsystem/mainwindow.cpp.
82

void QToolTipGroup::setDelay ( bool ) [slot]
84       Sets whether the display of the group text is delayed. See the "delay"
85       property for details.
86

void QToolTipGroup::setEnabled ( bool ) [slot]
88       Sets whether tool tips in the group are enabled. See the "enabled"
89       property for details.
90

void QToolTipGroup::showTip ( const QString & longText ) [signal]
92       This signal is emitted when one of the tool tips in the group is
93       displayed. longText is the extra text for the displayed tool tip.
94
95       See also removeTip().
96
97       Example: helpsystem/mainwindow.cpp.
98
99   Property Documentation

bool delay
101       This property holds whether the display of the group text is delayed.
102
103       If set to TRUE (the default), the group text is displayed at the same
104       time as the tool tip. Otherwise, the group text is displayed
105       immediately when the cursor enters the widget.
106
107       Set this property's value with setDelay() and get this property's value
108       with delay().
109

bool enabled
111       This property holds whether tool tips in the group are enabled.
112
113       This property's default is TRUE.
114
115       Set this property's value with setEnabled() and get this property's
116       value with enabled().
117
118

SEE ALSO
120       http://doc.trolltech.com/qtooltipgroup.html
121       http://www.trolltech.com/faq/tech.html
122

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

AUTHOR
129       Generated automatically from the source code.
130

BUGS
132       If you find a bug in Qt, please report it as described in
133       http://doc.trolltech.com/bughowto.html.  Good bug reports help us to
134       help you. Thank you.
135
136       The definitive Qt documentation is provided in HTML format; it is
137       located at $QTDIR/doc/html and can be read using Qt Assistant or with a
138       web browser. This man page is provided as a convenience for those users
139       who prefer man pages, although this format is not officially supported
140       by Trolltech.
141
142       If you find errors in this manual page, please report them to qt-
143       bugs@trolltech.com.  Please include the name of the manual page
144       (qtooltipgroup.3qt) and the Qt version (3.3.8).
145
146
147
148Trolltech AS                    2 February 2007             QToolTipGroup(3qt)



        

    


            
        

        

            Impressum