diff options
Diffstat (limited to 'doc/man/man3/tqaction.3qt')
| -rw-r--r-- | doc/man/man3/tqaction.3qt | 146 |
1 files changed, 73 insertions, 73 deletions
diff --git a/doc/man/man3/tqaction.3qt b/doc/man/man3/tqaction.3qt index 9ca76d07..4ff66ae6 100644 --- a/doc/man/man3/tqaction.3qt +++ b/doc/man/man3/tqaction.3qt @@ -1,5 +1,5 @@ '\" t -.TH QAction 3qt "2 February 2007" "Trolltech AS" \" -*- nroff -*- +.TH TQAction 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,36 +7,36 @@ .ad l .nh .SH NAME -QAction \- Abstract user interface action that can appear both in menus and tool bars +TQAction \- Abstract user interface action that can appear both in menus and tool bars .SH SYNOPSIS -\fC#include <ntqaction.h>\fR +\fC#include <tqaction.h>\fR .PP Inherits TQObject. .PP -Inherited by QActionGroup. +Inherited by TQActionGroup. .PP .SS "Public Members" .in +1c .ti -1c -.BI "\fBQAction\fR ( TQObject * parent, const char * name = 0 )" +.BI "\fBTQAction\fR ( TQObject * parent, const char * name = 0 )" .br .ti -1c -.BI "\fBQAction\fR ( const TQString & menuText, QKeySequence accel, TQObject * parent, const char * name = 0 )" +.BI "\fBTQAction\fR ( const TQString & menuText, QKeySequence accel, TQObject * parent, const char * name = 0 )" .br .ti -1c -.BI "\fBQAction\fR ( const TQIconSet & icon, const TQString & menuText, QKeySequence accel, TQObject * parent, const char * name = 0 )" +.BI "\fBTQAction\fR ( const TQIconSet & icon, const TQString & menuText, QKeySequence accel, TQObject * parent, const char * name = 0 )" .br .ti -1c -.BI "QAction ( const TQString & text, const TQIconSet & icon, const TQString & menuText, QKeySequence accel, TQObject * parent, const char * name = 0, bool toggle = FALSE ) \fI(obsolete)\fR" +.BI "TQAction ( const TQString & text, const TQIconSet & icon, const TQString & menuText, QKeySequence accel, TQObject * parent, const char * name = 0, bool toggle = FALSE ) \fI(obsolete)\fR" .br .ti -1c -.BI "QAction ( const TQString & text, const TQString & menuText, QKeySequence accel, TQObject * parent, const char * name = 0, bool toggle = FALSE ) \fI(obsolete)\fR" +.BI "TQAction ( const TQString & text, const TQString & menuText, QKeySequence accel, TQObject * parent, const char * name = 0, bool toggle = FALSE ) \fI(obsolete)\fR" .br .ti -1c -.BI "QAction ( TQObject * parent, const char * name, bool toggle ) \fI(obsolete)\fR" +.BI "TQAction ( TQObject * parent, const char * name, bool toggle ) \fI(obsolete)\fR" .br .ti -1c -.BI "\fB~QAction\fR ()" +.BI "\fB~TQAction\fR ()" .br .ti -1c .BI "virtual void \fBsetIconSet\fR ( const TQIconSet & )" @@ -174,25 +174,25 @@ Inherited by QActionGroup. .BI "virtual void \fBaddedTo\fR ( TQWidget * actionWidget, TQWidget * container )" .br .ti -1c -.BI "virtual void \fBaddedTo\fR ( int index, QPopupMenu * menu )" +.BI "virtual void \fBaddedTo\fR ( int index, TQPopupMenu * menu )" .br .in -1c .SH DESCRIPTION -The QAction class provides an abstract user interface action that can appear both in menus and tool bars. +The TQAction class provides an abstract user interface action that can appear both in menus and tool bars. .PP In GUI applications many commands can be invoked via a menu option, a toolbar button and a keyboard accelerator. Since the same action must be performed regardless of how the action was invoked, and since the menu and toolbar should be kept in sync, it is useful to represent a command as an \fIaction\fR. An action can be added to a menu and a toolbar and will automatically keep them in sync. For example, if the user presses a Bold toolbar button the Bold menu item will automatically be checked. .PP -A QAction may contain an icon, a menu text, an accelerator, a status text, a whats this text and a tool tip. Most of these can be set in the constructor. They can also be set independently with setIconSet(), setText(), setMenuText(), setToolTip(), setStatusTip(), setWhatsThis() and setAccel(). +A TQAction may contain an icon, a menu text, an accelerator, a status text, a whats this text and a tool tip. Most of these can be set in the constructor. They can also be set independently with setIconSet(), setText(), setMenuText(), setToolTip(), setStatusTip(), setWhatsThis() and setAccel(). .PP An action may be a toggle action e.g. a Bold toolbar button, or a command action, e.g. 'Open File' to invoke an open file dialog. Toggle actions emit the toggled() signal when their state changes. Both command and toggle actions emit the activated() signal when they are invoked. Use setToggleAction() to set an action's toggled status. To see if an action is a toggle action use isToggleAction(). A toggle action may be "on", isOn() returns TRUE, or "off", isOn() returns FALSE. .PP Actions are added to widgets (menus or toolbars) using addTo(), and removed using removeFrom(). .PP -Once a QAction has been created it should be added to the relevant menu and toolbar and then connected to the slot which will perform the action. For example: +Once a TQAction has been created it should be added to the relevant menu and toolbar and then connected to the slot which will perform the action. For example: .PP .nf .br - fileOpenAction = new QAction( QPixmap( fileopen ), "&Open...", + fileOpenAction = new TQAction( QPixmap( fileopen ), "&Open...", .br CTRL+Key_O, this, "open" ); .br @@ -203,7 +203,7 @@ We create a "File Save" action with a menu text of "&Save" and \fICtrl+S\fR as t .PP .nf .br - QToolBar * fileTools = new QToolBar( this, "file operations" ); + TQToolBar * fileTools = new TQToolBar( this, "file operations" ); .fi .PP .nf @@ -213,7 +213,7 @@ We create a "File Save" action with a menu text of "&Save" and \fICtrl+S\fR as t .PP .nf .br - QPopupMenu * file = new QPopupMenu( this ); + TQPopupMenu * file = new TQPopupMenu( this ); .br menuBar()->insertItem( "&File", file ); .fi @@ -231,18 +231,18 @@ To prevent recursion, don't create an action as a child of a widget that the act .PP See also Main Window and Related Classes and Basic Widgets. .SH MEMBER FUNCTION DOCUMENTATION -.SH "QAction::QAction ( TQObject * parent, const char * name = 0 )" +.SH "TQAction::TQAction ( TQObject * parent, const char * name = 0 )" Constructs an action called \fIname\fR with parent \fIparent\fR. .PP -If \fIparent\fR is a QActionGroup, the new action inserts itself into \fIparent\fR. +If \fIparent\fR is a TQActionGroup, the new action inserts itself into \fIparent\fR. .PP For accelerators and status tips to work, \fIparent\fR must either be a widget, or an action group whose parent is a widget. .PP \fBWarning:\fR To prevent recursion, don't create an action as a child of a widget that the action is later added to. -.SH "QAction::QAction ( const TQString & menuText, QKeySequence accel, TQObject * parent, const char * name = 0 )" +.SH "TQAction::TQAction ( const TQString & menuText, QKeySequence accel, TQObject * parent, const char * name = 0 )" This constructor results in an icon-less action with the the menu text \fImenuText\fR and keyboard accelerator \fIaccel\fR. It is a child of \fIparent\fR and called \fIname\fR. .PP -If \fIparent\fR is a QActionGroup, the action automatically becomes a member of it. +If \fIparent\fR is a TQActionGroup, the action automatically becomes a member of it. .PP For accelerators and status tips to work, \fIparent\fR must either be a widget, or an action group whose parent is a widget. .PP @@ -251,10 +251,10 @@ The action uses a stripped version of \fImenuText\fR (e.g. "&Menu Option..." bec Call setToggleAction(TRUE) to make the action a toggle action. .PP \fBWarning:\fR To prevent recursion, don't create an action as a child of a widget that the action is later added to. -.SH "QAction::QAction ( const TQIconSet & icon, const TQString & menuText, QKeySequence accel, TQObject * parent, const char * name = 0 )" +.SH "TQAction::TQAction ( const TQIconSet & icon, const TQString & menuText, QKeySequence accel, TQObject * parent, const char * name = 0 )" This constructor creates an action with the following properties: the icon or iconset \fIicon\fR, the menu text \fImenuText\fR and keyboard accelerator \fIaccel\fR. It is a child of \fIparent\fR and called \fIname\fR. .PP -If \fIparent\fR is a QActionGroup, the action automatically becomes a member of it. +If \fIparent\fR is a TQActionGroup, the action automatically becomes a member of it. .PP For accelerators and status tips to work, \fIparent\fR must either be a widget, or an action group whose parent is a widget. .PP @@ -263,126 +263,126 @@ The action uses a stripped version of \fImenuText\fR (e.g. "&Menu Option..." bec Call setToggleAction(TRUE) to make the action a toggle action. .PP \fBWarning:\fR To prevent recursion, don't create an action as a child of a widget that the action is later added to. -.SH "QAction::QAction ( const TQString & text, const TQIconSet & icon, const TQString & menuText, QKeySequence accel, TQObject * parent, const char * name = 0, bool toggle = FALSE )" +.SH "TQAction::TQAction ( const TQString & text, const TQIconSet & icon, const TQString & menuText, QKeySequence accel, TQObject * parent, const char * name = 0, bool toggle = FALSE )" \fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. .PP This constructor creates an action with the following properties: the description \fItext\fR, the icon or iconset \fIicon\fR, the menu text \fImenuText\fR and keyboard accelerator \fIaccel\fR. It is a child of \fIparent\fR and called \fIname\fR. If \fItoggle\fR is TRUE the action will be a toggle action, otherwise it will be a command action. .PP -If \fIparent\fR is a QActionGroup, the action automatically becomes a member of it. +If \fIparent\fR is a TQActionGroup, the action automatically becomes a member of it. .PP For accelerators and status tips to work, \fIparent\fR must either be a widget, or an action group whose parent is a widget. .PP The \fItext\fR and \fIaccel\fR will be used for tool tips and status tips unless you provide specific text for these using setToolTip() and setStatusTip(). -.SH "QAction::QAction ( const TQString & text, const TQString & menuText, QKeySequence accel, TQObject * parent, const char * name = 0, bool toggle = FALSE )" +.SH "TQAction::TQAction ( const TQString & text, const TQString & menuText, QKeySequence accel, TQObject * parent, const char * name = 0, bool toggle = FALSE )" \fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. .PP This constructor results in an icon-less action with the description \fItext\fR, the menu text \fImenuText\fR and the keyboard accelerator \fIaccel\fR. Its parent is \fIparent\fR and it is called \fIname\fR. If \fItoggle\fR is TRUE the action will be a toggle action, otherwise it will be a command action. .PP -The action automatically becomes a member of \fIparent\fR if \fIparent\fR is a QActionGroup. +The action automatically becomes a member of \fIparent\fR if \fIparent\fR is a TQActionGroup. .PP For accelerators and status tips to work, \fIparent\fR must either be a widget, or an action group whose parent is a widget. .PP The \fItext\fR and \fIaccel\fR will be used for tool tips and status tips unless you provide specific text for these using setToolTip() and setStatusTip(). -.SH "QAction::QAction ( TQObject * parent, const char * name, bool toggle )" +.SH "TQAction::TQAction ( TQObject * parent, const char * name, bool toggle )" \fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. .PP Constructs an action called \fIname\fR with parent \fIparent\fR. .PP If \fItoggle\fR is TRUE the action will be a toggle action, otherwise it will be a command action. .PP -If \fIparent\fR is a QActionGroup, the new action inserts itself into \fIparent\fR. +If \fIparent\fR is a TQActionGroup, the new action inserts itself into \fIparent\fR. .PP For accelerators and status tips to work, \fIparent\fR must either be a widget, or an action group whose parent is a widget. -.SH "QAction::~QAction ()" +.SH "TQAction::~TQAction ()" Destroys the object and frees allocated resources. -.SH "QKeySequence QAction::accel () const" +.SH "QKeySequence TQAction::accel () const" Returns the action's accelerator key. See the "accel" property for details. -.SH "void QAction::activate ()\fC [slot]\fR" +.SH "void TQAction::activate ()\fC [slot]\fR" Activates the action and executes all connected slots. This only works for actions that are not toggle action. .PP See also toggle(). -.SH "void QAction::activated ()\fC [signal]\fR" +.SH "void TQAction::activated ()\fC [signal]\fR" This signal is emitted when an action is activated by the user, e.g. when the user clicks a menu option or a toolbar button or presses an action's accelerator key combination. .PP Connect to this signal for command actions. Connect to the toggled() signal for toggle actions. .PP Examples: .)l action/application.cpp, chart/chartform.cpp, and themes/themes.cpp. -.SH "bool QAction::addTo ( TQWidget * w )\fC [virtual]\fR" +.SH "bool TQAction::addTo ( TQWidget * w )\fC [virtual]\fR" Adds this action to widget \fIw\fR. .PP -Currently actions may be added to QToolBar and QPopupMenu widgets. +Currently actions may be added to TQToolBar and TQPopupMenu widgets. .PP An action added to a tool bar is automatically displayed as a tool button; an action added to a pop up menu appears as a menu option. .PP -addTo() returns TRUE if the action was added successfully and FALSE otherwise. (If \fIw\fR is not a QToolBar or QPopupMenu the action will not be added and FALSE will be returned.) +addTo() returns TRUE if the action was added successfully and FALSE otherwise. (If \fIw\fR is not a TQToolBar or TQPopupMenu the action will not be added and FALSE will be returned.) .PP See also removeFrom(). .PP Examples: .)l action/application.cpp, action/toggleaction/toggleaction.cpp, and chart/chartform.cpp. .PP -Reimplemented in QActionGroup. -.SH "void QAction::addedTo ( TQWidget * actionWidget, TQWidget * container )\fC [virtual protected]\fR" +Reimplemented in TQActionGroup. +.SH "void TQAction::addedTo ( TQWidget * actionWidget, TQWidget * container )\fC [virtual protected]\fR" This function is called from the addTo() function when it has created a widget (\fIactionWidget\fR) for the action in the \fIcontainer\fR. -.SH "void QAction::addedTo ( int index, QPopupMenu * menu )\fC [virtual protected]\fR" +.SH "void TQAction::addedTo ( int index, TQPopupMenu * menu )\fC [virtual protected]\fR" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP This function is called from the addTo() function when it has created a menu item at the index position \fIindex\fR in the popup menu \fImenu\fR. -.SH "TQIconSet QAction::iconSet () const" +.SH "TQIconSet TQAction::iconSet () const" Returns the action's icon. See the "iconSet" property for details. -.SH "bool QAction::isEnabled () const" +.SH "bool TQAction::isEnabled () const" Returns TRUE if the action is enabled; otherwise returns FALSE. See the "enabled" property for details. -.SH "bool QAction::isOn () const" +.SH "bool TQAction::isOn () const" Returns TRUE if a toggle action is on; otherwise returns FALSE. See the "on" property for details. -.SH "bool QAction::isToggleAction () const" +.SH "bool TQAction::isToggleAction () const" Returns TRUE if the action is a toggle action; otherwise returns FALSE. See the "toggleAction" property for details. -.SH "bool QAction::isVisible () const" +.SH "bool TQAction::isVisible () const" Returns TRUE if the action can be seen (e.g. in menus and toolbars); otherwise returns FALSE. See the "visible" property for details. -.SH "TQString QAction::menuText () const" +.SH "TQString TQAction::menuText () const" Returns the action's menu text. See the "menuText" property for details. -.SH "bool QAction::removeFrom ( TQWidget * w )\fC [virtual]\fR" +.SH "bool TQAction::removeFrom ( TQWidget * w )\fC [virtual]\fR" Removes the action from widget \fIw\fR. .PP Returns TRUE if the action was removed successfully; otherwise returns FALSE. .PP See also addTo(). -.SH "void QAction::setAccel ( const QKeySequence & key )\fC [virtual]\fR" +.SH "void TQAction::setAccel ( const QKeySequence & key )\fC [virtual]\fR" Sets the action's accelerator key to \fIkey\fR. See the "accel" property for details. -.SH "void QAction::setDisabled ( bool disable )\fC [slot]\fR" +.SH "void TQAction::setDisabled ( bool disable )\fC [slot]\fR" Disables the action if \fIdisable\fR is TRUE; otherwise enables the action. .PP See the enabled documentation for more information. -.SH "void QAction::setEnabled ( bool )\fC [virtual slot]\fR" +.SH "void TQAction::setEnabled ( bool )\fC [virtual slot]\fR" Sets whether the action is enabled. See the "enabled" property for details. -.SH "void QAction::setIconSet ( const TQIconSet & )\fC [virtual]\fR" +.SH "void TQAction::setIconSet ( const TQIconSet & )\fC [virtual]\fR" Sets the action's icon. See the "iconSet" property for details. -.SH "void QAction::setMenuText ( const TQString & )\fC [virtual]\fR" +.SH "void TQAction::setMenuText ( const TQString & )\fC [virtual]\fR" Sets the action's menu text. See the "menuText" property for details. -.SH "void QAction::setOn ( bool )\fC [virtual slot]\fR" +.SH "void TQAction::setOn ( bool )\fC [virtual slot]\fR" Sets whether a toggle action is on. See the "on" property for details. -.SH "void QAction::setStatusTip ( const TQString & )\fC [virtual]\fR" +.SH "void TQAction::setStatusTip ( const TQString & )\fC [virtual]\fR" Sets the action's status tip. See the "statusTip" property for details. -.SH "void QAction::setText ( const TQString & )\fC [virtual]\fR" +.SH "void TQAction::setText ( const TQString & )\fC [virtual]\fR" Sets the action's descriptive text. See the "text" property for details. -.SH "void QAction::setToggleAction ( bool )\fC [virtual]\fR" +.SH "void TQAction::setToggleAction ( bool )\fC [virtual]\fR" Sets whether the action is a toggle action. See the "toggleAction" property for details. -.SH "void QAction::setToolTip ( const TQString & )\fC [virtual]\fR" +.SH "void TQAction::setToolTip ( const TQString & )\fC [virtual]\fR" Sets the action's tool tip. See the "toolTip" property for details. -.SH "void QAction::setVisible ( bool )\fC [slot]\fR" +.SH "void TQAction::setVisible ( bool )\fC [slot]\fR" Sets whether the action can be seen (e.g. in menus and toolbars). See the "visible" property for details. -.SH "void QAction::setWhatsThis ( const TQString & )\fC [virtual]\fR" +.SH "void TQAction::setWhatsThis ( const TQString & )\fC [virtual]\fR" Sets the action's "What's This?" help text. See the "whatsThis" property for details. -.SH "TQString QAction::statusTip () const" +.SH "TQString TQAction::statusTip () const" Returns the action's status tip. See the "statusTip" property for details. -.SH "TQString QAction::text () const" +.SH "TQString TQAction::text () const" Returns the action's descriptive text. See the "text" property for details. -.SH "void QAction::toggle ()\fC [slot]\fR" +.SH "void TQAction::toggle ()\fC [slot]\fR" Toggles the state of a toggle action. .PP See also on, activate(), toggled(), and toggleAction. -.SH "void QAction::toggled ( bool on )\fC [signal]\fR" -This signal is emitted when a toggle action changes state; command actions and QActionGroups don't emit toggled(). +.SH "void TQAction::toggled ( bool on )\fC [signal]\fR" +This signal is emitted when a toggle action changes state; command actions and TQActionGroups don't emit toggled(). .PP The \fIon\fR argument denotes the new state: If \fIon\fR is TRUE the toggle action is switched on, and if \fIon\fR is FALSE the toggle action is switched off. .PP @@ -390,12 +390,12 @@ To trigger a user command depending on whether a toggle action has been switched .PP .nf .br - QMainWindow * window = new QMainWindow; + TQMainWindow * window = new TQMainWindow; .fi .PP .nf .br - QAction * labelonoffaction = new QAction( window, "labelonoff" ); + TQAction * labelonoffaction = new TQAction( window, "labelonoff" ); .fi .PP .nf @@ -408,9 +408,9 @@ To trigger a user command depending on whether a toggle action has been switched See also activated(), toggleAction, and on. .PP Example: action/toggleaction/toggleaction.cpp. -.SH "TQString QAction::toolTip () const" +.SH "TQString TQAction::toolTip () const" Returns the action's tool tip. See the "toolTip" property for details. -.SH "TQString QAction::whatsThis () const" +.SH "TQString TQAction::whatsThis () const" Returns the action's "What's This?" help text. See the "whatsThis" property for details. .SS "Property Documentation" .SH "QKeySequence accel" @@ -424,7 +424,7 @@ This property holds whether the action is enabled. .PP Disabled actions can't be chosen by the user. They don't disappear from the menu/tool bar but are displayed in a way which indicates that they are unavailable, e.g. they might be displayed grayed out. .PP -What's this? help on disabled actions is still available provided the QAction::whatsThis property is set. +What's this? help on disabled actions is still available provided the TQAction::whatsThis property is set. .PP Set this property's value with setEnabled() and get this property's value with isEnabled(). .SH "TQIconSet iconSet" @@ -448,7 +448,7 @@ Set this property's value with setMenuText() and get this property's value with .SH "bool on" This property holds whether a toggle action is on. .PP -This property is always on (TRUE) for command actions and QActionGroups; setOn() has no effect on them. For action's where isToggleAction() is TRUE, this property's default value is off (FALSE). +This property is always on (TRUE) for command actions and TQActionGroups; setOn() has no effect on them. For action's where isToggleAction() is TRUE, this property's default value is off (FALSE). .PP See also toggleAction. .PP @@ -468,7 +468,7 @@ Set this property's value with setStatusTip() and get this property's value with .SH "TQString text" This property holds the action's descriptive text. .PP -If QMainWindow::usesTextLabel is TRUE, the text appears as a label in the relevant tool button. It also serves as the default text in menus and tool tips if these have not been specifically defined. There is no default text. +If TQMainWindow::usesTextLabel is TRUE, the text appears as a label in the relevant tool button. It also serves as the default text in menus and tool tips if these have not been specifically defined. There is no default text. .PP See also menuText, toolTip, and statusTip. .PP @@ -478,7 +478,7 @@ This property holds whether the action is a toggle action. .PP A toggle action is one which has an on/off state. For example a Bold toolbar button is either on or off. An action which is not a toggle action is a command action; a command action is simply executed, e.g. file save. This property's default is FALSE. .PP -In some situations, the state of one toggle action should depend on the state of others. For example, "Left Align", "Center" and" Right Align" toggle actions are mutually exclusive. To achieve exclusive toggling, add the relevant toggle actions to a QActionGroup with the QActionGroup::exclusive property set to TRUE. +In some situations, the state of one toggle action should depend on the state of others. For example, "Left Align", "Center" and" Right Align" toggle actions are mutually exclusive. To achieve exclusive toggling, add the relevant toggle actions to a TQActionGroup with the TQActionGroup::exclusive property set to TRUE. .PP Set this property's value with setToggleAction() and get this property's value with isToggleAction(). .SH "TQString toolTip" @@ -511,7 +511,7 @@ See also QWhatsThis. Set this property's value with setWhatsThis() and get this property's value with whatsThis(). .SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqaction.html +.BR http://doc.trolltech.com/tqaction.html .BR http://www.trolltech.com/faq/tech.html .SH COPYRIGHT Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com. See the |