A basic dialog that provides typical buttons found on most DAZ Studio dialogs.
Inherits :
DAZ Script |
---|
DzBasicDialog () |
void | applyClicked () |
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().
See Also:
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 showApplyButton() to make it visible.
void : addButton( DzButton btn, Number index=1 )
Adds a button into the horizontal layout of the dialog's button bar.
Parameter(s):
void : addLayout( DzLayout layout, Number stretch=0 )
Adds a layout into the main vertical layout of the dialog.
Parameter(s):
void : addSpacing( Number spacing )
Adds spacing into the main vertical layout of the dialog.
Parameter(s):
void : addStretch( Number stretch=0 )
Adds stretch into the main vertical layout of the dialog.
Parameter(s):
void : addWidget( DzWidget child, Number stretch=0, DzWidget::AlignmentFlags alignment=0 )
Adds a widget into the main vertical layout of the dialog.
Parameter(s):
void : insertLayout( Number index, DzLayout layout, Number stretch=0 )
Inserts a layout into the main vertical layout of the dialog.
Parameter(s):
Since:
void : insertWidget( Number index, DzWidget child, Number stretch=0, DzWidget::AlignmentFlags alignment=0 )
Inserts a widget into the main vertical layout of the dialog.
Parameter(s):
Since:
void : setAcceptButtonAsDefault()
Sets the 'Accept' button is set as the default button for the dialog.
Since:
void : setAcceptButtonEnabled( Boolean onOff )
Enables or disables the Accept button. By default, the button is enabled.
Parameter(s):
true
, the 'Accept' button will be available to the user. If false
, the button will not be shown.void : setAcceptButtonText( String text )
Sets the text for the dialog's accept button. By default, the button is labelled 'Accept'.
Parameter(s):
void : setApplyButtonAsDefault()
Sets the 'Apply' button is set as the default button for the dialog.
Since:
void : setApplyButtonEnabled( Boolean onOff )
Enables or disables the Apply button. By default, the button is disabled.
Parameter(s):
true
, the 'Apply' button will be available to the user. If false
, the button will not be shown.void : setApplyButtonText( String text )
Sets the text for the dialog's apply button. By default, the button is labelled 'Apply'.
Parameter(s):
void : setCancelButtonAsDefault()
Sets the 'Cancel' button is set as the default button for the dialog.
Since:
void : setCancelButtonEnabled( Boolean onOff )
Enables or disables the Cancel button. By default, the button is enabled.
Parameter(s):
true
, the 'Cancel' button will be available to the user. If false
, the button will not be shown.void : setCancelButtonText( String text )
Sets the text for the dialog's cancel button. By default, the button is labelled 'Cancel'.
Parameter(s):
void : setDefaultButton( DzButton btn )
Set the default button for the dialog.
Parameter(s):
Since:
void : setHelpButtonAsDefault()
Sets the 'Help' button is set as the default button for the dialog.
Since:
void : setHelpButtonEnabled( Boolean onOff )
Enables or disables the Help button. By default, the button is enabled.
Parameter(s):
true
, the 'Help' button will be available to the user. If false
, the button will not be shown.void : showAcceptButton( Boolean onOff )
Shows or hides the 'Accept' button. By default, the button is shown.
Parameter(s):
true
, the 'Accept' button will be available to the user. If false
, the button will not be shown.void : showApplyButton( Boolean onOff )
Shows or hides the 'Apply' button. By default, the button is hidden.
Parameter(s):
true
, the 'Apply' button will be available to the user. If false
, the button will not be shown.void : showCancelButton( Boolean onOff )
Shows or hides the 'Cancel' button. By default, the button is shown.
Parameter(s):
true
, the 'Cancel' button will be available to the user. If false
, the button will not be shown.void : showHelpButton( Boolean onOff )
Shows or hides the 'What's This' button. By default, the button is shown.
Parameter(s):
true
, the 'What's This' button will be available to the user. If false
, the button will not be shown.void : enableApplyButton( Boolean onOff )
Deprecated
Exists only to keep old code working. Do not use in new code. Use showApplyButton() instead.
void : enableCancelButton( Boolean onOff )
Deprecated
Exists only to keep old code working. Do not use in new code. Use showCancelButton() instead.
void : enableHelpButton( Boolean onOff )
Deprecated
Exists only to keep old code working. Do not use in new code. Use showHelpButton() instead.
void : applyClicked()
Signature:“applyClicked()”
Emitted when the 'Apply' button is clicked by the user.