ShowPropertiesSettings

Stores settings for setting up and displaying a DesignObjectDialog such as whether the dialog is part of a larger workflow or used for Model creation. More...

Collaboration diagram for ShowPropertiesSettings:

Public Member Functions
	ShowPropertiesSettings (UUID id, const PopupInfo &origin=PopupInfo())
	Constructs settings for showing properties of a design object.
	ShowPropertiesSettings (UUID id, DesignDialogStyle style, const PopupInfo &origin=PopupInfo())
	Constructs settings for showing properties with a specific dialog style.
void	setupForStyle (DesignDialogStyle style)
	Configures the button titles and icons based on the given dialog style.

Public Attributes
String	cancel_button_icon
	The icon for the cancel button.
TranslatedString	cancel_button_title
	The title of the cancel button.
std::function< void()>	cancel_function
	Callback invoked when the dialog is cancelled.
bool	delete_model_on_cancel = false
	Whether to delete the model if the dialog is cancelled.
String	finish_button_icon
	The icon for the finish/accept button.
TranslatedString	finish_button_title
	The title of the finish/accept button.
std::function< void()>	finished_function
	Callback invoked when the dialog is accepted.
bool	force_dock = false
	Whether to force the dialog to appear docked.
bool	force_popup = false
	Whether to force the dialog to appear as a popup.
UUID	id
	The UUID of the design object to show properties for.
bool	is_creation_dialog = false
	Whether this dialog is for creating a new object.
bool	is_viewport_selection = false
	Whether the dialog was triggered from a viewport selection.
PopupInfo	popup_origin
	The popup positioning and display information.

Detailed Description

Stores settings for setting up and displaying a DesignObjectDialog such as whether the dialog is part of a larger workflow or used for Model creation.

---

Definition at line 27 of file ShowPropertySettings.h.

Constructor & Destructor Documentation

ShowPropertiesSettings() [1/2]

ShowPropertiesSettings::ShowPropertiesSettings	(	UUID	id,
		const PopupInfo &	origin = PopupInfo() )

Constructs settings for showing properties of a design object.

Parameters

[in]	id	The UUID of the object to show properties for.
[in]	origin	The popup positioning information.

ShowPropertiesSettings() [2/2]

ShowPropertiesSettings::ShowPropertiesSettings	(	UUID	id,
		DesignDialogStyle	style,
		const PopupInfo &	origin = PopupInfo() )

Constructs settings for showing properties with a specific dialog style.

Parameters

[in]	id	The UUID of the object to show properties for.
[in]	style	The dialog style to use.
[in]	origin	The popup positioning information.

Member Function Documentation

setupForStyle()

void ShowPropertiesSettings::setupForStyle

(

DesignDialogStyle

style

)

Configures the button titles and icons based on the given dialog style.

Parameters

[in]

style

The dialog style to apply.

Referenced by CheckoutCode::AddAndShow(), and ModelTileTable::init().

---

The documentation for this struct was generated from the following file:

• NDEVR/Headers/ShowPropertySettings.h