HydroCouple  2.0.0-alpha.1
HydroCouple Interface Definitions
Loading...
Searching...
No Matches
Public Member Functions | List of all members
HydroCouple::IUIProvider Class Referenceabstract

IUIProvider is an optional side interface for entities that can present a graphical editor and/or viewer. More...

#include <hydrocouple.h>

Collaboration diagram for HydroCouple::IUIProvider:

Public Member Functions

virtual ~IUIProvider ()=default
 IUIProvider::~IUIProvider is a virtual destructor.
 
virtual bool hasEditor () const =0
 hasEditor indicates whether this entity has a UI editor.
 
virtual void showEditor (void *opaqueUIPointer=nullptr)=0
 showEditor shows the editor for this entity.
 
virtual bool hasViewer () const =0
 hasViewer indicates whether this entity has a UI viewer.
 
virtual void showViewer (void *opaqueUIPointer=nullptr)=0
 showViewer shows the viewer for this entity.
 

Detailed Description

IUIProvider is an optional side interface for entities that can present a graphical editor and/or viewer.

UI concerns were removed from IModelComponent and IComponentDataItem so that the core standard stays headless. Entities with UI support implement this interface and their component advertises Capability::UserInterface.

Constructor & Destructor Documentation

◆ ~IUIProvider()

virtual HydroCouple::IUIProvider::~IUIProvider ( )
virtualdefault

IUIProvider::~IUIProvider is a virtual destructor.

Member Function Documentation

◆ hasEditor()

virtual bool HydroCouple::IUIProvider::hasEditor ( ) const
nodiscardpure virtual

hasEditor indicates whether this entity has a UI editor.

Returns
A boolean indicating whether this entity has an editor.

◆ hasViewer()

virtual bool HydroCouple::IUIProvider::hasViewer ( ) const
nodiscardpure virtual

hasViewer indicates whether this entity has a UI viewer.

Returns
A boolean indicating whether this entity has a viewer.

◆ showEditor()

virtual void HydroCouple::IUIProvider::showEditor ( void * opaqueUIPointer = nullptr)
pure virtual

showEditor shows the editor for this entity.

Parameters
[in]opaqueUIPointerIs an opaque pointer to the UI object that is used to show the editor if it is available otherwise nullptr.

◆ showViewer()

virtual void HydroCouple::IUIProvider::showViewer ( void * opaqueUIPointer = nullptr)
pure virtual

showViewer shows the viewer for this entity.

Parameters
[in]opaqueUIPointerIs an opaque pointer to the UI object that is used to show the viewer if it is available otherwise nullptr.
The documentation for this class was generated from the following file: