FlowCanvas::Connection Class Reference

A connection (line) between two canvas objects. More...

#include <Connection.hpp>

Inheritance diagram for FlowCanvas::Connection:

Collaboration diagram for FlowCanvas::Connection:

Classes
struct	Handle
	A handle on a connection line to allow mouse interaction. More...

Public Types
enum	HandleStyle { HANDLE_NONE , HANDLE_RECT , HANDLE_CIRCLE }

Public Member Functions
	Connection (boost::shared_ptr< Canvas > canvas, boost::shared_ptr< Connectable > source, boost::shared_ptr< Connectable > dest, uint32_t color, bool show_arrow_head=false)
virtual	~Connection ()
virtual void	move (double, double)
virtual void	zoom (double z)
bool	selected () const
void	set_selected (bool b)
virtual double	length_hint () const
void	set_label (const std::string &str)
void	show_handle (bool show)
void	set_color (uint32_t color)
void	set_highlighted (bool b)
void	raise_to_top ()
void	select_tick ()
const boost::weak_ptr< Connectable >	source () const
const boost::weak_ptr< Connectable >	dest () const
void	set_handle_style (HandleStyle s)

Protected Member Functions
void	update_location ()

Protected Attributes
const boost::weak_ptr< Canvas >	_canvas
const boost::weak_ptr< Connectable >	_source
const boost::weak_ptr< Connectable >	_dest
Gnome::Canvas::Bpath	_bpath
GnomeCanvasPathDef *	_path
FlowCanvas::Connection::Handle *	_handle
uint32_t	_color
HandleStyle	_handle_style
bool	_selected:1
bool	_show_arrowhead:1

Friends
class	Canvas
class	Connectable

Detailed Description

A connection (line) between two canvas objects.

Member Enumeration Documentation

HandleStyle

enum FlowCanvas::Connection::HandleStyle

Enumerator
HANDLE_NONE
HANDLE_RECT
HANDLE_CIRCLE

Constructor & Destructor Documentation

Connection()

FlowCanvas::Connection::Connection	(	boost::shared_ptr< Canvas >	canvas,
		boost::shared_ptr< Connectable >	source,
		boost::shared_ptr< Connectable >	dest,
		uint32_t	color,
		bool	show_arrow_head = false )

~Connection()

virtual FlowCanvas::Connection::~Connection ( )

virtual

Member Function Documentation

move()

virtual void FlowCanvas::Connection::move ( double , double  )

inlinevirtual

zoom()

virtual void FlowCanvas::Connection::zoom ( double z )

virtual

selected()

bool FlowCanvas::Connection::selected ( ) const

inline

References _selected.

set_selected()

void FlowCanvas::Connection::set_selected

(

bool

b

)

length_hint()

virtual double FlowCanvas::Connection::length_hint ( ) const

inlinevirtual

set_label()

void FlowCanvas::Connection::set_label

(

const std::string &

str

)

show_handle()

void FlowCanvas::Connection::show_handle

(

bool

show

)

set_color()

void FlowCanvas::Connection::set_color

(

uint32_t

color

)

set_highlighted()

void FlowCanvas::Connection::set_highlighted

(

bool

b

)

raise_to_top()

void FlowCanvas::Connection::raise_to_top

(

)

select_tick()

void FlowCanvas::Connection::select_tick

(

)

source()

const boost::weak_ptr< Connectable > FlowCanvas::Connection::source ( ) const

inline

References _source.

dest()

const boost::weak_ptr< Connectable > FlowCanvas::Connection::dest ( ) const

inline

References _dest.

set_handle_style()

void FlowCanvas::Connection::set_handle_style ( HandleStyle s )

inline

References _handle_style.

update_location()

void FlowCanvas::Connection::update_location ( )

protected

Friends And Related Symbol Documentation

Canvas

friend class Canvas

friend

Connectable

friend class Connectable

friend

Member Data Documentation

_canvas

const boost::weak_ptr<Canvas> FlowCanvas::Connection::_canvas

protected

_source

const boost::weak_ptr<Connectable> FlowCanvas::Connection::_source

protected

Referenced by source().

_dest

const boost::weak_ptr<Connectable> FlowCanvas::Connection::_dest

protected

Referenced by dest().

_bpath

Gnome::Canvas::Bpath FlowCanvas::Connection::_bpath

protected

_path

GnomeCanvasPathDef* FlowCanvas::Connection::_path

protected

_handle

FlowCanvas::Connection::Handle* FlowCanvas::Connection::_handle

protected

_color

uint32_t FlowCanvas::Connection::_color

protected

_handle_style

HandleStyle FlowCanvas::Connection::_handle_style

protected

Referenced by set_handle_style().

_selected

bool FlowCanvas::Connection::_selected

protected

Referenced by selected().

_show_arrowhead

bool FlowCanvas::Connection::_show_arrowhead

protected

---

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

• flowcanvas/Connection.hpp