#include <scroll_group.h>

Inheritance diagram for ArdourCanvas::ScrollGroup:

Public Types
enum	ScrollSensitivity { ScrollsVertically = 0x1 , ScrollsHorizontally = 0x2 }

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

Public Member Functions
	ScrollGroup (Canvas *, ScrollSensitivity)

	ScrollGroup (Item *, ScrollSensitivity)

void	scroll_to (Duple const &d)

Duple	scroll_offset () const

bool	covers_canvas (Duple const &d) const

bool	covers_window (Duple const &d) const

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

ScrollSensitivity	sensitivity () const

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

	Container (Item *)

	Container (Item *, Duple const &position)

void	compute_bounding_box () const

void	prepare_for_render (Rect const &area) const

void	set_render_with_alpha (double alpha)

double	render_with_alpha () const

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

	Item (Item *)

	Item (Item *, Duple const &p)

virtual	~Item ()

void	redraw () 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

virtual void	size_request (double &w, double &h) 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 &)

virtual void	_size_allocate (Rect const &)

virtual void	size_allocate_children (Rect const &r)

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	add (Item *)

virtual void	add_front (Item *)

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 *)

virtual void	child_changed (bool bbox_changed)

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 ()

virtual void	dump (std::ostream &) const

std::string	whatami () const

bool	resize_queued () const

void	queue_resize ()

bool	scroll_translation () const

void	disable_scroll_translation ()

virtual void	layout ()

Duple	position_offset () const

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

	Fill (const Fill &)=delete

Fill &	operator= (const Fill &)=delete

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)

	Outline (const Outline &)=delete

Outline &	operator= (const Outline &)=delete

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)

Private Attributes
ScrollSensitivity	_scroll_sensitivity

Duple	_scroll_offset

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

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 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

Detailed Description

A ScrollGroup has no contents of its own, but renders its children in a way that reflects the most recent call to its scroll_to() method.

Definition at line 31 of file scroll_group.h.

Member Enumeration Documentation

◆ ScrollSensitivity

enum ArdourCanvas::ScrollGroup::ScrollSensitivity

Enumerator
ScrollsVertically
ScrollsHorizontally

Definition at line 34 of file scroll_group.h.

Constructor & Destructor Documentation

◆ ScrollGroup() [1/2]

ArdourCanvas::ScrollGroup::ScrollGroup	(	Canvas *	,
		ScrollSensitivity
	)

◆ ScrollGroup() [2/2]

ArdourCanvas::ScrollGroup::ScrollGroup	(	Item *	,
		ScrollSensitivity
	)

Member Function Documentation

◆ covers_canvas()

bool ArdourCanvas::ScrollGroup::covers_canvas ( Duple const & d ) const

◆ covers_window()

bool ArdourCanvas::ScrollGroup::covers_window ( Duple const & d ) const

◆ render()

void ArdourCanvas::ScrollGroup::render	(	Rect const &	area,
		Cairo::RefPtr< Cairo::Context >	context
	)		const

virtual

The render() method is likely to be identical in all containers (just call Item::render_children()). It can be overridden as necessary.

Reimplemented from ArdourCanvas::Container.

◆ scroll_offset()

Duple ArdourCanvas::ScrollGroup::scroll_offset ( ) const

inline

Definition at line 43 of file scroll_group.h.

◆ scroll_to()

void ArdourCanvas::ScrollGroup::scroll_to ( Duple const & d )

◆ sensitivity()

ScrollSensitivity ArdourCanvas::ScrollGroup::sensitivity ( ) const

inline

Definition at line 50 of file scroll_group.h.

Member Data Documentation

◆ _scroll_offset

Duple ArdourCanvas::ScrollGroup::_scroll_offset

private

Definition at line 54 of file scroll_group.h.

◆ _scroll_sensitivity

ScrollSensitivity ArdourCanvas::ScrollGroup::_scroll_sensitivity