#include <Port.hpp>

Inheritance diagram for FlowCanvas::Port:

[legend]

Collaboration diagram for FlowCanvas::Port:

[legend]

Classes
struct	Control
	Port control value indicator "gauge". More...

Public Member Functions
	Port (boost::shared_ptr< Module > module, const std::string &name, bool is_input, uint32_t color)

virtual	~Port ()

void	disconnect_all ()

virtual Gnome::Art::Point	src_connection_point ()

virtual Gnome::Art::Point	dst_connection_point (const Gnome::Art::Point &src)

virtual Gnome::Art::Point	connection_point_vector (double dx, double dy)

boost::weak_ptr< Module >	module () const

void	set_fill_color (uint32_t c)

void	show_label (bool b)

void	set_selected (bool b)

bool	selected () const

void	set_highlighted (bool highlight, bool highlight_parent=true, bool highlight_connections=true, bool raise_connections=true)

void	zoom (float z)

void	popup_menu (guint button, guint32 activate_time)

virtual void	create_menu ()

void	set_menu (Gtk::Menu *m)

Gtk::Menu *	menu () const

double	width () const

void	set_width (double w)

void	set_height (double h)

double	border_width () const

void	set_border_width (double w)

double	natural_width () const

const std::string &	name () const

virtual void	set_name (const std::string &n)

bool	is_input () const

bool	is_output () const

uint32_t	color () const

double	height () const

virtual bool	is_toggled () const

virtual void	set_toggled (bool b)

virtual void	toggle (bool signal=true)

virtual void	set_control (float value, bool signal=true)

virtual void	set_control_min (float min)

virtual void	set_control_max (float max)

float	control_value () const

float	control_min () const

float	control_max () const

void	show_control ()

void	hide_control ()

bool	operator== (const std::string &name)

Public Member Functions inherited from FlowCanvas::Connectable
virtual	~Connectable ()

virtual void	add_connection (boost::shared_ptr< Connection > c)

virtual void	remove_connection (boost::shared_ptr< Connection > c)

virtual void	move_connections ()

virtual void	raise_connections ()

bool	is_connected_to (boost::shared_ptr< Connectable > other)

Connections &	connections ()

Public Attributes
sigc::signal< void >	signal_renamed

sigc::signal< void, float >	signal_control_changed

Protected Member Functions
void	on_menu_hide ()

Protected Attributes
boost::weak_ptr< Module >	_module

std::string	_name

Gnome::Canvas::Text *	_label

Gnome::Canvas::Rect *	_rect

Gtk::Menu *	_menu

Control *	_control

double	_width

double	_height

double	_border_width

uint32_t	_color

bool	_is_input:1

bool	_selected:1

bool	_toggled:1

Protected Attributes inherited from FlowCanvas::Connectable
Connections	_connections
	needed for dragging

Friends
class	Canvas

Additional Inherited Members
Public Types inherited from FlowCanvas::Connectable
typedef std::list< boost::weak_ptr< Connection > >	Connections

Detailed Description

A port on a Module.

This is a group that contains both the label and rectangle for a port.

Constructor & Destructor Documentation

◆ Port()

FlowCanvas::Port::Port	(	boost::shared_ptr< Module >	module,
		const std::string &	name,
		bool	is_input,
		uint32_t	color )

◆ ~Port()

virtual FlowCanvas::Port::~Port ( )

virtual

Member Function Documentation

◆ disconnect_all()

void FlowCanvas::Port::disconnect_all ( )

◆ src_connection_point()

virtual Gnome::Art::Point FlowCanvas::Port::src_connection_point ( )

virtual

Implements FlowCanvas::Connectable.

◆ dst_connection_point()

virtual Gnome::Art::Point FlowCanvas::Port::dst_connection_point ( const Gnome::Art::Point & src )

virtual

Implements FlowCanvas::Connectable.

◆ connection_point_vector()

virtual Gnome::Art::Point FlowCanvas::Port::connection_point_vector	(	double	dx,
		double	dy )

virtual

Implements FlowCanvas::Connectable.

◆ module()

boost::weak_ptr< Module > FlowCanvas::Port::module ( ) const

inline

References _module.

◆ set_fill_color()

void FlowCanvas::Port::set_fill_color ( uint32_t c )

inline

References _rect.

◆ show_label()

void FlowCanvas::Port::show_label ( bool b )

◆ set_selected()

void FlowCanvas::Port::set_selected ( bool b )

◆ selected()

bool FlowCanvas::Port::selected ( ) const

inline

References _selected.

◆ set_highlighted()

void FlowCanvas::Port::set_highlighted	(	bool	highlight,
		bool	highlight_parent = true,
		bool	highlight_connections = true,
		bool	raise_connections = true )

◆ zoom()

void FlowCanvas::Port::zoom ( float z )

◆ popup_menu()

void FlowCanvas::Port::popup_menu	(	guint	button,
		guint32	activate_time )

inline

References _menu, and create_menu().

◆ create_menu()

virtual void FlowCanvas::Port::create_menu ( )

virtual

Referenced by popup_menu().

◆ set_menu()

void FlowCanvas::Port::set_menu ( Gtk::Menu * m )

◆ menu()

Gtk::Menu * FlowCanvas::Port::menu ( ) const

inline

References _menu.

◆ width()

double FlowCanvas::Port::width ( ) const

inline

References _width.

◆ set_width()

