DzPane Class Reference
[Interface Components]

Base class for all interface panes. More...

Inheritance diagram for DzPane:

DzHierarchyPane DzLibraryPane DzScriptedStepsPane DzScriptPane DzShaderPane List of all members.

Methods

String getLabel ()
DzActionMenu getOptionsMenu ()
Number getOptionsMenuVersion ()
DzPaneGroup getPaneGroup ()
void hidePane ()
void moveToGroup (DzPaneGroup group)
void refresh ()
void restoreSettings (DzPaneSettings settings)
void saveSettings (DzPaneSettings settings)
void showPane ()

Signals

void labelChanged (String newLabel)
 Signature: "labelChanged(const QString&)"
void menuChanged ()
 Signature: "menuChanged()"
void visibilityChanged (Boolean state)
 Signature: "visibilityChanged(bool)"

Detailed Description

Base class for all interface panes.


Member Function Documentation

String DzPane::getLabel (  ) 

Returns:
The label of the pane.

DzActionMenu DzPane::getOptionsMenu (  ) 

Returns:
The DzActionMenu for the pane.
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().

int DzPane::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 DzPane::getPaneGroup (  ) 

Returns:
The DzPaneGroup parent that we belong to.

void DzPane::hidePane (  ) 

Hides this pane in the interface.

DzPane::labelChanged ( String  newLabel  )  [signal]

Signature: "labelChanged(const QString&)"

Emitted when the pane's label has changed.

void DzPane::menuChanged (  )  [signal]

Signature: "menuChanged()"

Emitted when the options menu for the pane has changed.

void DzPane::moveToGroup ( DzPaneGroup  group  ) 

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

void DzPane::refresh (  ) 

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

Reimplemented in DzHierarchyPane.

void DzPane::restoreSettings ( DzPaneSettings  settings  ) 

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

void DzPane::saveSettings ( DzPaneSettings  settings  ) 

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

void DzPane::showPane (  ) 

Shows this pane in the interface.

DzPane::visibilityChanged ( Boolean  state  )  [signal]

Signature: "visibilityChanged(bool)"

Emitted when the pane is shown or hidden.


Generated on Thu Sep 24 12:21:14 2009

Copyright © 2002 - 2009 DAZ 3D, Inc.