Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > a6711891ce757817bba854bf3f25205a > files > 1918

qtjambi-doc-4.3.3-3mdv2008.1.i586.rpm

<class name="QActionGroup" doc="/**
&lt;p&gt;The &lt;a href=&quot;QActionGroup.html#QActionGroup(com.trolltech.qt.core.QObject)&quot;&gt;&lt;tt&gt;QActionGroup&lt;/tt&gt;&lt;/a&gt; class groups actions together.&lt;/p&gt;
&lt;p&gt;In some situations it is useful to group actions together. For example, if you have a &lt;b&gt;Left Align&lt;/b&gt; action, a &lt;b&gt;Right Align&lt;/b&gt; action, a &lt;b&gt;Justify&lt;/b&gt; action, and a &lt;b&gt;Center&lt;/b&gt; action, only one of these actions should be active at any one time. One simple way of achieving this is to group the actions together in an action group.&lt;/p&gt;
&lt;p&gt;Here's a example (from the Menus&lt;/tt&gt; example):&lt;/p&gt;
&lt;pre&gt;        alignmentGroup = new QActionGroup(this);
        alignmentGroup-&amp;gt;addAction(leftAlignAct);
        alignmentGroup-&amp;gt;addAction(rightAlignAct);
        alignmentGroup-&amp;gt;addAction(justifyAct);
        alignmentGroup-&amp;gt;addAction(centerAct);
        leftAlignAct-&amp;gt;setChecked(true);&lt;/pre&gt;
&lt;p&gt;Here we create a new action group. Since the action group is exclusive by default, only one of the actions in the group is checked at any one time.&lt;/p&gt;
&lt;p align=&quot;center&quot;&gt;&lt;img src=&quot;%2E%2E/images/qactiongroup-align.png&quot; alt=&quot;Alignment options in a QMenu&quot; /&gt;&lt;/p&gt;&lt;p&gt;A &lt;a href=&quot;QActionGroup.html#QActionGroup(com.trolltech.qt.core.QObject)&quot;&gt;&lt;tt&gt;QActionGroup&lt;/tt&gt;&lt;/a&gt; emits an &lt;a href=&quot;QActionGroup.html#triggered(com.trolltech.qt.gui.QAction)&quot;&gt;&lt;tt&gt;triggered&lt;/tt&gt;&lt;/a&gt; signal when one of its actions is chosen. Each action in an action group emits its &lt;a href=&quot;QActionGroup.html#triggered(com.trolltech.qt.gui.QAction)&quot;&gt;&lt;tt&gt;triggered&lt;/tt&gt;&lt;/a&gt; signal as usual.&lt;/p&gt;
&lt;p&gt;As stated above, an action group is exclusive&lt;/tt&gt; by default; it ensures that only one checkable action is active at any one time. If you want to group checkable actions without making them exclusive, you can turn of exclusiveness by calling &lt;a href=&quot;QActionGroup.html#setExclusive(boolean)&quot;&gt;&lt;tt&gt;setExclusive&lt;/tt&gt;&lt;/a&gt;(false).&lt;/p&gt;
&lt;p&gt;Actions can be added to an action group using &lt;a href=&quot;QActionGroup.html#addAction(com.trolltech.qt.gui.QIcon, java.lang.String)&quot;&gt;&lt;tt&gt;addAction&lt;/tt&gt;&lt;/a&gt;, but it is usually more convenient to specify a group when creating actions; this ensures that actions are automatically created with a parent. Actions can be visually separated from each other by adding a separator action to the group; create an action and use &lt;a href=&quot;QAction.html&quot;&gt;&lt;tt&gt;QAction&lt;/tt&gt;&lt;/a&gt;'s setSeparator() function to make it considered a separator. Action groups are added to widgets with the QWidget::addActions() function.&lt;/p&gt;

@see &lt;a href=&quot;QAction.html&quot;&gt;&lt;tt&gt;QAction&lt;/tt&gt;&lt;/a&gt; */">
    <signal name="protected final void hovered(com.trolltech.qt.gui.QAction arg__1)" doc="/**
