#include <uiInfoHandler.h>

Classes
struct	Icon

Public Types
enum	Quadrant { None, UpperLeft, UpperRight, LowerLeft, LowerRight }

enum	Mode { Normal, Disabled, Active, Selected }

typedef std::shared_ptr< UIInfoHandler >	Ptr

Public Member Functions
	UIInfoHandler ()=default
	Constructor. More...

	UIInfoHandler (const UIInfoHandler &)=default
	Default copy constructor. More...

virtual	~UIInfoHandler ()=default
	Destructor. More...

virtual bool	treeViewCellInfo (const SceneItem::Ptr &item, CellInfo &info) const =0

virtual Icon	treeViewIcon (const SceneItem::Ptr &item) const

virtual std::string	treeViewTooltip (const SceneItem::Ptr &item) const

virtual std::string	getLongRunTimeLabel () const =0

Static Public Member Functions
static Ptr	uiInfoHandler (Rtid rt)

Detailed Description

This base class defines an interface that runtimes can implement to provide UI related information.

Definition at line 69 of file uiInfoHandler.h.

Member Typedef Documentation

◆ Ptr

typedef std::shared_ptr<UIInfoHandler> Ufe::UIInfoHandler::Ptr

Definition at line 72 of file uiInfoHandler.h.

Member Enumeration Documentation

◆ Mode

enum Ufe::UIInfoHandler::Mode

Enumerator
Normal	Icon state when available (not active and not selected).
Disabled	Icon state when not available.
Active	Icon state when highlighted or focused, but not selected.
Selected	Icon state when selected.

Definition at line 76 of file uiInfoHandler.h.

◆ Quadrant

enum Ufe::UIInfoHandler::Quadrant

Enumerator
None
UpperLeft
UpperRight
LowerLeft
LowerRight

Definition at line 74 of file uiInfoHandler.h.

Constructor & Destructor Documentation

◆ UIInfoHandler() [1/2]

Ufe::UIInfoHandler::UIInfoHandler ( )

default

Constructor.

◆ UIInfoHandler() [2/2]

Ufe::UIInfoHandler::UIInfoHandler ( const UIInfoHandler & )

default

Default copy constructor.

◆ ~UIInfoHandler()

virtual Ufe::UIInfoHandler::~UIInfoHandler ( )

virtualdefault

Destructor.

Member Function Documentation

◆ getLongRunTimeLabel()

virtual std::string Ufe::UIInfoHandler::getLongRunTimeLabel ( ) const

pure virtual

Get a long (more descriptive) label for the runtime. This label (possibly localized) can be displayed in the UI.

◆ treeViewCellInfo()

virtual bool Ufe::UIInfoHandler::treeViewCellInfo	(	const SceneItem::Ptr &	item,
		CellInfo &	info
	)		const

pure virtual

Get the cell information for the input scene item. This cell information can be used when displaying the item in a tree view editor. It is expected that the input cell info will contain the default tree drawing info and in the override method you can change any of these values.

Parameters

[in]	item	The scene item to get cell info for
[in,out]	info	The cell info

Returns: True, if any cell info values were changed, otherwise false.

◆ treeViewIcon()

virtual Icon Ufe::UIInfoHandler::treeViewIcon ( const SceneItem::Ptr & item ) const

virtual

Get the icon name with optional badge icon (draw overtop) for the input scene item. This can be used to load an icon for display in a tree view editor. The implementation in this class returns a default Icon struct (empty strings) which signifies that no special icon exists for this item. Note: it is allowed to return just a base icon, just a badge icon or both.

Returns: Icon struct

◆ treeViewTooltip()

virtual std::string Ufe::UIInfoHandler::treeViewTooltip ( const SceneItem::Ptr & item ) const

virtual

Get an extra tooltip string for the input scene item. This extra tooltip will normally be displayed after any base tooltip provided by the tree view itself. The tooltip string can be formatted using HTML 4 markup. The implementation in this class returns an empty string.

Returns: Tooltip extra string or empty string.

◆ uiInfoHandler()

static Ptr Ufe::UIInfoHandler::uiInfoHandler ( Rtid rt )

static

Convenience method to retrieve the UI Info Handler from the input runtime id. The handler interface will remain valid as long as the given runtime remains set in the runtime manager.

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

common/include/ufe/uiInfoHandler.h

Classes

Public Types

Public Member Functions

Static Public Member Functions