openassetio::v1::ui::access Namespace Reference

Access modes available for UI operations. More...

Enumerations
enum	UIAccess : std::underlying_type_t< internal::access::Access > { kRead = internal::access::Access::kRead, kWrite = internal::access::Access::kWrite, kCreateRelated = internal::access::Access::kCreateRelated }
	Access pattern for a UI Delegate request. More...

Detailed Description

Access modes available for UI operations.

Enumeration Type Documentation

enum UIAccess : std::underlying_type_t< internal::access::Access >

strong

Access pattern for a UI Delegate request.

Enumerator
kRead	Used to request a UI element for viewing existing entities. For example, this could be a browser for selecting an existing entity; or a panel providing additional information on a given entity.
kWrite	Used to request a UI element as part of a publishing workflow. For example, this could be a panel for augmenting traits that are used by the host in the publishing process, or published in addition to those derived by the host.
kCreateRelated	Used to request a UI element as part of a publishing workflow, where the published data is related to, but not the same as, a given entity. For example, the host could be publishing an organisational unit akin to a "folder", and wishes to communicate that a child folder should be created, rather than versioning up an existing one.