path: root/doc/man/man3/tqtoolbutton.3qt

'\" t
.TH TQToolButton 3qt "2 February 2007" "Trolltech AS" \" -*- nroff -*-
.\" Copyright 1992-2007 Trolltech ASA.  All rights reserved.  See the
.\" license file included in the distribution for a complete license
.\" statement.
.\"
.ad l
.nh
.SH NAME
TQToolButton \- Quick-access button to commands or options, usually used inside a TQToolBar
.SH SYNOPSIS
\fC#include <tqtoolbutton.h>\fR
.PP
Inherits QButton.
.PP
.SS "Public Members"
.in +1c
.ti -1c
.BI "enum \fBTextPosition\fR { BesideIcon, BelowIcon, Right = BesideIcon, Under = BelowIcon }"
.br
.ti -1c
.BI "\fBTQToolButton\fR ( TQWidget * parent, const char * name = 0 )"
.br
.ti -1c
.BI "\fBTQToolButton\fR ( const TQIconSet & iconSet, const TQString & textLabel, const TQString & grouptext, TQObject * receiver, const char * slot, TQToolBar * parent, const char * name = 0 )"
.br
.ti -1c
.BI "\fBTQToolButton\fR ( ArrowType type, TQWidget * parent, const char * name = 0 )"
.br
.ti -1c
.BI "\fB~TQToolButton\fR ()"
.br
.ti -1c
.BI "virtual void \fBsetIconSet\fR ( const TQIconSet & )"
.br
.ti -1c
.BI "TQIconSet \fBiconSet\fR () const"
.br
.ti -1c
.BI "bool \fBusesBigPixmap\fR () const"
.br
.ti -1c
.BI "bool \fBusesTextLabel\fR () const"
.br
.ti -1c
.BI "TQString \fBtextLabel\fR () const"
.br
.ti -1c
.BI "void \fBsetPopup\fR ( TQPopupMenu * popup )"
.br
.ti -1c
.BI "TQPopupMenu * \fBpopup\fR () const"
.br
.ti -1c
.BI "void \fBsetPopupDelay\fR ( int delay )"
.br
.ti -1c
.BI "int \fBpopupDelay\fR () const"
.br
.ti -1c
.BI "void \fBopenPopup\fR ()"
.br
.ti -1c
.BI "void \fBsetAutoRaise\fR ( bool enable )"
.br
.ti -1c
.BI "bool \fBautoRaise\fR () const"
.br
.ti -1c
.BI "TextPosition \fBtextPosition\fR () const"
.br
.in -1c
.SS "Public Slots"
.in +1c
.ti -1c
.BI "virtual void \fBsetUsesBigPixmap\fR ( bool enable )"
.br
.ti -1c
.BI "virtual void \fBsetUsesTextLabel\fR ( bool enable )"
.br
.ti -1c
.BI "virtual void \fBsetTextLabel\fR ( const TQString & newLabel, bool tipToo )"
.br
.ti -1c
.BI "virtual void \fBsetToggleButton\fR ( bool enable )"
.br
.ti -1c
.BI "virtual void \fBsetOn\fR ( bool enable )"
.br
.ti -1c
.BI "void \fBtoggle\fR ()"
.br
.ti -1c
.BI "void \fBsetTextLabel\fR ( const TQString & )"
.br
.ti -1c
.BI "void \fBsetTextPosition\fR ( TextPosition pos )"
.br
.in -1c
.SS "Properties"
.in +1c
.ti -1c
.BI "bool \fBautoRaise\fR - whether auto-raising is enabled"
.br
.ti -1c
.BI "BackgroundMode \fBbackgroundMode\fR - the toolbutton's background mode  \fI(read " "only" ")\fR"
.br
.ti -1c
.BI "TQIconSet \fBiconSet\fR - the icon set providing the icon shown on the button"
.br
.ti -1c
.BI "bool \fBon\fR - whether this tool button is on"
.br
.ti -1c
.BI "TQPixmap \fBpixmap\fR - the pixmap of the button  \fI(read " "only" ")\fR"
.br
.ti -1c
.BI "int \fBpopupDelay\fR - the time delay between pressing the button and the appearance of the associated popup menu in milliseconds"
.br
.ti -1c
.BI "TQString \fBtextLabel\fR - the label of this button"
.br
.ti -1c
.BI "TextPosition \fBtextPosition\fR - the position of the text label of this button"
.br
.ti -1c
.BI "bool \fBtoggleButton\fR - whether this tool button is a toggle button"
.br
.ti -1c
.BI "bool \fBusesBigPixmap\fR - whether this toolbutton uses big pixmaps"
.br
.ti -1c
.BI "bool \fBusesTextLabel\fR - whether the toolbutton displays a text label below the button pixmap"
.br
.in -1c
.SS "Protected Members"
.in +1c
.ti -1c
.BI "bool \fBuses3D\fR () const"
.br
.in -1c
.SH DESCRIPTION
The TQToolButton class provides a quick-access button to commands or options, usually used inside a TQToolBar.
.PP
A tool button is a special button that provides quick-access to specific commands or options. As opposed to a normal command button, a tool button usually doesn't show a text label, but shows an icon instead. Its classic usage is to select tools, for example the "pen" tool in a drawing program. This would be implemented with a TQToolButton as toggle button (see setToggleButton() ).
.PP
TQToolButton supports auto-raising. In auto-raise mode, the button draws a 3D frame only when the mouse points at it. The feature is automatically turned on when a button is used inside a TQToolBar. Change it with setAutoRaise().
.PP
A tool button's icon is set as TQIconSet. This makes it possible to specify different pixmaps for the disabled and active state. The disabled pixmap is used when the button's functionality is not available. The active pixmap is displayed when the button is auto-raised because the mouse pointer is hovering over it.
.PP
The button's look and dimension is adjustable with setUsesBigPixmap() and setUsesTextLabel(). When used inside a TQToolBar in a TQMainWindow, the button automatically adjusts to TQMainWindow's settings (see TQMainWindow::setUsesTextLabel() and TQMainWindow::setUsesBigPixmaps()). The pixmap set on a TQToolButton will be set to 22x22 if it is bigger than this size. If usesBigPixmap() is TRUE, then the pixmap will be set to 32x32.
.PP
A tool button can offer additional choices in a popup menu. The feature is sometimes used with the "Back" button in a web browser. After pressing and holding the button down for a while, a menu pops up showing a list of possible pages to jump to. With TQToolButton you can set a popup menu using setPopup(). The default delay is 600ms; you can adjust it with setPopupDelay().
.PP
<center>
.ce 1
.B "[Image Omitted]"
.PP
</center> TQToolbar with TQToolbuttons
.PP
See also QPushButton, TQToolBar, TQMainWindow, GUI Design Handbook: Push Button, and Basic Widgets.
.SS "Member Type Documentation"
.SH "TQToolButton::TextPosition"
The position of the tool button's textLabel in relation to the tool button's icon.
.TP
\fCTQToolButton::BesideIcon\fR - The text appears beside the icon.
.TP
\fCTQToolButton::BelowIcon\fR - The text appears below the icon.
.SH MEMBER FUNCTION DOCUMENTATION
.SH "TQToolButton::TQToolButton ( TQWidget * parent, const char * name = 0 )"
Constructs an empty tool button called \fIname\fR, with parent \fIparent\fR.
.SH "TQToolButton::TQToolButton ( const TQIconSet & iconSet, const TQString & textLabel, const TQString & grouptext, TQObject * receiver, const char * slot, TQToolBar * parent, const char * name = 0 )"
Constructs a tool button called \fIname\fR, that is a child of \fIparent\fR (which must be a TQToolBar).
.PP
The tool button will display \fIiconSet\fR, with its text label and tool tip set to \fItextLabel\fR and its status bar message set to \fIgrouptext\fR. It will be connected to the \fIslot\fR in object \fIreceiver\fR.
.SH "TQToolButton::TQToolButton ( ArrowType type, TQWidget * parent, const char * name = 0 )"
Constructs a tool button as an arrow button. The ArrowType \fItype\fR defines the arrow direction. Possible values are LeftArrow, RightArrow, UpArrow and DownArrow.
.PP
An arrow button has auto-repeat turned on by default.
.PP
The \fIparent\fR and \fIname\fR arguments are sent to the TQWidget constructor.
.SH "TQToolButton::~TQToolButton ()"
Destroys the object and frees any allocated resources.
.SH "bool TQToolButton::autoRaise () const"
Returns TRUE if auto-raising is enabled; otherwise returns FALSE. See the "autoRaise" property for details.
.SH "TQIconSet TQToolButton::iconSet () const"
Returns the icon set providing the icon shown on the button. See the "iconSet" property for details.
.SH "void TQToolButton::openPopup ()"
Opens (pops up) the associated popup menu. If there is no such menu, this function does nothing. This function does not return until the popup menu has been closed by the user.
.SH "TQPopupMenu * TQToolButton::popup () const"
Returns the associated popup menu, or 0 if no popup menu has been defined.
.PP
See also setPopup().
.SH "int TQToolButton::popupDelay () const"
Returns the time delay between pressing the button and the appearance of the associated popup menu in milliseconds. See the "popupDelay" property for details.
.SH "void TQToolButton::setAutoRaise ( bool enable )"
Sets whether auto-raising is enabled to \fIenable\fR. See the "autoRaise" property for details.
.SH "void TQToolButton::setIconSet ( const TQIconSet & )\fC [virtual]\fR"
Sets the icon set providing the icon shown on the button. See the "iconSet" property for details.
.SH "void TQToolButton::setOn ( bool enable )\fC [virtual slot]\fR"
Sets whether this tool button is on to \fIenable\fR. See the "on" property for details.
.SH "void TQToolButton::setPopup ( TQPopupMenu * popup )"
Associates the popup menu \fIpopup\fR with this tool button.
.PP
The popup will be shown each time the tool button has been pressed down for a certain amount of time. A typical application example is the "back" button in some web browsers's tool bars. If the user clicks it, the browser simply browses back to the previous page. If the user presses and holds the button down for a while, the tool button shows a menu containing the current history list.
.PP
Ownership of the popup menu is not transferred to the tool button.
.PP
See also popup().
.SH "void TQToolButton::setPopupDelay ( int delay )"
Sets the time delay between pressing the button and the appearance of the associated popup menu in milliseconds to \fIdelay\fR. See the "popupDelay" property for details.
.SH "void TQToolButton::setTextLabel ( const TQString & )\fC [slot]\fR"
Sets the label of this button. See the "textLabel" property for details.
.SH "void TQToolButton::setTextLabel ( const TQString & newLabel, bool tipToo )\fC [virtual slot]\fR"
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
.PP
Sets the label of this button to \fInewLabel\fR and automatically sets it as a tool tip if \fItipToo\fR is TRUE.
.SH "void TQToolButton::setTextPosition ( TextPosition pos )\fC [slot]\fR"
Sets the position of the text label of this button to \fIpos\fR. See the "textPosition" property for details.
.SH "void TQToolButton::setToggleButton ( bool enable )\fC [virtual slot]\fR"
Sets whether this tool button is a toggle button to \fIenable\fR. See the "toggleButton" property for details.
.SH "void TQToolButton::setUsesBigPixmap ( bool enable )\fC [virtual slot]\fR"
Sets whether this toolbutton uses big pixmaps to \fIenable\fR. See the "usesBigPixmap" property for details.
.SH "void TQToolButton::setUsesTextLabel ( bool enable )\fC [virtual slot]\fR"
Sets whether the toolbutton displays a text label below the button pixmap to \fIenable\fR. See the "usesTextLabel" property for details.
.SH "TQString TQToolButton::textLabel () const"
Returns the label of this button. See the "textLabel" property for details.
.SH "TextPosition TQToolButton::textPosition () const"
Returns the position of the text label of this button. See the "textPosition" property for details.
.SH "void TQToolButton::toggle ()\fC [slot]\fR"
Toggles the state of this tool button.
.PP
This function has no effect on non-toggling buttons.
.PP
See also toggleButton and toggled().
.SH "bool TQToolButton::uses3D () const\fC [protected]\fR"
Returns TRUE if this button should be drawn using raised edges; otherwise returns FALSE.
.PP
See also drawButton().
.SH "bool TQToolButton::usesBigPixmap () const"
Returns TRUE if this toolbutton uses big pixmaps; otherwise returns FALSE. See the "usesBigPixmap" property for details.
.SH "bool TQToolButton::usesTextLabel () const"
Returns TRUE if the toolbutton displays a text label below the button pixmap; otherwise returns FALSE. See the "usesTextLabel" property for details.
.SS "Property Documentation"
.SH "bool autoRaise"
This property holds whether auto-raising is enabled.
.PP
The default is disabled (i.e. FALSE).
.PP
Set this property's value with setAutoRaise() and get this property's value with autoRaise().
.SH "BackgroundMode backgroundMode"
This property holds the toolbutton's background mode.
.PP
Get this property with backgroundMode().
.PP
See also TQWidget::backgroundMode.
.SH "TQIconSet iconSet"
This property holds the icon set providing the icon shown on the button.
.PP
Setting this property sets TQToolButton::pixmap to a null pixmap. There is no default iconset.
.PP
See also pixmap, toggleButton, and on.
.PP
Set this property's value with setIconSet() and get this property's value with iconSet().
.SH "bool on"
This property holds whether this tool button is on.
.PP
This property has no effect on non-toggling buttons. The default is FALSE (i.e. off).
.PP
See also toggleButton and toggle().
.PP
Set this property's value with setOn().
.SH "TQPixmap pixmap"
This property holds the pixmap of the button.
.PP
The pixmap property has no meaning for tool buttons. Use the iconSet property instead.
.SH "int popupDelay"
This property holds the time delay between pressing the button and the appearance of the associated popup menu in milliseconds.
.PP
Usually this is around half a second. A value of 0 draws the down arrow button to the side of the button which can be used to open up the popup menu.
.PP
See also setPopup().
.PP
Set this property's value with setPopupDelay() and get this property's value with popupDelay().
.SH "TQString textLabel"
This property holds the label of this button.
.PP
Setting this property automatically sets the text as a tool tip too. There is no default text.
.PP
Set this property's value with setTextLabel() and get this property's value with textLabel().
.SH "TextPosition textPosition"
This property holds the position of the text label of this button.
.PP
Set this property's value with setTextPosition() and get this property's value with textPosition().
.SH "bool toggleButton"
This property holds whether this tool button is a toggle button.
.PP
Toggle buttons have an on/off state similar to check boxes. A tool button is not a toggle button by default.
.PP
See also on and toggle().
.PP
Set this property's value with setToggleButton().
.SH "bool usesBigPixmap"
This property holds whether this toolbutton uses big pixmaps.
.PP
TQToolButton automatically connects this property to the relevant signal in the TQMainWindow in which it resides. We strongly recommend that you use TQMainWindow::setUsesBigPixmaps() instead.
.PP
This property's default is TRUE.
.PP
\fBWarning:\fR If you set some buttons (in a TQMainWindow) to have big pixmaps and others to have small pixmaps, TQMainWindow may not get the geometry right.
.PP
Set this property's value with setUsesBigPixmap() and get this property's value with usesBigPixmap().
.SH "bool usesTextLabel"
This property holds whether the toolbutton displays a text label below the button pixmap.
.PP
The default is FALSE.
.PP
TQToolButton automatically connects this slot to the relevant signal in the TQMainWindow in which is resides.
.PP
Set this property's value with setUsesTextLabel() and get this property's value with usesTextLabel().

.SH "SEE ALSO"
.BR http://doc.trolltech.com/tqtoolbutton.html
.BR http://www.trolltech.com/faq/tech.html
.SH COPYRIGHT
Copyright 1992-2007 Trolltech ASA, 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 help us to help you. Thank you.
.P
The definitive TQt documentation is provided in HTML format; it is
located at $TQTDIR/doc/html and can be read using TQt Assistant or with
a web browser. This man page is provided as a convenience for those
users who prefer man pages, although this format is not officially
supported by Trolltech. 
.P
If you find errors in this manual page, please report them to
.BR qt-bugs@trolltech.com .
Please include the name of the manual page (tqtoolbutton.3qt) and the Qt
version (3.3.8).