Sophie

Sophie

distrib > * > 2009.0 > i586 > by-pkgid > a6711891ce757817bba854bf3f25205a > files > 2403

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

<class name="QToolBox" doc="/**
&lt;p&gt;The &lt;a href=&quot;QToolBox.html#QToolBox(com.trolltech.qt.gui.QWidget, com.trolltech.qt.core.Qt.WindowFlags)&quot;&gt;&lt;tt&gt;QToolBox&lt;/tt&gt;&lt;/a&gt; class provides a column of tabbed widget items.&lt;/p&gt;
&lt;p&gt;A toolbox is a widget that displays a column of tabs one above the other, with the current item displayed below the current tab. Every tab has an index position within the column of tabs. A tab's item is a &lt;a href=&quot;QWidget.html#QWidget(com.trolltech.qt.gui.QWidget, com.trolltech.qt.core.Qt.WindowFlags)&quot;&gt;&lt;tt&gt;QWidget&lt;/tt&gt;&lt;/a&gt;.&lt;/p&gt;
&lt;p&gt;Each item has an &lt;a href=&quot;QToolBox.html#itemText(int)&quot;&gt;&lt;tt&gt;itemText&lt;/tt&gt;&lt;/a&gt;, an optional &lt;a href=&quot;QToolBox.html#itemIcon(int)&quot;&gt;&lt;tt&gt;itemIcon&lt;/tt&gt;&lt;/a&gt;, an optional &lt;a href=&quot;QToolBox.html#itemToolTip(int)&quot;&gt;&lt;tt&gt;itemToolTip&lt;/tt&gt;&lt;/a&gt;, and a &lt;a href=&quot;QToolBox.html#widget(int)&quot;&gt;&lt;tt&gt;widget&lt;/tt&gt;&lt;/a&gt;. The item's attributes can be changed with &lt;a href=&quot;QToolBox.html#setItemText(int, java.lang.String)&quot;&gt;&lt;tt&gt;setItemText&lt;/tt&gt;&lt;/a&gt;, &lt;a href=&quot;QToolBox.html#setItemIcon(int, com.trolltech.qt.gui.QIcon)&quot;&gt;&lt;tt&gt;setItemIcon&lt;/tt&gt;&lt;/a&gt;, and &lt;a href=&quot;QToolBox.html#setItemToolTip(int, java.lang.String)&quot;&gt;&lt;tt&gt;setItemToolTip&lt;/tt&gt;&lt;/a&gt;. Each item can be enabled or disabled individually with &lt;a href=&quot;QToolBox.html#setItemEnabled(int, boolean)&quot;&gt;&lt;tt&gt;setItemEnabled&lt;/tt&gt;&lt;/a&gt;.&lt;/p&gt;
&lt;p&gt;Items are added using &lt;a href=&quot;QToolBox.html#addItem(com.trolltech.qt.gui.QWidget, com.trolltech.qt.gui.QIcon, java.lang.String)&quot;&gt;&lt;tt&gt;addItem&lt;/tt&gt;&lt;/a&gt;, or inserted at particular positions using &lt;a href=&quot;QToolBox.html#insertItem(int, com.trolltech.qt.gui.QWidget, java.lang.String)&quot;&gt;&lt;tt&gt;insertItem&lt;/tt&gt;&lt;/a&gt;. The total number of items is given by &lt;a href=&quot;QToolBox.html#count()&quot;&gt;&lt;tt&gt;count&lt;/tt&gt;&lt;/a&gt;. Items can be deleted with delete, or removed from the toolbox with &lt;a href=&quot;QToolBox.html#removeItem(int)&quot;&gt;&lt;tt&gt;removeItem&lt;/tt&gt;&lt;/a&gt;. Combining &lt;a href=&quot;QToolBox.html#removeItem(int)&quot;&gt;&lt;tt&gt;removeItem&lt;/tt&gt;&lt;/a&gt; and &lt;a href=&quot;QToolBox.html#insertItem(int, com.trolltech.qt.gui.QWidget, java.lang.String)&quot;&gt;&lt;tt&gt;insertItem&lt;/tt&gt;&lt;/a&gt; allows you to move items to different positions.&lt;/p&gt;
&lt;p&gt;The index of the current item widget is returned by &lt;a href=&quot;QToolBox.html#currentIndex()&quot;&gt;&lt;tt&gt;currentIndex&lt;/tt&gt;&lt;/a&gt;, and set with &lt;a href=&quot;QToolBox.html#setCurrentIndex(int)&quot;&gt;&lt;tt&gt;setCurrentIndex&lt;/tt&gt;&lt;/a&gt;. The index of a particular item can be found using &lt;a href=&quot;QToolBox.html#indexOf(com.trolltech.qt.gui.QWidget)&quot;&gt;&lt;tt&gt;indexOf&lt;/tt&gt;&lt;/a&gt;, and the item at a given index is returned by item().&lt;/p&gt;
&lt;p&gt;The &lt;a href=&quot;QToolBox.html#currentChanged(int)&quot;&gt;&lt;tt&gt;currentChanged&lt;/tt&gt;&lt;/a&gt; signal is emitted when the current item is changed.&lt;/p&gt;

