Inkscape: Inkscape::CanvasItemGuideLine Class Reference

Searching...

No Matches

#include <canvas-item-guideline.h>

Inheritance diagram for Inkscape::CanvasItemGuideLine:

Public Member Functions
	CanvasItemGuideLine (CanvasItemGroup *group, Glib::ustring label, Geom::Point const &origin, Geom::Point const &normal)
	Create a control guide line.

void	set_origin (Geom::Point const &origin)
	Sets origin of guide line (place where handle is located).

void	set_normal (Geom::Point const &normal)
	Sets orientation of guide line.

double	closest_distance_to (Geom::Point const &p)
	Returns distance between point in canvas units and nearest point on guideLine.

bool	contains (Geom::Point const &p, double tolerance=0) override
	Returns true if point p (in canvas units) is within tolerance (canvas units) distance of guideLine (or 1 if tolerance is zero).

void	set_visible (bool visible) override

void	set_stroke (uint32_t color) override

void	set_label (Glib::ustring &&label)

void	set_locked (bool locked)

void	set_inverted (bool inverted)
	Sets the inverted nature of the line.

CanvasItemGuideHandle *	dot () const
	Returns the pointer to the origin control (the "dot")

Public Member Functions inherited from Inkscape::CanvasItem
	CanvasItem (CanvasItemContext *context)

	CanvasItem (CanvasItemGroup *parent)

	CanvasItem (CanvasItem const &)=delete

CanvasItem &	operator= (CanvasItem const &)=delete

void	unlink ()

UI::Widget::Canvas *	get_canvas () const

CanvasItemGroup *	get_parent () const

bool	is_descendant_of (CanvasItem const *ancestor) const

void	set_z_position (int zpos)

void	raise_to_top ()

void	lower_to_bottom ()

void	request_update ()

void	update (bool propagate)

virtual void	visit_page_rects (std::function< void(Geom::Rect const &)> const &) const

Geom::OptRect const &	get_bounds () const

void	grab (EventMask event_mask, Glib::RefPtr< Gdk::Cursor > const &={})

void	ungrab ()

void	render (Inkscape::CanvasItemBuffer &buf) const

bool	is_visible () const

void	request_redraw ()

virtual void	set_fill (uint32_t rgba)

void	set_fill (CanvasItemColor color)

void	set_fill_pattern (Cairo::RefPtr< Cairo::Pattern > pattern)

void	set_stroke (CanvasItemColor color)

void	set_stroke_width (double width)
	Set the stroke width.

void	set_outline (uint32_t color)
	Set the outline color.

void	set_outline_width (double width)
	Set the outline width.

double	get_effective_outline () const
	Get the effective outline.

void	set_name (std::string &&name)

std::string const &	get_name () const

void	update_canvas_item_ctrl_sizes (int size_index)

void	set_pickable (bool pickable)

bool	is_pickable () const

sigc::connection	connect_event (sigc::slot< bool(CanvasEvent const &)> const &slot)

virtual bool	handle_event (CanvasEvent const &event)

void	canvas_item_print_tree (int level=0, int zorder=0) const

Protected Member Functions
	~CanvasItemGuideLine () override=default

void	_update (bool propagate) override
	Update and redraw control guideLine.

void	_render (Inkscape::CanvasItemBuffer &buf) const override
	Render guideLine to screen via Cairo.

Protected Member Functions inherited from Inkscape::CanvasItem
virtual	~CanvasItem ()

Geom::Affine const &	affine () const

virtual void	_mark_net_invisible ()

virtual void	_invalidate_ctrl_handles ()

template<typename F >
void	defer (F &&f)

Protected Attributes
Geom::Point	_origin

Geom::Point	_normal = Geom::Point(0, 1)

Glib::ustring	_label

bool	_locked = true

bool	_inverted = false

CanvasItemPtr< CanvasItemGuideHandle >	_origin_ctrl

Protected Attributes inherited from Inkscape::CanvasItem
CanvasItemContext *	_context

CanvasItemGroup *	_parent

Geom::OptRect	_bounds

bool	_need_update = false

bool	_visible = true

bool	_net_visible = true

bool	_pickable = false

uint32_t	_fill = CANVAS_ITEM_COLORS[CANVAS_ITEM_SECONDARY]

Cairo::RefPtr< Cairo::Pattern >	_fill_pattern

uint32_t	_stroke = CANVAS_ITEM_COLORS[CANVAS_ITEM_PRIMARY]

double	_stroke_width = 1.0

uint32_t	_outline = 0x0

double	_outline_width = 0

std::string	_name

sigc::signal< bool(CanvasEvent const &)>	_event_signal

Static Protected Attributes
static constexpr uint32_t	CONTROL_LOCKED_COLOR = 0x00000080

static constexpr double	LABEL_SEP = 2.0

Additional Inherited Members
Public Attributes inherited from Inkscape::CanvasItem
boost::intrusive::list_member_hook	member_hook

Detailed Description

Definition at line 33 of file canvas-item-guideline.h.

Constructor & Destructor Documentation

◆ CanvasItemGuideLine()

Inkscape::CanvasItemGuideLine::CanvasItemGuideLine	(	CanvasItemGroup *	group,
		Glib::ustring	label,
		Geom::Point const &	origin,
		Geom::Point const &	normal
	)