ot::GraphicsFlowItem Class Reference

#include "GraphicsFlowItem.h"

Public Types
enum	FlowConnectorType {   Input , InputSecondary , InputOptional , Output ,   OutputSecondary , OutputOptional }

Public Member Functions
	GraphicsFlowItem ()
	GraphicsFlowItem (const std::string &_name)
	GraphicsFlowItem (const std::string &_name, const std::string &_title)
virtual	~GraphicsFlowItem ()
void	setName (const std::string &_name)
const std::string &	name (void) const
void	setTitle (const std::string &_title)
const std::string &	title (void) const
void	setToolTip (const std::string &_toolTip)
void	setTitleColor (const ot::Color &_color)
void	setBackgroundImagePath (const std::string &_path)
void	setLeftTitleCornerImagePath (const std::string &_path)
void	setRightTitleCornerImagePath (const std::string &_path)
void	addConnector (const std::string &_name, FlowConnectorType _type, const std::string &_tip=std::string())
void	addConnector (const std::string &_name, const std::string &_title, FlowConnectorType _type, const std::string &_tip=std::string())
GraphicsItemCfg *	createGraphicsItem (void) const
	Creates a GraphicsItemCfg in the "OpenTwin flow block" style that takes the current configuration into account. The caller takes ownership of the item.

Member Enumeration Documentation

FlowConnectorType

enum ot::GraphicsFlowItem::FlowConnectorType

Enumerator
Input
InputSecondary
InputOptional
Output
OutputSecondary
OutputOptional

Constructor & Destructor Documentation

GraphicsFlowItem() [1/3]

ot::GraphicsFlowItem::GraphicsFlowItem

(

)

GraphicsFlowItem() [2/3]

ot::GraphicsFlowItem::GraphicsFlowItem

(

const std::string &

_name

)

GraphicsFlowItem() [3/3]

ot::GraphicsFlowItem::GraphicsFlowItem	(	const std::string &	_name,
		const std::string &	_title )

~GraphicsFlowItem()

ot::GraphicsFlowItem::~GraphicsFlowItem ( )

virtual

Member Function Documentation

addConnector() [1/2]

void ot::GraphicsFlowItem::addConnector	(	const std::string &	_name,
		const std::string &	_title,
		FlowConnectorType	_type,
		const std::string &	_tip = std::string() )

addConnector() [2/2]

void ot::GraphicsFlowItem::addConnector	(	const std::string &	_name,
		FlowConnectorType	_type,
		const std::string &	_tip = std::string() )

createGraphicsItem()

GraphicsItemCfg * ot::GraphicsFlowItem::createGraphicsItem ( void ) const

inline

Creates a GraphicsItemCfg in the "OpenTwin flow block" style that takes the current configuration into account. The caller takes ownership of the item.

name()

const std::string & ot::GraphicsFlowItem::name ( void ) const

inline

setBackgroundImagePath()

void ot::GraphicsFlowItem::setBackgroundImagePath ( const std::string & _path )

inline

setLeftTitleCornerImagePath()

void ot::GraphicsFlowItem::setLeftTitleCornerImagePath ( const std::string & _path )

inline

setName()

void ot::GraphicsFlowItem::setName ( const std::string & _name )

inline

setRightTitleCornerImagePath()

void ot::GraphicsFlowItem::setRightTitleCornerImagePath ( const std::string & _path )

inline

setTitle()

void ot::GraphicsFlowItem::setTitle ( const std::string & _title )

inline

setTitleColor()

void ot::GraphicsFlowItem::setTitleColor ( const ot::Color & _color )

inline

setToolTip()

void ot::GraphicsFlowItem::setToolTip ( const std::string & _toolTip )

inline

title()

const std::string & ot::GraphicsFlowItem::title ( void ) const

inline

---

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

• Libraries/OTGuiAPI/include/OTGuiAPI/GraphicsFlowItem.h
• Libraries/OTGuiAPI/src/GraphicsFlowItem.cpp