diff options
Diffstat (limited to 'doc/man/man3/tqtabwidget.3qt')
| -rw-r--r-- | doc/man/man3/tqtabwidget.3qt | 142 |
1 files changed, 71 insertions, 71 deletions
diff --git a/doc/man/man3/tqtabwidget.3qt b/doc/man/man3/tqtabwidget.3qt index 85cf45a9..4abdbd8a 100644 --- a/doc/man/man3/tqtabwidget.3qt +++ b/doc/man/man3/tqtabwidget.3qt @@ -1,5 +1,5 @@ '\" t -.TH QTabWidget 3qt "2 February 2007" "Trolltech AS" \" -*- nroff -*- +.TH TQTabWidget 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,16 +7,16 @@ .ad l .nh .SH NAME -QTabWidget \- Stack of tabbed widgets +TQTabWidget \- Stack of tabbed widgets .SH SYNOPSIS -\fC#include <ntqtabwidget.h>\fR +\fC#include <tqtabwidget.h>\fR .PP Inherits TQWidget. .PP .SS "Public Members" .in +1c .ti -1c -.BI "\fBQTabWidget\fR ( TQWidget * parent = 0, const char * name = 0, WFlags f = 0 )" +.BI "\fBTQTabWidget\fR ( TQWidget * parent = 0, const char * name = 0, WFlags f = 0 )" .br .ti -1c .BI "virtual void \fBaddTab\fR ( TQWidget * child, const TQString & label )" @@ -25,7 +25,7 @@ Inherits TQWidget. .BI "virtual void \fBaddTab\fR ( TQWidget * child, const TQIconSet & iconset, const TQString & label )" .br .ti -1c -.BI "virtual void \fBaddTab\fR ( TQWidget * child, QTab * tab )" +.BI "virtual void \fBaddTab\fR ( TQWidget * child, TQTab * tab )" .br .ti -1c .BI "virtual void \fBinsertTab\fR ( TQWidget * child, const TQString & label, int index = -1 )" @@ -34,7 +34,7 @@ Inherits TQWidget. .BI "virtual void \fBinsertTab\fR ( TQWidget * child, const TQIconSet & iconset, const TQString & label, int index = -1 )" .br .ti -1c -.BI "virtual void \fBinsertTab\fR ( TQWidget * child, QTab * tab, int index = -1 )" +.BI "virtual void \fBinsertTab\fR ( TQWidget * child, TQTab * tab, int index = -1 )" .br .ti -1c .BI "void \fBchangeTab\fR ( TQWidget * w, const TQString & label )" @@ -160,20 +160,20 @@ Inherits TQWidget. .SS "Protected Members" .in +1c .ti -1c -.BI "void \fBsetTabBar\fR ( QTabBar * tb )" +.BI "void \fBsetTabBar\fR ( TQTabBar * tb )" .br .ti -1c -.BI "QTabBar * \fBtabBar\fR () const" +.BI "TQTabBar * \fBtabBar\fR () const" .br .in -1c .SH DESCRIPTION -The QTabWidget class provides a stack of tabbed widgets. +The TQTabWidget class provides a stack of tabbed widgets. .PP A tab widget provides a tab bar of tabs and a `page area' below (or above, see TabPosition) the tabs. Each tab is associated with a different widget (called a `page'). Only the current tab's page is shown in the page area; all the other tabs' pages are hidden. The user can show a different page by clicking on its tab or by pressing its Alt+\fIletter\fR accelerator if it has one. .PP -The normal way to use QTabWidget is to do the following in the constructor: <ol type=1> +The normal way to use TQTabWidget is to do the following in the constructor: <ol type=1> .IP 1 -Create a QTabWidget. +Create a TQTabWidget. .IP 2 Create a TQWidget for each of the pages in the tab dialog, insert children into it, set up geometry management for it and use addTab() (or insertTab()) to set up a tab and keyboard accelerator for it. .IP 3 @@ -181,7 +181,7 @@ Connect to the signals and slots. .PP The position of the tabs is set with setTabPosition(), their shape with setTabShape(), and their margin with setMargin(). .PP -If you don't call addTab() and the QTabWidget is already visible, then the page you have created will not be visible. Don't confuse the object name you supply to the TQWidget constructor and the tab label you supply to addTab(). addTab() takes a name which indicates an accelerator and is meaningful and descriptive to the user, whereas the widget name is used primarily for debugging. +If you don't call addTab() and the TQTabWidget is already visible, then the page you have created will not be visible. Don't confuse the object name you supply to the TQWidget constructor and the tab label you supply to addTab(). addTab() takes a name which indicates an accelerator and is meaningful and descriptive to the user, whereas the widget name is used primarily for debugging. .PP The signal currentChanged() is emitted when the user selects a page. .PP @@ -191,9 +191,9 @@ You can change a tab's label and iconset using changeTab() or setTabLabel() and .PP Each tab is either enabled or disabled at any given time (see setTabEnabled()). If a tab is enabled, the tab text is drawn normally and the user can select that tab. If it is disabled, the tab is drawn in a different way and the user cannot select that tab. Note that even if a tab is disabled, the page can still be visible, for example if all of the tabs happen to be disabled. .PP -Although tab widgets can be a very good way to split up a complex dialog, it's also very easy to get into a mess. See QTabDialog for some design hints. An alternative is to use a TQWidgetStack for which you provide some means of navigating between pages, for example, a TQToolBar or a QListBox. +Although tab widgets can be a very good way to split up a complex dialog, it's also very easy to get into a mess. See TQTabDialog for some design hints. An alternative is to use a TQWidgetStack for which you provide some means of navigating between pages, for example, a TQToolBar or a TQListBox. .PP -Most of the functionality in QTabWidget is provided by a QTabBar (at the top, providing the tabs) and a TQWidgetStack (most of the area, organizing the individual pages). +Most of the functionality in TQTabWidget is provided by a TQTabBar (at the top, providing the tabs) and a TQWidgetStack (most of the area, organizing the individual pages). .PP .ce 1 .B "[Image Omitted]" @@ -202,24 +202,24 @@ Most of the functionality in QTabWidget is provided by a QTabBar (at the top, pr .ce 1 .B "[Image Omitted]" .PP -See also QTabDialog, TQToolBox, Advanced Widgets, and Organizers. +See also TQTabDialog, TQToolBox, Advanced Widgets, and Organizers. .SS "Member Type Documentation" -.SH "QTabWidget::TabPosition" -This enum type defines where QTabWidget draws the tab row: +.SH "TQTabWidget::TabPosition" +This enum type defines where TQTabWidget draws the tab row: .TP -\fCQTabWidget::Top\fR - above the pages +\fCTQTabWidget::Top\fR - above the pages .TP -\fCQTabWidget::Bottom\fR - below the pages -.SH "QTabWidget::TabShape" +\fCTQTabWidget::Bottom\fR - below the pages +.SH "TQTabWidget::TabShape" This enum type defines the shape of the tabs: .TP -\fCQTabWidget::Rounded\fR - rounded look (normal) +\fCTQTabWidget::Rounded\fR - rounded look (normal) .TP -\fCQTabWidget::Triangular\fR - triangular look (very unusual, included for completeness) +\fCTQTabWidget::Triangular\fR - triangular look (very unusual, included for completeness) .SH MEMBER FUNCTION DOCUMENTATION -.SH "QTabWidget::QTabWidget ( TQWidget * parent = 0, const char * name = 0, WFlags f = 0 )" +.SH "TQTabWidget::TQTabWidget ( TQWidget * parent = 0, const char * name = 0, WFlags f = 0 )" Constructs a tabbed widget called \fIname\fR with parent \fIparent\fR, and widget flags \fIf\fR. -.SH "void QTabWidget::addTab ( TQWidget * child, const TQString & label )\fC [virtual]\fR" +.SH "void TQTabWidget::addTab ( TQWidget * child, const TQString & label )\fC [virtual]\fR" Adds another tab and page to the tab view. .PP The new page is \fIchild\fR; the tab's label is \fIlabel\fR. Note the difference between the widget name (which you supply to widget constructors and to setTabEnabled(), for example) and the tab label. The name is internal to the program and invariant, whereas the label is shown on-screen and may vary according to language and other factors. @@ -234,37 +234,37 @@ See also insertTab(). .PP Examples: .)l addressbook/centralwidget.cpp and themes/themes.cpp. -.SH "void QTabWidget::addTab ( TQWidget * child, const TQIconSet & iconset, const TQString & label )\fC [virtual]\fR" +.SH "void TQTabWidget::addTab ( TQWidget * child, const TQIconSet & iconset, const TQString & label )\fC [virtual]\fR" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Adds another tab and page to the tab view. .PP This function is the same as addTab(), but with an additional \fIiconset\fR. -.SH "void QTabWidget::addTab ( TQWidget * child, QTab * tab )\fC [virtual]\fR" +.SH "void TQTabWidget::addTab ( TQWidget * child, TQTab * tab )\fC [virtual]\fR" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP -This is a low-level function for adding tabs. It is useful if you are using setTabBar() to set a QTabBar subclass with an overridden QTabBar::paint() function for a subclass of QTab. The \fIchild\fR is the new page and \fItab\fR is the tab to put the \fIchild\fR on. -.SH "void QTabWidget::changeTab ( TQWidget * w, const TQString & label )" +This is a low-level function for adding tabs. It is useful if you are using setTabBar() to set a TQTabBar subclass with an overridden TQTabBar::paint() function for a subclass of TQTab. The \fIchild\fR is the new page and \fItab\fR is the tab to put the \fIchild\fR on. +.SH "void TQTabWidget::changeTab ( TQWidget * w, const TQString & label )" Defines a new \fIlabel\fR for page \fIw\fR's tab. -.SH "void QTabWidget::changeTab ( TQWidget * w, const TQIconSet & iconset, const TQString & label )" +.SH "void TQTabWidget::changeTab ( TQWidget * w, const TQIconSet & iconset, const TQString & label )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Defines a new \fIiconset\fR and a new \fIlabel\fR for page \fIw\fR's tab. -.SH "TQWidget * QTabWidget::cornerWidget ( TQt::Corner corner = TQt::TopRight ) const" +.SH "TQWidget * TQTabWidget::cornerWidget ( TQt::Corner corner = TQt::TopRight ) const" Returns the widget shown in the \fIcorner\fR of the tab widget or 0. -.SH "int QTabWidget::count () const" +.SH "int TQTabWidget::count () const" Returns the number of tabs in the tab bar. See the "count" property for details. -.SH "void QTabWidget::currentChanged ( TQWidget * )\fC [signal]\fR" +.SH "void TQTabWidget::currentChanged ( TQWidget * )\fC [signal]\fR" This signal is emitted whenever the current page changes. The parameter is the new current page. .PP See also currentPage(), showPage(), and tabLabel(). -.SH "TQWidget * QTabWidget::currentPage () const" +.SH "TQWidget * TQTabWidget::currentPage () const" Returns a pointer to the page currently being displayed by the tab dialog. The tab dialog does its best to make sure that this value is never 0 (but if you try hard enough, it can be). -.SH "int QTabWidget::currentPageIndex () const" +.SH "int TQTabWidget::currentPageIndex () const" Returns the index position of the current tab page. See the "currentPage" property for details. -.SH "int QTabWidget::indexOf ( TQWidget * w ) const" +.SH "int TQTabWidget::indexOf ( TQWidget * w ) const" Returns the index position of page \fIw\fR, or -1 if the widget cannot be found. -.SH "void QTabWidget::insertTab ( TQWidget * child, const TQString & label, int index = -1 )\fC [virtual]\fR" +.SH "void TQTabWidget::insertTab ( TQWidget * child, const TQString & label, int index = -1 )\fC [virtual]\fR" Inserts another tab and page to the tab view. .PP The new page is \fIchild\fR; the tab's label is \fIlabel\fR. Note the difference between the widget name (which you supply to widget constructors and to setTabEnabled(), for example) and the tab label. The name is internal to the program and invariant, whereas the label is shown on-screen and may vary according to language and other factors. @@ -276,87 +276,87 @@ If \fIindex\fR is not specified, the tab is simply appended. Otherwise it is ins If you call insertTab() after show(), the screen will flicker and the user may be confused. .PP See also addTab(). -.SH "void QTabWidget::insertTab ( TQWidget * child, const TQIconSet & iconset, const TQString & label, int index = -1 )\fC [virtual]\fR" +.SH "void TQTabWidget::insertTab ( TQWidget * child, const TQIconSet & iconset, const TQString & label, int index = -1 )\fC [virtual]\fR" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Inserts another tab and page to the tab view. .PP This function is the same as insertTab(), but with an additional \fIiconset\fR. -.SH "void QTabWidget::insertTab ( TQWidget * child, QTab * tab, int index = -1 )\fC [virtual]\fR" +.SH "void TQTabWidget::insertTab ( TQWidget * child, TQTab * tab, int index = -1 )\fC [virtual]\fR" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP -This is a lower-level method for inserting tabs, similar to the other insertTab() method. It is useful if you are using setTabBar() to set a QTabBar subclass with an overridden QTabBar::paint() function for a subclass of QTab. The \fIchild\fR is the new page, \fItab\fR is the tab to put the \fIchild\fR on and \fIindex\fR is the position in the tab bar that this page should occupy. -.SH "bool QTabWidget::isTabEnabled ( TQWidget * w ) const" +This is a lower-level method for inserting tabs, similar to the other insertTab() method. It is useful if you are using setTabBar() to set a TQTabBar subclass with an overridden TQTabBar::paint() function for a subclass of TQTab. The \fIchild\fR is the new page, \fItab\fR is the tab to put the \fIchild\fR on and \fIindex\fR is the position in the tab bar that this page should occupy. +.SH "bool TQTabWidget::isTabEnabled ( TQWidget * w ) const" Returns TRUE if the page \fIw\fR is enabled; otherwise returns FALSE. .PP See also setTabEnabled() and TQWidget::enabled. -.SH "TQString QTabWidget::label ( int index ) const" +.SH "TQString TQTabWidget::label ( int index ) const" Returns the label of the tab at index position \fIindex\fR or TQString::null if the \fIindex\fR is out of range. -.SH "int QTabWidget::margin () const" +.SH "int TQTabWidget::margin () const" Returns the margin in this tab widget. See the "margin" property for details. -.SH "TQWidget * QTabWidget::page ( int index ) const" +.SH "TQWidget * TQTabWidget::page ( int index ) const" Returns the tab page at index position \fIindex\fR or 0 if the \fIindex\fR is out of range. -.SH "void QTabWidget::removePage ( TQWidget * w )\fC [virtual slot]\fR" +.SH "void TQTabWidget::removePage ( TQWidget * w )\fC [virtual slot]\fR" Removes page \fIw\fR from this stack of widgets. Does not delete \fIw\fR. .PP See also addTab(), showPage(), and TQWidgetStack::removeWidget(). -.SH "void QTabWidget::removeTabToolTip ( TQWidget * w )" +.SH "void TQTabWidget::removeTabToolTip ( TQWidget * w )" Removes the tab tool tip for page \fIw\fR. If the page does not have a tip, nothing happens. .PP See also setTabToolTip() and tabToolTip(). -.SH "void QTabWidget::setCornerWidget ( TQWidget * w, TQt::Corner corner = TQt::TopRight )" +.SH "void TQTabWidget::setCornerWidget ( TQWidget * w, TQt::Corner corner = TQt::TopRight )" Sets widget \fIw\fR to be the shown in the specified \fIcorner\fR of the tab widget. .PP Only the horizontal element of the \fIcorner\fR will be used. .PP See also cornerWidget() and tabPosition. -.SH "void QTabWidget::setCurrentPage ( int )\fC [slot]\fR" +.SH "void TQTabWidget::setCurrentPage ( int )\fC [slot]\fR" Sets the index position of the current tab page. See the "currentPage" property for details. -.SH "void QTabWidget::setMargin ( int )" +.SH "void TQTabWidget::setMargin ( int )" Sets the margin in this tab widget. See the "margin" property for details. -.SH "void QTabWidget::setTabBar ( QTabBar * tb )\fC [protected]\fR" -Replaces the dialog's QTabBar heading with the tab bar \fItb\fR. Note that this must be called \fIbefore\fR any tabs have been added, or the behavior is undefined. +.SH "void TQTabWidget::setTabBar ( TQTabBar * tb )\fC [protected]\fR" +Replaces the dialog's TQTabBar heading with the tab bar \fItb\fR. Note that this must be called \fIbefore\fR any tabs have been added, or the behavior is undefined. .PP See also tabBar(). -.SH "void QTabWidget::setTabEnabled ( TQWidget * w, bool enable )" +.SH "void TQTabWidget::setTabEnabled ( TQWidget * w, bool enable )" If \fIenable\fR is TRUE, page \fIw\fR is enabled; otherwise page \fIw\fR is disabled. The page's tab is redrawn appropriately. .PP -QTabWidget uses TQWidget::setEnabled() internally, rather than keeping a separate flag. +TQTabWidget uses TQWidget::setEnabled() internally, rather than keeping a separate flag. .PP -Note that even a disabled tab/page may be visible. If the page is visible already, QTabWidget will not hide it; if all the pages are disabled, QTabWidget will show one of them. +Note that even a disabled tab/page may be visible. If the page is visible already, TQTabWidget will not hide it; if all the pages are disabled, TQTabWidget will show one of them. .PP See also isTabEnabled() and TQWidget::enabled. -.SH "void QTabWidget::setTabIconSet ( TQWidget * w, const TQIconSet & iconset )" +.SH "void TQTabWidget::setTabIconSet ( TQWidget * w, const TQIconSet & iconset )" Sets the iconset for page \fIw\fR to \fIiconset\fR. -.SH "void QTabWidget::setTabLabel ( TQWidget * w, const TQString & l )" +.SH "void TQTabWidget::setTabLabel ( TQWidget * w, const TQString & l )" Sets the tab label for page \fIw\fR to \fIl\fR -.SH "void QTabWidget::setTabPosition ( TabPosition )" +.SH "void TQTabWidget::setTabPosition ( TabPosition )" Sets the position of the tabs in this tab widget. See the "tabPosition" property for details. -.SH "void QTabWidget::setTabShape ( TabShape s )" +.SH "void TQTabWidget::setTabShape ( TabShape s )" Sets the shape of the tabs in this tab widget to \fIs\fR. See the "tabShape" property for details. -.SH "void QTabWidget::setTabToolTip ( TQWidget * w, const TQString & tip )" +.SH "void TQTabWidget::setTabToolTip ( TQWidget * w, const TQString & tip )" Sets the tab tool tip for page \fIw\fR to \fItip\fR. .PP See also removeTabToolTip() and tabToolTip(). -.SH "void QTabWidget::showPage ( TQWidget * w )\fC [virtual slot]\fR" +.SH "void TQTabWidget::showPage ( TQWidget * w )\fC [virtual slot]\fR" Ensures that page \fIw\fR is shown. This is useful mainly for accelerators. .PP \fBWarning:\fR Used carelessly, this function can easily surprise or confuse the user. .PP -See also QTabBar::currentTab. -.SH "QTabBar * QTabWidget::tabBar () const\fC [protected]\fR" -Returns the current QTabBar. +See also TQTabBar::currentTab. +.SH "TQTabBar * TQTabWidget::tabBar () const\fC [protected]\fR" +Returns the current TQTabBar. .PP See also setTabBar(). -.SH "TQIconSet QTabWidget::tabIconSet ( TQWidget * w ) const" +.SH "TQIconSet TQTabWidget::tabIconSet ( TQWidget * w ) const" Returns the iconset of page \fIw\fR or a null iconset if \fIw\fR is not a tab page or does not have an iconset. -.SH "TQString QTabWidget::tabLabel ( TQWidget * w ) const" +.SH "TQString TQTabWidget::tabLabel ( TQWidget * w ) const" Returns the label text for the tab on page \fIw\fR. -.SH "TabPosition QTabWidget::tabPosition () const" +.SH "TabPosition TQTabWidget::tabPosition () const" Returns the position of the tabs in this tab widget. See the "tabPosition" property for details. -.SH "TabShape QTabWidget::tabShape () const" +.SH "TabShape TQTabWidget::tabShape () const" Returns the shape of the tabs in this tab widget. See the "tabShape" property for details. -.SH "TQString QTabWidget::tabToolTip ( TQWidget * w ) const" +.SH "TQString TQTabWidget::tabToolTip ( TQWidget * w ) const" Returns the tab tool tip for page \fIw\fR or TQString::null if no tool tip has been set. .PP See also setTabToolTip() and removeTabToolTip(). @@ -374,7 +374,7 @@ This property holds the index position of the current tab page. .PP Set this property's value with setCurrentPage() and get this property's value with currentPageIndex(). .PP -See also QTabBar::currentTab. +See also TQTabBar::currentTab. .SH "int margin" This property holds the margin in this tab widget. .PP @@ -384,7 +384,7 @@ Set this property's value with setMargin() and get this property's value with ma .SH "TabPosition tabPosition" This property holds the position of the tabs in this tab widget. .PP -Possible values for this property are QTabWidget::Top and QTabWidget::Bottom. +Possible values for this property are TQTabWidget::Top and TQTabWidget::Bottom. .PP See also TabPosition. .PP @@ -392,14 +392,14 @@ Set this property's value with setTabPosition() and get this property's value wi .SH "TabShape tabShape" This property holds the shape of the tabs in this tab widget. .PP -Possible values for this property are QTabWidget::Rounded (default) or QTabWidget::Triangular. +Possible values for this property are TQTabWidget::Rounded (default) or TQTabWidget::Triangular. .PP See also TabShape. .PP Set this property's value with setTabShape() and get this property's value with tabShape(). .SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqtabwidget.html +.BR http://doc.trolltech.com/tqtabwidget.html .BR http://www.trolltech.com/faq/tech.html .SH COPYRIGHT Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com. See the |