User Tools

Site Tools


DzPane

Methods

Signals

voidlabelChanged ( String newLabel )
voidmenuChanged ()
voidpaneGroupChanged ( DzPaneGroup oldGroup, DzPaneGroup newGroup )
voidtabBarHiddenChanged ( Boolean hidden )
voidvisibilityChanged ( Boolean onOff )

Detailed Description

A “Pane” is the application's implementation of a persistent non-modal set of closely related widgets that can be stacked, ordered, docked, undocked, minimized, restored, shown, hidden, positioned and/or resized by the end-user.

Each pane has a label that is attached to the outer perimeter of the pane; whether the label appears as a tab/button/etc. to the user depends on the “style” that they currently has applied. A pane's label should briefly describe the concept (product, service, etc.) presented to the user within the pane.

Actions performed by the user that are closely related to the concept of a given pane, but do not warrant a persitent widget within the pane itself, or are more advanced in nature, should be considered for placement with the pane's option menu.

A pane is only ever displayed to the user within a DzPaneGroup; this is what gives the pane its ability to be stacked, ordered, docked, undocked, minimized, restored, shown, hidden, positioned and/or resized. A pane can only ever exist within one DzPaneGroup at a time.

Panes are singletons; there is only one instance of a given DzPane subclass. Panes are registered with DzPaneMgr and are available to access and modifiy via script. Use DzPaneMgr::findPane() to obtain a pointer to the single instance of the subclass, using its classname.

Methods


void : buildOptionsMenu( DzActionMenu menu )

Sub classes must reimplement this function to generate a default options menu if they have one. This function is called when the pane is loaded for the first time or the interface is reset. Otherwise, the option menus are loaded from the user's interface settings file.

Parameter(s):

  • menu - The menu to add to.

String : getLabel()

Return Value:

  • The label of this pane.

DzActionMenu : getOptionsMenu()

Return Value:

Attention:

  • This function should not be used for adding a DzAction to a pane's option menu. Doing so defeats the user's ability to customize their interface settings. Instead, adding an action should be accomplished by reimplementing DzAction::getDefaultMenuPath().

Number : getOptionsMenuVersion()

Sub classes must reimplement this function to provide the interface manager with the ability to update the user's settings file when the pane's default menu has changed. This function should return a value of 1 or greater if the pane provides a menu. Each time the default menu changes, this number should be incremented.


DzPaneGroup : getPaneGroup()

Return Value:


void : hidePane()

Hides this pane in the interface.


void : makeGroupDockable()

Moves the DzPaneGroup that this pane is in, out of an undockable dialog.

Since:

  • 4.10.0.46

void : makeGroupUndockable()

Moves the DzPaneGroup that this pane resides in to a dialog.


void : makeUndockable( Size minSize=Size )

Creates a DzPaneGroup in a dialog, and moves this pane into it.

Parameter(s):

  • minSize - The minimum size for the dialog (if any). This will be expanded to at least the minimum size of the pane.

void : moveToGroup( DzPaneGroup group )

Moves this pane from its current pane group into the given pane group.

Parameter(s):

  • group - The group to move this pane to.

void : refresh()

Called to refresh internal pane data when scene contents, etc have changed.


void : restoreSettings( DzPaneSettings settings )

Sub classes must reimplement this function to restore their saved settings.

Parameter(s):

  • settings - The settings to restore.

void : saveSettings( DzPaneSettings settings )

Sub classes must reimplement this function to save their current settings.

Parameter(s):

  • settings - The settings that will be saved.

void : setLabel( String label )

Sets the label for this pane.

Parameter(s):

  • label - The new label for this pane.

void : showPane()

Shows this pane in the interface.


void : undock( Point pos=Point, Size size=Size )

Creates an undocked DzPaneGroup and moves this pane into it.

Parameter(s):

  • pos - The position for the undocked pane group (if any).
  • size - The size for the undocked pane group (if any). This will be expanded to at least the minimum size of the pane.

Since:

  • 4.10.0.47

void : undockGroup( Point pos=Point, Size size=Size )

Undocks the DzPaneGroup that this pane resides in.

Parameter(s):

  • pos - The position for the undocked pane group (if any).
  • size - The size for the undocked pane group (if any). This will be expanded to at least the minimum size of the pane.

Since:

  • 4.10.0.47

Signals


void : labelChanged( String newLabel )

Signature:“labelChanged(const QString&)”

Emitted when the pane's label has changed.

Parameter(s):

  • newLabel - The new label for the pane.

void : menuChanged()

Signature:“menuChanged()”

Emitted when the options menu for the pane has changed.


void : paneGroupChanged( DzPaneGroup oldGroup, DzPaneGroup newGroup )

TODO: Add description.


void : tabBarHiddenChanged( Boolean hidden )

Signature:“tabBarHiddenChanged(bool)”

Emitted when the visibility of the pane's tab bar is changed. When the tab bar is hidden, it's options menu is not visible. If desired, pane instances can listen to this signal to know when the menu is hidden in order to provide an alternate method of accessing the menu options.

Parameter(s):

  • hidden - If true, the tab bar is hidden.

void : visibilityChanged( Boolean onOff )

Signature:“visibilityChanged(bool)”

Emitted when the pane is shown or hidden.

Parameter(s):

  • onOff - If true, the pane is visible.