DzLibraryPane Class Reference
[Interface Components]

Pane to display and access content from the library. More...

Inheritance diagram for DzLibraryPane:

DzPane List of all members.
void adjustFileInfoHeight (Number amount)
void adjustFolderListHeight (Number amount)
void browseToCategory (String categoryPath)
void cancelScan ()
DzContentManagerViewType contentViewType ()
DzContentFolder getCurrentFolder ()
Array getSelectedFileList ()
void goBack ()
void goForward ()
void goUp ()
void postScanEvent ()
void scanForContent ()
void setCurrentFolder (String folderPath)
void setFileInfoHeight (Boolean minimize, Number h)
void setFolderListHeight (Boolean minimize, Number h)
void setViewType (DzContentManagerViewType type)
void showFileExtensions (Boolean onOff)
void showFileToolTip (Boolean onOff)
Boolean showingFileExtensions ()
Boolean showingFileTooltip ()
void toggleFileInfoHeight ()
void toggleFolderListHeight ()
Boolean viewingLargeFileIcons ()
void viewLargeFileIcons (Boolean onOff)

Signals

void contextMenuAboutToShow (DzMenu menu, DzContentFile file)
 Signature: "contextMenuAboutToShow(DzMenu*,DzContentFile*)"
void showFileExtensionsChanged (Boolean onOff)
 Signature: "showFileExtensionsChanged(bool)"
void showFileTooltipChanged (Boolean onOff)
 Signature: "showFileTooltipChanged(bool)"
void viewCategoriesEZChanged (Boolean onOff)
 Signature: "viewCategoriesEZChanged(bool)"
void viewCategoriesListChanged (Boolean onOff)
 Signature: "viewCategoriesListChanged(bool)"
void viewCategoriesTreeChanged (Boolean onOff)
 Signature: "viewCategoriesTreeChanged(bool)"
void viewFoldersAsListChanged (Boolean onOff)
 Signature: "viewFoldersAsListChanged(bool)"
void viewFoldersAsTreeChanged (Boolean onOff)
 Signature: "viewFoldersAsTreeChanged(bool)"
void viewLargeFileIconsChanged (Boolean onOff)
 Signature: "viewLargeFileIconsChanged(bool)"

Detailed Description

Pane to display and access content from the library.

The interface pane used to display content assets according to categoric arrangement.

Todo:
DzContentManagerViewType is not exposed to script

Member Function Documentation

DzLibraryPane::adjustFileInfoHeight ( Number  amount  ) 

Sets divider bar value for the file browser/info widgets

Parameters:
amount The number of pixels to adjust the divider bar, between the file browser and file info widgets, by.

void DzLibraryPane::adjustFolderListHeight ( Number  amount  ) 

Sets divider bar value for the folder/file widgets

Parameters:
amount The number of pixels to adjust the divider bar, between the folder list and file browser widgets, by.

void DzLibraryPane::browseToCategory ( String  categoryPath  ) 

Browses to the given category in the library pane.

void DzLibraryPane::cancelScan (  ) 

Cancels a content scan

DzContentManagerViewType DzLibraryPane::contentViewType (  ) 

Returns:
0 if the folders are displayed to the user as a set of scrollable lists. 1 if they are being displayed in tree style. 2 if categories are being displayed.

DzLibraryPane::contextMenuAboutToShow ( DzMenu  menu,
DzContentFile  file 
) [signal]

Signature: "contextMenuAboutToShow(DzMenu*,DzContentFile*)"

Emitted when the pane is about to display a context menu. Other objects can connect to this signal to add custom items to the menu that is displayed to the user.

DzContentFolder DzLibraryPane::getCurrentFolder (  ) 

Returns:
The current folder that the browser is pointing to, if any.

Array DzLibraryPane::getSelectedFileList (  ) 

Returns:
A list of currently selected files in the content browser, if any.

void DzLibraryPane::goBack (  ) 

Returns to the previous folder after a folder change

void DzLibraryPane::goForward (  ) 

Returns to the previous folder after a goBack() call

void DzLibraryPane::goUp (  ) 

Changes to the parent folder of the current folder

