Sophie

Sophie

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

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

<class name="QWorkspace" doc="/**
&lt;p&gt;The &lt;a href=&quot;QWorkspace.html#QWorkspace(com.trolltech.qt.gui.QWidget)&quot;&gt;&lt;tt&gt;QWorkspace&lt;/tt&gt;&lt;/a&gt; widget provides a workspace window that can be used in an MDI application.&lt;/p&gt;
&lt;p&gt;Multiple Document Interface (MDI) applications are typically composed of a main window containing a menu bar, a toolbar, and a central &lt;a href=&quot;QWorkspace.html#QWorkspace(com.trolltech.qt.gui.QWidget)&quot;&gt;&lt;tt&gt;QWorkspace&lt;/tt&gt;&lt;/a&gt; widget. The workspace itself is used to display a number of child windows, each of which is a widget.&lt;/p&gt;
&lt;p&gt;The workspace itself is an ordinary Qt widget. It has a standard constructor that takes a parent widget. Workspaces can be placed in any layout, but are typically given as the central widget in a &lt;a href=&quot;QMainWindow.html&quot;&gt;&lt;tt&gt;QMainWindow&lt;/tt&gt;&lt;/a&gt;:&lt;/p&gt;
&lt;pre&gt;    MainWindow::MainWindow()
    {
        workspace = new QWorkspace;
        setCentralWidget(workspace);
        ...
    }&lt;/pre&gt;
&lt;p&gt;Child windows (MDI windows) are standard Qt widgets that are inserted into the workspace with &lt;a href=&quot;QWorkspace.html#addWindow(com.trolltech.qt.gui.QWidget, com.trolltech.qt.core.Qt.WindowFlags)&quot;&gt;&lt;tt&gt;addWindow&lt;/tt&gt;&lt;/a&gt;. As with top-level widgets, you can call functions such as &lt;a href=&quot;QWidget.html#show()&quot;&gt;&lt;tt&gt;show&lt;/tt&gt;&lt;/a&gt;, &lt;a href=&quot;QWidget.html#hide()&quot;&gt;&lt;tt&gt;hide&lt;/tt&gt;&lt;/a&gt;, &lt;a href=&quot;QWidget.html#showMaximized()&quot;&gt;&lt;tt&gt;showMaximized&lt;/tt&gt;&lt;/a&gt;, and &lt;a href=&quot;QWidget.html#setWindowTitle(java.lang.String)&quot;&gt;&lt;tt&gt;setWindowTitle&lt;/tt&gt;&lt;/a&gt; on a child window to change its appearance within the workspace. You can also provide widget flags to determine the layout of the decoration or the behavior of the widget itself.&lt;/p&gt;
&lt;p&gt;To change or retrieve the geometry of a child window, you must operate on its &lt;a href=&quot;QWidget.html#parentWidget()&quot;&gt;&lt;tt&gt;parentWidget&lt;/tt&gt;&lt;/a&gt;. The &lt;a href=&quot;QWidget.html#parentWidget()&quot;&gt;&lt;tt&gt;parentWidget&lt;/tt&gt;&lt;/a&gt; provides access to the decorated frame that contains the child window widget. When a child window is maximised, its decorated frame is hidden. If the top-level widget contains a menu bar, it will display the maximised window's operations menu to the left of the menu entries, and the window's controls to the right.&lt;/p&gt;
&lt;p&gt;A child window becomes active when it gets the keyboard focus, or when &lt;a href=&quot;QWidget.html#setFocus()&quot;&gt;&lt;tt&gt;setFocus&lt;/tt&gt;&lt;/a&gt; is called. The user can activate a window by moving focus in the usual ways, for example by clicking a window or by pressing Tab. The workspace emits a signal &lt;a href=&quot;QWorkspace.html#windowActivated(com.trolltech.qt.gui.QWidget)&quot;&gt;&lt;tt&gt;windowActivated&lt;/tt&gt;&lt;/a&gt; when the active window changes, and the function &lt;a href=&quot;QWorkspace.html#activeWindow()&quot;&gt;&lt;tt&gt;activeWindow&lt;/tt&gt;&lt;/a&gt; returns a pointer to the active child window, or 0 if no window is active.&lt;/p&gt;
&lt;p&gt;The convenience function &lt;a href=&quot;QWorkspace.html#windowList(com.trolltech.qt.gui.QWorkspace.WindowOrder)&quot;&gt;&lt;tt&gt;windowList&lt;/tt&gt;&lt;/a&gt; returns a list of all child windows. This information could be used in a popup menu containing a list of windows, for example. This feature is also available as part of the Window Menu&lt;/tt&gt; Solution.&lt;/p&gt;
&lt;p&gt;&lt;a href=&quot;QWorkspace.html#QWorkspace(com.trolltech.qt.gui.QWidget)&quot;&gt;&lt;tt&gt;QWorkspace&lt;/tt&gt;&lt;/a&gt; provides two built-in layout strategies for child windows: &lt;a href=&quot;QWorkspace.html#cascade()&quot;&gt;&lt;tt&gt;cascade&lt;/tt&gt;&lt;/a&gt; and &lt;a href=&quot;QWorkspace.html#tile()&quot;&gt;&lt;tt&gt;tile&lt;/tt&gt;&lt;/a&gt;. Both are slots so you can easily connect menu entries to them.&lt;/p&gt;
&lt;p align=&quot;center&quot;&gt;&lt;img src=&quot;%2E%2E/images/qworkspace-arrange.png&quot; /&gt;&lt;/p&gt;&lt;p&gt;If you want your users to be able to work with child windows larger than the visible workspace area, set the &lt;a href=&quot;QWorkspace.html#scrollBarsEnabled()&quot;&gt;&lt;tt&gt;scrollBarsEnabled&lt;/tt&gt;&lt;/a&gt; property to true.&lt;/p&gt;

