Provides static constants, option group builders, and metadata queries for the build action system, including icons, categories, descriptions, and supported actions. More...

Collaboration diagram for BuildActionDefines:

[legend]

Static Public Member Functions
static void	ActivateOptionGroup (GenericOptionGroup &group)
	Populates the option group for license activation actions.
static StringView	BestSourceFolder ()
	Returns the best available source folder path.
static void	BuildCollectStatisticsGroup (GenericOptionGroup &group)
	Populates the option group for code statistics collection.
static void	BuildEasyIncludeGroup (GenericOptionGroup &group)
	Populates the option group for easy-include generation.
static void	BuildInstallerGroup (GenericOptionGroup &group)
	Populates the option group for installer builder actions.
static void	BuildSetVariableGroup (GenericOptionGroup &group, bool has_parent)
	Populates the option group for variable assignment actions.
static void	BuildShaderGroup (GenericOptionGroup &group)
	Populates the option group for shader compilation actions.
static void	BuildZipGroup (GenericOptionGroup &group, bool is_compress)
	Populates the option group for zip/unzip actions.
static Buffer< TranslatedString >	Categories ()
	Returns all build action category names.
static TranslatedString	Category (BuildAction action)
	Returns the category name for the given build action.
static void	CreateFactoryGroup (GenericOptionGroup &group)
	Populates the option group for creating a new IOFactory.
static void	CreateGenerateModelGroup (GenericOptionGroup &group)
	Populates the option group for generating a new model.
static void	CreateWidgetGroup (GenericOptionGroup &group)
	Populates the option group for creating a new widget.
static TranslatedString	Description (BuildAction action)
	Returns the description for the given build action.
static void	FileActionGroup (GenericOptionGroup &group)
	Populates the option group for general file actions.
static void	FileCopyMoveActionGroup (BuildAction action, GenericOptionGroup &group)
	Populates the option group for file copy or move actions.
static void	FileDeleteActionGroup (GenericOptionGroup &group)
	Populates the option group for file deletion actions.
static void	FileFiltersGroup (GenericOptionGroup &group)
	Populates the option group for file filter settings.
static void	GitActionGroup (GenericOptionGroup &group)
	Populates the option group for git command actions.
static void	GitCloneGroup (GenericOptionGroup &group)
	Populates the option group for git clone actions.
static StringView	Icon (BuildAction action)
	Returns the icon resource name for the given build action.
static void	IncrementVersionGroup (GenericOptionGroup &group)
	Populates the option group for version increment actions.
static bool	IsSupported (const BuildAction &action)
	Checks whether a given build action is supported on this platform.
static void	QTCreatorCroup (GenericOptionGroup &group)
	Populates the option group for Qt Creator actions.
static void	RegistrySetGroup (GenericOptionGroup &group)
	Populates the option group for registry variable actions.
static void	SoundOptionGroup (GenericOptionGroup &group)
	Populates the option group for sound playback actions.
static Buffer< std::pair< TranslatedString, StringAllocatingView > >	SourceDirectories ()
	Returns all known source directory paths with their display names.
static Buffer< BuildAction >	SupportedActions ()
	Returns all supported build actions.
static bool	UseSource ()
	Returns whether source-based building is available.
static void	VSActionOptionGroup (GenericOptionGroup &group)
	Populates the option group for Visual Studio build actions.

Detailed Description

Provides static constants, option group builders, and metadata queries for the build action system, including icons, categories, descriptions, and supported actions.

Definition at line 85 of file BuildActions.h.

Member Function Documentation

◆ ActivateOptionGroup()

void BuildActionDefines::ActivateOptionGroup ( GenericOptionGroup & group )

static

Populates the option group for license activation actions.

Parameters

[in] group The option group to populate.

◆ BestSourceFolder()

StringView BuildActionDefines::BestSourceFolder ( )

static

Returns the best available source folder path.

Returns: The source folder path view.

◆ BuildCollectStatisticsGroup()

void BuildActionDefines::BuildCollectStatisticsGroup ( GenericOptionGroup & group )

static

Populates the option group for code statistics collection.

Parameters

[in] group The option group to populate.

◆ BuildEasyIncludeGroup()

void BuildActionDefines::BuildEasyIncludeGroup ( GenericOptionGroup & group )

static

Populates the option group for easy-include generation.

Parameters

[in] group The option group to populate.

◆ BuildInstallerGroup()

void BuildActionDefines::BuildInstallerGroup ( GenericOptionGroup & group )

static

Populates the option group for installer builder actions.

Parameters

[in] group The option group to populate.

◆ BuildSetVariableGroup()

void BuildActionDefines::BuildSetVariableGroup	(	GenericOptionGroup &	group,
		bool	has_parent )

static

Populates the option group for variable assignment actions.

Parameters

[in]	group	The option group to populate.
[in]	has_parent	Whether the action has a parent workflow.

◆ BuildShaderGroup()

void BuildActionDefines::BuildShaderGroup ( GenericOptionGroup & group )

static

Populates the option group for shader compilation actions.

Parameters

[in] group The option group to populate.

◆ BuildZipGroup()

void BuildActionDefines::BuildZipGroup	(	GenericOptionGroup &	group,
		bool	is_compress )

static

Populates the option group for zip/unzip actions.

Parameters

[in]	group	The option group to populate.
[in]	is_compress	Whether the action is compression (true) or extraction (false).

◆ Categories()

Buffer< TranslatedString > BuildActionDefines::Categories ( )

static

Returns all build action category names.

Returns: A buffer of translated category names.