void FlowCanvas::Port::set_width ( double w )

◆ set_height()

void FlowCanvas::Port::set_height ( double h )

◆ border_width()

double FlowCanvas::Port::border_width ( ) const

inline

References _border_width.

◆ set_border_width()

void FlowCanvas::Port::set_border_width ( double w )

◆ natural_width()

double FlowCanvas::Port::natural_width ( ) const

◆ name()

const std::string & FlowCanvas::Port::name ( ) const

inline

References _name.

Referenced by operator==().

◆ set_name()

virtual void FlowCanvas::Port::set_name ( const std::string & n )

virtual

◆ is_input()

bool FlowCanvas::Port::is_input ( ) const

inline

References _is_input.

◆ is_output()

bool FlowCanvas::Port::is_output ( ) const

inline

References _is_input.

◆ color()

uint32_t FlowCanvas::Port::color ( ) const

inline

References _color.

◆ height()

double FlowCanvas::Port::height ( ) const

inline

References _height.

◆ is_toggled()

virtual bool FlowCanvas::Port::is_toggled ( ) const

inlinevirtual

References _toggled.

◆ set_toggled()

virtual void FlowCanvas::Port::set_toggled ( bool b )

inlinevirtual

References _toggled.

◆ toggle()

virtual void FlowCanvas::Port::toggle ( bool signal = true )

virtual

◆ set_control()

virtual void FlowCanvas::Port::set_control	(	float	value,
		bool	signal = true )

virtual

◆ set_control_min()

virtual void FlowCanvas::Port::set_control_min ( float min )

virtual

◆ set_control_max()

virtual void FlowCanvas::Port::set_control_max ( float max )

virtual

◆ control_value()

float FlowCanvas::Port::control_value ( ) const

inline

References _control, and FlowCanvas::Port::Control::value.

◆ control_min()

float FlowCanvas::Port::control_min ( ) const

inline

References _control, and FlowCanvas::Port::Control::min.

◆ control_max()

float FlowCanvas::Port::control_max ( ) const

inline

References _control, and FlowCanvas::Port::Control::max.

◆ show_control()

void FlowCanvas::Port::show_control ( )

◆ hide_control()

void FlowCanvas::Port::hide_control ( )

◆ operator==()

bool FlowCanvas::Port::operator== ( const std::string & name )

inline

References _name, and name().

◆ on_menu_hide()

void FlowCanvas::Port::on_menu_hide ( )

protected

Friends And Related Symbol Documentation

◆ Canvas

friend class Canvas

friend

Member Data Documentation

◆ signal_renamed

sigc::signal<void> FlowCanvas::Port::signal_renamed

◆ signal_control_changed

sigc::signal<void,float> FlowCanvas::Port::signal_control_changed

◆ _module

boost::weak_ptr<Module> FlowCanvas::Port::_module

protected

Referenced by module().

◆ _name

std::string FlowCanvas::Port::_name

protected

Referenced by name(), and operator==().

◆ _label

Gnome::Canvas::Text* FlowCanvas::Port::_label

protected

◆ _rect

Gnome::Canvas::Rect* FlowCanvas::Port::_rect

protected

Referenced by set_fill_color().

◆ _menu

Gtk::Menu* FlowCanvas::Port::_menu

protected

Referenced by menu(), and popup_menu().

◆ _control

Control* FlowCanvas::Port::_control

protected

Referenced by control_max(), control_min(), and control_value().

◆ _width

double FlowCanvas::Port::_width

protected

Referenced by width().

◆ _height

double FlowCanvas::Port::_height

protected

Referenced by height().

◆ _border_width

double FlowCanvas::Port::_border_width

protected

Referenced by border_width().

◆ _color

uint32_t FlowCanvas::Port::_color

protected

Referenced by color().

◆ _is_input

bool FlowCanvas::Port::_is_input

protected

Referenced by is_input(), and is_output().

◆ _selected

bool FlowCanvas::Port::_selected

protected

Referenced by selected().

◆ _toggled

bool FlowCanvas::Port::_toggled

protected

Referenced by is_toggled(), and set_toggled().

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

flowcanvas/Port.hpp

Classes

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Port()

◆ ~Port()

Member Function Documentation

◆ disconnect_all()

◆ src_connection_point()

◆ dst_connection_point()

◆ connection_point_vector()

◆ module()

◆ set_fill_color()

◆ show_label()

◆ set_selected()

◆ selected()

◆ set_highlighted()

◆ zoom()

◆ popup_menu()

◆ create_menu()

◆ set_menu()

◆ menu()

◆ width()

◆ set_width()

◆ set_height()

◆ border_width()

◆ set_border_width()

◆ natural_width()

◆ name()

◆ set_name()

◆ is_input()

◆ is_output()

◆ color()

◆ height()

◆ is_toggled()

◆ set_toggled()

◆ toggle()

◆ set_control()

◆ set_control_min()

◆ set_control_max()

◆ control_value()

◆ control_min()

◆ control_max()

◆ show_control()

◆ hide_control()

◆ operator==()

◆ on_menu_hide()

Friends And Related Symbol Documentation

◆ Canvas

Member Data Documentation

◆ signal_renamed

◆ signal_control_changed

◆ _module

◆ _name

◆ _label

◆ _rect

◆ _menu

◆ _control

◆ _width

◆ _height

◆ _border_width

◆ _color

◆ _is_input

◆ _selected

◆ _toggled