CppPluginSystemUIDelegatePlugin Class Reference

Base class to be subclassed by plugins binding a host to a UI delegate. More...

#include <CppPluginSystemUIDelegatePlugin.hpp>

Inheritance diagram for CppPluginSystemUIDelegatePlugin:

Public Types
using	Ptr = CppPluginSystemUIDelegatePluginPtr
using	ConstPtr = CppPluginSystemUIDelegatePluginConstPtr

Public Member Functions
	~CppPluginSystemUIDelegatePlugin () override
	Defaulted destructor. More...
virtual managerApi::UIDelegateInterfacePtr	interface ()=0
	Constructs an instance of the UIDelegateInterface. More...

Detailed Description

Base class to be subclassed by plugins binding a host to a UI delegate.

This is used by the dynamic plugin discovery mechanism to instantiate the UIDelegateInterface implementation for the asset management system.

Plugin authors must subclass this class and expose instances of it via a PluginFactory function pointer, which is in turn exposed in the plugin binary by a top level C linkage openassetioUIPlugin function.

See also

CppPluginSystemUIDelegateImplementationFactory

Member Typedef Documentation

using ConstPtr = CppPluginSystemUIDelegatePluginConstPtr

using Ptr = CppPluginSystemUIDelegatePluginPtr

Constructor & Destructor Documentation

~CppPluginSystemUIDelegatePlugin ( )

override

Defaulted destructor.

Member Function Documentation

virtual managerApi::UIDelegateInterfacePtr interface ( )

pure virtual

Constructs an instance of the UIDelegateInterface.

This is an instance of some class derived from UIDelegateInterface to be bound to the Host-facing UIDelegate.

Generally this is only directly called by the CppPluginSystemUIDelegateImplementationFactory.

Returns

UIDelegateInterface instance

---

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

• /src/src/openassetio-ui/include/openassetio/ui/pluginSystem/CppPluginSystemUIDelegatePlugin.hpp