DzBasicDialog Class Reference
[Interface Dialog Objects]

A basic dialog that provides typical buttons found on most DAZ Studio dialogs. More...

Inheritance diagram for DzBasicDialog:

DzDialog DzWidget List of all members.

Constructors

 DzBasicDialog ()

Methods

void addButton (DzButton btn, Number index=1)
void addLayout (DzLayout layout, Number stretch=0)
void addSpacing (Number spacing)
void addStretch (Number stretch=0)
void addWidget (DzWidget child, Number stretch=0)
void enableApplyButton (Boolean onOff)
void enableCancelButton (Boolean onOff)
void enableHelpButton (Boolean onOff)
void setAcceptButtonText (String text)
void setApplyButtonText (String text)
void setCancelButtonText (String text)

Detailed Description

A basic dialog that provides typical buttons found on most DAZ Studio dialogs.

The buttons provided by the dialog are: 'What's This', 'Apply', 'Accept',and 'Cancel'. Custom buttons can also be added to the set of default buttons by calling addButton(). All buttons but the 'Accept' button can be hidden or shown. By default, the 'Apply' button is the only hidden button. The text on the default buttons can be customized.

The dialog has a vertical box layout above the horizontal set of buttons. Widgets and sub-layouts can be added to this layout using addWidget() and addLayout().


Constructor & Destructor Documentation

DzBasicDialog::DzBasicDialog (  ) 

Default Constructor. Creates a typical DAZ Studio dialog with 'What's This', 'Apply', 'Accept', and 'Cancel' buttons. By default, the 'Apply' button is hidden, call enableApplyButton() to make it visible.


Member Function Documentation

void DzBasicDialog::addButton ( DzButton  btn,
Number  index = 1 
) [slot]

Adds a button into the horizontal layout of the dialog's button bar.

Parameters:
btn The button to add to the dialog's button layout.
index The position in the button bar to insert the button.

void DzBasicDialog::addLayout ( DzLayout  layout,
Number  stretch = 0 
) [slot]

Adds a layout into the main vertical layout of the dialog.

Parameters:
child The layout to add as a child of the dialog's main layout.
stretch The stretch factor for the child layout.

void DzBasicDialog::addSpacing ( Number  spacing  )  [slot]

Adds spacing into the main vertical layout of the dialog.

Parameters:
spacing The amount of spacing to add.

void DzBasicDialog::addStretch ( Number  stretch = 0  )  [slot]

Adds stretch into the main vertical layout of the dialog.

Parameters:
stretch The stretch factor for the added stretchable space.

void DzBasicDialog::addWidget ( DzWidget  child,
Number  stretch = 0 
) [slot]

Adds a widget into the main vertical layout of the dialog.

Parameters:
child The widget to add to the dialog's main layout.
stretch The stretch factor for the child widget.

void DzBasicDialog::enableApplyButton ( Boolean  onOff  )  [slot]

Enables or disables the apply button. By default, the button is not enabled, in which case the button is not displayed in the dialog.

Parameters:
onOff If true, the 'Apply' button will be available to the user. If false, the button will not be shown.

void DzBasicDialog::enableCancelButton ( Boolean  onOff  )  [slot]

Enables or disables the cancel button. By default, the button is enabled.

Parameters:
onOff If true, the 'Cancel' button will be available to the user. If false, the button will not be shown.

void DzBasicDialog::enableHelpButton ( Boolean  onOff  )  [slot]

Enables or disables the What's This button. By default, the button is enabled.

Parameters:
onOff If true, the 'What's This' button will be available to the user. If false, the button will not be shown.

void DzBasicDialog::setAcceptButtonText ( String  text  )  [slot]

Sets the text for the dialog's accept button. By default, the button is labelled 'Accept'.

Parameters:
text The new label for the accept button.

void DzBasicDialog::setApplyButtonText ( String  text  )  [slot]

Sets the text for the dialog's apply button. By default, the button is labelled 'Apply'.

Parameters:
text The new label for the apply button.

void DzBasicDialog::setCancelButtonText ( String  text  )  [slot]

Sets the text for the dialog's cancel button. By default, the button is labelled 'Cancel'.

Parameters:
text The new label for the cancel button.


Generated on Thu Sep 24 12:21:10 2009

Copyright © 2002 - 2009 DAZ 3D, Inc.