@see &lt;a href=&quot;QTabWidget.html&quot;&gt;&lt;tt&gt;QTabWidget&lt;/tt&gt;&lt;/a&gt; */">
    <signal name="protected final void currentChanged(int index)" doc="/**
&lt;p&gt;This signal is emitted when the current item is changed. The new current item's index is passed in &lt;tt&gt;index&lt;/tt&gt;, or -1 if there is no current item.&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(int index)&lt;/tt&gt;&lt;/dd&gt;
&lt;dd&gt;&lt;tt&gt;void mySlot()&lt;/tt&gt;&lt;/dd&gt;
&lt;/dl&gt;
 */"/>
    <signal name="protected final void customContextMenuRequested(com.trolltech.qt.core.QPoint pos)" doc="/**
&lt;p&gt;This signal is emitted when the widget's &lt;a href=&quot;QWidget.html#contextMenuPolicy()&quot;&gt;&lt;tt&gt;contextMenuPolicy&lt;/tt&gt;&lt;/a&gt; is Qt::CustomContextMenu, and the user has requested a context menu on the widget. The position &lt;tt&gt;pos&lt;/tt&gt; is the position of the context menu event that the widget receives. Normally this is in widget coordinates. The exception to this rule is &lt;a href=&quot;QAbstractScrollArea.html&quot;&gt;&lt;tt&gt;QAbstractScrollArea&lt;/tt&gt;&lt;/a&gt; and its subclasses that map the context menu event to coordinates of the viewport()&lt;/tt&gt; .&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.core.QPoint pos)&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;a href=&quot;QWidget.html#mapToGlobal(com.trolltech.qt.core.QPoint)&quot;&gt;&lt;tt&gt;mapToGlobal&lt;/tt&gt;&lt;/a&gt;, &lt;a href=&quot;QMenu.html&quot;&gt;&lt;tt&gt;QMenu&lt;/tt&gt;&lt;/a&gt;, &lt;a href=&quot;QWidget.html#contextMenuPolicy()&quot;&gt;&lt;tt&gt;contextMenuPolicy&lt;/tt&gt;&lt;/a&gt;&lt;/dd&gt;
&lt;/dl&gt;
 */"/>
    <method name="public QToolBox(com.trolltech.qt.gui.QWidget parent, com.trolltech.qt.core.Qt.WindowFlags f)" doc="/**
&lt;p&gt;Constructs a new toolbox with the given &lt;tt&gt;parent&lt;/tt&gt; and the flags, &lt;tt&gt;f&lt;/tt&gt;.&lt;/p&gt;
 */"/>
    <method name="public QToolBox(com.trolltech.qt.gui.QWidget parent)" doc="/**
