#include <box.h>

Inheritance diagram for ArdourCanvas::Box:

Public Types
enum	Orientation { Vertical , Horizontal }

Public Types inherited from ArdourCanvas::Rectangle
enum	What { NOTHING = 0x0 , LEFT = 0x1 , RIGHT = 0x2 , TOP = 0x4 , BOTTOM = 0x8 , ALL = LEFT\|RIGHT\|TOP\|BOTTOM }

Public Types inherited from ArdourCanvas::Fill
typedef std::vector< std::pair< double, Gtkmm2ext::Color > >	StopList

Public Member Functions
	Box (Canvas *, Orientation)

	Box (Item *, Orientation)

	Box (Item *, Duple const &position, Orientation)

void	set_spacing (double s)

void	set_padding (double top, double right=-1.0, double bottom=-1.0, double left=-1.0)

void	set_margin (double top, double right=-1.0, double bottom=-1.0, double left=-1.0)

void	set_border_width (double w)

void	set_border_color (Gtkmm2ext::Color c)

void	add (Item *)

void	add_front (Item *)

void	layout ()

void	set_collapse_on_hide (bool)

void	set_homogenous (bool)

void	compute_bounding_box () const

void	size_request (double &w, double &h) const

void	size_allocate_children (Rect const &r)

void	_size_allocate (Rect const &r)

Public Member Functions inherited from ArdourCanvas::Rectangle
	Rectangle (Canvas *)

	Rectangle (Canvas *, Rect const &)

	Rectangle (Item *)

	Rectangle (Item *, Rect const &)

void	render (Rect const &, Cairo::RefPtr< Cairo::Context >) const

void	compute_bounding_box () const

void	_size_allocate (Rect const &)

Rect const &	get () const

Coord	x0 () const

Coord	y0 () const

Coord	x1 () const

Coord	y1 () const

Distance	height () const

Distance	width () const

void	set (Rect const &)

void	set_x0 (Coord)

void	set_y0 (Coord)

void	set_x1 (Coord)

void	set_y1 (Coord)

double	vertical_fraction (double y) const

void	set_corner_radius (double d)

void	set_outline_what (What)

void	set_outline_all ()

void	size_request (double &w, double &h) const

void	dump (std::ostream &) const

Public Member Functions inherited from ArdourCanvas::Item
	Item (Canvas *)

	Item (Item *)

	Item (Item *, Duple const &p)

virtual	~Item ()

void	redraw () const

virtual void	prepare_for_render (Rect const &area) const

virtual void	add_items_at_point (Duple point, std::vector< Item const * > &items) const

virtual bool	covers (Duple const &point) const

void	grab ()

void	ungrab ()

void	unparent ()

void	reparent (Item *, bool already_added=false)

Item *	parent () const

uint32_t	depth () const

const Item *	closest_ancestor_with (const Item &other) const

bool	common_ancestor_within (uint32_t, const Item &other) const

bool	is_ancestor_of (const Item &candidate) const

bool	is_descendant_of (const Item &candidate) const

void	set_position (Duple)

void	set_x_position (Coord)

void	set_y_position (Coord)

void	move (Duple)

Duple	position () const

Duple	window_origin () const

Duple	canvas_origin () const

ScrollGroup *	scroll_parent () const

void	set_size_request (double w, double h)

void	set_size_request_to_display_given_text (const std::vector< std::string > &strings, gint hpadding, gint vpadding)

void	size_allocate (Rect const &)

Rect	allocation () const

void	set_layout_sensitive (bool)

bool	layout_sensitive () const

Rect	bounding_box () const

Coord	height () const

Coord	width () const

Duple	item_to_parent (Duple const &) const

Rect	item_to_parent (Rect const &) const

Duple	parent_to_item (Duple const &) const

Rect	parent_to_item (Rect const &) const

void	canvas_to_item (Coord &, Coord &) const

void	item_to_canvas (Coord &, Coord &) const

Duple	canvas_to_item (Duple const &) const

Rect	item_to_canvas (Rect const &) const

Duple	item_to_canvas (Duple const &) const

Rect	canvas_to_item (Rect const &) const

Duple	item_to_window (Duple const &, bool rounded=true) const

Duple	window_to_item (Duple const &) const

Rect	item_to_window (Rect const &, bool rounded=true) const

Rect	window_to_item (Rect const &) const

void	raise_to_top ()

void	raise (int)

void	lower_to_bottom ()

virtual void	hide ()

virtual void	show ()

void	block_change_notifications ()

void	unblock_change_notifications ()

bool	self_visible () const

bool	visible () const

Canvas *	canvas () const

void	set_ignore_events (bool)

bool	ignore_events () const

void	set_data (std::string const &, void *)

void *	get_data (std::string const &) const

virtual void	remove (Item *)

void	clear (bool with_delete=false)

std::list< Item * > const &	items () const

void	raise_child_to_top (Item *)

void	raise_child (Item *, int)

void	lower_child_to_bottom (Item *)

PackOptions	pack_options () const