&lt;p&gt;This signal is emitted when the given &lt;tt&gt;arg__1&lt;/tt&gt; in the action group is highlighted by the user; for example, when the user pauses with the cursor over a menu option, toolbar button, or presses an action's shortcut key combination.&lt;/p&gt;
&lt;dl&gt;
&lt;dt&gt;&lt;b&gt;Compatible Slot Signatures:&lt;/b&gt;&lt;/dt&gt;
&lt;dd&gt;&lt;tt&gt;void mySlot(com.trolltech.qt.gui.QAction arg__1)&lt;/tt&gt;&lt;/dd&gt;
&lt;dd&gt;&lt;tt&gt;void mySlot()&lt;/tt&gt;&lt;/dd&gt;
&lt;/dl&gt;
&lt;dl&gt;
&lt;dt&gt;&lt;b&gt;See Also:&lt;/b&gt;&lt;/dt&gt;
&lt;dd&gt;&lt;tt&gt;QAction::activate&lt;/tt&gt;&lt;/dd&gt;
&lt;/dl&gt;
 */"/>
    <signal name="protected final void triggered(com.trolltech.qt.gui.QAction arg__1)" doc="/**
&lt;p&gt;This signal is emitted when the given &lt;tt&gt;arg__1&lt;/tt&gt; in the action group is activated by the user; for example, when the user clicks a menu option, toolbar button, or presses an action's shortcut key combination.&lt;/p&gt;
&lt;p&gt;Connect to this signal for command actions.&lt;/p&gt;
&lt;dl&gt;
&lt;dt&gt;&lt;b&gt;Compatible Slot Signatures:&lt;/b&gt;&lt;/dt&gt;
&lt;dd&gt;&lt;tt&gt;void mySlot(com.trolltech.qt.gui.QAction arg__1)&lt;/tt&gt;&lt;/dd&gt;
&lt;dd&gt;&lt;tt&gt;void mySlot()&lt;/tt&gt;&lt;/dd&gt;
&lt;/dl&gt;
&lt;dl&gt;
&lt;dt&gt;&lt;b&gt;See Also:&lt;/b&gt;&lt;/dt&gt;
&lt;dd&gt;&lt;tt&gt;QAction::activate&lt;/tt&gt;&lt;/dd&gt;
&lt;/dl&gt;
 */"/>
    <method name="public QActionGroup(com.trolltech.qt.core.QObject parent)" doc="/**
&lt;p&gt;Constructs an action group for the &lt;tt&gt;parent&lt;/tt&gt; object.&lt;/p&gt;
&lt;p&gt;The action group is exclusive by default. Call &lt;a href=&quot;QActionGroup.html#setExclusive(boolean)&quot;&gt;&lt;tt&gt;setExclusive&lt;/tt&gt;&lt;/a&gt;(false) to make the action group non-exclusive.&lt;/p&gt;
 */"/>
    <method name="public final java.util.List&lt;com.trolltech.qt.gui.QAction&gt; actions()" doc="/**
&lt;p&gt;Returns the list of this groups's actions. This may be empty.&lt;/p&gt;
 */"/>
    <method name="public final com.trolltech.qt.gui.QAction addAction(com.trolltech.qt.gui.QAction a)" doc="/**
&lt;p&gt;Adds the &lt;tt&gt;a&lt;/tt&gt; to this group, and returns it.&lt;/p&gt;
&lt;p&gt;Normally an action is added to a group by creating it with the group as its parent, so this function is not usually used.&lt;/p&gt;

@see &lt;tt&gt;QAction::setActionGroup&lt;/tt&gt; */"/>
    <method name="public final com.trolltech.qt.gui.QAction addAction(java.lang.String text)" doc="/**
&lt;p&gt;Creates and returns an action with &lt;tt&gt;text&lt;/tt&gt;. The newly created action is a child of this action group.&lt;/p&gt;
&lt;p&gt;Normally an action is added to a group by creating it with the group as parent, so this function is not usually used.&lt;/p&gt;

@see &lt;tt&gt;QAction::setActionGroup&lt;/tt&gt; */"/>
    <method name="public final com.trolltech.qt.gui.QAction addAction(com.trolltech.qt.gui.QIcon icon, java.lang.String text)" doc="/**
&lt;p&gt;Creates and returns an action with &lt;tt&gt;text&lt;/tt&gt; and an &lt;tt&gt;icon&lt;/tt&gt;. The newly created action is a child of this action group.&lt;/p&gt;
&lt;p&gt;Normally an action is added to a group by creating it with the group as its parent, so this function is not usually used.&lt;/p&gt;