@see &lt;a href=&quot;%2E%2E/porting4.html#qdockwindow&quot;&gt;&lt;tt&gt;QDockWindow&lt;/tt&gt;&lt;/a&gt;
@see MDI Example&lt;/tt&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;
 */"/>
    <signal name="protected final void windowActivated(com.trolltech.qt.gui.QWidget w)" doc="/**
&lt;p&gt;This signal is emitted when the child window &lt;tt&gt;w&lt;/tt&gt; becomes active. Note that &lt;tt&gt;w&lt;/tt&gt; can be 0, and that more than one signal may be emitted for a single activation event.&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.QWidget w)&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;QWorkspace.html#activeWindow()&quot;&gt;&lt;tt&gt;activeWindow&lt;/tt&gt;&lt;/a&gt;, &lt;a href=&quot;QWorkspace.html#windowList(com.trolltech.qt.gui.QWorkspace.WindowOrder)&quot;&gt;&lt;tt&gt;windowList&lt;/tt&gt;&lt;/a&gt;&lt;/dd&gt;
&lt;/dl&gt;
 */"/>
    <method name="public QWorkspace(com.trolltech.qt.gui.QWidget parent)" doc="/**
&lt;p&gt;Constructs a workspace with the given &lt;tt&gt;parent&lt;/tt&gt;.&lt;/p&gt;
 */"/>
    <method name="public QWorkspace()" doc="/**
&lt;p&gt;Equivalent to &lt;a href=&quot;QWorkspace.html#QWorkspace(com.trolltech.qt.gui.QWidget)&quot;&gt;&lt;tt&gt;QWorkspace&lt;/tt&gt;&lt;/a&gt;(0). */"/>
    <method name="public final void activateNextWindow()" doc="/**
&lt;p&gt;Gives the input focus to the next window in the list of child windows.&lt;/p&gt;

@see &lt;a href=&quot;QWorkspace.html#activatePreviousWindow()&quot;&gt;&lt;tt&gt;activatePreviousWindow&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void activatePreviousWindow()" doc="/**
&lt;p&gt;Gives the input focus to the previous window in the list of child windows.&lt;/p&gt;

@see &lt;a href=&quot;QWorkspace.html#activateNextWindow()&quot;&gt;&lt;tt&gt;activateNextWindow&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final com.trolltech.qt.gui.QWidget activeWindow()" doc="/**
&lt;p&gt;Returns a pointer to the widget corresponding to the active child window, or 0 if no window is active.&lt;/p&gt;

