qaction.3qt

linux下GUI编程工具qt的在线连接帮助手册

.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 QString & text, const QString & menuText, QKeySequence accel, QObject * parent, const char * name = 0, bool toggle = FALSE )"
This constructor results in an iconless action with the description \fItext\fR, the menu text \fImenuText\fR and the keyboard accelerator \fIaccel\fR. Its parent is \fIparent\fR and its name \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.
.PP
The \fIparent\fR should be a widget for accelerators and status tips to work.
.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 ()"
Destroys the object and frees allocated resources.
.SH "QKeySequence QAction::accel () const"
Returns the action's accelerator key. See the "accel" property for details.
.SH "void QAction::activated ()\fC [signal]\fR"
This signal is emitted when an action is activated by the user, i.e. 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
Example: action/application.cpp.
.SH "bool QAction::addTo ( QWidget * w )\fC [virtual]\fR"
Adds this action to widget \fIw\fR.
.PP
Currently actions may be added to QToolBar and QPopupMenu 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.)
.PP
See also removeFrom().
.PP
Examples:
.)l action/application.cpp, action/toggleaction/toggleaction.cpp and textedit/textedit.cpp.
.PP
Reimplemented in QActionGroup.
.SH "void QAction::addedTo ( QWidget * actionWidget, QWidget * container )\fC [virtual protected]\fR"
This function is called from the addTo() function when it created a widget (\fIactionWidget\fR) for the action in the \fIcontainer\fR.
.SH "void QAction::addedTo ( int index, QPopupMenu * 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 created a menu item at the index \fIindex\fR in the popup menu \fImenu\fR.
.SH "QIconSet QAction::iconSet () const"
Returns the action's icon. See the "iconSet" property for details.
.SH "bool QAction::isEnabled () const"
Returns TRUE if the action is enabled; otherwise returns FALSE. See the "enabled" property for details.
.SH "bool QAction::isOn () const"
Returns TRUE if a toggle action is on; otherwise returns FALSE. See the "on" property for details.
.SH "bool QAction::isToggleAction () const"
Returns TRUE if the action is a toggle action; otherwise returns FALSE. See the "toggleAction" property for details.
.SH "QString QAction::menuText () const"
Returns the action's menu text. See the "menuText" property for details.
.SH "bool QAction::removeFrom ( QWidget * w )\fC [virtual]\fR"
Removes the action from widget \fIw\fR.
.PP
Returns TRUE if the action was removed successfully, FALSE otherwise.
.PP
See also addTo().
.SH "void QAction::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::setEnabled ( bool )\fC [virtual slot]\fR"
Sets whether the action is enabled. See the "enabled" property for details.
.SH "void QAction::setIconSet ( const QIconSet & )\fC [virtual]\fR"
Sets the action's icon. See the "iconSet" property for details.
.SH "void QAction::setMenuText ( const QString & )\fC [virtual]\fR"
Sets the action's menu text. See the "menuText" property for details.
.SH "void QAction::setOn ( bool )\fC [virtual slot]\fR"
Sets whether a toggle action is on. See the "on" property for details.
.SH "void QAction::setStatusTip ( const QString & )\fC [virtual]\fR"
Sets the action's status tip. See the "statusTip" property for details.
.SH "void QAction::setText ( const QString & )\fC [virtual]\fR"
Sets the action's descriptive text. See the "text" property for details.
.SH "void QAction::setToggleAction ( bool )\fC [virtual]\fR"
Sets whether the action is a toggle action. See the "toggleAction" property for details.
.SH "void QAction::setToolTip ( const QString & )\fC [virtual]\fR"
Sets the action's tool tip. See the "toolTip" property for details.
.SH "void QAction::setWhatsThis ( const QString & )\fC [virtual]\fR"
Sets the action's "What's This ?" help text. See the "whatsThis" property for details.
.SH "QString QAction::statusTip () const"
Returns the action's status tip. See the "statusTip" property for details.
.SH "QString QAction::text () const"
Returns the action's descriptive text. See the "text" property for details.
.SH "void QAction::toggle ()\fC [slot]\fR"
Toggles the state of a toggle action.
.PP
See also on, toggled() and toggleAction.
.SH "void QAction::toggled ( bool )\fC [signal]\fR"
This signal is emitted when a toggle action changes state; command actions and QActionGroups don't emit toggled().
.PP
The argument denotes the new state; i.e. TRUE if the toggle action was switched on and FALSE if it was 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
.nf
.br
        QMainWindow * window = new QMainWindow;