@see &lt;tt&gt;QAction::setActionGroup&lt;/tt&gt; */"/>
    <method name="public final com.trolltech.qt.gui.QAction checkedAction()" doc="/**
&lt;p&gt;Returns the currently checked action in the group, or 0 if none are checked.&lt;/p&gt;
 */"/>
    <method name="public final boolean isEnabled()" doc="/**
&lt;p&gt;Returns whether the action group is enabled.&lt;/p&gt;
&lt;p&gt;Each action in the group will be enabled or disabled unless it has been explicitly disabled.&lt;/p&gt;

@see &lt;tt&gt;QAction::setEnabled&lt;/tt&gt; */"/>
    <method name="public final boolean isExclusive()" doc="/**
&lt;p&gt;Returns whether the action group does exclusive checking.&lt;/p&gt;
&lt;p&gt;If exclusive is true, only one checkable action in the action group can ever be active at any time. If the user chooses another checkable action in the group, the one they chose becomes active and the one that was active becomes inactive.&lt;/p&gt;

@see &lt;tt&gt;QAction::checkable&lt;/tt&gt; */"/>
    <method name="public final boolean isVisible()" doc="/**
&lt;p&gt;Returns whether the action group is visible.&lt;/p&gt;
&lt;p&gt;Each action in the action group will match the visible state of this group unless it has been explicitly hidden.&lt;/p&gt;

@see &lt;tt&gt;QAction::setEnabled&lt;/tt&gt; */"/>
    <method name="public final void removeAction(com.trolltech.qt.gui.QAction a)" doc="/**
&lt;p&gt;Removes the &lt;tt&gt;a&lt;/tt&gt; from this group. The action will have no parent as a result.&lt;/p&gt;

@see &lt;tt&gt;QAction::setActionGroup&lt;/tt&gt; */"/>
    <method name="public final void setDisabled(boolean b)" doc="/**
&lt;p&gt;This is a convenience function for the enabled&lt;/tt&gt; property, that is useful for signals--slots connections. If &lt;tt&gt;b&lt;/tt&gt; is true the action group is disabled; otherwise it is enabled.&lt;/p&gt;
 */"/>
    <method name="public final void setEnabled(boolean arg__1)" doc="/**
&lt;p&gt;Sets whether the action group is enabled to &lt;tt&gt;arg__1&lt;/tt&gt;.&lt;/p&gt;
&lt;p&gt;Each action in the group will be enabled or disabled unless it has been explicitly disabled.&lt;/p&gt;

@see &lt;a href=&quot;QActionGroup.html#isEnabled()&quot;&gt;&lt;tt&gt;isEnabled&lt;/tt&gt;&lt;/a&gt;
@see &lt;tt&gt;QAction::setEnabled&lt;/tt&gt; */"/>
    <method name="public final void setExclusive(boolean arg__1)" doc="/**
&lt;p&gt;Sets whether the action group does exclusive checking to &lt;tt&gt;arg__1&lt;/tt&gt;.&lt;/p&gt;
&lt;p&gt;If exclusive is true, only one checkable action in the action group can ever be active at any time. If the user chooses another checkable action in the group, the one they chose becomes active and the one that was active becomes inactive.&lt;/p&gt;

@see &lt;a href=&quot;QActionGroup.html#isExclusive()&quot;&gt;&lt;tt&gt;isExclusive&lt;/tt&gt;&lt;/a&gt;
@see &lt;tt&gt;QAction::checkable&lt;/tt&gt; */"/>
    <method name="public final void setVisible(boolean arg__1)" doc="/**
&lt;p&gt;Sets whether the action group is visible to &lt;tt&gt;arg__1&lt;/tt&gt;.&lt;/p&gt;
&lt;p&gt;Each action in the action group will match the visible state of this group unless it has been explicitly hidden.&lt;/p&gt;

@see &lt;a href=&quot;QActionGroup.html#isVisible()&quot;&gt;&lt;tt&gt;isVisible&lt;/tt&gt;&lt;/a&gt;
@see &lt;tt&gt;QAction::setEnabled&lt;/tt&gt; */"/>
</class>