Referenced by DevActionTree::init().

◆ Category()

TranslatedString BuildActionDefines::Category ( BuildAction action )

static

Returns the category name for the given build action.

Parameters

[in] action The build action.

Returns: The translated category name.

Referenced by DevActionTree::init().

◆ CreateFactoryGroup()

void BuildActionDefines::CreateFactoryGroup ( GenericOptionGroup & group )

static

Populates the option group for creating a new IOFactory.

Parameters

[in] group The option group to populate.

◆ CreateGenerateModelGroup()

void BuildActionDefines::CreateGenerateModelGroup ( GenericOptionGroup & group )

static

Populates the option group for generating a new model.

Parameters

[in] group The option group to populate.

◆ CreateWidgetGroup()

void BuildActionDefines::CreateWidgetGroup ( GenericOptionGroup & group )

static

Populates the option group for creating a new widget.

Parameters

[in] group The option group to populate.

◆ Description()

TranslatedString BuildActionDefines::Description ( BuildAction action )

static

Returns the description for the given build action.

Parameters

[in] action The build action.

Returns: The translated description.

◆ FileActionGroup()

void BuildActionDefines::FileActionGroup ( GenericOptionGroup & group )

static

Populates the option group for general file actions.

Parameters

[in] group The option group to populate.

◆ FileCopyMoveActionGroup()

void BuildActionDefines::FileCopyMoveActionGroup	(	BuildAction	action,
		GenericOptionGroup &	group )

static

Populates the option group for file copy or move actions.

Parameters

[in]	action	The specific action (copy or move).
[in]	group	The option group to populate.

◆ FileDeleteActionGroup()

void BuildActionDefines::FileDeleteActionGroup ( GenericOptionGroup & group )

static

Populates the option group for file deletion actions.

Parameters

[in] group The option group to populate.

◆ FileFiltersGroup()

void BuildActionDefines::FileFiltersGroup ( GenericOptionGroup & group )

static

Populates the option group for file filter settings.

Parameters

[in] group The option group to populate.

◆ GitActionGroup()

void BuildActionDefines::GitActionGroup ( GenericOptionGroup & group )

static

Populates the option group for git command actions.

Parameters

[in] group The option group to populate.

◆ GitCloneGroup()

void BuildActionDefines::GitCloneGroup ( GenericOptionGroup & group )

static

Populates the option group for git clone actions.

Parameters

[in] group The option group to populate.

◆ Icon()

StringView BuildActionDefines::Icon ( BuildAction action )

static

Returns the icon resource name for the given build action.

Parameters

[in] action The build action.

Returns: The icon name.

Referenced by DevActionTree::init().

◆ IncrementVersionGroup()

void BuildActionDefines::IncrementVersionGroup ( GenericOptionGroup & group )

static

Populates the option group for version increment actions.

Parameters

[in] group The option group to populate.

◆ IsSupported()

bool BuildActionDefines::IsSupported ( const BuildAction & action )

static

Checks whether a given build action is supported on this platform.

Parameters

[in] action The build action to check.

Returns: True if supported.

Referenced by DevActionTree::init().

◆ QTCreatorCroup()

void BuildActionDefines::QTCreatorCroup ( GenericOptionGroup & group )

static

Populates the option group for Qt Creator actions.

Parameters

[in] group The option group to populate.

◆ RegistrySetGroup()

void BuildActionDefines::RegistrySetGroup ( GenericOptionGroup & group )

static

Populates the option group for registry variable actions.

Parameters

[in] group The option group to populate.

◆ SoundOptionGroup()

void BuildActionDefines::SoundOptionGroup ( GenericOptionGroup & group )

static

Populates the option group for sound playback actions.

Parameters

[in] group The option group to populate.

◆ SourceDirectories()

Buffer< std::pair< TranslatedString, StringAllocatingView > > BuildActionDefines::SourceDirectories ( )

static

Returns all known source directory paths with their display names.

Returns: A buffer of name-path pairs.

◆ SupportedActions()

Buffer< BuildAction > BuildActionDefines::SupportedActions ( )

static

Returns all supported build actions.

Returns: A buffer of supported BuildAction values.

◆ UseSource()

bool BuildActionDefines::UseSource ( )

static

Returns whether source-based building is available.

Returns: True if building from source is configured.

◆ VSActionOptionGroup()

void BuildActionDefines::VSActionOptionGroup ( GenericOptionGroup & group )

static

Populates the option group for Visual Studio build actions.

Parameters

[in] group The option group to populate.

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

Developer/Headers/BuildActions.h

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ ActivateOptionGroup()

◆ BestSourceFolder()

◆ BuildCollectStatisticsGroup()

◆ BuildEasyIncludeGroup()

◆ BuildInstallerGroup()

◆ BuildSetVariableGroup()

◆ BuildShaderGroup()

◆ BuildZipGroup()

◆ Categories()

◆ Category()

◆ CreateFactoryGroup()

◆ CreateGenerateModelGroup()

◆ CreateWidgetGroup()

◆ Description()

◆ FileActionGroup()

◆ FileCopyMoveActionGroup()

◆ FileDeleteActionGroup()

◆ FileFiltersGroup()

◆ GitActionGroup()

◆ GitCloneGroup()

◆ Icon()

◆ IncrementVersionGroup()

◆ IsSupported()

◆ QTCreatorCroup()

◆ RegistrySetGroup()

◆ SoundOptionGroup()

◆ SourceDirectories()

◆ SupportedActions()

◆ UseSource()

◆ VSActionOptionGroup()