DzPaneMgr Class Reference
[Interface ComponentsManager Objects]

The manager for interface panes. More...

Inheritance diagram for DzPaneMgr:

QObject Object List of all members.

Enumerations



enum  DockSide {
  NO_DOCKING, DOCK_LEFT, DOCK_TOP, DOCK_RIGHT,
  DOCK_BOTTOM
}

Methods

void addLayout (DzPaneLayout layout)
void clearAllGroups ()
DzPaneLayout createLayout (String name, String description)
DzToolBar createToolBar (String name)
void enableActivityBar (Boolean onOff)
DzPaneLayout findLayout (String name)
DzPane findPane (String className)
DzToolBar findToolBar (String name)
DzPaneLayout getActiveLayout ()
Number getActiveLayoutIndex ()
String getActivityBarImage ()
Array getActivityBarImageList ()
DzPaneLayout getLayout (Number which)
Number getNumLayouts ()
Number getNumPaneGroups ()
Number getNumPanes ()
Number getNumToolBars ()
DzPaneGroup getPaneGroup (Number which)
Array getPaneGroupList ()
Array getPaneList ()
String getSessionLayout ()
DzToolBar getToolBar (Number i)
void hideAllPanes ()
void hideAllToolBars ()
DzError hidePane (DzPane pane)
DzError hidePane (String className)
DzError hidePaneGroup (DzPaneGroup group)
DzError hidePaneGroup (Number which)
Boolean isActivityBarEnabled ()
void loadNextActivityBarImage ()
DzError movePaneGroup (DzPaneGroup group, DockSide dock, Number index, Boolean newLine=false)
DzError movePaneGroup (DzPaneGroup group, DockSide dock=NO_DOCKING)
void removeAllLayouts ()
void removeAllToolBars ()
Boolean removeLayout (Number which)
Boolean removeLayout (String name)
void removeToolBar (String name)
DzError restoreLayout (String filename)
DzError saveLayout (String filename)
void setActiveLayout (DzPaneLayout which)
void setActiveLayout (Number which)
void setActivityBarImage (String img)
DzError setSessionLayout (String filename)
void showAllPanes ()
DzError showPane (DzPane pane)
DzError showPane (String className)
DzError showPaneGroup (DzPaneGroup group)
DzError showPaneGroup (Number which)
DzError tearOffPane (Number index, Number x=0, Number y=0)
DzError tearOffPane (DzPane pane, Number x=0, Number y=0)
DzError tearOffPane (String className, Number x=0, Number y=0)
DzError togglePane (Number index)
DzError togglePane (DzPane pane)
DzError togglePane (String className)

Signals

void activeLayoutChanged (Number which)
 Signature: "activeLayoutChanged(int)"
void activityBarEnabled (Boolean onOff)
 Signature: "activityBarEnabled(bool)"
void layoutListChanged ()
 Signature: "layoutListChanged()"
void layoutRestored (String filename)
 Signature: "layoutRestored(const QString&)"
void toolbarListChanged ()
 Signature: "toolbarListChanged()"

Detailed Description

The manager for interface panes.

There is only one instance of the pane manager object in DAZ Studio. You can get the pane manager by calling DzMainWindow::getPaneMgr().


Member Enumeration Documentation

enum DzPaneMgr::DockSide

The possible dock locations

Enumerator:
NO_DOCKING  Not docked
DOCK_LEFT  Docked on the left side
DOCK_TOP  Docked on the top
DOCK_RIGHT  Docked on the right side
DOCK_BOTTOM  Docked on the bottom


Member Function Documentation

void DzPaneMgr::activeLayoutChanged ( Number  which  )  [signal]

Signature: "activeLayoutChanged(int)"

Emitted when the active layout has changed.

void DzPaneMgr::activityBarEnabled ( Boolean  onOff  )  [signal]

Signature: "activityBarEnabled(bool)"

Emitted when the activity bar is enabled or disabled.

