A process for which the implementation can be scripted. More...

Inheritance diagram for ModuleProcessScript:

Public Member Functions
virtual bool	run (AppProgressBar &progress) override

ModuleProcessScriptEngine *	get_engine () const
	Return the engine associated with the process. The engine is a singleton common to all processes sharing the same class.

ModuleScriptedClassEngineData *	get_instance_data () const
	Return the data of the current process instance. The data is the one returned by ModuleScriptedClassEngineData::create_instance_data. Each instance of OfObject of the process class has its own data.

Public Member Functions inherited from ModuleProcess
	ModuleProcess (const bool &is_abortable=true)

virtual	~ModuleProcess ()

bool	run (const CoreBasicArray< CoreString > &args=CoreBasicArray< CoreString >(0, 0), const bool &is_abortable=true)

bool	run (const CoreBasicArray< CoreString > &args, AppProgressBar &progress)

virtual bool	begin_process (AppProgressBar &progress)

virtual bool	end_process (AppProgressBar &progress)

virtual bool	run_process (AppProgressBar &progress)

virtual bool	has_begun () const

virtual bool	on_attr_override (OfAttr &attr, const CoreString &val)

Static Public Member Functions
static bool	register_scripted_process (OfApp &app, const CoreString &class_name, ModuleProcessScriptEngine *engine, const CoreString &cid="")
	Allow to register and implement processes from scripting engines.

Protected Member Functions
void	on_attribute_change (const OfAttr &attr, int &dirtiness, const int &dirtiness_flags) override

Additional Inherited Members
Public Types inherited from EventObject
typedef void(*	EventInfoFunction )(EventObject &, const EventInfo &, void *)
	event callback signature for free functions / static methods.

typedef void(EventObject::*	EventInfoMethod )(EventObject &, const EventInfo &, void *)
	event callback signature for methods.

typedef void(*	EventFunction )(EventObject &, const CoreString &, void *)

typedef void(EventObject::*	EventMethod )(EventObject &, const CoreString &, void *)

Static Public Attributes inherited from ModuleObject
static constexpr unsigned int	null_variation = 0
	Key of the null resource variation.

Detailed Description

A process for which the implementation can be scripted.

Member Function Documentation

bool ModuleProcessScript::run ( AppProgressBar & progress )

overridevirtual

Runs the begin-run-end callback sequence.

Parameters

progress Process progress bar.

Returns: Returns true if all 3 callbacks succeeded. Otherwise returns false and stops after the callback that failed.

Reimplemented from ModuleProcess.