diff options
Diffstat (limited to 'doc/man/man3/tqtoolbutton.3qt')
| -rw-r--r-- | doc/man/man3/tqtoolbutton.3qt | 102 |
1 files changed, 51 insertions, 51 deletions
diff --git a/doc/man/man3/tqtoolbutton.3qt b/doc/man/man3/tqtoolbutton.3qt index 1b5bb76c0..6b3f8bbf1 100644 --- a/doc/man/man3/tqtoolbutton.3qt +++ b/doc/man/man3/tqtoolbutton.3qt @@ -1,5 +1,5 @@ '\" t -.TH QToolButton 3qt "2 February 2007" "Trolltech AS" \" -*- nroff -*- +.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. @@ -7,9 +7,9 @@ .ad l .nh .SH NAME -QToolButton \- Quick-access button to commands or options, usually used inside a QToolBar +TQToolButton \- Quick-access button to commands or options, usually used inside a TQToolBar .SH SYNOPSIS -\fC#include <ntqtoolbutton.h>\fR +\fC#include <tqtoolbutton.h>\fR .PP Inherits QButton. .PP @@ -19,16 +19,16 @@ Inherits QButton. .BI "enum \fBTextPosition\fR { BesideIcon, BelowIcon, Right = BesideIcon, Under = BelowIcon }" .br .ti -1c -.BI "\fBQToolButton\fR ( TQWidget * parent, const char * name = 0 )" +.BI "\fBTQToolButton\fR ( TQWidget * parent, const char * name = 0 )" .br .ti -1c -.BI "\fBQToolButton\fR ( const TQIconSet & iconSet, const TQString & textLabel, const TQString & grouptext, TQObject * receiver, const char * slot, QToolBar * parent, const char * name = 0 )" +.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 "\fBQToolButton\fR ( ArrowType type, TQWidget * parent, const char * name = 0 )" +.BI "\fBTQToolButton\fR ( ArrowType type, TQWidget * parent, const char * name = 0 )" .br .ti -1c -.BI "\fB~QToolButton\fR ()" +.BI "\fB~TQToolButton\fR ()" .br .ti -1c .BI "virtual void \fBsetIconSet\fR ( const TQIconSet & )" @@ -46,10 +46,10 @@ Inherits QButton. .BI "TQString \fBtextLabel\fR () const" .br .ti -1c -.BI "void \fBsetPopup\fR ( QPopupMenu * popup )" +.BI "void \fBsetPopup\fR ( TQPopupMenu * popup )" .br .ti -1c -.BI "QPopupMenu * \fBpopup\fR () const" +.BI "TQPopupMenu * \fBpopup\fR () const" .br .ti -1c .BI "void \fBsetPopupDelay\fR ( int delay )" @@ -140,66 +140,66 @@ Inherits QButton. .br .in -1c .SH DESCRIPTION -The QToolButton class provides a quick-access button to commands or options, usually used inside a QToolBar. +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 QToolButton as toggle button (see setToggleButton() ). +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 -QToolButton 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 QToolBar. Change it with setAutoRaise(). +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 QToolBar in a QMainWindow, the button automatically adjusts to QMainWindow's settings (see QMainWindow::setUsesTextLabel() and QMainWindow::setUsesBigPixmaps()). The pixmap set on a QToolButton will be set to 22x22 if it is bigger than this size. If usesBigPixmap() is TRUE, then the pixmap will be set to 32x32. +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 QToolButton you can set a popup menu using setPopup(). The default delay is 600ms; you can adjust it with setPopupDelay(). +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> QToolbar with QToolbuttons +</center> TQToolbar with TQToolbuttons .PP -See also QPushButton, QToolBar, QMainWindow, GUI Design Handbook: Push Button, and Basic Widgets. +See also QPushButton, TQToolBar, TQMainWindow, GUI Design Handbook: Push Button, and Basic Widgets. .SS "Member Type Documentation" -.SH "QToolButton::TextPosition" +.SH "TQToolButton::TextPosition" The position of the tool button's textLabel in relation to the tool button's icon. .TP -\fCQToolButton::BesideIcon\fR - The text appears beside the icon. +\fCTQToolButton::BesideIcon\fR - The text appears beside the icon. .TP -\fCQToolButton::BelowIcon\fR - The text appears below the icon. +\fCTQToolButton::BelowIcon\fR - The text appears below the icon. .SH MEMBER FUNCTION DOCUMENTATION -.SH "QToolButton::QToolButton ( TQWidget * parent, const char * name = 0 )" +.SH "TQToolButton::TQToolButton ( TQWidget * parent, const char * name = 0 )" Constructs an empty tool button called \fIname\fR, with parent \fIparent\fR. -.SH "QToolButton::QToolButton ( const TQIconSet & iconSet, const TQString & textLabel, const TQString & grouptext, TQObject * receiver, const char * slot, QToolBar * parent, const char * name = 0 )" -Constructs a tool button called \fIname\fR, that is a child of \fIparent\fR (which must be a QToolBar). +.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 "QToolButton::QToolButton ( ArrowType type, TQWidget * parent, const char * name = 0 )" +.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 "QToolButton::~QToolButton ()" +.SH "TQToolButton::~TQToolButton ()" Destroys the object and frees any allocated resources. -.SH "bool QToolButton::autoRaise () const" +.SH "bool TQToolButton::autoRaise () const" Returns TRUE if auto-raising is enabled; otherwise returns FALSE. See the "autoRaise" property for details. -.SH "TQIconSet QToolButton::iconSet () const" +.SH "TQIconSet TQToolButton::iconSet () const" Returns the icon set providing the icon shown on the button. See the "iconSet" property for details. -.SH "void QToolButton::openPopup ()" +.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 "QPopupMenu * QToolButton::popup () const" +.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 QToolButton::popupDelay () const" +.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 QToolButton::setAutoRaise ( bool enable )" +.SH "void TQToolButton::setAutoRaise ( bool enable )" Sets whether auto-raising is enabled to \fIenable\fR. See the "autoRaise" property for details. -.SH "void QToolButton::setIconSet ( const TQIconSet & )\fC [virtual]\fR" +.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 QToolButton::setOn ( bool enable )\fC [virtual slot]\fR" +.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 QToolButton::setPopup ( QPopupMenu * popup )" +.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. @@ -207,39 +207,39 @@ The popup will be shown each time the tool button has been pressed down for a ce Ownership of the popup menu is not transferred to the tool button. .PP See also popup(). -.SH "void QToolButton::setPopupDelay ( int delay )" +.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 QToolButton::setTextLabel ( const TQString & )\fC [slot]\fR" +.SH "void TQToolButton::setTextLabel ( const TQString & )\fC [slot]\fR" Sets the label of this button. See the "textLabel" property for details. -.SH "void QToolButton::setTextLabel ( const TQString & newLabel, bool tipToo )\fC [virtual slot]\fR" +.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 QToolButton::setTextPosition ( TextPosition pos )\fC [slot]\fR" +.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 QToolButton::setToggleButton ( bool enable )\fC [virtual slot]\fR" +.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 QToolButton::setUsesBigPixmap ( bool enable )\fC [virtual slot]\fR" +.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 QToolButton::setUsesTextLabel ( bool enable )\fC [virtual slot]\fR" +.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 QToolButton::textLabel () const" +.SH "TQString TQToolButton::textLabel () const" Returns the label of this button. See the "textLabel" property for details. -.SH "TextPosition QToolButton::textPosition () const" +.SH "TextPosition TQToolButton::textPosition () const" Returns the position of the text label of this button. See the "textPosition" property for details. -.SH "void QToolButton::toggle ()\fC [slot]\fR" +.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 QToolButton::uses3D () const\fC [protected]\fR" +.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 QToolButton::usesBigPixmap () const" +.SH "bool TQToolButton::usesBigPixmap () const" Returns TRUE if this toolbutton uses big pixmaps; otherwise returns FALSE. See the "usesBigPixmap" property for details. -.SH "bool QToolButton::usesTextLabel () const" +.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" @@ -257,7 +257,7 @@ 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 QToolButton::pixmap to a null pixmap. There is no default iconset. +Setting this property sets TQToolButton::pixmap to a null pixmap. There is no default iconset. .PP See also pixmap, toggleButton, and on. .PP @@ -303,11 +303,11 @@ Set this property's value with setToggleButton(). .SH "bool usesBigPixmap" This property holds whether this toolbutton uses big pixmaps. .PP -QToolButton automatically connects this property to the relevant signal in the QMainWindow in which it resides. We strongly recommend that you use QMainWindow::setUsesBigPixmaps() instead. +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 QMainWindow) to have big pixmaps and others to have small pixmaps, QMainWindow may not get the geometry right. +\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" @@ -315,12 +315,12 @@ This property holds whether the toolbutton displays a text label below the butto .PP The default is FALSE. .PP -QToolButton automatically connects this slot to the relevant signal in the QMainWindow in which is resides. +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/ntqtoolbutton.html +.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 |