Provides services to create code wrapper around operations affecting a selection of scene items. More...

#include <codeWrapperHandler.h>

Inheritance diagram for Ufe::CodeWrapperHandler:

Collaboration diagram for Ufe::CodeWrapperHandler:

Public Member Functions
virtual	~CodeWrapperHandler () override
	Destructor. More...

Public Member Functions inherited from Ufe::BatchOpsHandler
	BatchOpsHandler ()
	Constructor. More...

	BatchOpsHandler (const BatchOpsHandler &)=default
	Default copy constructor. More...

virtual	~BatchOpsHandler ()
	Destructor. More...

Protected Member Functions
virtual CodeWrapper::Ptr	createCodeWrapper (const Selection &selection, const std::string &operationName)
	Ask a runtime handler to create a code wrapper for the given selection and operation. By default returns null to mean that the run-time does not need to wrap the operation. More...

Protected Member Functions inherited from Ufe::BatchOpsHandler
virtual SelectionUndoableCommand::Ptr	duplicateSelectionCmd_ (const Selection &selection, const ValueDictionary &duplicateOptions)=0

Friends
class	CodeWrapperContainer

Additional Inherited Members
Public Types inherited from Ufe::BatchOpsHandler
typedef std::shared_ptr< BatchOpsHandler >	Ptr

Static Public Member Functions inherited from Ufe::BatchOpsHandler
static SelectionUndoableCommand::Ptr	duplicateSelectionCmd (const Selection &selection, const ValueDictionary &duplicateOptions)

Detailed Description

Provides services to create code wrapper around operations affecting a selection of scene items.

Derives from BatchOpsHandler to allow compatibility with UFE v4 and because it affects operations on multiple scene items.

Only the CodeWrapperContainer is able to create the code wrappers. This ensure proper usage of the handler and the code wrappers it creates.

Definition at line 32 of file codeWrapperHandler.h.

Constructor & Destructor Documentation

◆ ~CodeWrapperHandler()

virtual Ufe::CodeWrapperHandler::~CodeWrapperHandler ( )

overridevirtual

Destructor.

Member Function Documentation

◆ createCodeWrapper()

virtual CodeWrapper::Ptr Ufe::CodeWrapperHandler::createCodeWrapper	(	const Selection &	selection,
		const std::string &	operationName
	)

protectedvirtual

Ask a runtime handler to create a code wrapper for the given selection and operation. By default returns null to mean that the run-time does not need to wrap the operation.

Parameters

selection	The list of items to be affected by the operation.
operationName	The name of the overall operation, for example "group".

Friends And Related Function Documentation

◆ CodeWrapperContainer

friend class CodeWrapperContainer

friend

Definition at line 48 of file codeWrapperHandler.h.

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

common/include/ufe/codeWrapperHandler.h

Public Member Functions

Protected Member Functions

Friends