void DzPaneMgr::addLayout ( DzPaneLayout  layout  ) 

Adds the pane layout to the list of layouts for the pane manager.

void DzPaneMgr::clearAllGroups (  ) 

Removes all panes from all groups.

DzPaneLayout DzPaneMgr::createLayout ( String  name,
String  description 
)

Creates a new pane layout and adds it to the list of layouts for the pane manager.

DzToolBar DzPaneMgr::createToolBar ( String  name  ) 

Parameters:
name The name of the toolbar to get.
Returns:
A pointer to the tool bar of the given name, creates a tool bar if one does not already exist.

void DzPaneMgr::enableActivityBar ( Boolean  onOff  ) 

Sets whether or not the activity bar is visible in the interface.

DzPaneLayout DzPaneMgr::findLayout ( String  name  ) 

Parameters:
name The name of the layout to find.
Returns:
A pointer to the layout of the given name, or NULL if a matching layout was not found.

DzPane DzPaneMgr::findPane ( String  className  ) 

Returns:
The pane of the given type, NULL if none is found

DzToolBar DzPaneMgr::findToolBar ( String  name  ) 

Parameters:
name The name of the tool bar to find.
Returns:
A pointer to the tool bar of the given name, or NULL if a matching tool bar was not found.

DzPaneLayout DzPaneMgr::getActiveLayout (  ) 

Returns:
A pointer to the active layout for the pane manager.

Number DzPaneMgr::getActiveLayoutIndex (  ) 

Returns:
The index of the active layout for the pane manager.

String DzPaneMgr::getActivityBarImage (  ) 

Returns:
The name of the current activity bar image.

Array DzPaneMgr::getActivityBarImageList (  ) 

Returns:
A list of possible activity bar images.

DzPaneLayout DzPaneMgr::getLayout ( Number  which  ) 

Returns:
A pointer to the layout at the given index, NULL if the index is invalid

Number DzPaneMgr::getNumLayouts (  ) 

Returns:
The number of layouts currently available in the pane manager

Number DzPaneMgr::getNumPaneGroups (  ) 

Returns:
Number of pane groups currently available in the interface. Includes pane groups that are not currently showing.

Number DzPaneMgr::getNumPanes (  ) 

Returns:
Number of panes currently available in the interface. Includes panes that are not currently showing.

Number DzPaneMgr::getNumToolBars (  ) 

Returns:
The number of tool bars in the application.

DzPaneGroup DzPaneMgr::getPaneGroup ( Number  which  ) 

Returns:
The pane group at the given index, NULL if the index is invalid

Array DzPaneMgr::getPaneGroupList (  ) 

Returns:
An Array of all DzPaneGroup objects (aka Panes).

Array DzPaneMgr::getPaneList (  ) 

Returns:
An Array of all DzPane objects (aka Tabs).

String DzPaneMgr::getSessionLayout (  ) 

Returns:
The path to the file that is the layout for this session of DAZ Studio.

DzToolBar DzPaneMgr::getToolBar ( Number  i  ) 

Parameters:
i The index of the tool bar to return.
Returns:
A pointer to the i'th tool bar in the application, or NULL if the index is invalid.

void DzPaneMgr::hideAllPanes (  ) 

Hide all panes from view in the interface.

void DzPaneMgr::hideAllToolBars (  ) 

Hides all the tool bars in the application.

DzError DzPaneMgr::hidePane ( DzPane  pane  ) 

Hide the given pane from view in the interface.

DzError DzPaneMgr::hidePane ( String  className  ) 

Hide the given pane from view in the interface.

DzError DzPaneMgr::hidePaneGroup ( DzPaneGroup  group  ) 

Hide a pane group in the interface.

DzError DzPaneMgr::hidePaneGroup ( Number  which  ) 

Hide a pane group in the interface.

Boolean DzPaneMgr::isActivityBarEnabled (  ) 

Returns:
Whether or not the activity bar appears in the interface.

void DzPaneMgr::layoutListChanged (  )  [signal]