void DzLibraryPane::postScanEvent (  ) 

Sends an event to start a content scan.

void DzLibraryPane::scanForContent (  ) 

Scan the mapped directories for new content.

DzContentFolder DzLibraryPane::setCurrentFolder ( String  folderPath  ) 

Changes the current folder to the given folder, if it can be found in a content path.

void DzLibraryPane::setFileInfoHeight ( Boolean  minimize,
Number  h 
)

Sets the height for the file info widget.

Parameters:
minimize If true, the file info widget is toggled to the minimized state
h Height, in pixels, of the file info widget, in its normal state

void DzLibraryPane::setFolderListHeight ( Boolean  minimize,
Number  h 
)

Sets the height for the folder list widget.

Parameters:
minimize If true, the folder list widget is toggled to the minimized state
h Height, in pixels, of the folder list widget, in its normal state

void DzLibraryPane::setViewType ( DzContentManagerViewType  type  ) 

Sets the folder view to be a category, folder list, or folder tree view.

Parameters:
type If 0, the folders are displayed to the user as a set of scrollable lists. If 1, they are displayed as a tree style view. If 2, categories are displayed.

void DzLibraryPane::showFileExtensions ( Boolean  onOff  ) 

Sets whether or not to show file extensions.

DzLibraryPane::showFileExtensionsChanged ( Boolean  onOff  )  [signal]

Signature: "showFileExtensionsChanged(bool)"

Emitted when the view type has changed.

void DzLibraryPane::showFileToolTip ( Boolean  onOff  ) 

Sets whether the file information tool tip is displayed.

Parameters:
onOff If true, the file tool tip is displayed If false, the file tool tip is not displayed

DzLibraryPane::showFileTooltipChanged ( Boolean  onOff  )  [signal]

Signature: "showFileTooltipChanged(bool)"

Emitted when the view type has changed.

bool DzLibraryPane::showingFileExtensions (  ) 

Returns:
Whether or not file extensions are shown.

bool DzLibraryPane::showingFileTooltip (  ) 

Returns:
Whether or not file tool tips are shown.

void DzLibraryPane::toggleFileInfoHeight (  ) 

Toggles divider bar for the file browser/info widgets - i.e. opens/closes the file info view.

void DzLibraryPane::toggleFolderListHeight (  ) 

Toggles divider bar for the folder/file widgets - i.e. opens/closes the folder list view.

DzLibraryPane::viewCategoriesEZChanged ( Boolean  onOff  )  [signal]

Signature: "viewCategoriesEZChanged(bool)"

Emitted when the view type has changed.

DzLibraryPane::viewCategoriesListChanged ( Boolean  onOff  )  [signal]

Signature: "viewCategoriesListChanged(bool)"

Emitted when the view type has changed.

DzLibraryPane::viewCategoriesTreeChanged ( Boolean  onOff  )  [signal]

Signature: "viewCategoriesTreeChanged(bool)"

Emitted when the view type has changed.

DzLibraryPane::viewFoldersAsListChanged ( Boolean  onOff  )  [signal]

Signature: "viewFoldersAsListChanged(bool)"

Emitted when the view type has changed.

DzLibraryPane::viewFoldersAsTreeChanged ( Boolean  onOff  )  [signal]

Signature: "viewFoldersAsTreeChanged(bool)"

Emitted when the view type has changed.

Boolean DzLibraryPane::viewingLargeFileIcons (  ) 

Returns:
true if the large size file icons are being displayed to the user, false if the small file icons are being displayed.

void DzLibraryPane::viewLargeFileIcons ( Boolean  onOff  ) 

Sets the display of file icons to large or small.

Parameters:
onOff If true, the file icons are displayed at full size: 91 X 91 If false, the file icons are displayed at reduced size: 30 X 30

DzLibraryPane::viewLargeFileIconsChanged ( Boolean  onOff  )  [signal]

Signature: "viewLargeFileIconsChanged(bool)"

Emitted when the view type has changed.

Generated on Thu Sep 24 12:21:13 2009

Copyright © 2002 - 2009 DAZ 3D, Inc.