DockPanelOptions Class

Contains a set of properties and methods for configuring the docking manager. More...

Header: #include <DockPanelOptions>
Inherits: QObject

Public Functions

int autoHideAnimationDuration() const
QEasingCurve autoHideAnimationEasingCurve() const
DockWidgetPanel::DockPanelFeatures features() const
bool isArrowMarkersShown() const
bool isAutoHideAnimationEnabled() const
bool isDockPanelFullContentsWhileDraggingShown() const
bool isDockPanelTransparentWhileDragging() const
int margin() const
void setArrowMarkersShown(bool show)
void setAutoHideAnimationDuration(int duration)
void setAutoHideAnimationEasingCurve(const QEasingCurve &easing)
void setAutoHideAnimationEnabled(bool enabled)
void setDockPanelFullContentsWhileDraggingShown(bool show)
void setDockPanelTransparentWhileDragging(bool transparent)
void setFeatures(DockWidgetPanel::DockPanelFeatures features)
void setMargin(int margin)

Detailed Description

Member Function Documentation

int DockPanelOptions::autoHideAnimationDuration() const

Returns the duration for the auto-hide panels animation.

See also setAutoHideAnimationDuration().

QEasingCurve DockPanelOptions::autoHideAnimationEasingCurve() const

Returns the easing curve for the auto-hide panels animation. By default it is QEasingCurve::OutExpo.

See also setAutoHideAnimationEasingCurve().

DockWidgetPanel::DockPanelFeatures DockPanelOptions::features() const

Returns the features that used by default for all dock panels.

See also setFeatures().

bool DockPanelOptions::isArrowMarkersShown() const

Returns true if special arrow-markers shown while dragging dockpanel. Otherwise it returns false.

bool DockPanelOptions::isAutoHideAnimationEnabled() const

Returns true if animation for the auto-hide panels is enabled. Otherwise it is false.

bool DockPanelOptions::isDockPanelFullContentsWhileDraggingShown() const

Returns true if panel's contents shown while it dragging. Otherwise it is false.

See also isDockPanelTransparentWhileDragging.

bool DockPanelOptions::isDockPanelTransparentWhileDragging() const

Returns true if the panel's transparent while it dragging. Otherwise it is false.

See also isDockPanelFullContentsWhileDraggingShown.

int DockPanelOptions::margin() const

Returns the margin for for the dock layout.

See also setMargin().

void DockPanelOptions::setArrowMarkersShown(bool show)

Shows or hides depending on show the special arrow markers that indicate dockable areas while dragging the dock panel.

See also isArrowMarkersShown().

void DockPanelOptions::setAutoHideAnimationDuration(int duration)

Sets the duration for the auto-hide panels animation in msec. By default it is 200 msec.

See also autoHideAnimationDuration().

void DockPanelOptions::setAutoHideAnimationEasingCurve(const QEasingCurve &easing)

Sets the easing curve for the auto-hide panels animation to easing.

See also autoHideAnimationEasingCurve().

void DockPanelOptions::setAutoHideAnimationEnabled(bool enabled)

Enables or disables an animation for the auto-hide panels. Parameter enabled is true if animation is enabled.

See also isAutoHideAnimationEnabled().

void DockPanelOptions::setDockPanelFullContentsWhileDraggingShown(bool show)

Shows or hides the panel's contents while dragging depending on a show flag.

See also isDockPanelFullContentsWhileDraggingShown() and setDockPanelTransparentWhileDragging.

void DockPanelOptions::setDockPanelTransparentWhileDragging(bool transparent)

Sets transparent panel while it dragging to transparent.

See also isDockPanelTransparentWhileDragging() and setDockPanelFullContentsWhileDraggingShown.

void DockPanelOptions::setFeatures(DockWidgetPanel::DockPanelFeatures features)

Sets the panel features that used by default for all dock panels.

See also features().

void DockPanelOptions::setMargin(int margin)

Sets the margin for for the dock layout.

See also margin().