@see &lt;a href=&quot;QWorkspace.html#setActiveWindow(com.trolltech.qt.gui.QWidget)&quot;&gt;&lt;tt&gt;setActiveWindow&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final com.trolltech.qt.gui.QWidget addWindow(com.trolltech.qt.gui.QWidget w, com.trolltech.qt.core.Qt.WindowFlags flags)" doc="/**
&lt;p&gt;Adds widget &lt;tt&gt;w&lt;/tt&gt; as new sub window to the workspace. If &lt;tt&gt;flags&lt;/tt&gt; are non-zero, they will override the flags set on the widget.&lt;/p&gt;
&lt;p&gt;Returns the widget used for the window frame.&lt;/p&gt;
&lt;p&gt;To remove the widget &lt;tt&gt;w&lt;/tt&gt; from the workspace, simply call &lt;a href=&quot;QWidget.html#setParent(com.trolltech.qt.gui.QWidget, com.trolltech.qt.core.Qt.WindowFlags)&quot;&gt;&lt;tt&gt;setParent&lt;/tt&gt;&lt;/a&gt; with the new parent (or 0 to make it a stand-alone window).&lt;/p&gt;
 */"/>
    <method name="public final com.trolltech.qt.gui.QWidget addWindow(com.trolltech.qt.gui.QWidget w)" doc="/**
&lt;p&gt;Equivalent to &lt;a href=&quot;QWorkspace.html#addWindow(com.trolltech.qt.gui.QWidget, com.trolltech.qt.core.Qt.WindowFlags)&quot;&gt;&lt;tt&gt;addWindow&lt;/tt&gt;&lt;/a&gt;(&lt;tt&gt;w&lt;/tt&gt;, 0). */"/>
    <method name="public final void arrangeIcons()" doc="/**
&lt;p&gt;Arranges all iconified windows at the bottom of the workspace.&lt;/p&gt;

@see &lt;a href=&quot;QWorkspace.html#cascade()&quot;&gt;&lt;tt&gt;cascade&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QWorkspace.html#tile()&quot;&gt;&lt;tt&gt;tile&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final com.trolltech.qt.gui.QBrush background()" doc="/**
&lt;p&gt;Returns the workspace's background.&lt;/p&gt;

@see &lt;a href=&quot;QWorkspace.html#setBackground(com.trolltech.qt.gui.QBrush)&quot;&gt;&lt;tt&gt;setBackground&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void cascade()" doc="/**
&lt;p&gt;Arranges all the child windows in a cascade pattern.&lt;/p&gt;

@see &lt;a href=&quot;QWorkspace.html#tile()&quot;&gt;&lt;tt&gt;tile&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QWorkspace.html#arrangeIcons()&quot;&gt;&lt;tt&gt;arrangeIcons&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void closeActiveWindow()" doc="/**
&lt;p&gt;Closes the child window that is currently active.&lt;/p&gt;

@see &lt;a href=&quot;QWorkspace.html#closeAllWindows()&quot;&gt;&lt;tt&gt;closeAllWindows&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void closeAllWindows()" doc="/**
&lt;p&gt;Closes all child windows.&lt;/p&gt;
&lt;p&gt;If any child window fails to accept the close event, the remaining windows will remain open.&lt;/p&gt;

@see &lt;a href=&quot;QWorkspace.html#closeActiveWindow()&quot;&gt;&lt;tt&gt;closeActiveWindow&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final boolean scrollBarsEnabled()" doc="/**
&lt;p&gt;Returns whether the workspace provides scroll bars.&lt;/p&gt;
&lt;p&gt;If this property is true, the workspace will provide scroll bars if any of the child windows extend beyond the edges of the visible workspace. The workspace area will automatically increase to contain child windows if they are resized beyond the right or bottom edges of the visible area.&lt;/p&gt;
&lt;p&gt;If this property is false (the default), resizing child windows out of the visible area of the workspace is not permitted, although it is still possible to position them partially outside the visible area.&lt;/p&gt;

@see &lt;a href=&quot;QWorkspace.html#setScrollBarsEnabled(boolean)&quot;&gt;&lt;tt&gt;setScrollBarsEnabled&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void setActiveWindow(com.trolltech.qt.gui.QWidget w)" doc="/**
&lt;p&gt;Makes the child window that contains &lt;tt&gt;w&lt;/tt&gt; the active child window.&lt;/p&gt;

@see &lt;a href=&quot;QWorkspace.html#activeWindow()&quot;&gt;&lt;tt&gt;activeWindow&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void setBackground(com.trolltech.qt.gui.QBrush background)" doc="/**
&lt;p&gt;Sets the workspace's background to &lt;tt&gt;background&lt;/tt&gt;.&lt;/p&gt;

