You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
pytde/doc/classref/tdeui/KDockWidget.html

321 lines
19 KiB

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN
"http://www.w3.org/TR/html4/loose.dtd"">
<html>
<head>
<title>class KDockWidget</title>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<meta name="GENERATOR" content="wabbit dumphtml">
</head>
<body>
<h4>PyKDE - Python Bindings for KDE</h4>
<hr>
<table width="100%"><tr>
<td width ="70%">
<h1>class KDockWidget</h1><hr>
</td>
<td width="30%" valign="top" align="right">
<table>
<tr><td align="right"><a href="doc/index.html">Table of contents</a></td></tr>
<tr><td align="right"><a href="../index.html">Modules</a></td></tr>
<tr><td align="right"><a href="index.html">tdeui Classes</a></td></tr>
<tr><td align="right"><a href="../allclasses.html">All Classes</a></td></tr>
</table>
</td>
</tr></table>
<table>
<tr><td width="10%" align=left>Module</td>
<td width="30%" align=left>tdeui</td>
</tr>
<tr><td>Class</td>
<td>KDockWidget</td>
</tr>
<tr><td>Inherits</td>
<td>TQWidget </td>
</tr>
</table>
<h3>enums</h3><ul>
<li><b>DockPosition</b> = {DockNone, DockTop, DockLeft, DockRight, DockBottom, DockCenter, DockDesktop, DockToSpecialSites, DockCorner, DockFullSite, DockFullDocking
}<li><b>DockPosition</b> = {DockNone, DockTop, DockLeft, DockRight, DockBottom, DockCenter, DockDesktop, DockCorner, DockFullSite, DockFullDocking
}</ul>
<h3>methods</h3><ul>
<li><b>KDockWidget</b> (dockManager, name, pixmap, parent = 0, strCaption = 0, strTabPageLabel = " ", f = 0)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>a KDockWidget instance</i></td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>dockManager</td><td>KDockManager</td><td></td></tr>
<tr><td>name</td><td>char</td><td></td></tr>
<tr><td>pixmap</td><td>TQPixmap</td><td></td></tr>
<tr><td>parent</td><td>TQWidget</td><td>0</td></tr>
<tr><td>strCaption</td><td>TQString</td><td>0</td></tr>
<tr><td>strTabPageLabel</td><td>TQString</td><td>" "</td></tr>
<tr><td>f</td><td>WFlags</td><td>0</td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>changeHideShowState</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>currentDockPosition</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(KDockWidget.DockPosition)</i></td></tr>
<tr><td>In versions KDE 3.3.0 and above only</td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>dockBack</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>dockManager</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(KDockManager)</i></td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>dockSite</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(int)</i></td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>docking</b> (dw, dp)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>dw</td><td>KDockWidget</td><td></td></tr>
<tr><td>dp</td><td>KDockWidget.DockPosition</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>enableDocking</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(int)</i></td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>event</b> (a0)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(bool)</i></td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>a0</td><td>TQEvent</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>findNearestDockWidget</b> (pos)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(KDockWidget)</i></td></tr>
<tr><td>In versions KDE 3.1.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>pos</td><td>KDockWidget.DockPosition</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>forcedFixedHeight</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(int)</i></td></tr>
<tr><td>In versions KDE 3.1.0 and above only</td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>forcedFixedWidth</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(int)</i></td></tr>
<tr><td>In versions KDE 3.1.0 and above only</td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>getHeader</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(KDockWidgetAbstractHeader)</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>getWidget</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(TQWidget)</i></td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>hasUndocked</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>headerCloseButtonClicked</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>headerDockbackButtonClicked</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>iMBeingClosed</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>isDockBackPossible</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(bool)</i></td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>latestKDockContainer</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(TQWidget)</i></td></tr>
<tr><td>In versions KDE 3.1.0 and above only</td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>leaveEvent</b> (a0)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
<tr><td>In versions KDE 3.1.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>a0</td><td>TQEvent</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>loseFormerBrotherDockWidget</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>makeDockVisible</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>manualDock</b> (target, dockPos, spliPos = 50, pos = TQPoint (0 ,0 ), check = 0, tabIndex = -1)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(KDockWidget)</i></td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>target</td><td>KDockWidget</td><td></td></tr>
<tr><td>dockPos</td><td>KDockWidget.DockPosition</td><td></td></tr>
<tr><td>spliPos</td><td>int</td><td>50</td></tr>
<tr><td>pos</td><td>TQPoint</td><td>TQPoint (0 ,0 )</td></tr>
<tr><td>check</td><td>bool</td><td>0</td></tr>
<tr><td>tabIndex</td><td>int</td><td>-1</td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>mayBeHide</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(bool)</i></td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>mayBeShow</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(bool)</i></td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>mouseMoveEvent</b> (a0)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
<tr><td>In versions KDE 3.1.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>a0</td><td>TQMouseEvent</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>mousePressEvent</b> (a0)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
<tr><td>In versions KDE 3.1.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>a0</td><td>TQMouseEvent</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>mouseReleaseEvent</b> (a0)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
<tr><td>In versions KDE 3.1.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>a0</td><td>TQMouseEvent</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>paintEvent</b> (a0)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
<tr><td>In versions KDE 3.1.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>a0</td><td>TQPaintEvent</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>parentDockContainer</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(TQWidget)</i></td></tr>
<tr><td>In versions KDE 3.1.0 and above only</td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>parentDockTabGroup</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(KDockTabGroup)</i></td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>pixmap</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(TQPixmap)</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>restoreFromForcedFixedSize</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
<tr><td>In versions KDE 3.1.0 and above only</td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>setDockDefaultPos</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>setDockSite</b> (pos)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>pos</td><td>int</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>setDockWindowTransient</b> (parent, transientEnabled)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>parent</td><td>TQWidget</td><td></td></tr>
<tr><td>transientEnabled</td><td>bool</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>setDockWindowType</b> (windowType)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>windowType</td><td>NET.WindowType</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>setEnableDocking</b> (pos)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>pos</td><td>int</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>setForcedFixedHeight</b> (a0)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
<tr><td>In versions KDE 3.1.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>a0</td><td>int</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>setForcedFixedWidth</b> (a0)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
<tr><td>In versions KDE 3.1.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>a0</td><td>int</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>setFormerBrotherDockWidget</b> (a0)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
<tr><td>In versions KDE 3.2.1 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>a0</td><td>KDockWidget</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>setHeader</b> (ah)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>ah</td><td>KDockWidgetAbstractHeader</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>setLatestKDockContainer</b> (a0)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
<tr><td>In versions KDE 3.1.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>a0</td><td>TQWidget</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>setPixmap</b> (pixmap = TQPixmap ())
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>pixmap</td><td>TQPixmap</td><td>TQPixmap ()</td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>setTabPageLabel</b> (label)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>label</td><td>TQString</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>setToolTipString</b> (ttStr)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>ttStr</td><td>TQString</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>setWidget</b> (w)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>w</td><td>TQWidget</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>show</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>tabPageLabel</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(TQString)</i></td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>toDesktop</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
<tr><td>In versions KDE 3.1.0 and above only</td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>toolTipString</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(TQString)</i></td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>transientTo</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(TQWidget)</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>undock</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>updateHeader</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>widgetSet</b> (a0)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>a0</td><td>TQWidget</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
</ul>
</body>
</html>