void	set_pack_options (PackOptions)

std::string	whoami () const

const std::string &	tooltip () const

void	set_tooltip (const std::string &)

void	start_tooltip_timeout ()

void	stop_tooltip_timeout ()

std::string	whatami () const

bool	resize_queued () const

void	queue_resize ()

bool	scroll_translation () const

void	disable_scroll_translation ()

Duple	position_offset () const

Public Member Functions inherited from ArdourCanvas::Fill
	Fill (Item &self)

virtual	~Fill ()

virtual void	set_fill_color (Gtkmm2ext::Color)

virtual void	set_fill (bool)

Gtkmm2ext::Color	fill_color () const

bool	fill () const

void	set_gradient (StopList const &stops, bool is_vertical)

void	set_pattern (Cairo::RefPtr< Cairo::Pattern >)

Public Member Functions inherited from ArdourCanvas::Outline
	Outline (Item &self)

virtual	~Outline ()

Gtkmm2ext::Color	outline_color () const

virtual void	set_outline_color (Gtkmm2ext::Color)

Distance	outline_width () const

virtual void	set_outline_width (Distance)

bool	outline () const

virtual void	set_outline (bool)

Protected Member Functions
void	child_changed (bool bbox_changed)

Protected Member Functions inherited from ArdourCanvas::Item
void	begin_change ()

void	end_change ()

void	begin_visual_change ()

void	end_visual_change ()

void	set_bbox_clean () const

void	set_bbox_dirty () const

bool	bbox_dirty () const

void	invalidate_lut () const

void	clear_items (bool with_delete)

void	ensure_lut () const

void	add_child_bounding_boxes (bool include_hidden=false) const

void	render_children (Rect const &area, Cairo::RefPtr< Cairo::Context > context) const

void	prepare_for_render_children (Rect const &area) const

Duple	scroll_offset () const

Protected Member Functions inherited from ArdourCanvas::Fill
void	setup_fill_context (Cairo::RefPtr< Cairo::Context >) const

void	setup_gradient_context (Cairo::RefPtr< Cairo::Context >, Rect const &, Duple const &) const

Protected Member Functions inherited from ArdourCanvas::Outline
void	setup_outline_context (Cairo::RefPtr< Cairo::Context >) const

Protected Attributes
Orientation	orientation

double	spacing

double	top_padding

double	right_padding

double	bottom_padding

double	left_padding

double	top_margin

double	right_margin

double	bottom_margin

double	left_margin

Protected Attributes inherited from ArdourCanvas::Rectangle
Rect	_rect

Protected Attributes inherited from ArdourCanvas::Item
Canvas *	_canvas

Item *	_parent

ScrollGroup *	_scroll_parent

Duple	_position

bool	_visible

Rect	_pre_change_bounding_box

Rect	_bounding_box

PackOptions	_pack_options

Rect	_allocation

bool	_layout_sensitive

std::map< std::string, void * >	_data

LookupTable *	_lut

std::list< Item * >	_items

Protected Attributes inherited from ArdourCanvas::Fill
Item &	_self

Gtkmm2ext::Color	_fill_color

bool	_fill

bool	_transparent

StopList	_stops

bool	_vertical_gradient

Cairo::RefPtr< Cairo::Pattern >	_pattern

Protected Attributes inherited from ArdourCanvas::Outline
Item &	_self

Gtkmm2ext::Color	_outline_color

Distance	_outline_width

bool	_outline

Private Member Functions
void	reposition_children (Distance width, Distance height, bool width_shrink, bool height_shrink)

Private Attributes
bool	collapse_on_hide

bool	homogenous

bool	ignore_child_changes

Additional Inherited Members
Public Attributes inherited from ArdourCanvas::Item
sigc::signal1< bool, GdkEvent *, EventAccumulator< bool > >	Event

bool	_resize_queued

double	_requested_width

double	_requested_height

Static Public Attributes inherited from ArdourCanvas::Item
static int	default_items_per_cell

Detailed Description

a Container is an item which has no content of its own but renders its children in some geometrical arrangement.

Imagined examples of containers:

Container: renders each child at the child's self-determined position Box: renders each child along an axis (vertical or horizontal) Table/Grid: renders each child within a two-dimensional grid

Other?

Definition at line 42 of file canvas/canvas/box.h.

Member Enumeration Documentation

◆ Orientation

enum ArdourCanvas::Box::Orientation

Enumerator
Vertical
Horizontal

Definition at line 45 of file canvas/canvas/box.h.

Constructor & Destructor Documentation

◆ Box() [1/3]

ArdourCanvas::Box::Box	(	Canvas *	,
		Orientation
	)

◆ Box() [2/3]

ArdourCanvas::Box::Box	(	Item *	,
		Orientation
	)

◆ Box() [3/3]

ArdourCanvas::Box::Box	(	Item *	,
		Duple const &	position,
		Orientation
	)

Member Function Documentation

◆ _size_allocate()

void ArdourCanvas::Box::_size_allocate ( Rect const & r )

virtual

