User Tools

Site Tools


DzDockBar

Class that encapsulates a custom QToolBar that can be docked with a DzToolBar.

More...

Inherited By : statusbar_dz

Enumerations

Methods

DAZ Script
voiddock ( DzDockBar::DockArea area, String beforeBar=“” )
DockAreadockedArea ()
BooleanisClosed ()
voidsetClosed ( Boolean onOff )
voidundock ( Point pos )

Detailed Description

This class provides access to a custom bar in the interface that can be docked with a DzToolBar. This class is not intended to be constructed directly, rather it serves as a base class for other custom dockable bars.

See Also:

Enumerations


: DockArea

The areas of a DzActivityLayout where the bar can be docked.

  • ToolBarTop - The dock area at the top of a DzActivityLayout.
  • ToolBarBottom - The dock area at the bottom of a DzActivityLayout.
  • ToolBarLeft - The dock area on the left side of a DzActivityLayout.
  • ToolBarRight - The dock area on the right side of a DzActivityLayout.
  • NoToolBarArea - No dock area. The bar cannot be docked.

Methods


void : dock( DzDockBar::DockArea area, String beforeBar=“” )

Docks the bar in the specified area on the DzActivityLayout, and shows the bar if it is hidden.

Parameter(s):

  • area - The DockArea to dock the bar to.
  • beforeBar - The name of the bar in the area to dock before

DockArea : dockedArea()

Return Value:

  • The dock area that the bar is docked in.

Boolean : isClosed()

Return Value:

  • true if the bar is closed (not displayed), false if the bar is open (displayed).

void : setClosed( Boolean onOff )

Sets whether the bar is closed (not displayed), or open (displayed).


void : undock( Point pos )

Undocks the bar, moves it to the given global coordinates, and shows the bar if it is hidden.