@see &lt;a href=&quot;QWorkspace.html#background()&quot;&gt;&lt;tt&gt;background&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void setScrollBarsEnabled(boolean enable)" doc="/**
&lt;p&gt;Sets whether the workspace provides scroll bars to &lt;tt&gt;enable&lt;/tt&gt;.&lt;/p&gt;
&lt;p&gt;If this property is true, the workspace will provide scroll bars if any of the child windows extend beyond the edges of the visible workspace. The workspace area will automatically increase to contain child windows if they are resized beyond the right or bottom edges of the visible area.&lt;/p&gt;
&lt;p&gt;If this property is false (the default), resizing child windows out of the visible area of the workspace is not permitted, although it is still possible to position them partially outside the visible area.&lt;/p&gt;

@see &lt;a href=&quot;QWorkspace.html#scrollBarsEnabled()&quot;&gt;&lt;tt&gt;scrollBarsEnabled&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void tile()" doc="/**
&lt;p&gt;Arranges all child windows in a tile pattern.&lt;/p&gt;

@see &lt;a href=&quot;QWorkspace.html#cascade()&quot;&gt;&lt;tt&gt;cascade&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QWorkspace.html#arrangeIcons()&quot;&gt;&lt;tt&gt;arrangeIcons&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final java.util.List&lt;com.trolltech.qt.gui.QWidget&gt; windowList(com.trolltech.qt.gui.QWorkspace.WindowOrder order)" doc="/**
&lt;p&gt;Returns a list of all visible or minimized child windows. If &lt;tt&gt;order&lt;/tt&gt; is &lt;a href=&quot;QWorkspace.html#WindowOrder-enum&quot;&gt;&lt;tt&gt;CreationOrder&lt;/tt&gt;&lt;/a&gt; (the default), the windows are listed in the order in which they were inserted into the workspace. If &lt;tt&gt;order&lt;/tt&gt; is &lt;a href=&quot;QWorkspace.html#WindowOrder-enum&quot;&gt;&lt;tt&gt;StackingOrder&lt;/tt&gt;&lt;/a&gt;, the windows are listed in their stacking order, with the topmost window as the last item in the list.&lt;/p&gt;
 */"/>
    <method name="public final java.util.List&lt;com.trolltech.qt.gui.QWidget&gt; windowList()" doc="/**
&lt;p&gt;Equivalent to &lt;a href=&quot;QWorkspace.html#windowList(com.trolltech.qt.gui.QWorkspace.WindowOrder)&quot;&gt;&lt;tt&gt;windowList&lt;/tt&gt;&lt;/a&gt;(CreationOrder). */"/>
    <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="protected void childEvent(com.trolltech.qt.core.QChildEvent 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="public boolean eventFilter(com.trolltech.qt.core.QObject arg__1, com.trolltech.qt.core.QEvent arg__2)" doc="/**
&lt;p&gt;This function is reimplemented for internal reasons.&lt;/p&gt;
 */"/>
    <method name="protected void hideEvent(com.trolltech.qt.gui.QHideEvent e)" doc="/**
&lt;p&gt;This function is reimplemented for internal reasons.&lt;/p&gt;
 */"/>
    <method name="protected void paintEvent(com.trolltech.qt.gui.QPaintEvent e)" doc="/**
&lt;p&gt;This function is reimplemented for internal reasons.&lt;/p&gt;
 */"/>
    <method name="protected void resizeEvent(com.trolltech.qt.gui.QResizeEvent arg__1)" doc="/**
&lt;p&gt;This function is reimplemented for internal reasons.&lt;/p&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;
 */"/>
    <method name="public com.trolltech.qt.core.QSize sizeHint()" doc="/**
&lt;p&gt;This function is reimplemented for internal reasons.&lt;/p&gt;
 */"/>
    <method name="protected void wheelEvent(com.trolltech.qt.gui.QWheelEvent e)" doc="/**
&lt;p&gt;This function is reimplemented for internal reasons.&lt;/p&gt;
 */"/>
    <enum name="WindowOrder" doc="/**
&lt;p&gt;Specifies the order in which child windows are returned from &lt;a href=&quot;QWorkspace.html#windowList(com.trolltech.qt.gui.QWorkspace.WindowOrder)&quot;&gt;&lt;tt&gt;windowList&lt;/tt&gt;&lt;/a&gt;.&lt;/p&gt;
 */">
        <enum-value name="CreationOrder" doc="/**
&lt;p&gt;The windows are returned in the order of their creation&lt;/p&gt;
 */"/>
        <enum-value name="StackingOrder" doc="/**
&lt;p&gt;The windows are returned in the order of their stacking&lt;/p&gt;
 */"/>
</enum>
</class>