.fi
.PP
.nf
.br
        QAction * labelonoffaction = new QAction( window, "labelonoff", TRUE );
.fi
.PP
.nf
.br
        QObject::connect( labelonoffaction, SIGNAL( toggled( bool ) ),
.br
                          window, SLOT( setUsesTextLabel( bool ) ) );
.fi
.PP
See also activated(), toggleAction and on.
.PP
Example: action/toggleaction/toggleaction.cpp.
.SH "QString QAction::toolTip () const"
Returns the action's tool tip. See the "toolTip" property for details.
.SH "QString QAction::whatsThis () const"
Returns the action's "What's This ?" help text. See the "whatsThis" property for details.
.SS "Property Documentation"
.SH "QKeySequence accel"
This property holds the action's accelerator key.
.PP
The keycodes can be found in Qt::Key and Qt::Modifier.
.PP
Set this property's value with setAccel() and get this property's value with accel().
.SH "bool enabled"
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 greyed out.
.PP
What's this? help on disabled actions is still available provided the QAction::whatsThis property is set.
.PP
Set this property's value with setEnabled() and get this property's value with isEnabled().
.SH "QIconSet iconSet"
This property holds the action's icon.
.PP
The icon is used as tool button icon and in the menu to the left of the menu text.
.PP
(See the action/toggleaction/toggleaction.cpp example.)
.PP
Set this property's value with setIconSet() and get this property's value with iconSet().
.SH "QString menuText"
This property holds the action's menu text.
.PP
If the action is added to a menu the menu option will consist of the icon (if there is one), the menu text and the accelerator (if there is one). If the menu text is not explicitly set in the constructor or using setMenuText() the action's description text will be used as the menu text.
.PP
See also text.
.PP
Set this property's value with setMenuText() and get this property's value with menuText().
.SH "bool on"
This property holds whether a toggle action is on.
.PP
This property is always on for command actions and QActionGroups. setOn() has no effect on them.
.PP
See also toggleAction.
.PP
Set this property's value with setOn() and get this property's value with isOn().
.SH "QString statusTip"
This property holds the action's status tip.
.PP
The statusTip is displayed on all status bars that the toplevel widget parenting this action provides.
.PP
If no status tip is defined, the action uses the tool tip text.
.PP
See also statusTip and toolTip.
.PP
Set this property's value with setStatusTip() and get this property's value with statusTip().
.SH "QString text"
This property holds the action's descriptive text.
.PP
If QMainWindow::usesTextLabel is TRUE, the text appears as a label in the relevant toolbutton. It also serves as the default text in menus and tips if these have not been specifically defined.
.PP
See also menuText, toolTip and statusTip.
.PP
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. For example a file open toolbar button would invoke a file open dialog.
.PP
For exclusive toggling, add toggle actions to a QActionGroup with the QActionGroup::exclusive property set to TRUE.
.PP
Set this property's value with setToggleAction() and get this property's value with isToggleAction().
.SH "QString toolTip"
This property holds the action's tool tip.
.PP
This text is used for the tool tip. If no status tip has been set the tool tip will be used for the status tip.
.PP
If no tool tip is specified the action's text and accelerator description are used as a default tool tip.
.PP
See also statusTip and accel.
.PP
Set this property's value with setToolTip() and get this property's value with toolTip().
.SH "QString whatsThis"
This property holds the action's "What's This ?" help text.
.PP
The whats this text is used to provide a brief description of the action. The text may contain rich text (i.e. HTML tags -- see QStyleSheet for the list of supported tags).
.PP
See also QWhatsThis.
.PP
Set this property's value with setWhatsThis() and get this property's value with whatsThis().

.SH "SEE ALSO"
.BR http://doc.trolltech.com/qaction.html
.BR http://www.trolltech.com/faq/tech.html
.SH COPYRIGHT
Copyright 1992-2001 Trolltech AS, 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 Qt documentation is provided in HTML format; it is
located at $QTDIR/doc/html and can be read using Qt 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 [e-mail] .
Please include the name of the manual page (qaction.3qt) and the Qt
version (3.0.0).