diff options
Diffstat (limited to 'doc/man/man3/tqaction.3qt')
| -rw-r--r-- | doc/man/man3/tqaction.3qt | 46 |
1 files changed, 23 insertions, 23 deletions
diff --git a/doc/man/man3/tqaction.3qt b/doc/man/man3/tqaction.3qt index 6d1f6bdbf..9339b5017 100644 --- a/doc/man/man3/tqaction.3qt +++ b/doc/man/man3/tqaction.3qt @@ -27,10 +27,10 @@ Inherited by TQActionGroup. .BI "\fBTQAction\fR ( const TQIconSet & icon, const TQString & menuText, TQKeySequence accel, TQObject * parent, const char * name = 0 )" .br .ti -1c -.BI "TQAction ( const TQString & text, const TQIconSet & icon, const TQString & menuText, TQKeySequence accel, TQObject * parent, const char * name = 0, bool toggle = FALSE ) \fI(obsolete)\fR" +.BI "TQAction ( const TQString & text, const TQIconSet & icon, const TQString & menuText, TQKeySequence accel, TQObject * parent, const char * name = 0, bool toggle = false ) \fI(obsolete)\fR" .br .ti -1c -.BI "TQAction ( const TQString & text, const TQString & menuText, TQKeySequence accel, TQObject * parent, const char * name = 0, bool toggle = FALSE ) \fI(obsolete)\fR" +.BI "TQAction ( const TQString & text, const TQString & menuText, TQKeySequence accel, TQObject * parent, const char * name = 0, bool toggle = false ) \fI(obsolete)\fR" .br .ti -1c .BI "TQAction ( TQObject * parent, const char * name, bool toggle ) \fI(obsolete)\fR" @@ -184,7 +184,7 @@ In GUI applications many commands can be invoked via a menu option, a toolbar bu .PP 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. +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 @@ -248,7 +248,7 @@ For accelerators and status tips to work, \fIparent\fR must either be a widget, .PP The action uses a stripped version of \fImenuText\fR (e.g. "&Menu Option..." becomes "Menu Option") as descriptive text for toolbuttons. You can override this by setting a specific description with setText(). The same text and \fIaccel\fR will be used for tool tips and status tips unless you provide text for these using setToolTip() and setStatusTip(). .PP -Call setToggleAction(TRUE) to make the action a toggle action. +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 "TQAction::TQAction ( const TQIconSet & icon, const TQString & menuText, TQKeySequence accel, TQObject * parent, const char * name = 0 )" @@ -260,23 +260,23 @@ For accelerators and status tips to work, \fIparent\fR must either be a widget, .PP The action uses a stripped version of \fImenuText\fR (e.g. "&Menu Option..." becomes "Menu Option") as descriptive text for toolbuttons. You can override this by setting a specific description with setText(). The same text and \fIaccel\fR will be used for tool tips and status tips unless you provide text for these using setToolTip() and setStatusTip(). .PP -Call setToggleAction(TRUE) to make the action a toggle action. +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 "TQAction::TQAction ( const TQString & text, const TQIconSet & icon, const TQString & menuText, TQKeySequence accel, TQObject * parent, const char * name = 0, bool toggle = FALSE )" +.SH "TQAction::TQAction ( const TQString & text, const TQIconSet & icon, const TQString & menuText, TQKeySequence 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. +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 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 "TQAction::TQAction ( const TQString & text, const TQString & menuText, TQKeySequence accel, TQObject * parent, const char * name = 0, bool toggle = FALSE )" +.SH "TQAction::TQAction ( const TQString & text, const TQString & menuText, TQKeySequence 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. +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 TQActionGroup. .PP @@ -288,7 +288,7 @@ The \fItext\fR and \fIaccel\fR will be used for tool tips and status tips unless .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. +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 TQActionGroup, the new action inserts itself into \fIparent\fR. .PP @@ -315,7 +315,7 @@ 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 TQToolBar or TQPopupMenu 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 @@ -332,25 +332,25 @@ This function is called from the addTo() function when it has created a menu ite .SH "TQIconSet TQAction::iconSet () const" Returns the action's icon. See the "iconSet" property for details. .SH "bool TQAction::isEnabled () const" -Returns TRUE if the action is enabled; otherwise returns FALSE. See the "enabled" property for details. +Returns true if the action is enabled; otherwise returns false. See the "enabled" property for details. .SH "bool TQAction::isOn () const" -Returns TRUE if a toggle action is on; otherwise returns FALSE. See the "on" property for details. +Returns true if a toggle action is on; otherwise returns false. See the "on" property for details. .SH "bool TQAction::isToggleAction () const" -Returns TRUE if the action is a toggle action; otherwise returns FALSE. See the "toggleAction" property for details. +Returns true if the action is a toggle action; otherwise returns false. See the "toggleAction" property for details. .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. +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 TQAction::menuText () const" Returns the action's menu text. See the "menuText" property for details. .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. +Returns true if the action was removed successfully; otherwise returns false. .PP See also addTo(). .SH "void TQAction::setAccel ( const TQKeySequence & key )\fC [virtual]\fR" Sets the action's accelerator key to \fIkey\fR. See the "accel" property for details. .SH "void TQAction::setDisabled ( bool disable )\fC [slot]\fR" -Disables the action if \fIdisable\fR is TRUE; otherwise enables the action. +Disables the action if \fIdisable\fR is true; otherwise enables the action. .PP See the enabled documentation for more information. .SH "void TQAction::setEnabled ( bool )\fC [virtual slot]\fR" @@ -384,7 +384,7 @@ See also on, activate(), toggled(), and toggleAction. .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. +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 To trigger a user command depending on whether a toggle action has been switched on or off connect it to a slot that takes a bool to indicate the state, e.g. .PP @@ -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 TQActionGroups; 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 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. +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 @@ -476,9 +476,9 @@ Set this property's value with setText() and get this property's value with text .SH "bool toggleAction" 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. +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 TQActionGroup with the TQActionGroup::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" @@ -496,7 +496,7 @@ Set this property's value with setToolTip() and get this property's value with t .SH "bool visible" This property holds whether the action can be seen (e.g. in menus and toolbars). .PP -If \fIvisible\fR is TRUE the action can be seen (e.g. in menus and toolbars) and chosen by the user; if \fIvisible\fR is FALSE the action cannot be seen or chosen by the user. +If \fIvisible\fR is true the action can be seen (e.g. in menus and toolbars) and chosen by the user; if \fIvisible\fR is false the action cannot be seen or chosen by the user. .PP Actions which are not visible are \fInot\fR grayed out; they do not appear at all. .PP |