 |
Qt 4.8
|
|
Qt 4.8
|
The QDockWidget class provides a widget that can be docked inside a QMainWindow or floated as a top-level window on the desktop. More...
#include <qdockwidget.h>
Public Types | |
| enum | DockWidgetFeature { DockWidgetClosable = 0x01, DockWidgetMovable = 0x02, DockWidgetFloatable = 0x04, DockWidgetVerticalTitleBar = 0x08, DockWidgetFeatureMask = 0x0f, AllDockWidgetFeatures = DockWidgetClosable|DockWidgetMovable|DockWidgetFloatable, NoDockWidgetFeatures = 0x00, Reserved = 0xff } |
 Public Types inherited from QWidget | |
| enum | RenderFlag { DrawWindowBackground = 0x1, DrawChildren = 0x2, IgnoreMask = 0x4 } |
| This enum describes how to render the widget when calling QWidget::render(). More... | |
| Public Types inherited from QPaintDevice | |
| enum | PaintDeviceMetric { PdmWidth = 1, PdmHeight, PdmWidthMM, PdmHeightMM, PdmNumColors, PdmDepth, PdmDpiX, PdmDpiY, PdmPhysicalDpiX, PdmPhysicalDpiY } |
Signals | |
| void | allowedAreasChanged (Qt::DockWidgetAreas allowedAreas) |
| This signal is emitted when the allowedAreas property changes. More... | |
| void | dockLocationChanged (Qt::DockWidgetArea area) |
| This signal is emitted when the dock widget is moved to another dock area, or is moved to a different location in its current dock area. More... | |
| void | featuresChanged (QDockWidget::DockWidgetFeatures features) |
| This signal is emitted when the features property changes. More... | |
| void | topLevelChanged (bool topLevel) |
| This signal is emitted when the floating property changes. More... | |
| void | visibilityChanged (bool visible) |
| This signal is emitted when the dock widget becomes visible (or invisible). More... | |
| Signals inherited from QWidget | |
| void | customContextMenuRequested (const QPoint &pos) |
| This signal is emitted when the widget's contextMenuPolicy is Qt::CustomContextMenu, and the user has requested a context menu on the widget. More... | |
| Signals inherited from QObject | |
| void | destroyed (QObject *=0) |
| This signal is emitted immediately before the object obj is destroyed, and can not be blocked. More... | |
Public Functions | |
| Qt::DockWidgetAreas | allowedAreas () const |
| DockWidgetFeatures | features () const |
| bool | isAreaAllowed (Qt::DockWidgetArea area) const |
| Returns true if this dock widget can be placed in the given area; otherwise returns false. More... | |
| bool | isFloating () const |
| QDockWidget (const QString &title, QWidget *parent=0, Qt::WindowFlags flags=0) | |
| Constructs a QDockWidget with parent parent and window flags flags. More... | |
| QDockWidget (QWidget *parent=0, Qt::WindowFlags flags=0) | |
| Constructs a QDockWidget with parent parent and window flags flags. More... | |
| void | setAllowedAreas (Qt::DockWidgetAreas areas) |
| void | setFeatures (DockWidgetFeatures features) |
| void | setFloating (bool floating) |
| void | setTitleBarWidget (QWidget *widget) |
| Sets an arbitrary widget as the dock widget's title bar. More... | |
| void | setWidget (QWidget *widget) |
| Sets the widget for the dock widget to widget. More... | |
| QWidget * | titleBarWidget () const |
| Returns the custom title bar widget set on the QDockWidget, or 0 if no custom title bar has been set. More... | |
| QAction * | toggleViewAction () const |
| Returns a checkable action that can be used to show or close this dock widget. More... | |
| QWidget * | widget () const |
| Returns the widget for the dock widget. More... | |
| ~QDockWidget () | |
| Destroys the dock widget. More... | |
| Public Functions inherited from QWidget | |
| bool | acceptDrops () const |
| QString | accessibleDescription () const |
| QString | accessibleName () const |
| QList< QAction * > | actions () const |
| Returns the (possibly empty) list of this widget's actions. More... | |
| void | activateWindow () |
| Sets the top-level widget containing this widget to be the active window. More... | |
| void | addAction (QAction *action) |
| Appends the action action to this widget's list of actions. More... | |
| void | addActions (QList< QAction *> actions) |
| Appends the actions actions to this widget's list of actions. More... | |
| void | adjustSize () |
| Adjusts the size of the widget to fit its contents. More... | |
| bool | autoFillBackground () const |
| QPalette::ColorRole | backgroundRole () const |
| Returns the background role of the widget. More... | |
| QSize | baseSize () const |
| QWidget * | childAt (int x, int y) const |
| Returns the visible child widget at the position ({x}, {y}) in the widget's coordinate system. More... | |
| QWidget * | childAt (const QPoint &p) const |
| Returns the visible child widget at point p in the widget's own coordinate system. More... | |
| QRect | childrenRect () const |
| QRegion | childrenRegion () const |
| void | clearFocus () |
| Takes keyboard input focus from the widget. More... | |
| void | clearMask () |
| Removes any mask set by setMask(). More... | |
| QMargins | contentsMargins () const |
| The contentsMargins function returns the widget's contents margins. More... | |
| QRect | contentsRect () const |
| Returns the area inside the widget's margins. More... | |
| Qt::ContextMenuPolicy | contextMenuPolicy () const |
| void | createWinId () |
| QCursor | cursor () const |
| int | devType () const |
| WId | effectiveWinId () const |
| Returns the effective window system identifier of the widget, i. More... | |
| void | ensurePolished () const |
| Ensures that the widget has been polished by QStyle (i.e., has a proper font and palette). More... | |
| Qt::FocusPolicy | focusPolicy () const |
| QWidget * | focusProxy () const |
| Returns the focus proxy, or 0 if there is no focus proxy. More... | |
| QWidget * | focusWidget () const |
| Returns the last child of this widget that setFocus had been called on. More... | |
| const QFont & | font () const |
| QFontInfo | fontInfo () const |
| Returns the font info for the widget's current font. More... | |
| QFontMetrics | fontMetrics () const |
| Returns the font metrics for the widget's current font. More... | |
| QPalette::ColorRole | foregroundRole () const |
| Returns the foreground role. More... | |
| QRect | frameGeometry () const |
| QSize | frameSize () const |
| const QRect & | geometry () const |
| void | getContentsMargins (int *left, int *top, int *right, int *bottom) const |
| Returns the widget's contents margins for left, top, right, and bottom. More... | |
| HDC | getDC () const |
| Returns the window system handle of the widget, for low-level access. More... | |
| void | grabGesture (Qt::GestureType type, Qt::GestureFlags flags=Qt::GestureFlags()) |
| Subscribes the widget to a given gesture with specific flags. More... | |
| void | grabKeyboard () |
| Grabs the keyboard input. More... | |
| void | grabMouse () |
| Grabs the mouse input. More... | |
| void | grabMouse (const QCursor &) |
| int | grabShortcut (const QKeySequence &key, Qt::ShortcutContext context=Qt::WindowShortcut) |
| Adds a shortcut to Qt's shortcut system that watches for the given key sequence in the given context. More... | |
| QGraphicsEffect * | graphicsEffect () const |
| The graphicsEffect function returns a pointer to the widget's graphics effect. More... | |
| QGraphicsProxyWidget * | graphicsProxyWidget () const |
| Returns the proxy widget for the corresponding embedded widget in a graphics view; otherwise returns 0. More... | |
| bool | hasFocus () const |
| bool | hasMouseTracking () const |
| int | height () const |
| virtual int | heightForWidth (int) const |
| Returns the preferred height for this widget, given the width w. More... | |
| QInputContext * | inputContext () |
| This function returns the QInputContext for this widget. More... | |
| Qt::InputMethodHints | inputMethodHints () const |
| virtual QVariant | inputMethodQuery (Qt::InputMethodQuery) const |
| This method is only relevant for input widgets. More... | |
| void | insertAction (QAction *before, QAction *action) |
| Inserts the action action to this widget's list of actions, before the action before. More... | |
| void | insertActions (QAction *before, QList< QAction *> actions) |
| Inserts the actions actions to this widget's list of actions, before the action before. More... | |
| WId | internalWinId () const |
| Returns the window system identifier of the widget, or 0 if the widget is not created yet. More... | |
| bool | isActiveWindow () const |
| bool | isAncestorOf (const QWidget *child) const |
| Returns true if this widget is a parent, (or grandparent and so on to any level), of the given child, and both widgets are within the same window; otherwise returns false. More... | |
| bool | isEnabled () const |
| bool | isEnabledTo (QWidget *) const |
| Returns true if this widget would become enabled if ancestor is enabled; otherwise returns false. More... | |
| bool | isEnabledToTLW () const |
| This function is deprecated. More... | |
| bool | isFullScreen () const |
| bool | isHidden () const |
| Returns true if the widget is hidden, otherwise returns false. More... | |
| bool | isLeftToRight () const |
| bool | isMaximized () const |
| bool | isMinimized () const |
| bool | isModal () const |
| bool | isRightToLeft () const |
| bool | isTopLevel () const |
| Use isWindow() instead. More... | |
| bool | isVisible () const |
| bool | isVisibleTo (QWidget *) const |
| Returns true if this widget would become visible if ancestor is shown; otherwise returns false. More... | |
| bool | isWindow () const |
| Returns true if the widget is an independent window, otherwise returns false. More... | |
| bool | isWindowModified () const |
| QLayout * | layout () const |
| Returns the layout manager that is installed on this widget, or 0 if no layout manager is installed. More... | |
| Qt::LayoutDirection | layoutDirection () const |
| QLocale | locale () const |
| Qt::HANDLE | macCGHandle () const |
| Returns the CoreGraphics handle of the widget. More... | |
| Qt::HANDLE | macQDHandle () const |
| Returns the QuickDraw handle of the widget. More... | |
| QPoint | mapFrom (QWidget *, const QPoint &) const |
| Translates the widget coordinate pos from the coordinate system of parent to this widget's coordinate system. More... | |
| QPoint | mapFromGlobal (const QPoint &) const |
| Translates the global screen coordinate pos to widget coordinates. More... | |
| QPoint | mapFromParent (const QPoint &) const |
| Translates the parent widget coordinate pos to widget coordinates. More... | |
| QPoint | mapTo (QWidget *, const QPoint &) const |
| Translates the widget coordinate pos to the coordinate system of parent. More... | |
| QPoint | mapToGlobal (const QPoint &) const |
| Translates the widget coordinate pos to global screen coordinates. More... | |
| QPoint | mapToParent (const QPoint &) const |
| Translates the widget coordinate pos to a coordinate in the parent widget. More... | |
| QRegion | mask () const |
| Returns the mask currently set on a widget. More... | |
| int | maximumHeight () const |
| QSize | maximumSize () const |
| int | maximumWidth () const |
| int | minimumHeight () const |
| QSize | minimumSize () const |
| virtual QSize | minimumSizeHint () const |
| int | minimumWidth () const |
| void | move (int x, int y) |
| This corresponds to move(QPoint(x, y)). More... | |
| void | move (const QPoint &) |
| QWidget * | nativeParentWidget () const |
| Returns the native parent for this widget, i. More... | |
| QWidget * | nextInFocusChain () const |
| Returns the next widget in this widget's focus chain. More... | |
| QRect | normalGeometry () const |
| void | overrideWindowFlags (Qt::WindowFlags type) |
| Sets the window flags for the widget to flags, without telling the window system. More... | |
| void | overrideWindowState (Qt::WindowStates state) |
| QPaintEngine * | paintEngine () const |
| Returns the widget's paint engine. More... | |
| const QPalette & | palette () const |
| QWidget * | parentWidget () const |
| Returns the parent of this widget, or 0 if it does not have any parent widget. More... | |
| QPoint | pos () const |
| QWidget * | previousInFocusChain () const |
| The previousInFocusChain function returns the previous widget in this widget's focus chain. More... | |
| QWidget (QWidget *parent=0, Qt::WindowFlags f=0) | |
| Constructs a widget which is a child of parent, with widget flags set to f. More... | |
| QRect | rect () const |
| void | releaseDC (HDC) const |
| Releases the HDC hdc acquired by a previous call to getDC(). More... | |
| void | releaseKeyboard () |
| Releases the keyboard grab. More... | |
| void | releaseMouse () |
| Releases the mouse grab. More... | |
| void | releaseShortcut (int id) |
| Removes the shortcut with the given id from Qt's shortcut system. More... | |
| void | removeAction (QAction *action) |
| Removes the action action from this widget's list of actions. More... | |
| void | render (QPaintDevice *target, const QPoint &targetOffset=QPoint(), const QRegion &sourceRegion=QRegion(), RenderFlags renderFlags=RenderFlags(DrawWindowBackground|DrawChildren)) |
| Renders the sourceRegion of this widget into the target using renderFlags to determine how to render. More... | |
| void | render (QPainter *painter, const QPoint &targetOffset=QPoint(), const QRegion &sourceRegion=QRegion(), RenderFlags renderFlags=RenderFlags(DrawWindowBackground|DrawChildren)) |
| Renders the widget into the painter's QPainter::device(). More... | |
| void | repaint (int x, int y, int w, int h) |
| This version repaints a rectangle (x, y, w, h) inside the widget. More... | |
| void | repaint (const QRect &) |
| This version repaints a rectangle rect inside the widget. More... | |
| void | repaint (const QRegion &) |
| This version repaints a region rgn inside the widget. More... | |
| void | resize (int w, int h) |
| This corresponds to resize(QSize(w, h)). More... | |
| void | resize (const QSize &) |
| bool | restoreGeometry (const QByteArray &geometry) |
| Restores the geometry and state top-level widgets stored in the byte array geometry. More... | |
| QByteArray | saveGeometry () const |
| Saves the current geometry and state for top-level widgets. More... | |
| void | scroll (int dx, int dy) |
| Scrolls the widget including its children dx pixels to the right and dy downward. More... | |
| void | scroll (int dx, int dy, const QRect &) |
| This version only scrolls r and does not move the children of the widget. More... | |
| void | setAcceptDrops (bool on) |
| void | setAccessibleDescription (const QString &description) |
| void | setAccessibleName (const QString &name) |
| void | setAttribute (Qt::WidgetAttribute, bool on=true) |
| Sets the attribute attribute on this widget if on is true; otherwise clears the attribute. More... | |
| void | setAutoFillBackground (bool enabled) |
| void | setBackgroundRole (QPalette::ColorRole) |
| Sets the background role of the widget to role. More... | |
| void | setBaseSize (const QSize &) |
| void | setBaseSize (int basew, int baseh) |
| This corresponds to setBaseSize(QSize(basew, baseh)). More... | |
| void | setContentsMargins (int left, int top, int right, int bottom) |
| Sets the margins around the contents of the widget to have the sizes left, top, right, and bottom. More... | |
| void | setContentsMargins (const QMargins &margins) |
| The setContentsMargins function sets the margins around the widget's contents. More... | |
| void | setContextMenuPolicy (Qt::ContextMenuPolicy policy) |
| void | setCursor (const QCursor &) |
| void | setFixedHeight (int h) |
| Sets both the minimum and maximum heights of the widget to h without changing the widths. More... | |
| void | setFixedSize (const QSize &) |
| Sets both the minimum and maximum sizes of the widget to s, thereby preventing it from ever growing or shrinking. More... | |
| void | setFixedSize (int w, int h) |
| Sets the width of the widget to w and the height to h. More... | |
| void | setFixedWidth (int w) |
| Sets both the minimum and maximum width of the widget to w without changing the heights. More... | |
| void | setFocus (Qt::FocusReason reason) |
| Gives the keyboard input focus to this widget (or its focus proxy) if this widget or one of its parents is the active window. More... | |
| void | setFocusPolicy (Qt::FocusPolicy policy) |
| void | setFocusProxy (QWidget *) |
| Sets the widget's focus proxy to widget w. More... | |
| void | setFont (const QFont &) |
| Use the single-argument overload instead. More... | |
| void | setForegroundRole (QPalette::ColorRole) |
| Sets the foreground role of the widget to role. More... | |
| void | setGeometry (int x, int y, int w, int h) |
| This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This corresponds to setGeometry(QRect(x, y, w, h)). More... | |
| void | setGeometry (const QRect &) |
| void | setGraphicsEffect (QGraphicsEffect *effect) |
| The setGraphicsEffect function is for setting the widget's graphics effect. More... | |
| void | setInputContext (QInputContext *) |
| This function sets the input context context on this widget. More... | |
| void | setInputMethodHints (Qt::InputMethodHints hints) |
| void | setLayout (QLayout *) |
| Sets the layout manager for this widget to layout. More... | |
| void | setLayoutDirection (Qt::LayoutDirection direction) |
| void | setLocale (const QLocale &locale) |
| void | setMask (const QBitmap &) |
| Causes only the pixels of the widget for which bitmap has a corresponding 1 bit to be visible. More... | |
| void | setMask (const QRegion &) |
| Causes only the parts of the widget which overlap region to be visible. More... | |
| void | setMaximumHeight (int maxh) |
| void | setMaximumSize (const QSize &) |
| void | setMaximumSize (int maxw, int maxh) |
| This function corresponds to setMaximumSize(QSize(maxw, maxh)). More... | |
| void | setMaximumWidth (int maxw) |
| void | setMinimumHeight (int minh) |
| void | setMinimumSize (const QSize &) |
| void | setMinimumSize (int minw, int minh) |
| This function corresponds to setMinimumSize(QSize(minw, minh)). More... | |
| void | setMinimumWidth (int minw) |
| void | setMouseTracking (bool enable) |
| void | setPalette (const QPalette &) |
| Use the single-argument overload instead. More... | |
| void | setParent (QWidget *parent) |
| Sets the parent of the widget to parent, and resets the window flags. More... | |
| void | setParent (QWidget *parent, Qt::WindowFlags f) |
| This function also takes widget flags, f as an argument. More... | |
| void | setShortcutAutoRepeat (int id, bool enable=true) |
| If enable is true, auto repeat of the shortcut with the given id is enabled; otherwise it is disabled. More... | |
| void | setShortcutEnabled (int id, bool enable=true) |
| If enable is true, the shortcut with the given id is enabled; otherwise the shortcut is disabled. More... | |
| void | setSizeIncrement (const QSize &) |
| void | setSizeIncrement (int w, int h) |
| Sets the x (width) size increment to w and the y (height) size increment to h. More... | |
| void | setSizePolicy (QSizePolicy) |
| void | setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical) |
| Sets the size policy of the widget to horizontal and vertical, with standard stretch and no height-for-width. More... | |
| void | setStatusTip (const QString &) |
| void | setStyle (QStyle *) |
| Sets the widget's GUI style to style. More... | |
| void | setToolTip (const QString &) |
| void | setUpdatesEnabled (bool enable) |
| void | setupUi (QWidget *widget) |
| Sets up the user interface for the specified widget. More... | |
| void | setWhatsThis (const QString &) |
| void | setWindowFilePath (const QString &filePath) |
| void | setWindowFlags (Qt::WindowFlags type) |
| void | setWindowIcon (const QIcon &icon) |
| void | setWindowIconText (const QString &) |
| void | setWindowModality (Qt::WindowModality windowModality) |
| void | setWindowOpacity (qreal level) |
| void | setWindowRole (const QString &) |
| Sets the window's role to role. More... | |
| void | setWindowState (Qt::WindowStates state) |
| Sets the window state to windowState. More... | |
| void | setWindowSurface (QWindowSurface *surface) |
| Sets the window surface to be the surface specified. More... | |
| QSize | size () const |
| virtual QSize | sizeHint () const |
| QSize | sizeIncrement () const |
| QSizePolicy | sizePolicy () const |
| void | stackUnder (QWidget *) |
| Places the widget under w in the parent widget's stack. More... | |
| QString | statusTip () const |
| QStyle * | style () const |
| QString | styleSheet () const |
| bool | testAttribute (Qt::WidgetAttribute) const |
| Returns true if attribute attribute is set on this widget; otherwise returns false. More... | |
| QString | toolTip () const |
| QWidget * | topLevelWidget () const |
| bool | underMouse () const |
| Returns true if the widget is under the mouse cursor; otherwise returns false. More... | |
| void | ungrabGesture (Qt::GestureType type) |
| Unsubscribes the widget from a given gesture type. More... | |
| void | unsetCursor () |
| void | unsetLayoutDirection () |
| void | unsetLocale () |
| void | update (int x, int y, int w, int h) |
| This version updates a rectangle (x, y, w, h) inside the widget. More... | |
| void | update (const QRect &) |
| This version updates a rectangle rect inside the widget. More... | |
| void | update (const QRegion &) |
| This version repaints a region rgn inside the widget. More... | |
| void | updateGeometry () |
| Notifies the layout system that this widget has changed and may need to change geometry. More... | |
| bool | updatesEnabled () const |
| QRegion | visibleRegion () const |
| Returns the unobscured region where paint events can occur. More... | |
| QString | whatsThis () const |
| int | width () const |
| QWidget * | window () const |
| Returns the window for this widget, i.e. More... | |
| QString | windowFilePath () const |
| Qt::WindowFlags | windowFlags () const |
| Window flags are a combination of a type (e. More... | |
| QIcon | windowIcon () const |
| QString | windowIconText () const |
| Qt::WindowModality | windowModality () const |
| qreal | windowOpacity () const |
| QString | windowRole () const |
| Returns the window's role, or an empty string. More... | |
| Qt::WindowStates | windowState () const |
| Returns the current window state. More... | |
| QWindowSurface * | windowSurface () const |
| Returns the QWindowSurface this widget will be drawn into. More... | |
| QString | windowTitle () const |
| Qt::WindowType | windowType () const |
| Returns the window type of this widget. More... | |
| WId | winId () const |
| Returns the window system identifier of the widget. More... | |
| int | x () const |
| const QX11Info & | x11Info () const |
| Returns information about the configuration of the X display used to display the widget. More... | |
| Qt::HANDLE | x11PictureHandle () const |
| Returns the X11 Picture handle of the widget for XRender support. More... | |
| int | y () const |
| ~QWidget () | |
| Destroys the widget. More... | |
| Public Functions inherited from QObject | |
| bool | blockSignals (bool b) |
| If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it). More... | |
| const QObjectList & | children () const |
| Returns a list of child objects. More... | |
| bool | connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const |
| bool | disconnect (const char *signal=0, const QObject *receiver=0, const char *member=0) |
| bool | disconnect (const QObject *receiver, const char *member=0) |
| void | dumpObjectInfo () |
| Dumps information about signal connections, etc. More... | |
| void | dumpObjectTree () |
| Dumps a tree of children to the debug output. More... | |
| QList< QByteArray > | dynamicPropertyNames () const |
| Returns the names of all properties that were dynamically added to the object using setProperty(). More... | |
| virtual bool | eventFilter (QObject *, QEvent *) |
| Filters events if this object has been installed as an event filter for the watched object. More... | |
| template<typename T > | |
| T | findChild (const QString &aName=QString()) const |
| Returns the child of this object that can be cast into type T and that is called name, or 0 if there is no such object. More... | |
| template<typename T > | |
| QList< T > | findChildren (const QString &aName=QString()) const |
| Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects. More... | |
| template<typename T > | |
| QList< T > | findChildren (const QRegExp &re) const |
| bool | inherits (const char *classname) const |
| Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false. More... | |
| void | installEventFilter (QObject *) |
| Installs an event filter filterObj on this object. More... | |
| bool | isWidgetType () const |
| Returns true if the object is a widget; otherwise returns false. More... | |
| void | killTimer (int id) |
| Kills the timer with timer identifier, id. More... | |
| virtual const QMetaObject * | metaObject () const |
| Returns a pointer to the meta-object of this object. More... | |
| void | moveToThread (QThread *thread) |
| Changes the thread affinity for this object and its children. More... | |
| QString | objectName () const |
| QObject * | parent () const |
| Returns a pointer to the parent object. More... | |
| QVariant | property (const char *name) const |
| Returns the value of the object's name property. More... | |
| Q_INVOKABLE | QObject (QObject *parent=0) |
| Constructs an object with parent object parent. More... | |
| void | removeEventFilter (QObject *) |
| Removes an event filter object obj from this object. More... | |
| void | setObjectName (const QString &name) |
| void | setParent (QObject *) |
| Makes the object a child of parent. More... | |
| bool | setProperty (const char *name, const QVariant &value) |
| Sets the value of the object's name property to value. More... | |
| void | setUserData (uint id, QObjectUserData *data) |
| bool | signalsBlocked () const |
| Returns true if signals are blocked; otherwise returns false. More... | |
| int | startTimer (int interval) |
| Starts a timer and returns a timer identifier, or returns zero if it could not start a timer. More... | |
| QThread * | thread () const |
| Returns the thread in which the object lives. More... | |
| QObjectUserData * | userData (uint id) const |
| virtual | ~QObject () |
| Destroys the object, deleting all its child objects. More... | |
| Public Functions inherited from QPaintDevice | |
| int | colorCount () const |
| int | depth () const |
| int | height () const |
| int | heightMM () const |
| int | logicalDpiX () const |
| int | logicalDpiY () const |
| QT_DEPRECATED int | numColors () const |
| bool | paintingActive () const |
| int | physicalDpiX () const |
| int | physicalDpiY () const |
| int | width () const |
| int | widthMM () const |
| virtual | ~QPaintDevice () |
Protected Functions | |
| void | changeEvent (QEvent *event) |
| Reimplemented Function More... | |
| void | closeEvent (QCloseEvent *event) |
| Reimplemented Function More... | |
| bool | event (QEvent *event) |
| Reimplemented Function More... | |
| void | initStyleOption (QStyleOptionDockWidget *option) const |
| Initialize option with the values from this QDockWidget. More... | |
| void | paintEvent (QPaintEvent *event) |
| Reimplemented Function More... | |
| Protected Functions inherited from QWidget | |
| virtual void | actionEvent (QActionEvent *) |
| This event handler is called with the given event whenever the widget's actions are changed. More... | |
| virtual void | contextMenuEvent (QContextMenuEvent *) |
| This event handler, for event event, can be reimplemented in a subclass to receive widget context menu events. More... | |
| void | create (WId=0, bool initializeWindow=true, bool destroyOldWindow=true) |
| Creates a new widget window if window is 0, otherwise sets the widget's window to window. More... | |
| void | destroy (bool destroyWindow=true, bool destroySubWindows=true) |
| Frees up window system resources. More... | |
| virtual void | dragEnterEvent (QDragEnterEvent *) |
| This event handler is called when a drag is in progress and the mouse enters this widget. More... | |
| virtual void | dragLeaveEvent (QDragLeaveEvent *) |
| This event handler is called when a drag is in progress and the mouse leaves this widget. More... | |
| virtual void | dragMoveEvent (QDragMoveEvent *) |
| This event handler is called if a drag is in progress, and when any of the following conditions occur: the cursor enters this widget, the cursor moves within this widget, or a modifier key is pressed on the keyboard while this widget has the focus. More... | |
| virtual void | dropEvent (QDropEvent *) |
| This event handler is called when the drag is dropped on this widget. More... | |
| virtual void | enabledChange (bool) |
| virtual void | enterEvent (QEvent *) |
| This event handler can be reimplemented in a subclass to receive widget enter events which are passed in the event parameter. More... | |
| virtual void | focusInEvent (QFocusEvent *) |
| This event handler can be reimplemented in a subclass to receive keyboard focus events (focus received) for the widget. More... | |
| bool | focusNextChild () |
| Finds a new widget to give the keyboard focus to, as appropriate for Tab, and returns true if it can find a new widget, or false if it can't. More... | |
| virtual bool | focusNextPrevChild (bool next) |
| Finds a new widget to give the keyboard focus to, as appropriate for Tab and Shift+Tab, and returns true if it can find a new widget, or false if it can't. More... | |
| virtual void | focusOutEvent (QFocusEvent *) |
| This event handler can be reimplemented in a subclass to receive keyboard focus events (focus lost) for the widget. More... | |
| bool | focusPreviousChild () |
| Finds a new widget to give the keyboard focus to, as appropriate for Shift+Tab, and returns true if it can find a new widget, or false if it can't. More... | |
| virtual void | fontChange (const QFont &) |
| virtual void | hideEvent (QHideEvent *) |
| This event handler can be reimplemented in a subclass to receive widget hide events. More... | |
| virtual void | inputMethodEvent (QInputMethodEvent *) |
| This event handler, for event event, can be reimplemented in a subclass to receive Input Method composition events. More... | |
| virtual void | keyPressEvent (QKeyEvent *) |
| This event handler, for event event, can be reimplemented in a subclass to receive key press events for the widget. More... | |
| virtual void | keyReleaseEvent (QKeyEvent *) |
| This event handler, for event event, can be reimplemented in a subclass to receive key release events for the widget. More... | |
| virtual void | languageChange () |
| virtual void | leaveEvent (QEvent *) |
| This event handler can be reimplemented in a subclass to receive widget leave events which are passed in the event parameter. More... | |
| virtual bool | macEvent (EventHandlerCallRef, EventRef) |
| This special event handler can be reimplemented in a subclass to receive native Macintosh events. More... | |
| int | metric (PaintDeviceMetric) const |
| Internal implementation of the virtual QPaintDevice::metric() function. More... | |
| virtual void | mouseDoubleClickEvent (QMouseEvent *) |
| This event handler, for event event, can be reimplemented in a subclass to receive mouse double click events for the widget. More... | |
| virtual void | mouseMoveEvent (QMouseEvent *) |
| This event handler, for event event, can be reimplemented in a subclass to receive mouse move events for the widget. More... | |
| virtual void | mousePressEvent (QMouseEvent *) |
| This event handler, for event event, can be reimplemented in a subclass to receive mouse press events for the widget. More... | |
| virtual void | mouseReleaseEvent (QMouseEvent *) |
| This event handler, for event event, can be reimplemented in a subclass to receive mouse release events for the widget. More... | |
| virtual void | moveEvent (QMoveEvent *) |
| This event handler can be reimplemented in a subclass to receive widget move events which are passed in the event parameter. More... | |
| virtual void | paletteChange (const QPalette &) |
| QWidget (QWidgetPrivate &d, QWidget *parent, Qt::WindowFlags f) | |
| virtual bool | qwsEvent (QWSEvent *) |
| This special event handler can be reimplemented in a subclass to receive native Qt for Embedded Linux events which are passed in the event parameter. More... | |
| void | resetInputContext () |
| This function can be called on the widget that currently has focus to reset the input method operating on it. More... | |
| virtual void | resizeEvent (QResizeEvent *) |
| This event handler can be reimplemented in a subclass to receive widget resize events which are passed in the event parameter. More... | |
| virtual void | showEvent (QShowEvent *) |
| This event handler can be reimplemented in a subclass to receive widget show events which are passed in the event parameter. More... | |
| virtual void | styleChange (QStyle &) |
| virtual void | tabletEvent (QTabletEvent *) |
| This event handler, for event event, can be reimplemented in a subclass to receive tablet events for the widget. More... | |
| virtual void | wheelEvent (QWheelEvent *) |
| This event handler, for event event, can be reimplemented in a subclass to receive wheel events for the widget. More... | |
| virtual void | windowActivationChange (bool) |
| virtual bool | winEvent (MSG *message, long *result) |
| This special event handler can be reimplemented in a subclass to receive native Windows events which are passed in the message parameter. More... | |
| virtual bool | x11Event (XEvent *) |
| This special event handler can be reimplemented in a subclass to receive native X11 events passed in the event parameter. More... | |
| Protected Functions inherited from QObject | |
| virtual void | childEvent (QChildEvent *) |
| This event handler can be reimplemented in a subclass to receive child events. More... | |
| virtual void | connectNotify (const char *signal) |
| This virtual function is called when something has been connected to signal in this object. More... | |
| virtual void | customEvent (QEvent *) |
| This event handler can be reimplemented in a subclass to receive custom events. More... | |
| virtual void | disconnectNotify (const char *signal) |
| This virtual function is called when something has been disconnected from signal in this object. More... | |
| QObject (QObjectPrivate &dd, QObject *parent=0) | |
| int | receivers (const char *signal) const |
| Returns the number of receivers connected to the signal. More... | |
| QObject * | sender () const |
| Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns 0. More... | |
| int | senderSignalIndex () const |
| virtual void | timerEvent (QTimerEvent *) |
| This event handler can be reimplemented in a subclass to receive timer events for the object. More... | |
| Protected Functions inherited from QPaintDevice | |
| QPaintDevice () | |
Properties | |
| Qt::DockWidgetAreas | allowedAreas |
| areas where the dock widget may be placed More... | |
| DockWidgetFeatures | features |
| whether the dock widget is movable, closable, and floatable More... | |
| bool | floating |
| whether the dock widget is floating More... | |
| QString | windowTitle |
| the dock widget title (caption) More... | |
Friends | |
| class | QDockAreaLayout |
| class | QDockAreaLayoutInfo |
| class | QDockWidgetItem |
| class | QDockWidgetLayout |
| class | QMainWindowLayout |
Additional Inherited Members | |
| Public Slots inherited from QWidget | |
| bool | close () |
| Closes this widget. More... | |
| void | hide () |
| Hides the widget. More... | |
| void | lower () |
| Lowers the widget to the bottom of the parent widget's stack. More... | |
| void | raise () |
| Raises this widget to the top of the parent widget's stack. More... | |
| void | repaint () |
| Repaints the widget directly by calling paintEvent() immediately, unless updates are disabled or the widget is hidden. More... | |
| void | setDisabled (bool) |
| Disables widget input events if disable is true; otherwise enables input events. More... | |
| void | setEnabled (bool) |
| void | setFocus () |
| Gives the keyboard input focus to this widget (or its focus proxy) if this widget or one of its parents is the active window. More... | |
| void | setHidden (bool hidden) |
| Convenience function, equivalent to setVisible(!hidden). More... | |
| QT_MOC_COMPAT void | setShown (bool shown) |
| Use setVisible(shown) instead. More... | |
| void | setStyleSheet (const QString &styleSheet) |
| virtual void | setVisible (bool visible) |
| void | setWindowModified (bool) |
| void | setWindowTitle (const QString &) |
| void | show () |
| Shows the widget and its child widgets. More... | |
| void | showFullScreen () |
| Shows the widget in full-screen mode. More... | |
| void | showMaximized () |
| Shows the widget maximized. More... | |
| void | showMinimized () |
| Shows the widget minimized, as an icon. More... | |
| void | showNormal () |
| Restores the widget after it has been maximized or minimized. More... | |
| void | update () |
| Updates the widget unless updates are disabled or the widget is hidden. More... | |
| Public Slots inherited from QObject | |
| void | deleteLater () |
| Schedules this object for deletion. More... | |
| Static Public Functions inherited from QWidget | |
| static QWidget * | find (WId) |
| Returns a pointer to the widget with window identifer/handle id. More... | |
| static QWidget * | keyboardGrabber () |
| Returns the widget that is currently grabbing the keyboard input. More... | |
| static QWidget * | mouseGrabber () |
| Returns the widget that is currently grabbing the mouse input. More... | |
| static void | setTabOrder (QWidget *, QWidget *) |
| Puts the second widget after the first widget in the focus order. More... | |
| Static Public Functions inherited from QObject | |
| static bool | connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection) |
| Creates a connection of the given type from the signal in the sender object to the method in the receiver object. More... | |
| static bool | connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection) |
| static bool | disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member) |
| Disconnects signal in object sender from method in object receiver. More... | |
| static bool | disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member) |
| static uint | registerUserData () |
| static QString | tr (const char *sourceText, const char *comment=0, int n=-1) |
| static QString | trUtf8 (const char *sourceText, const char *comment=0, int n=-1) |
| Static Public Functions inherited from QPaintDevice | |
| static QWSDisplay * | qwsDisplay () |
| Static Public Variables inherited from QObject | |
| static const QMetaObject | staticMetaObject |
| This variable stores the meta-object for the class. More... | |
| Protected Slots inherited from QWidget | |
| void | updateMicroFocus () |
| Updates the widget's micro focus. More... | |
| Protected Variables inherited from QObject | |
| QScopedPointer< QObjectData > | d_ptr |
| Protected Variables inherited from QPaintDevice | |
| ushort | painters |
| Static Protected Variables inherited from QObject | |
| static const QMetaObject | staticQtMetaObject |
| Related Functions inherited from QWidget | |
| QWidgetList | |
| WId | |
| Platform dependent window identifier. More... | |
| Related Functions inherited from QObject | |
| T | qFindChildqFindChildren (const QObject *obj, const QString &name)() |
| QList< T > | qFindChildrenqFindChildren (const QObject *obj, const QString &name)() |
| QList< T > | qFindChildrenqFindChildren (const QObject *obj, const QRegExp ®Exp)() |
| T * | qobject_cast (QObject *object) |
| QObjectList | |
| void * | qt_find_obj_child (QObject *parent, const char *type, const QString &name) |
| Returns a pointer to the object named name that inherits type and with a given parent. More... | |
| Related Functions inherited from QPaintDevice | |
| const Q_GUI_EXPORT QX11Info * | qt_x11Info (const QPaintDevice *pd) |
| Returns the QX11Info structure for the pd paint device. More... | |
The QDockWidget class provides a widget that can be docked inside a QMainWindow or floated as a top-level window on the desktop.
QDockWidget provides the concept of dock widgets, also know as tool palettes or utility windows. Dock windows are secondary windows placed in the {dock widget area} around the central widget in a QMainWindow.
Dock windows can be moved inside their current area, moved into new areas and floated (e.g., undocked) by the end-user. The QDockWidget API allows the programmer to restrict the dock widgets ability to move, float and close, as well as the areas in which they can be placed.
A QDockWidget consists of a title bar and the content area. The title bar displays the dock widgets window title, a float button and a close button. Depending on the state of the QDockWidget, the float and close buttons may be either disabled or not shown at all.
The visual appearance of the title bar and buttons is dependent on the style in use.
A QDockWidget acts as a wrapper for its child widget, set with setWidget(). Custom size hints, minimum and maximum sizes and size policies should be implemented in the child widget. QDockWidget will respect them, adjusting its own constraints to include the frame and title. Size constraints should not be set on the QDockWidget itself, because they change depending on whether it is docked; a docked QDockWidget has no frame and a smaller title bar.
Definition at line 60 of file qdockwidget.h.
| Enumerator | |
|---|---|
| DockWidgetClosable | |
| DockWidgetMovable | |
| DockWidgetFloatable | |
| DockWidgetVerticalTitleBar | |
| DockWidgetFeatureMask | |
| AllDockWidgetFeatures | |
| NoDockWidgetFeatures | |
| Reserved | |
Definition at line 78 of file qdockwidget.h.
|
explicit |
Constructs a QDockWidget with parent parent and window flags flags.
The dock widget will be placed in the left dock widget area.
The window title is set to title. This title is used when the QDockWidget is docked and undocked. It is also used in the context menu provided by QMainWindow.
Definition at line 1189 of file qdockwidget.cpp.
|
explicit |
Constructs a QDockWidget with parent parent and window flags flags.
The dock widget will be placed in the left dock widget area.
Definition at line 1171 of file qdockwidget.cpp.
| QDockWidget::~QDockWidget | ( | ) |
| Qt::DockWidgetAreas QDockWidget::allowedAreas | ( | ) | const |
Referenced by setAllowedAreas().
|
signal |
This signal is emitted when the allowedAreas property changes.
The allowedAreas parameter gives the new value of the property.
Referenced by setAllowedAreas().
|
protectedvirtual |
Reimplemented Function
Reimplemented from QWidget.
Definition at line 1348 of file qdockwidget.cpp.
|
protectedvirtual |
Reimplemented Function
Reimplemented from QWidget.
Definition at line 1378 of file qdockwidget.cpp.
|
signal |
This signal is emitted when the dock widget is moved to another dock area, or is moved to a different location in its current dock area.
This happens when the dock widget is moved programmatically or is dragged to a new location by the user.
Referenced by QMainWindowLayout::addDockWidget(), QMainWindowLayout::restoreDockWidget(), QDockAreaLayoutInfo::restoreState(), QMainWindowLayout::splitDockWidget(), and QMainWindowLayout::tabifyDockWidget().
|
protectedvirtual |
Reimplemented Function
Reimplemented from QWidget.
Definition at line 1415 of file qdockwidget.cpp.
| DockWidgetFeatures QDockWidget::features | ( | ) | const |
Referenced by setFeatures().
|
signal |
This signal is emitted when the features property changes.
The features parameter gives the new value of the property.
Referenced by setFeatures().
|
protected |
Initialize option with the values from this QDockWidget.
This method is useful for subclasses when they need a QStyleOptionDockWidget, but don't want to fill in all the information themselves.
Definition at line 618 of file qdockwidget.cpp.
Referenced by paintEvent(), and QDockWidgetLayout::setGeometry().
|
inline |
Returns true if this dock widget can be placed in the given area; otherwise returns false.
Definition at line 104 of file qdockwidget.h.
|
inline |
Definition at line 96 of file qdockwidget.h.
Referenced by QAccessibleTitleBar::actionText(), QWindowsVistaStyle::drawControl(), event(), QDockWidgetLayout::minimumSize(), paintEvent(), QDockWidgetLayout::setGeometry(), and QDockWidgetLayout::sizeHint().
|
protectedvirtual |
Reimplemented Function
Reimplemented from QWidget.
Definition at line 1387 of file qdockwidget.cpp.
| void QDockWidget::setAllowedAreas | ( | Qt::DockWidgetAreas | areas | ) |
Definition at line 1321 of file qdockwidget.cpp.
| void QDockWidget::setFeatures | ( | DockWidgetFeatures | features | ) |
Definition at line 1245 of file qdockwidget.cpp.
| void QDockWidget::setFloating | ( | bool | floating | ) |
Definition at line 1287 of file qdockwidget.cpp.
Referenced by QDockAreaLayoutInfo::restoreState().
| void QDockWidget::setTitleBarWidget | ( | QWidget * | widget | ) |
Sets an arbitrary widget as the dock widget's title bar.
If widget is 0, any custom title bar widget previously set on the dock widget is removed, but not deleted, and the default title bar will be used instead.
If a title bar widget is set, QDockWidget will not use native window decorations when it is floated.
Here are some tips for implementing custom title bars:
Mouse events that are not explicitly handled by the title bar widget must be ignored by calling QMouseEvent::ignore(). These events then propagate to the QDockWidget parent, which handles them in the usual manner, moving when the title bar is dragged, docking and undocking when it is double-clicked, etc.
The title bar widget must have a valid QWidget::sizeHint() and QWidget::minimumSizeHint(). These functions should take into account the current orientation of the title bar.
Using qobject_cast() as shown above, the title bar widget has full access to its parent QDockWidget. Hence it can perform such operations as docking and hiding in response to user actions.
Definition at line 1632 of file qdockwidget.cpp.
| void QDockWidget::setWidget | ( | QWidget * | widget | ) |
Sets the widget for the dock widget to widget.
If the dock widget is visible when widget is added, you must QWidget::show() it explicitly.
Note that you must add the layout of the widget before you call this function; if not, the widget will not be visible.
Definition at line 1226 of file qdockwidget.cpp.
Referenced by QScriptEngineDebugger::standardWindow().
| QWidget * QDockWidget::titleBarWidget | ( | ) | const |
Returns the custom title bar widget set on the QDockWidget, or 0 if no custom title bar has been set.
Definition at line 1656 of file qdockwidget.cpp.
| QAction * QDockWidget::toggleViewAction | ( | ) | const |
Returns a checkable action that can be used to show or close this dock widget.
The action's text is set to the dock widget's window title.
Definition at line 1522 of file qdockwidget.cpp.
Referenced by QMainWindow::createPopupMenu(), and QScriptEngineDebugger::standardWindow().
|
signal |
This signal is emitted when the floating property changes.
The topLevel parameter is true if the dock widget is now floating; otherwise it is false.
|
signal |
This signal is emitted when the dock widget becomes visible (or invisible).
This happens when the widget is hidden or shown, as well as when it is docked in a tabbed dock area and its tab becomes selected or unselected.
Referenced by QDockAreaLayoutInfo::apply(), and event().
| QWidget * QDockWidget::widget | ( | ) | const |
Returns the widget for the dock widget.
This function returns zero if the widget has not been set.
Definition at line 1209 of file qdockwidget.cpp.
Referenced by QAccessibleDockWidget::childCount(), and QAccessibleDockWidget::rect().
|
friend |
Definition at line 130 of file qdockwidget.h.
|
friend |
Definition at line 134 of file qdockwidget.h.
|
friend |
Definition at line 131 of file qdockwidget.h.
|
friend |
Definition at line 133 of file qdockwidget.h.
|
friend |
Definition at line 132 of file qdockwidget.h.
|
private |
areas where the dock widget may be placed
The default is Qt::AllDockWidgetAreas.
Definition at line 67 of file qdockwidget.h.
|
private |
whether the dock widget is movable, closable, and floatable
By default, this property is set to a combination of DockWidgetClosable, DockWidgetMovable and DockWidgetFloatable.
Definition at line 66 of file qdockwidget.h.
Referenced by hasFeature().
|
private |
whether the dock widget is floating
A floating dock widget is presented to the user as an independent window "on top" of its parent QMainWindow, instead of being docked in the QMainWindow.
By default, this property is true.
Definition at line 65 of file qdockwidget.h.
|
private |
the dock widget title (caption)
By default, this property contains an empty string.
Definition at line 68 of file qdockwidget.h.