DzMainWindow Class Reference
[Core ObjectsInterface Components]

The main interface widget. More...

List of all members.

Properties

Boolean alwaysOnTop
Boolean toolTipsEnabled

Methods

Boolean askSaveChanges ()
Boolean askTurnOffLimits ()
Boolean checkExistingFile (String name)
void displayPrompt (String msg, Number millisec=-1)
Boolean doAudioClipOpenDialog (String filename)
DzDockArea dockArea (Point pos)
Boolean doDirectoryDialog (String title, String desc, String dir)
Boolean doFileDialog (Boolean open, String title, String startWith, DzFileFilter fileFilter, String filename)
Boolean doFileExport ()
Boolean doFileImport ()
Boolean doFileMerge ()
Boolean doFileOpen ()
Boolean doFileSave ()
Boolean doFileSaveAs ()
Boolean doImageDialog (Boolean open, String filename)
Image doImageOpen ()
Boolean doImageSaveAs (Image image)
Boolean doNewFile ()
Boolean doOpenFilesDialog (String title, String startWith, DzFileFilter fileFilter, Array filenames)
Boolean doVideoClipSaveAs (DzVideoClip clip)
Boolean doVideoClipSaveDialog (String filename)
void exitFullScreen ()
DzActionMgr getActionMgr ()
DzDockArea getBottomDockArea ()
DzDockArea getLeftDockArea ()
DzPaneMgr getPaneMgr ()
DzDockArea getRightDockArea ()
DzDockArea getTopDockArea ()
DzViewportMgr getViewportMgr ()
void goFullScreen ()
void removePrompt ()
void repaintActive3DViewport ()

Signals

void aboutToClose ()
 Signature: "aboutToClose()"
void alwaysOnTopChanged (Boolean onOff)
 Signature: "aboutToClose()"
void started ()
 Signature: "started()"


Detailed Description

The main interface widget.

There is only one of these widgets in the application, which is created and owned by DzApp.

It can be accessed by using the MainWindow global variable.


Member Function Documentation

void DzMainWindow::aboutToClose (  )  [signal]

Signature: "aboutToClose()"

Emitted just before the main window closes.

DzMainWindow::alwaysOnTopChanged ( Boolean  onOff  )  [signal]

Signature: "aboutToClose()"

Emitted when the main window is switched to/from being always on top.

bool DzMainWindow::askSaveChanges (  ) 

Presents the user with a dialog that asks if they want to save changes to the scene, and does a scene save if the user selects yes.

Returns:
False if the user selects 'Cancel', true if the user selects 'Yes' or 'No'.

bool DzMainWindow::askTurnOffLimits (  ) 

Presents the user with a dialog that asks if they want to turn off limits to apply the pose currently being loaded.

Returns:
true if limits should be turned off - false if limits should be left alone.

Boolean DzMainWindow::checkExistingFile ( String  name  ) 

Checks to see if the given file already exists - if it does, prompts the user if they want to overwrite it.

Parameters:
name The name of the file to look for.
Returns:
true if the file does not exist or the user wants to overwrite it - false if the user needs to select a new name.

void DzMainWindow::displayPrompt ( String  msg,
Number  millisec = -1 
)

Display a message in the status bar.

Parameters:
line Message to display
ms If greater than zero, the message will be displayed for the given amount of time, otherwise the message will be displayed until another message is sent.

Boolean DzMainWindow::doAudioClipOpenDialog ( String  filename  ) 

Conenience file dialog: Automatically creates a filter list for all audio formats we can import and displays a file open dialog

Returns:
true if the user selects a file, False if the user cancels.

DzDockArea DzMainWindow::dockArea ( Point  pos  ) 

Returns:
The dock area located at the goven position.

Boolean DzMainWindow::doDirectoryDialog ( String  title,
String  desc,
String  dir 
)

Display a dialog for the user to choose a directory

Parameters:
title Title of the dialog box - NO LONGER USED, use desc instead
desc A description caption for the dialog
dir Return value for chosen dir (empty on cancel)
Returns:
true if the user selects a directory, False if the user cancels.

Boolean DzMainWindow::doFileDialog ( Boolean  open,
String  title,
String  startWith,
DzFileFilter  fileFilter,
String  filename 
)

Display a dialog for the user to choose a file

Parameters:
open If true displays an open file dialog, otherwise displays a save file dialog.
title Title of the dialog box
startsWith Starting directory (can include a default file name)
fileFilter List of file types that can be selected.
filename Return value for filename
Returns:
true if the user selects a file, False if the user cancels.

Boolean DzMainWindow::doFileExport (  ) 

Displays a dialog for saving the scene to a non-native file, and saves the scene if the user does not cancel.

