roviz: AbstractItemInputOutputBase Class Reference

roviz 0.7

Code Documentation of roviz

The AbstractItemInputOutputBase class provides common functionality for the ItemInput and ItemOutput classes. More...

#include <abstract_item_input_output_base.h>

Inheritance diagram for AbstractItemInputOutputBase:

Inheritance graph

Collaboration diagram for AbstractItemInputOutputBase:

Collaboration graph

Signals
void	positionChanged ()
	This signal is emitted whenever this objects local or scene position has changed. More...

Public Member Functions
	AbstractItemInputOutputBase (class AbstractItem *parent, int transportType, QString const &description, QRectF const &shape)
	Constructs an AbstractItemInputOutputBase. More...

int	transportType () const
	Returns the type of data this object handles. More...

AbstractItem *	owner () const
	Returns the owner of this object. More...

virtual QObject *	data () const =0
	Returns the data provided by this object. More...

virtual QPointF	localPosition () const
	Returns the local position of this object. More...

virtual QPointF	scenePosition () const
	Returns the scene position of this object. More...

virtual QRectF	boundingRect () const

virtual void	paint (QPainter painter, QStyleOptionGraphicsItem const option, QWidget *widget)

virtual bool	isConnected () const =0
	This is a virtual pure function. It is used to determine whether or not this input or output is currently connected. More...

Protected Member Functions
void	setLocalPosition (QPointF const &position)
	Sets the local position of this object. More...

void	updateScenePosition ()
	Updates the scene position. Causes this objects position within the item scene to be updated. More...

Friends
class	AbstractItemPrivate

class	AbstractItem

Detailed Description

The AbstractItemInputOutputBase class provides common functionality for the ItemInput and ItemOutput classes.

Constructor & Destructor Documentation

◆ AbstractItemInputOutputBase()

AbstractItemInputOutputBase::AbstractItemInputOutputBase	(	class AbstractItem *	parent,
		int	transportType,
		QString const &	description,
		QRectF const &	shape
	)

Constructs an AbstractItemInputOutputBase.

Parameters

parent	The AbstractItem this object belongs to
transportType	The type of data this object handles
description	A description of this object that is shown to the user
shape	The shape of this object

Member Function Documentation

◆ data()

virtual QObject* AbstractItemInputOutputBase::data ( ) const

pure virtual

Returns the data provided by this object.

Returns: The data provided by this object

Implemented in ItemOutput, and ItemInput.

Here is the caller graph for this function:

◆ isConnected()

virtual bool AbstractItemInputOutputBase::isConnected ( ) const

pure virtual

This is a virtual pure function. It is used to determine whether or not this input or output is currently connected.

Returns: true if the object is connected, false otherwise

Implemented in ItemOutput, and ItemInput.

◆ localPosition()

QPointF AbstractItemInputOutputBase::localPosition ( ) const

virtual

Returns the local position of this object.

Returns: The local position of this object

See also: scenePosition

Here is the caller graph for this function:

◆ owner()

AbstractItem * AbstractItemInputOutputBase::owner ( ) const

Returns the owner of this object.

Returns: The owner of this object

Here is the caller graph for this function:

◆ positionChanged

void AbstractItemInputOutputBase::positionChanged ( )

signal

This signal is emitted whenever this objects local or scene position has changed.

See also: updateScenePosition

Here is the caller graph for this function:

◆ scenePosition()

QPointF AbstractItemInputOutputBase::scenePosition ( ) const

virtual

Returns the scene position of this object.

Returns: The scene position of this object

See also: localPosition

Reimplemented in ItemOutput, and ItemInput.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setLocalPosition()

void AbstractItemInputOutputBase::setLocalPosition ( QPointF const & position )

protected

Sets the local position of this object.

Parameters

position The new center position of this object

See also: positionChanged

◆ transportType()

int AbstractItemInputOutputBase::transportType ( ) const

Returns the type of data this object handles.

Returns: The type of data this object handles

Here is the caller graph for this function:

◆ updateScenePosition()

void AbstractItemInputOutputBase::updateScenePosition ( )

protected

Updates the scene position. Causes this objects position within the item scene to be updated.

See also: positionChanged

Here is the call graph for this function:

Here is the caller graph for this function:

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

itemframework/itemframework/include/item/abstract_item_input_output_base.h
itemframework/itemframework/moc/moc_abstract_item_input_output_base.cpp
itemframework/itemframework/src/item/abstract_item_input_output_base.cpp