The primary editor widget for configuring a build action definition, including action type selection, option editing, workflow management, and execution. More...

Inheritance diagram for BuildActionWidget:

[legend]

Collaboration diagram for BuildActionWidget:

[legend]

Public Member Functions
	BuildActionWidget (const DynamicPointer< QTDesignObject > &object, QWidget *parent=nullptr)
	Constructs the widget and sets the given design object as the target.
	BuildActionWidget (QWidget *parent=nullptr)
	Constructs the widget with no initial target.
LogPtr	defaultLog (const BuildActionDefinition &def)
	Returns or creates the default log for the given definition.
BuildActionDefinition	definition () const
	Returns the BuildActionDefinition derived from the current target.
void	setBuildAction (const BuildAction &action)
	Programmatically sets the build action type.
virtual void	setLog (LogPtr log, bool is_temp=false)
	Sets the log target for build action output.
void	setTarget (const DynamicPointer< QTDesignObject > &object) override
	Sets the target design object for this editor.
QSize	sizeHint () const override
	Returns the preferred size for this widget.
virtual void	updateValues () override
	Refreshes all UI fields from the current target data.
Public Member Functions inherited from Editor
	Editor (const DynamicPointer< QTDesignObject > &object, QWidget *parent=nullptr)
	Constructs an Editor targeting the given design object.
	Editor (QWidget *parent=nullptr)
	Constructs an Editor with no design object target.
virtual Buffer< QWidget * >	bottomOptions ()
	Returns widgets to be placed at the bottom of the editor layout.
virtual StringView	customDialogIcon () const
	Returns a custom icon name for the editor dialog, or an empty string if none.
virtual TranslatedString	customDialogTitle () const
	Returns a custom title for the editor dialog, or an empty string if none.
virtual bool	disableExport () const
	Returns whether exporting should be disabled for this editor.
Model	getModel () const
	Returns the target design object as a Model.
DesignObject	getObject () const
	Returns the target design object.
virtual bool	isBusy () const
	Returns whether the editor is currently busy performing an operation.
void	isBusyStatusChanged ()
	Emitted when the busy status of the editor changes.
virtual bool	isHorizontal () const
	Returns whether the editor layout is horizontal.
virtual void	moveTargetWithMouse ()
	Initiates interactive mouse-based movement of the target object in the viewport.
void	objectUpdatedSignal ()
	Emitted when the target object has been updated.
virtual InterfaceOrientationController *	orientationController () const
	Returns the orientation controller associated with this editor.
virtual Buffer< QWidget * >	printableWidgetOptions ()
	Returns option widgets to configure printing for this editor.
virtual Buffer< QWidget * >	printableWidgets ()
	Returns the widgets that can be printed from this editor.
virtual void	requestScrollEnabled (bool enabled)
	Requests enabling or disabling scrolling within the editor.
virtual void	setHorizontal (bool horizontal)
	Sets whether the editor layout is horizontal.
virtual void	setReadOnly (bool read_only)
	Sets whether the editor is in read-only mode.
virtual void	setup (DesignObjectDialog *, const ShowPropertiesSettings &)
	Sets up the editor with a parent dialog and property display settings.
virtual EditorShowMode	showMode () const
	Returns the preferred display mode for this editor.
const DynamicPointer< QTDesignObject > &	target () const
	Returns the current design object target.

Protected Member Functions
void	init ()
	Initializes UI elements and signal connections.
Protected Member Functions inherited from Editor
void	onDesignObjectDeletedSlot ()
	Slot called when the target design object is deleted.
void	onDesignObjectUpdateSlot ()
	Slot called when the target design object is updated.

Protected Attributes
Button *	m_about_button = nullptr
	Button showing action description.
QCustomComboBox *	m_action_type_combobox = nullptr
	Combo box for selecting the action type.
QCustomTextEdit *	m_command_line = nullptr
	Text editor for command-line preview.
DevActionTree *	m_dev_tree = nullptr
	Tree widget for action type selection.
GenericOptionsGroup *	m_generic_options = nullptr
	Widget for action-specific generic options.
bool	m_is_temp_log = true
	Whether the current log is temporary.
LogPtr	m_log = nullptr
	The active log.
TerminalDialog *	m_log_view = nullptr
	Terminal dialog for build output.
DesignObjectStringWidget *	m_name_widget = nullptr
	Widget for editing the action name.
Button *	m_next_button = nullptr
	Button to navigate to the next action.
Button *	m_previous_button = nullptr
	Button to navigate to the previous action.
Button *	m_run_cancel_button = nullptr
	Button to run or cancel the action.
QCustomStackedWidget *	m_stacked_widget = nullptr
	Stacked widget switching between action views.
Button *	m_variables_button = nullptr
	Button showing available variables.
BuildWorkflowTable *	m_workflow_table = nullptr
	Table for managing workflow child actions.
QWidget *	m_workflow_widget = nullptr
	Container widget for workflow child actions.
Protected Attributes inherited from Editor
DynamicPointer< QTDesignObject >	m_design_object
	The design object being edited.
bool	m_is_read_only = false
	Whether the editor is in read-only mode.
InterfaceOrientationController *	m_orientation_controller
	The orientation controller for this editor.

Detailed Description

The primary editor widget for configuring a build action definition, including action type selection, option editing, workflow management, and execution.

Definition at line 17 of file BuildActionWidget.h.

Constructor & Destructor Documentation

◆ BuildActionWidget() [1/2]

BuildActionWidget::BuildActionWidget ( QWidget * parent = nullptr )

Constructs the widget with no initial target.

Parameters

[in] parent Optional parent widget.

◆ BuildActionWidget() [2/2]

BuildActionWidget::BuildActionWidget	(	const DynamicPointer< QTDesignObject > &	object,
		QWidget *	parent = nullptr )

Constructs the widget and sets the given design object as the target.

Parameters

[in]	object	The design object to edit.
[in]	parent	Optional parent widget.

Member Function Documentation

◆ defaultLog()

LogPtr BuildActionWidget::defaultLog ( const BuildActionDefinition & def )

Returns or creates the default log for the given definition.

Parameters

[in] def The build action definition.

Returns: The log pointer.

◆ definition()

BuildActionDefinition BuildActionWidget::definition ( ) const

Returns the BuildActionDefinition derived from the current target.

Returns: The build action definition.

◆ setBuildAction()

void BuildActionWidget::setBuildAction ( const BuildAction & action )

Programmatically sets the build action type.

Parameters

[in] action The build action to set.

◆ setLog()

virtual void BuildActionWidget::setLog	(	LogPtr	log,
		bool	is_temp = false )

virtual

Sets the log target for build action output.

Parameters

[in]	log	The log to use.
[in]	is_temp	Whether this is a temporary log.

◆ setTarget()

void BuildActionWidget::setTarget ( const DynamicPointer< QTDesignObject > & object )

overridevirtual

Sets the target design object for this editor.

Parameters

[in] object The design object to edit.

Reimplemented from Editor.

◆ sizeHint()

QSize BuildActionWidget::sizeHint ( ) const

override

Returns the preferred size for this widget.

Returns: The recommended size hint.

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

Developer/Headers/BuildActionWidget.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ BuildActionWidget() [1/2]

◆ BuildActionWidget() [2/2]

Member Function Documentation

◆ defaultLog()

◆ definition()

◆ setBuildAction()

◆ setLog()

◆ setTarget()

◆ sizeHint()