Signature: "layoutListChanged()"

Emitted when the list of available layouts has changed.

void DzPaneMgr::layoutRestored ( String  filename  )  [signal]

Signature: "layoutRestored(const QString&)"

Emitted when the layout is restored from a file.

void DzPaneMgr::loadNextActivityBarImage (  ) 

Loads the next image from the directory and sets it for the activity bar.

DzError DzPaneMgr::movePaneGroup ( DzPaneGroup  group,
DockSide  dock,
Number  index,
Boolean  newLine = false 
)

Moves a group to a new dock location.

DzError DzPaneMgr::movePaneGroup ( DzPaneGroup  group,
DockSide  dock = NO_DOCKING 
)

Moves a group to a new dock location.

void DzPaneMgr::removeAllLayouts (  ) 

Removes all the current layouts from the pane manager.

void DzPaneMgr::removeAllToolBars (  ) 

Removes all tool bars from the application.

Boolean DzPaneMgr::removeLayout ( Number  which  ) 

Removes the given layout from the pane manager.

Returns:
true if the layout existed and was removed.

Boolean DzPaneMgr::removeLayout ( String  name  ) 

Removes the given layout from the pane manager.

Returns:
true if the layout existed and was removed.

void DzPaneMgr::removeToolBar ( String  name  ) 

Parameters:
name The name of the tool bar to remove. Removes a tool bar from the application.

DzError DzPaneMgr::restoreLayout ( String  filename  ) 

Restores the pane layout from the given file.

DzError DzPaneMgr::saveLayout ( String  filename  ) 

Saves the current pane layout to the given file.

void DzPaneMgr::setActiveLayout ( DzPaneLayout  which  ) 

Sets the active layout for the pane manager.

void DzPaneMgr::setActiveLayout ( Number  which  ) 

Sets the active layout for the pane manager.

void DzPaneMgr::setActivityBarImage ( String  img  ) 

Sets the image for the activity bar.

Parameters:
img The name of the image to use in the activity bar, this should be one of the strings returned by getActivityImageList().

DzError DzPaneMgr::setSessionLayout ( String  filename  ) 

Sets the file that will be loaded and saved as the user's layout for this DAZ Studio session.

void DzPaneMgr::showAllPanes (  ) 

Make all panes visible in the interface.

DzError DzPaneMgr::showPane ( DzPane  pane  ) 

Make the given pane visible in the interface.

DzError DzPaneMgr::showPane ( String  className  ) 

Make the given pane visible in the interface.

DzError DzPaneMgr::showPaneGroup ( DzPaneGroup  group  ) 

Show a pane group in the interface.

DzError DzPaneMgr::showPaneGroup ( Number  which  ) 

Show a pane group in the interface.

DzError DzPaneMgr::tearOffPane ( Number  index,
Number  x = 0,
Number  y = 0 
)

Put the pane in its own pane group, if it's not already, and moves the pane group out of any dock area.

DzError DzPaneMgr::tearOffPane ( DzPane  pane,
Number  x = 0,
Number  y = 0 
)

Put the pane in its own pane group, if it's not already, and moves the pane group out of any dock area.

DzError DzPaneMgr::tearOffPane ( String  className,
Number  x = 0,
Number  y = 0 
)

Put the pane in its own pane group, if it's not already, and moves the pane group out of any dock area.

DzError DzPaneMgr::togglePane ( Number  index  ) 

Toggle the given pane's visiblity in the interface

DzError DzPaneMgr::togglePane ( DzPane  pane  ) 

Toggle the given pane's visiblity in the interface

DzError DzPaneMgr::togglePane ( String  className  ) 

Toggle the given pane's visiblity in the interface

void DzPaneMgr::toolbarListChanged (  )  [signal]

Signature: "toolbarListChanged()"

Emitted when the list of available toolbars has changed.


Generated on Thu Sep 24 12:21:14 2009

Copyright © 2002 - 2009 DAZ 3D, Inc.