&lt;p&gt;Equivalent to &lt;a href=&quot;QToolBox.html#QToolBox(com.trolltech.qt.gui.QWidget, com.trolltech.qt.core.Qt.WindowFlags)&quot;&gt;&lt;tt&gt;QToolBox&lt;/tt&gt;&lt;/a&gt;(&lt;tt&gt;parent&lt;/tt&gt;, 0). */"/>
    <method name="public QToolBox()" doc="/**
&lt;p&gt;Equivalent to &lt;a href=&quot;QToolBox.html#QToolBox(com.trolltech.qt.gui.QWidget, com.trolltech.qt.core.Qt.WindowFlags)&quot;&gt;&lt;tt&gt;QToolBox&lt;/tt&gt;&lt;/a&gt;(0, 0). */"/>
    <method name="public final int addItem(com.trolltech.qt.gui.QWidget widget, java.lang.String text)" doc="/**
&lt;p&gt;Adds the widget &lt;tt&gt;widget&lt;/tt&gt; in a new tab at bottom of the toolbox. The new tab's text is set to &lt;tt&gt;text&lt;/tt&gt;. Returns the new tab's index.&lt;/p&gt;
 */"/>
    <method name="public final int addItem(com.trolltech.qt.gui.QWidget widget, com.trolltech.qt.gui.QIcon icon, java.lang.String text)" doc="/**
&lt;p&gt;Adds the &lt;tt&gt;widget&lt;/tt&gt; in a new tab at bottom of the toolbox. The new tab's text is set to &lt;tt&gt;text&lt;/tt&gt;, and the &lt;tt&gt;icon&lt;/tt&gt; is displayed to the left of the &lt;tt&gt;text&lt;/tt&gt;. Returns the new tab's index.&lt;/p&gt;
 */"/>
    <method name="public final int count()" doc="/**
&lt;p&gt;Returns The number of items contained in the toolbox..&lt;/p&gt;
 */"/>
    <method name="public final int currentIndex()" doc="/**
&lt;p&gt;Returns The index of the current item, or -1 if the toolbox is empty..&lt;/p&gt;

@see &lt;a href=&quot;QToolBox.html#setCurrentIndex(int)&quot;&gt;&lt;tt&gt;setCurrentIndex&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QToolBox.html#indexOf(com.trolltech.qt.gui.QWidget)&quot;&gt;&lt;tt&gt;indexOf&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QToolBox.html#widget(int)&quot;&gt;&lt;tt&gt;widget&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final com.trolltech.qt.gui.QWidget currentWidget()" doc="/**
&lt;p&gt;Returns a pointer to the current widget, or 0 if there is no such item.&lt;/p&gt;

@see &lt;a href=&quot;QToolBox.html#currentIndex()&quot;&gt;&lt;tt&gt;currentIndex&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QToolBox.html#setCurrentWidget(com.trolltech.qt.gui.QWidget)&quot;&gt;&lt;tt&gt;setCurrentWidget&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final int indexOf(com.trolltech.qt.gui.QWidget widget)" doc="/**
&lt;p&gt;Returns the index of &lt;tt&gt;widget&lt;/tt&gt;, or -1 if the item does not exist.&lt;/p&gt;
 */"/>
    <method name="public final int insertItem(int index, com.trolltech.qt.gui.QWidget widget, com.trolltech.qt.gui.QIcon icon, java.lang.String text)" doc="/**
&lt;p&gt;Inserts the &lt;tt&gt;widget&lt;/tt&gt; at position &lt;tt&gt;index&lt;/tt&gt;, or at the bottom of the toolbox if &lt;tt&gt;index&lt;/tt&gt; is out of range. The new item's text is set to &lt;tt&gt;text&lt;/tt&gt;, and the &lt;tt&gt;icon&lt;/tt&gt; is displayed to the left of the &lt;tt&gt;text&lt;/tt&gt;. Returns the new item's index.&lt;/p&gt;
 */"/>
    <method name="public final int insertItem(int index, com.trolltech.qt.gui.QWidget widget, java.lang.String text)" doc="/**
