OpenAssetIO
An abstract API for generalising interactions between a host application and an asset management system
UIDelegateFactory::UIDelegateDetail Struct Reference

Simple struct containing the default configuration details of a potential UI delegate implementation. More...

#include <UIDelegateFactory.hpp>

Public Member Functions

bool operator== (const UIDelegateDetail &other) const
 Compare all fields in this instance and another for by-value equality. More...
 
bool operator!= (const UIDelegateDetail &other) const
 Compare all fields in this instance and another for by-value non-equality. More...
 

Public Attributes

Identifier identifier
 Identifier of the UI delegate. More...
 
Str displayName
 Human readable display name of the UI delegate, suitable for presenting in a UI. More...
 
InfoDictionary info
 Arbitrary key-value information supplied by the UI delegate. More...
 

Detailed Description

Simple struct containing the default configuration details of a potential UI delegate implementation.

Member Function Documentation

bool operator!= ( const UIDelegateDetail other) const
inline

Compare all fields in this instance and another for by-value non-equality.

Parameters
otherOther instance to compare against.
Returns
true if any field compares non-equal, false otherwise.
bool operator== ( const UIDelegateDetail other) const
inline

Compare all fields in this instance and another for by-value equality.

Parameters
otherOther instance to compare against.
Returns
true if all fields compare equal, false otherwise.

Member Data Documentation

Str displayName

Human readable display name of the UI delegate, suitable for presenting in a UI.

See also
UIDelegate::displayName
Identifier identifier

Identifier of the UI delegate.

See also
UIDelegate::identifier

Arbitrary key-value information supplied by the UI delegate.

See also
UIDelegate::info

The documentation for this struct was generated from the following file:
  • /src/src/openassetio-ui/include/openassetio/ui/hostApi/UIDelegateFactory.hpp