QDockWidget Class Reference · PyQt4 中文文檔

# QDockWidget Class Reference ## [[QtGui](index.htm) module] 該QDockWidget類提供了可以在里面一個停靠窗口小部件[QMainWindow](qmainwindow.html)或浮在桌面上的頂層窗口。[More...](#details) 繼承[QWidget](qwidget.html)。 ### Types * `enum DockWidgetFeature { DockWidgetClosable, DockWidgetMovable, DockWidgetFloatable, DockWidgetVerticalTitleBar, AllDockWidgetFeatures, NoDockWidgetFeatures }` * `class **[DockWidgetFeatures](index.htm)**` ### Methods * `__init__ (self, QString?title, QWidget?parent?=?None, Qt.WindowFlags?flags?=?0)` * `__init__ (self, QWidget?parent?=?None, Qt.WindowFlags?flags?=?0)` * `Qt.DockWidgetAreas allowedAreas (self)` * `changeEvent (self, QEvent?event)` * `closeEvent (self, QCloseEvent?event)` * `bool event (self, QEvent?event)` * `DockWidgetFeatures features (self)` * `initStyleOption (self, QStyleOptionDockWidget?option)` * `bool isAreaAllowed (self, Qt.DockWidgetArea?area)` * `bool isFloating (self)` * `paintEvent (self, QPaintEvent?event)` * `setAllowedAreas (self, Qt.DockWidgetAreas?areas)` * `setFeatures (self, DockWidgetFeatures?features)` * `setFloating (self, bool?floating)` * `setTitleBarWidget (self, QWidget?widget)` * `setWidget (self, QWidget?widget)` * `QWidget titleBarWidget (self)` * `QAction toggleViewAction (self)` * `QWidget widget (self)` ### Qt Signals * `void allowedAreasChanged (Qt::DockWidgetAreas)` * `void dockLocationChanged (Qt::DockWidgetArea)` * `void featuresChanged (QDockWidget::DockWidgetFeatures)` * `void topLevelChanged (bool)` * `void visibilityChanged (bool)` * * * ## Detailed Description 該QDockWidget類提供了可以在里面一個停靠窗口小部件[QMainWindow](qmainwindow.html)或浮在桌面上的頂層窗口。 QDockWidget提供碼頭部件的概念，也知道作為工具選項板或實用程序窗口。塢窗是放置在輔助窗口_dock widget area_周圍的[central widget](qmainwindow.html#centralWidget)在[QMainWindow](qmainwindow.html)。 ![](https://img.kancloud.cn/37/7d/377d76007b428e4a755fe5d5c9e2846a_455x302.png) 停靠窗口可他們目前的區域內移動，移動到新的領域和浮動（例如，取消停靠）由最終用戶。該QDockWidget API允許程序員來限制移動的船塢部件的能力， float和關閉，以及在它們可以被放置區域。 ### Appearance 一個QDockWidget包括標題欄和內容區域。標題欄顯示的停靠小部件[window title](qwidget.html#windowTitle-prop)，一_float_按鈕和_close_按鈕。取決于QDockWidget ，狀態的_float_和_close_按鈕可能會被禁用或根本不顯示。標題欄和按鈕的外觀取決于[style](qstyle.html)在使用中。一個QDockWidget作為一個包裝它的子控件，設置[setWidget](qdockwidget.html#setWidget)（）。自定義大小的提示，最小和最大大小和尺寸的政策應該在孩子小部件來實現。 QDockWidget會尊重他們，調整自己的約束，包括框架和標題。尺寸的限制，不應在QDockWidget本身進行設置，因為它們取決于它是否停靠改變;停靠QDockWidget沒有幀和一個較小的標題欄。 * * * ## Type Documentation ``` QDockWidget.DockWidgetFeature ``` | Constant | Value | Description | | --- | --- | --- | | `QDockWidget.DockWidgetClosable` | `0x01` | 碼頭widget可以被關閉。在某些系統上被告席小部件都會有一個關閉按鈕時，它的（在MacOS 10.5為例）浮動。 | | `QDockWidget.DockWidgetMovable` | `0x02` | 碼頭widget可以碼頭之間由用戶移動。 | | `QDockWidget.DockWidgetFloatable` | `0x04` | 碼頭小部件可以從主窗口分離，飄然作為一個獨立的窗口。 | | `QDockWidget.DockWidgetVerticalTitleBar` | `0x08` | 碼頭插件播放在其左側垂直標題欄。這可以用來增加的垂直空間的量[QMainWindow](qmainwindow.html)。 | | `QDockWidget.AllDockWidgetFeatures` | `DockWidgetClosable | DockWidgetMovable | DockWidgetFloatable` | （已取消）的碼頭小部件可以被關閉，移動和漂浮。由于新的功能可能會在以后的版本中添加，碼頭小部件的外觀和行為，如果你使用這個標志可能會改變。請注明個人標志代替。 | | `QDockWidget.NoDockWidgetFeatures` | `0x00` | 被告席部件不能關閉，移動或浮動。 | 該DockWidgetFeatures類型是一個typedef為[QFlags](index.htm)\u003cDockWidgetFeature\u003e 。它存儲DockWidgetFeature值的或組合。 * * * ## Method Documentation ``` QDockWidget.__init__ (self, QString?title, QWidget?parent?=?None, Qt.WindowFlags?flags?=?0) ``` 該_parent_的說法，如果不是沒有，原因_self_通過Qt的，而不是PyQt的擁有。構造一個[QDockWidget](qdockwidget.html)與父_parent_和窗口標志_flags_。被告席上的部件將被放置在左側碼頭小工具區域。窗口標題設置為_title_。這個標題時使用[QDockWidget](qdockwidget.html)停靠和取消停靠。它也可用于在所提供的上下文菜單[QMainWindow](qmainwindow.html)。 **See also** [setWindowTitle](qwidget.html#windowTitle-prop)（）。 ``` QDockWidget.__init__ (self, QWidget?parent?=?None, Qt.WindowFlags?flags?=?0) ``` 該_parent_的說法，如果不是沒有，原因_self_通過Qt的，而不是PyQt的擁有。構造一個[QDockWidget](qdockwidget.html)與父_parent_和窗口標志_flags_。被告席上的部件將被放置在左側碼頭小工具區域。 ``` Qt.DockWidgetAreas QDockWidget.allowedAreas (self) ``` [ ``` QDockWidget.changeEvent (self, QEvent?event) ``` ](index.htm) [從重新實現](index.htm)[QWidget.changeEvent](qwidget.html#changeEvent)（）。 ``` QDockWidget.closeEvent (self, QCloseEvent?event) ``` 從重新實現[QWidget.closeEvent](qwidget.html#closeEvent)（）。 ``` bool QDockWidget.event (self, QEvent?event) ``` 從重新實現[QObject.event](qobject.html#event)（）。 ``` DockWidgetFeatures QDockWidget.features (self) ``` [ ``` QDockWidget.initStyleOption (self, QStyleOptionDockWidget?option) ``` ](index.htm) [初始化_option_與其它的值](index.htm)[QDockWidget](qdockwidget.html)。當他們需要一個這種方法是有用的子類[QStyleOptionDockWidget](qstyleoptiondockwidget.html)，但不希望在所有的信息填寫自己。 **See also** [QStyleOption.initFrom](qstyleoption.html#initFrom)（）。 ``` bool QDockWidget.isAreaAllowed (self, Qt.DockWidgetArea?area) ``` 返回True如果此停靠小部件可以放置在給定的_area_否則返回False 。 ``` bool QDockWidget.isFloating (self) ``` ``` QDockWidget.paintEvent (self, QPaintEvent?event) ``` 從重新實現[QWidget.paintEvent](qwidget.html#paintEvent)（）。 ``` QDockWidget.setAllowedAreas (self, Qt.DockWidgetAreas?areas) ``` ``` QDockWidget.setFeatures (self, DockWidgetFeatures?features) ``` ``` QDockWidget.setFloating (self, bool?floating) ``` ``` QDockWidget.setTitleBarWidget (self, QWidget?widget) ``` 該_widget_說法有它的所有權轉移給Qt的。設置一個任意_widget_作為基座部件的標題欄。如果_widget_為0 ，任何自定義標題欄小工具以前在碼頭上小部件設置被刪除，但不能刪除，默認的標題欄將被使用。如果標題欄小工具設置，[QDockWidget](qdockwidget.html)將不使用本機窗口裝飾時，它是浮動的。下面是實現自定義標題欄的一些提示： * Mouse events that are not explicitly handled by the title bar widget must be ignored by calling [QMouseEvent.ignore](qevent.html#ignore)(). These events then propagate to the [QDockWidget](qdockwidget.html) parent, which handles them in the usual manner, moving when the title bar is dragged, docking and undocking when it is double-clicked, etc. * When [DockWidgetVerticalTitleBar](qdockwidget.html#DockWidgetFeature-enum) is set on [QDockWidget](qdockwidget.html), the title bar widget is repositioned accordingly. In [resizeEvent](qwidget.html#resizeEvent)(), the title bar should check what orientation it should assume: ``` [QDockWidget](qdockwidget.html) *dockWidget = qobject_cast<[QDockWidget](qdockwidget.html)*>(parentWidget()); if (dockWidget->features() & [QDockWidget](qdockwidget.html).DockWidgetVerticalTitleBar) { // I need to be vertical } else { // I need to be horizontal } ``` * The title bar widget must have a valid [QWidget.sizeHint](qwidget.html#sizeHint-prop)() and [QWidget.minimumSizeHint](qwidget.html#minimumSizeHint-prop)(). These functions should take into account the current orientation of the title bar. * It is not possible to remove a title bar from a dock widget. However, a similar effect can be achieved by setting a default constructed [QWidget](qwidget.html) as the title bar widget. Using [qobject_cast](qobject.html#qobject_cast)（）如上圖所示，在標題欄小工具可以完全訪問它的父[QDockWidget](qdockwidget.html)。因此，它可以響應于用戶的操作作為對接和遮蓋力執行這樣的操作。此功能被引入Qt的4.3 。 **See also** [titleBarWidget](qdockwidget.html#titleBarWidget)（）和[DockWidgetVerticalTitleBar](qdockwidget.html#DockWidgetFeature-enum)。 ``` QDockWidget.setWidget (self, QWidget?widget) ``` 該_widget_說法有它的所有權轉移給Qt的。設置部件碼頭小部件_widget_。如果船塢部件是可見的，當_widget_是說，你必須[show()](qwidget.html#show)它明確。請注意，您必須添加的布局_widget_你調用這個函數之前，如果沒有，_widget_將不可見。 **See also** [widget](qdockwidget.html#widget)（）。 ``` QWidget QDockWidget.titleBarWidget (self) ``` [](qwidget.html) [返回的自定義標題欄widget集](qwidget.html)[QDockWidget](qdockwidget.html)，或者0，如果沒有自定義標題欄已定。此功能被引入Qt的4.3 。 **See also** [setTitleBarWidget](qdockwidget.html#setTitleBarWidget)（）。 ``` QAction QDockWidget.toggleViewAction (self) ``` [ 返回一個可用于顯示或關閉此停靠小部件可檢查的動作。該操作的文本設置為停靠窗口小部件的窗口標題。 ](qaction.html) [**See also**](qaction.html) [QAction.text](qaction.html#text-prop)和[QWidget.windowTitle](qwidget.html#windowTitle-prop)。 ``` QWidget QDockWidget.widget (self) ``` [ 返回部件碼頭部件。該函數返回零，如果插件并未設置。 ](qwidget.html) [**See also**](qwidget.html) [setWidget](qdockwidget.html#setWidget)（）。 * * * ## Qt Signal Documentation ``` void allowedAreasChanged (Qt::DockWidgetAreas) ``` 這是該信號的默認超載。這個信號被發射時的[allowedAreas](qdockwidget.html#allowedAreas-prop)屬性更改。該_allowedAreas_參數給出該屬性的新值。 ``` void dockLocationChanged (Qt::DockWidgetArea) ``` 這是該信號的默認超載。當基座部件被移動到另一個碼頭這個信號被發射_area_，或移動到其當前船塢區的不同位置。發生這種情況時，基座部件被編程方式移動或由用戶拖動到一個新位置。此功能被引入Qt的4.3 。 ``` void featuresChanged (QDockWidget::DockWidgetFeatures) ``` 這是該信號的默認超載。這個信號被發射時的[features](qdockwidget.html#features-prop)屬性更改。該_features_參數給出該屬性的新值。 ``` void topLevelChanged (bool) ``` 這是該信號的默認超載。這個信號被發射時的[floating](qdockwidget.html#floating-prop)屬性更改。該_topLevel_參數為True ，如果停靠小部件，現在浮動，否則為假。 **See also** [isWindow](qwidget.html#isWindow)（）。 ``` void visibilityChanged (bool) ``` 這是該信號的默認超載。當基座部件成為這個信號被發射_visible_（或不可見）。這種情況發生在小部件是隱藏或顯示，以及當它停靠在一個標籤式碼頭區，其標籤變成選擇或取消選擇。此功能被引入Qt的4.3 。