Q3Action Class Reference

 #include <Q3Action>

Member Function Documentation

Q3Action::Q3Action ( QObject * parent, const char * name = 0 )

Constructs an action called name with parent parent.

If parent is a Q3ActionGroup, the new action inserts itself into parent.

For accelerators and status tips to work, parent must either be a widget, or an action group whose parent is a widget.

Warning: To prevent recursion, don't create an action as a child of a widget that the action is later added to.

Q3Action::Q3Action ( const QString & menuText, QKeySequence accel, QObject * parent, const char * name = 0 )

This constructor results in an icon-less action with the menu text menuText and keyboard accelerator accel. It is a child of parent and called name.

If parent is a Q3ActionGroup, the action automatically becomes a member of it.

For accelerators and status tips to work, parent must either be a widget, or an action group whose parent is a widget.

The action uses a stripped version of menuText (e.g. "&Menu Option..." becomes "Menu Option") as descriptive text for tool buttons. You can override this by setting a specific description with setText(). The same text and accel will be used for tool tips and status tips unless you provide text for these using setToolTip() and setStatusTip().

Call setToggleAction(true) to make the action a toggle action.

Warning: To prevent recursion, don't create an action as a child of a widget that the action is later added to.

Q3Action::Q3Action ( const QIcon & icon, const QString & menuText, QKeySequence accel, QObject * parent, const char * name = 0 )

This constructor creates an action with the following properties: the icon or icon icon, the menu text menuText and keyboard accelerator accel. It is a child of parent and called name.

If parent is a Q3ActionGroup, the action automatically becomes a member of it.

For accelerators and status tips to work, parent must either be a widget, or an action group whose parent is a widget.

The action uses a stripped version of menuText (e.g. "&Menu Option..." becomes "Menu Option") as descriptive text for tool buttons. You can override this by setting a specific description with setText(). The same text and accel will be used for tool tips and status tips unless you provide text for these using setToolTip() and setStatusTip().

Call setToggleAction(true) to make the action a toggle action.

Warning: To prevent recursion, don't create an action as a child of a widget that the action is later added to.

Q3Action::Q3Action ( const QString & text, const QIcon & icon, const QString & menuText, QKeySequence accel, QObject * parent, const char * name = 0, bool toggle = false )

This constructor creates an action with the following properties: the description text, the icon or icon icon, the menu text menuText and keyboard accelerator accel. It is a child of parent and called name. If toggle is true the action will be a toggle action, otherwise it will be a command action.

If parent is a Q3ActionGroup, the action automatically becomes a member of it.

For accelerators and status tips to work, parent must either be a widget, or an action group whose parent is a widget.

The text and accel will be used for tool tips and status tips unless you provide specific text for these using setToolTip() and setStatusTip().

Q3Action::Q3Action ( const QString & text, const QString & menuText, QKeySequence accel, QObject * parent, const char * name = 0, bool toggle = false )

This constructor results in an icon-less action with the description text, the menu text menuText and the keyboard accelerator accel. Its parent is parent and it is called name. If toggle is true the action will be a toggle action, otherwise it will be a command action.

The action automatically becomes a member of parent if parent is a Q3ActionGroup.

For accelerators and status tips to work, parent must either be a widget, or an action group whose parent is a widget.

The text and accel will be used for tool tips and status tips unless you provide specific text for these using setToolTip() and setStatusTip().

Q3Action::Q3Action ( QObject * parent, const char * name, bool toggle )

Constructs an action called name with parent parent.

If toggle is true the action will be a toggle action, otherwise it will be a command action.

If parent is a Q3ActionGroup, the new action inserts itself into parent.

For accelerators and status tips to work, parent must either be a widget, or an action group whose parent is a widget.

Q3Action::~Q3Action ()

Destroys the object and frees allocated resources.

void Q3Action::activate () [slot]

Activates the action and executes all connected slots. This only works for actions that are not toggle actions.

See also toggle().

void Q3Action::activated () [signal]

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.

Connect to this signal for command actions. Connect to the toggled() signal for toggle actions.

bool Q3Action::addTo ( QWidget * w ) [virtual]

Adds this action to widget w.

Currently actions may be added to Q3ToolBar and Q3PopupMenu widgets.

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.

addTo() returns true if the action was added successfully and false otherwise. (If w is not a Q3ToolBar or Q3PopupMenu the action will not be added and false will be returned.)

See also removeFrom().

void Q3Action::addedTo ( QWidget * actionWidget, QWidget * container ) [virtual protected]

This function is called from the addTo() function when it has created a widget (actionWidget) for the action in the container.

void Q3Action::addedTo ( int index, Q3PopupMenu * menu ) [virtual protected]

This is an overloaded function.

This function is called from the addTo() function when it has created a menu item at the index position index in the popup menu menu.

bool Q3Action::removeFrom ( QWidget * w ) [virtual]

Removes the action from widget w.

Returns true if the action was removed successfully; otherwise returns false.

See also addTo().

void Q3Action::setDisabled ( bool disable ) [slot]

Disables the action if disable is true; otherwise enables the action.

See the enabled documentation for more information.

void Q3Action::toggle () [slot]

Toggles the state of a toggle action.

See also on, activate(), toggled(), and isToggleAction().

void Q3Action::toggled ( bool on ) [signal]

This signal is emitted when a toggle action changes state; command actions and Q3ActionGroups don't emit toggled().

The on argument denotes the new state: If on is true the toggle action is switched on, and if on is false the toggle action is switched off.

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.

See also activated(), setToggleAction(), and setOn().