&lt;p&gt;Inserts the &lt;tt&gt;widget&lt;/tt&gt; at position &lt;tt&gt;index&lt;/tt&gt;, or at the bottom of the toolbox if &lt;tt&gt;index&lt;/tt&gt; is out of range. The new item's text is set to &lt;tt&gt;text&lt;/tt&gt;. Returns the new item's index.&lt;/p&gt;
 */"/>
    <method name="public final boolean isItemEnabled(int index)" doc="/**
&lt;p&gt;Returns true if the item at position &lt;tt&gt;index&lt;/tt&gt; is enabled; otherwise returns false.&lt;/p&gt;
 */"/>
    <method name="public final com.trolltech.qt.gui.QIcon itemIcon(int index)" doc="/**
&lt;p&gt;Returns the icon of the item at position &lt;tt&gt;index&lt;/tt&gt;, or a null icon if &lt;tt&gt;index&lt;/tt&gt; is out of range.&lt;/p&gt;

@see &lt;a href=&quot;QToolBox.html#setItemIcon(int, com.trolltech.qt.gui.QIcon)&quot;&gt;&lt;tt&gt;setItemIcon&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final java.lang.String itemText(int index)" doc="/**
&lt;p&gt;Returns the text of the item at position &lt;tt&gt;index&lt;/tt&gt;, or an empty string if &lt;tt&gt;index&lt;/tt&gt; is out of range.&lt;/p&gt;

@see &lt;a href=&quot;QToolBox.html#setItemText(int, java.lang.String)&quot;&gt;&lt;tt&gt;setItemText&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final java.lang.String itemToolTip(int index)" doc="/**
&lt;p&gt;Returns the tooltip of the item at position &lt;tt&gt;index&lt;/tt&gt;, or an empty string if &lt;tt&gt;index&lt;/tt&gt; is out of range.&lt;/p&gt;

@see &lt;a href=&quot;QToolBox.html#setItemToolTip(int, java.lang.String)&quot;&gt;&lt;tt&gt;setItemToolTip&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void removeItem(int index)" doc="/**
&lt;p&gt;Removes the item at position &lt;tt&gt;index&lt;/tt&gt; from the toolbox. Note that the widget is &lt;i&gt;not&lt;/i&gt; deleted.&lt;/p&gt;
 */"/>
    <method name="public final void setCurrentIndex(int index)" doc="/**
&lt;p&gt;Sets The index of the current item, or -1 if the toolbox is empty. to &lt;tt&gt;index&lt;/tt&gt;.&lt;/p&gt;

@see &lt;a href=&quot;QToolBox.html#currentIndex()&quot;&gt;&lt;tt&gt;currentIndex&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QToolBox.html#indexOf(com.trolltech.qt.gui.QWidget)&quot;&gt;&lt;tt&gt;indexOf&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QToolBox.html#widget(int)&quot;&gt;&lt;tt&gt;widget&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void setCurrentWidget(com.trolltech.qt.gui.QWidget widget)" doc="/**
&lt;p&gt;Makes&lt;tt&gt;widget&lt;/tt&gt; the current widget. The &lt;tt&gt;widget&lt;/tt&gt; must be an item in this tool box.&lt;/p&gt;