Reimplemented from ArdourCanvas::Item.

◆ add()

void ArdourCanvas::Box::add ( Item * )

virtual

Reimplemented from ArdourCanvas::Item.

◆ add_front()

void ArdourCanvas::Box::add_front ( Item * )

virtual

Reimplemented from ArdourCanvas::Item.

◆ child_changed()

void ArdourCanvas::Box::child_changed ( bool bbox_changed )

protectedvirtual

Reimplemented from ArdourCanvas::Item.

◆ compute_bounding_box()

void ArdourCanvas::Box::compute_bounding_box ( ) const

virtual

Update _bounding_box and _bounding_box_dirty

Implements ArdourCanvas::Item.

◆ layout()

void ArdourCanvas::Box::layout ( )

virtual

Reimplemented from ArdourCanvas::Item.

◆ reposition_children()

void ArdourCanvas::Box::reposition_children	(	Distance	width,
		Distance	height,
		bool	width_shrink,
		bool	height_shrink
	)

private

◆ set_border_color()

void ArdourCanvas::Box::set_border_color ( Gtkmm2ext::Color c )

inline

Definition at line 60 of file canvas/canvas/box.h.

◆ set_border_width()

void ArdourCanvas::Box::set_border_width ( double w )

inline

Definition at line 59 of file canvas/canvas/box.h.

◆ set_collapse_on_hide()

void ArdourCanvas::Box::set_collapse_on_hide ( bool )

◆ set_homogenous()

void ArdourCanvas::Box::set_homogenous ( bool )

◆ set_margin()

void ArdourCanvas::Box::set_margin	(	double	top,
		double	right = `-1.0`,
		double	bottom = `-1.0`,
		double	left = `-1.0`
	)

◆ set_padding()

void ArdourCanvas::Box::set_padding	(	double	top,
		double	right = `-1.0`,
		double	bottom = `-1.0`,
		double	left = `-1.0`
	)

◆ set_spacing()

void ArdourCanvas::Box::set_spacing ( double s )

◆ size_allocate_children()

void ArdourCanvas::Box::size_allocate_children ( Rect const & r )

virtual

Reimplemented from ArdourCanvas::Item.

◆ size_request()

void ArdourCanvas::Box::size_request	(	double &	w,
		double &	h
	)		const

virtual

Reimplemented from ArdourCanvas::Item.

Member Data Documentation

◆ bottom_margin

double ArdourCanvas::Box::bottom_margin

protected

Definition at line 78 of file canvas/canvas/box.h.

◆ bottom_padding

double ArdourCanvas::Box::bottom_padding

protected

Definition at line 77 of file canvas/canvas/box.h.

◆ collapse_on_hide

bool ArdourCanvas::Box::collapse_on_hide

private

Definition at line 82 of file canvas/canvas/box.h.

◆ homogenous

bool ArdourCanvas::Box::homogenous

private

Definition at line 83 of file canvas/canvas/box.h.

◆ ignore_child_changes

bool ArdourCanvas::Box::ignore_child_changes

mutableprivate

Definition at line 84 of file canvas/canvas/box.h.

◆ left_margin

double ArdourCanvas::Box::left_margin

protected

Definition at line 78 of file canvas/canvas/box.h.

◆ left_padding

double ArdourCanvas::Box::left_padding

protected

Definition at line 77 of file canvas/canvas/box.h.

◆ orientation

Orientation ArdourCanvas::Box::orientation

protected

Definition at line 75 of file canvas/canvas/box.h.

◆ right_margin

double ArdourCanvas::Box::right_margin

protected

Definition at line 78 of file canvas/canvas/box.h.

◆ right_padding

double ArdourCanvas::Box::right_padding

protected

Definition at line 77 of file canvas/canvas/box.h.

◆ spacing

double ArdourCanvas::Box::spacing

protected

Definition at line 76 of file canvas/canvas/box.h.

◆ top_margin

double ArdourCanvas::Box::top_margin

protected

Definition at line 78 of file canvas/canvas/box.h.

◆ top_padding

double ArdourCanvas::Box::top_padding

protected

Definition at line 77 of file canvas/canvas/box.h.

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

canvas/canvas/box.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Orientation

Constructor & Destructor Documentation

◆ Box() [1/3]

◆ Box() [2/3]

◆ Box() [3/3]

Member Function Documentation

◆ _size_allocate()

◆ add()

◆ add_front()

◆ child_changed()

◆ compute_bounding_box()

◆ layout()

◆ reposition_children()

◆ set_border_color()

◆ set_border_width()

◆ set_collapse_on_hide()

◆ set_homogenous()

◆ set_margin()

◆ set_padding()

◆ set_spacing()

◆ size_allocate_children()

◆ size_request()

Member Data Documentation

◆ bottom_margin

◆ bottom_padding

◆ collapse_on_hide

◆ homogenous

◆ ignore_child_changes

◆ left_margin

◆ left_padding

◆ orientation

◆ right_margin

◆ right_padding

◆ spacing

◆ top_margin

◆ top_padding