#include <ruler.h>

Inheritance diagram for ArdourCanvas::Ruler:

Classes
struct	Mark

struct	Metric

Public Member Functions
	Ruler (Canvas , const Metric m)

	Ruler (Canvas , const Metric m, Rect const &)

	Ruler (Item , const Metric m)

	Ruler (Item , const Metric m, Rect const &)

virtual	~Ruler ()

void	set_range (int64_t lower, int64_t upper)

void	set_font_description (Pango::FontDescription)

void	set_second_font_description (Pango::FontDescription)

void	set_metric (const Metric *)

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

void	set_divide_colors (Gtkmm2ext::Color top, Gtkmm2ext::Color bottom)

void	set_divide_height (double)

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

	Rectangle (Canvas *, Rect const &)

	Rectangle (Item *)

	Rectangle (Item *, Rect 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 &)

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

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
const Metric *	_metric

int64_t	_lower

int64_t	_upper

double	_divide_height

Gtkmm2ext::Color	_divider_color_top

Gtkmm2ext::Color	_divider_color_bottom

Pango::FontDescription *	_font_description

Pango::FontDescription *	_second_font_description

std::vector< Mark >	marks

bool	_need_marks

Additional Inherited Members
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 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::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

Detailed Description

Definition at line 33 of file canvas/canvas/ruler.h.

Constructor & Destructor Documentation

◆ Ruler() [1/4]

ArdourCanvas::Ruler::Ruler	(	Canvas *	,
		const Metric *	m
	)

◆ Ruler() [2/4]

ArdourCanvas::Ruler::Ruler	(	Canvas *	,
		const Metric *	m,
		Rect const &
	)

◆ Ruler() [3/4]

ArdourCanvas::Ruler::Ruler	(	Item *	,
		const Metric *	m
	)

◆ Ruler() [4/4]

ArdourCanvas::Ruler::Ruler	(	Item *	,
		const Metric *	m,
		Rect const &
	)

◆ ~Ruler()

virtual ArdourCanvas::Ruler::~Ruler ( )

inlinevirtual

Definition at line 64 of file canvas/canvas/ruler.h.

Member Function Documentation

◆ render()

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

virtual

Render this item to a Cairo context.

Parameters

area	Area to draw, in window coordinates

Items must convert their own coordinates into window coordinates because Cairo is limited to a fixed point coordinate space that does not extend as far as the Ardour timeline. All rendering must be done using coordinates that do not exceed the (rough) limits of the canvas' window, to avoid odd errors within Cairo as it converts doubles into its fixed point format and then tesselates the results.

Reimplemented from ArdourCanvas::Rectangle.

◆ set_divide_colors()

void ArdourCanvas::Ruler::set_divide_colors	(	Gtkmm2ext::Color	top,
		Gtkmm2ext::Color	bottom
	)

◆ set_divide_height()

void ArdourCanvas::Ruler::set_divide_height ( double )

◆ set_font_description()

void ArdourCanvas::Ruler::set_font_description ( Pango::FontDescription )

◆ set_metric()

void ArdourCanvas::Ruler::set_metric ( const Metric * )

◆ set_range()

void ArdourCanvas::Ruler::set_range	(	int64_t	lower,
		int64_t	upper
	)

◆ set_second_font_description()

void ArdourCanvas::Ruler::set_second_font_description ( Pango::FontDescription )

Member Data Documentation

◆ _divide_height

double ArdourCanvas::Ruler::_divide_height

private

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

◆ _divider_color_bottom

Gtkmm2ext::Color ArdourCanvas::Ruler::_divider_color_bottom

private

Definition at line 86 of file canvas/canvas/ruler.h.

◆ _divider_color_top

Gtkmm2ext::Color ArdourCanvas::Ruler::_divider_color_top

private

Definition at line 85 of file canvas/canvas/ruler.h.

◆ _font_description

Pango::FontDescription* ArdourCanvas::Ruler::_font_description

private

Definition at line 88 of file canvas/canvas/ruler.h.

◆ _lower

int64_t ArdourCanvas::Ruler::_lower

private

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

◆ _metric

const Metric* ArdourCanvas::Ruler::_metric

private

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

◆ _need_marks

bool ArdourCanvas::Ruler::_need_marks

mutableprivate

Definition at line 91 of file canvas/canvas/ruler.h.

◆ _second_font_description

Pango::FontDescription* ArdourCanvas::Ruler::_second_font_description

private

Definition at line 89 of file canvas/canvas/ruler.h.

◆ _upper

int64_t ArdourCanvas::Ruler::_upper

private

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

◆ marks

std::vector<Mark> ArdourCanvas::Ruler::marks

mutableprivate

Definition at line 90 of file canvas/canvas/ruler.h.

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

canvas/canvas/ruler.h

Classes

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Ruler() [1/4]

◆ Ruler() [2/4]

◆ Ruler() [3/4]

◆ Ruler() [4/4]

◆ ~Ruler()

Member Function Documentation

◆ render()

◆ set_divide_colors()

◆ set_divide_height()

◆ set_font_description()

◆ set_metric()

◆ set_range()

◆ set_second_font_description()

Member Data Documentation

◆ _divide_height

◆ _divider_color_bottom

◆ _divider_color_top

◆ _font_description

◆ _lower

◆ _metric

◆ _need_marks

◆ _second_font_description

◆ _upper

◆ marks