@see &lt;a href=&quot;QToolBox.html#addItem(com.trolltech.qt.gui.QWidget, com.trolltech.qt.gui.QIcon, java.lang.String)&quot;&gt;&lt;tt&gt;addItem&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QToolBox.html#setCurrentIndex(int)&quot;&gt;&lt;tt&gt;setCurrentIndex&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QToolBox.html#currentWidget()&quot;&gt;&lt;tt&gt;currentWidget&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void setItemEnabled(int index, boolean enabled)" doc="/**
&lt;p&gt;If &lt;tt&gt;enabled&lt;/tt&gt; is true then the item at position &lt;tt&gt;index&lt;/tt&gt; is enabled; otherwise the item at position &lt;tt&gt;index&lt;/tt&gt; is disabled.&lt;/p&gt;

@see &lt;a href=&quot;QToolBox.html#isItemEnabled(int)&quot;&gt;&lt;tt&gt;isItemEnabled&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void setItemIcon(int index, com.trolltech.qt.gui.QIcon icon)" doc="/**
&lt;p&gt;Sets the icon of the item at position &lt;tt&gt;index&lt;/tt&gt; to &lt;tt&gt;icon&lt;/tt&gt;.&lt;/p&gt;

@see &lt;a href=&quot;QToolBox.html#itemIcon(int)&quot;&gt;&lt;tt&gt;itemIcon&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void setItemText(int index, java.lang.String text)" doc="/**
&lt;p&gt;Sets the text of the item at position &lt;tt&gt;index&lt;/tt&gt; to &lt;tt&gt;text&lt;/tt&gt;.&lt;/p&gt;
&lt;p&gt;If the provided text contains an ampersand character ('&amp;amp;'), a mnemonic is automatically created for it. The character that follows the '&amp;amp;' will be used as the shortcut key. Any previous mnemonic will be overwritten, or cleared if no mnemonic is defined by the text. See the &lt;a href=&quot;QShortcut.html#mnemonic&quot;&gt;QShortcut&lt;/a&gt; documentation for details (to display an actual ampersand, use '&amp;amp;&amp;amp;').&lt;/p&gt;

@see &lt;a href=&quot;QToolBox.html#itemText(int)&quot;&gt;&lt;tt&gt;itemText&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void setItemToolTip(int index, java.lang.String toolTip)" doc="/**
&lt;p&gt;Sets the tooltip of the item at position &lt;tt&gt;index&lt;/tt&gt; to &lt;tt&gt;toolTip&lt;/tt&gt;.&lt;/p&gt;

@see &lt;a href=&quot;QToolBox.html#itemToolTip(int)&quot;&gt;&lt;tt&gt;itemToolTip&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final com.trolltech.qt.gui.QWidget widget(int index)" doc="/**
&lt;p&gt;Returns the widget at position &lt;tt&gt;index&lt;/tt&gt;, or 0 if there is no such item.&lt;/p&gt;
 */"/>
    <method name="protected void changeEvent(com.trolltech.qt.core.QEvent arg__1)" doc="/**
&lt;p&gt;This function is reimplemented for internal reasons.&lt;/p&gt;
 */"/>
    <method name="public boolean event(com.trolltech.qt.core.QEvent e)" doc="/**
&lt;p&gt;This function is reimplemented for internal reasons.&lt;/p&gt;
 */"/>
    <method name="protected void itemInserted(int index)" doc="/**
&lt;p&gt;This virtual handler is called after a new item was added or inserted at position &lt;tt&gt;index&lt;/tt&gt;.&lt;/p&gt;

@see &lt;a href=&quot;QToolBox.html#itemRemoved(int)&quot;&gt;&lt;tt&gt;itemRemoved&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="protected void itemRemoved(int index)" doc="/**
&lt;p&gt;This virtual handler is called after an item was removed from position &lt;tt&gt;index&lt;/tt&gt;.&lt;/p&gt;

@see &lt;a href=&quot;QToolBox.html#itemInserted(int)&quot;&gt;&lt;tt&gt;itemInserted&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="protected void showEvent(com.trolltech.qt.gui.QShowEvent e)" doc="/**
&lt;p&gt;This function is reimplemented for internal reasons.&lt;/p&gt;
 */"/>
</class>