OpenAssetIO
An abstract API for generalising interactions between a host application and an asset management system
openassetio::v1::ui::hostApi Namespace Reference

This namespace contains code relevant to anyone wanting to add support for a host application. More...

Classes

class  UIDelegate
 The UIDelegate is the host facing representation of an asset management system's bespoke UI Delegate. More...
 
class  UIDelegateFactory
 The UIDelegateFactory is the primary mechanism for querying for available UI Delegate plugins and constructing instances of them. More...
 
class  UIDelegateImplementationFactoryInterface
 UI Delegate Factories are responsible for instantiating classes that derive from UIDelegateInterface for use within a host. More...
 
class  UIDelegateRequestInterface
 Abstract interface encapsulating a UI Delegate request that may change over time. More...
 
class  UIDelegateState
 Class encapsulating the UI Delegate state that may change over time. More...
 

Typedefs

using UIDelegateRequestInterfacePtr = std::shared_ptr< UIDelegateRequestInterface >
 
using UIDelegateRequestInterfaceConstPtr = std::shared_ptr< const UIDelegateRequestInterface >
 
using UIDelegateStatePtr = std::shared_ptr< UIDelegateState >
 
using UIDelegateStateConstPtr = std::shared_ptr< const UIDelegateState >
 
using UIDelegatePtr = std::shared_ptr< UIDelegate >
 
using UIDelegateConstPtr = std::shared_ptr< const UIDelegate >
 
using UIDelegateImplementationFactoryInterfacePtr = std::shared_ptr< UIDelegateImplementationFactoryInterface >
 
using UIDelegateImplementationFactoryInterfaceConstPtr = std::shared_ptr< const UIDelegateImplementationFactoryInterface >
 
using UIDelegateFactoryPtr = std::shared_ptr< UIDelegateFactory >
 
using UIDelegateFactoryConstPtr = std::shared_ptr< const UIDelegateFactory >
 

Detailed Description

This namespace contains code relevant to anyone wanting to add support for a host application.

If you are an asset management system developer, see managerApi.

Typedef Documentation

typedef std::shared_ptr< const UIDelegate > UIDelegateConstPtr
using UIDelegateFactoryConstPtr = std::shared_ptr<const UIDelegateFactory >
using UIDelegateFactoryPtr = std::shared_ptr< UIDelegateFactory >
typedef std::shared_ptr< UIDelegate > UIDelegatePtr
typedef std::shared_ptr< const UIDelegateState > UIDelegateStateConstPtr
typedef std::shared_ptr< UIDelegateState > UIDelegateStatePtr