Returns:
true if a file was selected and successfully saved, otherwise false.

Boolean DzMainWindow::doFileImport (  ) 

Displays a dialog for loading a non-native file, and loads the file if the user does not cancel.

Returns:
true if a file was selected and successfully loaded, otherwise false.

Boolean DzMainWindow::doFileMerge (  ) 

Displays a dialog for loading a native scene file, and merges the file into the current scene if the user does not cancel.

Returns:
true if a file was selected and successfully loaded, otherwise false.

Boolean DzMainWindow::doFileOpen (  ) 

Displays a dialog for loading a native scene file, and opens the file as a new scene if the user does not cancel.

Returns:
true if a file was selected and successfully loaded, otherwise false.

Boolean DzMainWindow::doFileSave (  ) 

Saves the scene to the current scene file - displaying a dialog to the user if a file needs to be selected.

Returns:
true if a file was selected and successfully saved, otherwise false.

Boolean DzMainWindow::doFileSaveAs (  ) 

Displays a dialog for saving the scene to a native file, and saves the scene if the user does not cancel.

Returns:
true if a file was selected and successfully saved, otherwise false.

Boolean DzMainWindow::doImageDialog ( Boolean  open,
String  filename 
)

Conenience file dialog: Automatically creates a filter list for all image formats we can import/export and displays a file open/save dialog

Parameters:
open If true displays an open image dialog, otherwise displays a save image dialog.
filename Return value for filename
Returns:
true if the user selects a file, False if the user cancels.

Boolean DzMainWindow::doImageOpen (  ) 

Displays a dialog for loading an image file, and loads the file if the user does not cancel.

Returns:
Empty image if the user cancels, or loading fails, otherwise the selected image.

Boolean DzMainWindow::doImageSaveAs ( Image  image  ) 

Displays a dialog for saving the given image, and saves the image if the user does not cancel.

Returns:
true if a file was selected and successfully saved, otherwise false.

bool DzMainWindow::doNewFile (  ) 

Clears the scene

Boolean DzMainWindow::doOpenFilesDialog ( String  title,
String  startWith,
DzFileFilter  fileFilter,
Array  filenames 
)

Display a dialog for the user to open one or more files

Parameters:
title Title of the dialog box
startsWith Starting directory (can include a default file name)
fileFilter List of file types that can be selected.
filenames Set to the resulting list of files chosen by the user.
Returns:
true if the user selects a file, False if the user cancels.

Boolean DzMainWindow::doVideoClipSaveAs ( DzVideoClip  clip  ) 

Displays a dialog for saving the given video clip, and saves the clip if the user does not cancel.

Returns:
true if a file was selected and successfully saved, otherwise false.

Boolean DzMainWindow::doVideoClipSaveDialog ( String  filename  ) 

Conenience file dialog: Automatically creates a filter list for all video formats we can export and displays a file save dialog

Returns:
true if the user selects a file, False if the user cancels.

void DzMainWindow::exitFullScreen (  ) 

Switches from full screen back to normal mode

DzActionMgr DzMainWindow::getActionMgr (  ) 

Returns:
A pointer to the global Action manager for the application interface

DzDockArea DzMainWindow::getBottomDockArea (  ) 

Returns:
The dock area located at the bottom of the main window.

DzDockArea DzMainWindow::getLeftDockArea (  ) 

Returns:
The dock area located at the left of the main window.

DzPaneMgr DzMainWindow::getPaneMgr (  ) 

Returns:
A pointer to the global pane manager for the application interface

DzDockArea DzMainWindow::getRightDockArea (  ) 

Returns:
The dock area located at the right of the main window.

DzDockArea DzMainWindow::getTopDockArea (  ) 

Returns:
The dock area located at the top of the main window.

DzViewportMgr DzMainWindow::getViewportMgr (  ) 

Returns:
A pointer to the global viewport manager for the application interface

void DzMainWindow::goFullScreen (  ) 

Switches from normal to full screen mode

void DzMainWindow::removePrompt (  ) 

Clear the message in the status bar.

void DzMainWindow::repaintActive3DViewport (  ) 

A convenience method for forcing a repaint of the currently active 3D viewport (if any).

void DzMainWindow::started (  )  [signal]

Signature: "started()"

Emitted after the startup() function has finished.


Member Data Documentation

Boolean DzMainWindow::alwaysOnTop

Whether or not the main window is always on top of other application windows.

bool DzMainWindow::toolTipsEnabled

Whether or not tool tips are enabled.


Generated on Thu Sep 24 12:21:13 2009

Copyright © 2002 - 2009 DAZ 3D, Inc.