Inkscape: SPDesktop Class Reference

Searching...

No Matches

To do: update description of desktop. More...

#include <desktop.h>

Classes
class	DesktopAffine

Public Types
enum	CanvasFlip { FLIP_NONE = 0 , FLIP_HORIZONTAL = 1 , FLIP_VERTICAL = 2 }

Public Member Functions
	SPDesktop (SPNamedView *nv)

	~SPDesktop ()

	SPDesktop (SPDesktop const &)=delete

SPDesktop &	operator= (SPDesktop const &)=delete

	SPDesktop (SPDesktop &&)=delete

SPDesktop &	operator= (SPDesktop &&)=delete

SPDocument *	doc () const

Inkscape::MessageStack *	messageStack () const

Inkscape::MessageContext *	tipsMessageContext () const

void	setDesktopWidget (SPDesktopWidget *dtw)

Inkscape::UI::Tools::ToolBase *	getTool () const

Inkscape::Selection *	getSelection () const

SPDocument *	getDocument () const

Inkscape::UI::Widget::Canvas *	getCanvas () const

SPNamedView *	getNamedView () const

SPDesktopWidget *	getDesktopWidget () const

Inkscape::Display::SnapIndicator *	getSnapIndicator () const

int	viewNumber () const

Inkscape::CanvasItemGroup *	getCanvasControls () const

Inkscape::CanvasItemGroup *	getCanvasPagesBg () const

Inkscape::CanvasItemGroup *	getCanvasPagesFg () const

Inkscape::CanvasItemGroup *	getCanvasGrids () const

Inkscape::CanvasItemGroup *	getCanvasGuides () const

Inkscape::CanvasItemGroup *	getCanvasSketch () const

Inkscape::CanvasItemGroup *	getCanvasTemp () const

Inkscape::CanvasItemCatchall *	getCanvasCatchall () const

Inkscape::CanvasItemDrawing *	getCanvasDrawing () const

template<typename F >
sigc::connection	connectDestroy (F &&slot)

template<typename F >
sigc::connection	connectDocumentReplaced (F &&slot)

template<typename F >
sigc::connection	connectEventContextChanged (F &&slot)

template<typename F >
sigc::connection	connectSetStyle (F &&slot)

template<typename F >
sigc::connection	connectQueryStyle (F &&slot)

sigc::connection	connect_gradient_stop_selected (sigc::slot< void(SPStop *)> const &slot)

sigc::connection	connect_control_point_selected (sigc::slot< void(Inkscape::UI::ControlPointSelection *)> const &slot)

sigc::connection	connect_text_cursor_moved (sigc::slot< void(Inkscape::UI::Tools::TextTool *)> const &slot)

void	emit_gradient_stop_selected (SPStop *stop)

void	emit_control_point_selected (Inkscape::UI::ControlPointSelection *selection)

void	emit_text_cursor_moved (Inkscape::UI::Tools::TextTool *tool)

Inkscape::LayerManager &	layerManager ()

Inkscape::LayerManager const &	layerManager () const

Inkscape::MessageContext *	guidesMessageContext () const

Inkscape::Display::TemporaryItem *	add_temporary_canvasitem (Inkscape::CanvasItem *item, int lifetime_msecs, bool move_to_bottom=true)
	One should not keep a reference to the SPCanvasItem, the temporary item code will delete the object for you and the reference will become invalid without you knowing it.

void	remove_temporary_canvasitem (Inkscape::Display::TemporaryItem *tempitem)
	It is perfectly safe to call this function while the object has already been deleted due to a timeout.

Inkscape::Display::TranslucencyGroup &	getTranslucencyGroup () const

Inkscape::UI::Dialog::DialogContainer *	getContainer ()

bool	isWithinViewport (SPItem const *item) const
	True if desktop viewport intersects item's bbox.

bool	itemIsHidden (SPItem const *item) const

void	activate_guides (bool activate)
	Set activate status of current desktop's named view.

void	change_document (SPDocument *document)
	Make desktop switch documents.

void	setTool (std::string const &toolName)
	Replaces the currently active tool with a new one.

void	set_coordinate_status (Geom::Point const &p)
	Sets the coordinate status to a given point.

SPItem *	getItemFromListAtPointBottom (std::vector< SPItem * > const &list, Geom::Point const &p) const

SPItem *	getItemAtPoint (Geom::Point const &p, bool into_groups, SPItem *upto=nullptr) const

std::vector< SPItem * >	getItemsAtPoints (std::vector< Geom::Point > ps, bool all_layers=true, bool topmost_only=true, size_t limit=0, bool active_only=true) const

SPItem *	getGroupAtPoint (Geom::Point const &p) const

Geom::Point	point () const
	Returns the mouse point in desktop coordinates; if mouse is outside the canvas, returns the center of canvas viewpoint.

void	prev_transform ()
	Revert back to previous transform if possible.

void	next_transform ()
	Set transform to next in list.

void	clear_transform_history ()
	Clear transform lists.

void	set_display_area (bool log=true)
	Does all the dirty work in setting the display area.

void	set_display_area (Geom::Point const &c, Geom::Point const &w, bool log=true)
	Map the drawing to the window so that 'c' lies at 'w' where where 'c' is a point on the canvas and 'w' is position in window in screen pixels.

void	set_display_area (Geom::Rect const &a, Geom::Coord border, bool log=true)
	Map the center of rectangle 'r' (which specifies a non-rotated region of the drawing) to lie at the center of the window.

Geom::Parallelogram	get_display_area () const
	Return canvas viewbox in desktop coordinates.

void	set_display_width (Geom::Rect const &a, Geom::Coord border)
	Set display area in only the width dimension.

void	set_display_center (Geom::Rect const &a)
	Centre Rect, without zooming.

void	zoom_absolute (Geom::Point const &c, double zoom, bool keep_point=true)
	Zoom to the given absolute zoom level.

void	zoom_relative (Geom::Point const &c, double zoom, bool keep_point=true)
	Zoom in or out relatively to the current zoom.

void	zoom_realworld (Geom::Point const &c, double ratio)
	Zoom in to an absolute realworld ratio, e.g.

void	zoom_drawing ()
	Zoom to whole drawing.

void	zoom_selection ()
	Zoom to selection.

void	schedule_zoom_from_document ()
	Schedule the zoom/view settings from the document to be applied to the desktop just after the canvas is first allocated a size, but before any drawing has started.

double	current_zoom () const

Geom::Point	current_center () const

void	zoom_quick (bool enable=true)
	Performs a quick zoom into what the user is working on.

bool	quick_zoomed () const
	Returns whether the desktop is in quick zoom mode or not.

void	quick_preview (bool activate)

void	set_rotation_lock (bool lock)

bool	get_rotation_lock () const

void	zoom_grab_focus ()
	Tell widget to let zoom widget grab keyboard focus.

void	rotate_grab_focus ()
	Tell widget to let rotate widget grab keyboard focus.

void	rotate_absolute_keep_point (Geom::Point const &c, double rotate)
	Set new rotation, keeping the point 'c' fixed in the desktop window.

void	rotate_relative_keep_point (Geom::Point const &c, double rotate)
	Rotate keeping the point 'c' fixed in the desktop window.

void	rotate_absolute_center_point (Geom::Point const &c, double rotate)
	Set new rotation, aligning the point 'c' to the center of desktop window.

void	rotate_relative_center_point (Geom::Point const &c, double rotate)
	Rotate aligning the point 'c' to the center of desktop window.

void	flip_absolute_keep_point (Geom::Point const &c, CanvasFlip flip)
	Set new flip direction, keeping the point 'c' fixed in the desktop window.

void	flip_relative_keep_point (Geom::Point const &c, CanvasFlip flip)
	Flip direction, keeping the point 'c' fixed in the desktop window.

void	flip_absolute_center_point (Geom::Point const &c, CanvasFlip flip)
	Set new flip direction, aligning the point 'c' to the center of desktop window.

void	flip_relative_center_point (Geom::Point const &c, CanvasFlip flip)
	Flip direction, aligning the point 'c' to the center of desktop window.

bool	is_flipped (CanvasFlip flip)

Geom::Rotate const &	current_rotation () const

void	scroll_absolute (Geom::Point const &point)
	Scroll canvas by to a particular point (window coordinates).

void	scroll_relative (Geom::Point const &delta)
	Scroll canvas by specific coordinate amount (window coordinates).

void	scroll_relative_in_svg_coords (double dx, double dy)
	Scroll canvas by specific coordinate amount in svg coordinates.

bool	scroll_to_point (Geom::Point const &s_dt, double autoscrollspeed=0)
	Scroll screen so as to keep point 'p' visible in window.

Geom::IntPoint	getWindowSize () const

void	setWindowSize (Geom::IntPoint const &size)

void	setWindowTransient (Gtk::Window &window, int transient_policy=1)

InkscapeWindow const *	getInkscapeWindow () const

InkscapeWindow *	getInkscapeWindow ()

void	presentWindow ()

void	showInfoDialog (Glib::ustring const &message)

bool	warnDialog (Glib::ustring const &text)

void	setRenderMode (Inkscape::RenderMode mode)

void	setColorMode (Inkscape::ColorMode mode)

void	toggleCommandPalette ()

void	toggleRulers ()

void	toggleScrollbars ()

void	setTempHideOverlays (bool hide)
	Shows or hides the on-canvas overlays and controls, such as grids, guides, manipulation handles, knots, selection cues, etc.

void	layoutWidget ()

void	setToolboxFocusTo (char const *label)

Gtk::Widget *	get_toolbar_by_name (Glib::ustring const &name)

void	setToolboxAdjustmentValue (char const *id, double val)

bool	isToolboxButtonActive (char const *id) const

void	updateDialogs ()

void	showNotice (Glib::ustring const &msg, int timeout=0)

void	setWaitingCursor ()

void	clearWaitingCursor ()

bool	isWaitingCursor () const

void	toggleLockGuides ()

void	toggleToolbar (char const *toolbar_name)

bool	isMinimised () const

bool	is_darktheme () const

bool	is_maximized () const

bool	is_fullscreen () const

bool	is_focusMode () const
	Checks to see if the user is working in focused mode.

void	focusMode (bool mode=true)
	Changes whether the user is in focus mode or not.

Geom::Affine const &	w2d () const
	Transformation from window to desktop coordinates (zoom/rotate).

Geom::Point	w2d (Geom::Point const &p) const

Geom::Affine const &	d2w () const
	Transformation from desktop to window coordinates.

Geom::Point	d2w (Geom::Point const &p) const

Geom::Affine const &	doc2dt () const

Geom::Affine const &	dt2doc () const

Geom::Point	doc2dt (Geom::Point const &p) const

Geom::Point	dt2doc (Geom::Point const &p) const

double	yaxisdir () const

bool	is_yaxisdown () const

void	setDocument (SPDocument *doc)
	Associate document with desktop.

void	onWindowStateChanged (Gdk::Toplevel::State changed, Gdk::Toplevel::State new_toplevel_state)
	onWindowStateChanged

void	applyCurrentOrToolStyle (SPObject *obj, Glib::ustring const &tool_path, bool with_text)
	Apply the desktop's current style or the tool style to the object.

Public Attributes
SPCSSAttr *	current = nullptr
	Current style.

bool	_focusMode = false
	Whether we're focused working or general working.

unsigned	dkey = 0

unsigned	interaction_disabled_counter = 0

bool	waiting_cursor = false

bool	showing_dialogs = false

bool	rotation_locked = false

bool	guides_active = false

SPItem *	gr_item = nullptr

GrPointType	gr_point_type = POINT_LG_BEGIN

unsigned	gr_point_i = 0

Inkscape::PaintTarget	gr_fill_or_stroke = Inkscape::FOR_FILL

Glib::ustring	_reconstruction_old_layer_id

sigc::signal< bool(SPCSSAttr const *, bool)>::accumulated< StopOnTrue >	_set_style_signal

sigc::signal< int(SPStyle *, int)>::accumulated< StopOnNonZero >	_query_style_signal

sigc::signal< void(double)>	signal_zoom_changed
	Emitted when the zoom factor changes (not emitted when scrolling).

Private Member Functions
void	_setupCanvasItems ()

void	_attachDocument ()

void	_detachDocument ()

bool	drawing_handler (Inkscape::CanvasEvent const &event, Inkscape::DrawingItem *item)
	Calls event handler of current event context.

void	reconstruction_start ()
	Called when document is starting to be rebuilt.

void	reconstruction_finish ()
	Called when document rebuild is finished.

void	handle_y_axis_flip (double yshift)

void	on_zoom_begin (Gdk::EventSequence *sequence)

void	on_zoom_scale (double scale)

void	on_zoom_end (Gdk::EventSequence *sequence)

void	onStatusMessage (Inkscape::MessageType type, char const *message)

Private Attributes
SPDocument *	document = nullptr

std::unique_ptr< Inkscape::MessageStack >	_message_stack

std::unique_ptr< Inkscape::MessageContext >	_tips_message_context

std::unique_ptr< Inkscape::MessageContext >	_guides_message_context

sigc::scoped_connection	_message_changed_connection

sigc::scoped_connection	_message_idle_connection

sigc::connection	_document_uri_set_connection

sigc::connection	_saved_or_modified_conn

std::unique_ptr< Inkscape::UI::Tools::ToolBase >	_tool

std::unique_ptr< Inkscape::Display::TemporaryItemList >	_temporary_item_list

std::unique_ptr< Inkscape::Display::TranslucencyGroup >	_translucency_group

std::unique_ptr< Inkscape::Display::SnapIndicator >	_snapindicator

SPNamedView *	namedview = nullptr

int	_view_number {}

std::unique_ptr< Inkscape::UI::Widget::Canvas >	canvas

std::unique_ptr< Inkscape::Selection >	_selection
	current selection; will never generally be NULL

Inkscape::CanvasItemGroup *	_canvas_group_controls = nullptr
	Handles, knots, nodes, etc.

Inkscape::CanvasItemGroup *	_canvas_group_drawing = nullptr
	SVG Drawing.

Inkscape::CanvasItemGroup *	_canvas_group_grids = nullptr
	Grids.

Inkscape::CanvasItemGroup *	_canvas_group_guides = nullptr
	Guide lines.

Inkscape::CanvasItemGroup *	_canvas_group_sketch = nullptr
	Temporary items before becoming permanent.

Inkscape::CanvasItemGroup *	_canvas_group_temp = nullptr
	Temporary items that self-destruct.

Inkscape::CanvasItemGroup *	_canvas_group_pages_bg = nullptr
	Page background.

Inkscape::CanvasItemGroup *	_canvas_group_pages_fg = nullptr
	Page border + shadow.

Inkscape::CanvasItemCatchall *	_canvas_catchall = nullptr
	The bottom item for unclaimed events.

Inkscape::CanvasItemDrawing *	_canvas_drawing = nullptr
	The actual SVG drawing (a.k.a. arena).

SPDesktopWidget *	_widget = nullptr

DesktopAffine	_current_affine

std::list< DesktopAffine >	transforms_past

std::list< DesktopAffine >	transforms_future

bool	_quick_zoom_enabled = false
	Signifies that currently we're in quick zoom mode.

DesktopAffine	_quick_zoom_affine
	The transform of the screen before quick zoom.

bool	_overlays_visible = true
	Whether the overlays are temporarily hidden.

bool	_saved_guides_visible = false
	Remembers guides' visibility when hiding overlays.

std::unique_ptr< Inkscape::LayerManager >	_layer_manager

sigc::signal< void(SPDesktop *)>	_destroy_signal

sigc::signal< void(SPDesktop , SPDocument )>	_document_replaced_signal

sigc::signal< void(SPDesktop , Inkscape::UI::Tools::ToolBase )>	_event_context_changed_signal

sigc::signal< void(SPStop *)>	_gradient_stop_selected

sigc::signal< void(Inkscape::UI::ControlPointSelection *)>	_control_point_selected

sigc::signal< void(Inkscape::UI::Tools::TextTool *)>	_text_cursor_moved

sigc::scoped_connection	_reconstruction_start_connection

sigc::scoped_connection	_reconstruction_finish_connection

sigc::scoped_connection	_schedule_zoom_from_document_connection

sigc::scoped_connection	_y_axis_flipped

std::optional< double >	_begin_zoom

Detailed Description

To do: update description of desktop.

Define separation of desktop-widget, desktop, window, canvas, etc.

Definition at line 148 of file desktop.h.

Member Enumeration Documentation

◆ CanvasFlip

enum SPDesktop::CanvasFlip

Enumerator
FLIP_NONE
FLIP_HORIZONTAL
FLIP_VERTICAL

Definition at line 355 of file desktop.h.

Constructor & Destructor Documentation

◆ SPDesktop() [1/3]

SPDesktop::SPDesktop ( SPNamedView * nv )

◆ ~SPDesktop()

SPDesktop::~SPDesktop ( )

Definition at line 187 of file desktop.cpp.

References _destroy_signal, _detachDocument(), _guides_message_context, _selection, _snapindicator, _temporary_item_list, _tool, canvas, delete_then_null(), and document.

◆ SPDesktop() [2/3]

SPDesktop::SPDesktop ( SPDesktop const & )

delete

◆ SPDesktop() [3/3]

SPDesktop::SPDesktop ( SPDesktop && )

delete

Member Function Documentation

◆ _attachDocument()

void SPDesktop::_attachDocument ( )

private

Definition at line 1197 of file desktop.cpp.

References _canvas_drawing, _document_replaced_signal, _document_uri_set_connection, _reconstruction_finish_connection, _reconstruction_old_layer_id, _reconstruction_start_connection, _saved_or_modified_conn, _view_number, _widget, _y_axis_flipped, activate_guides(), SPDocument::connectFilenameSet(), SPDocument::connectReconstructionFinish(), SPDocument::connectReconstructionStart(), SPDocument::connectSavedOrModified(), SPDesktopWidget::desktopChangedTitle(), dkey, document, SPDocument::ensureUpToDate(), Inkscape::CanvasItemDrawing::get_drawing(), SPDocument::get_y_axis_flipped(), SPDocument::getNamedView(), SPDocument::getRoot(), SPNamedView::getShowGrids(), handle_y_axis_flip(), SPItem::invoke_show(), namedview, Inkscape::DrawingItem::prependChild(), reconstruction_finish(), reconstruction_start(), Inkscape::Drawing::root(), SPNamedView::set_desk_color(), SPNamedView::setShowGrids(), SPNamedView::show(), sp_namedview_update_layers_from_document(), and SPNamedView::viewcount.

Referenced by setDocument().

◆ _detachDocument()

void SPDesktop::_detachDocument ( )

private

Definition at line 1256 of file desktop.cpp.

References _document_uri_set_connection, _reconstruction_finish_connection, _reconstruction_start_connection, _saved_or_modified_conn, _schedule_zoom_from_document_connection, dkey, document, SPDocument::getRoot(), SPNamedView::hide(), SPItem::invoke_hide(), and namedview.

Referenced by setDocument(), and ~SPDesktop().

◆ _setupCanvasItems()

void SPDesktop::_setupCanvasItems ( )

private

◆ activate_guides()

void SPDesktop::activate_guides ( bool activate )

Set activate status of current desktop's named view.

Definition at line 272 of file desktop.cpp.

References activate(), SPNamedView::activateGuides(), guides_active, and namedview.

Referenced by _attachDocument().

◆ add_temporary_canvasitem()

Inkscape::Display::TemporaryItem * SPDesktop::add_temporary_canvasitem	(	Inkscape::CanvasItem *	item,
		int	lifetime_msecs,
		bool	move_to_bottom = `true`
	)

One should not keep a reference to the SPCanvasItem, the temporary item code will delete the object for you and the reference will become invalid without you knowing it.

It is perfectly safe to ignore the returned pointer: the object is deleted by itself, so don't delete it elsewhere! The only valid use of the returned TemporaryItem* is as argument for SPDesktop::remove_temporary_canvasitem, because the object might be deleted already without you knowing it. move_to_bottom = true by default so the item does not interfere with handling of other items on the canvas like nodes.

Definition at line 229 of file desktop.cpp.

References _temporary_item_list, and item.

Referenced by Inkscape::ObjectSet::cloneOriginal(), Inkscape::Display::SnapIndicator::make_alignment_indicator(), Inkscape::Display::SnapIndicator::make_distribution_indicators(), Inkscape::LivePathEffect::Parameter::param_higlight(), Inkscape::UI::Tools::NodeTool::root_handler(), Inkscape::Display::SnapIndicator::set_new_debugging_point(), Inkscape::Display::SnapIndicator::set_new_snapsource(), Inkscape::Display::SnapIndicator::set_new_snaptarget(), and Inkscape::UI::Tools::sp_update_helperpath().

◆ applyCurrentOrToolStyle()

void SPDesktop::applyCurrentOrToolStyle	(	SPObject *	obj,
		Glib::ustring const &	tool_path,
		bool	with_text
	)

Apply the desktop's current style or the tool style to the object.

Definition at line 1110 of file desktop.cpp.

References css, Inkscape::Preferences::get(), Inkscape::Preferences::getBool(), Inkscape::Preferences::getInheritedStyle(), SPObject::setCSS(), sp_desktop_get_style(), and sp_repr_css_attr_unref().

Referenced by Inkscape::UI::Tools::Box3dTool::drag().

◆ change_document()

void SPDesktop::change_document ( SPDocument * document )

Make desktop switch documents.

Definition at line 281 of file desktop.cpp.

References _selection, _tool, _widget, InkscapeWindow::change_document(), SPDesktopWidget::desktopChangedDocument(), getInkscapeWindow(), setDocument(), setTool(), and sp_namedview_zoom_and_view_from_document().

Referenced by InkscapeApplication::document_swap().

◆ clear_transform_history()

void SPDesktop::clear_transform_history ( )

Clear transform lists.

Definition at line 437 of file desktop.cpp.

References transforms_future, and transforms_past.

Referenced by sp_namedview_window_from_document().

◆ clearWaitingCursor()

void SPDesktop::clearWaitingCursor ( )

Definition at line 1166 of file desktop.cpp.

References _tool, and waiting_cursor.

Referenced by Inkscape::UI::NewFromTemplate::_createFromTemplate(), Inkscape::UI::Dialog::CloneTiler::apply(), Inkscape::ObjectSet::breakApart(), Inkscape::Extension::ExecutionEnv::cancel(), Inkscape::ObjectSet::combine(), Inkscape::ObjectSet::createBitmapCopy(), Inkscape::UI::Tools::InteractiveBooleansTool::InteractiveBooleansTool(), Inkscape::ObjectSet::pathReverse(), Inkscape::Extension::ExecutionEnv::run(), Inkscape::ObjectSet::simplifyPaths(), and Inkscape::ObjectSet::toCurves().

◆ connect_control_point_selected()

sigc::connection SPDesktop::connect_control_point_selected ( sigc::slot< void(Inkscape::UI::ControlPointSelection *)> const & slot )

Definition at line 1353 of file desktop.cpp.

References _control_point_selected.

Referenced by Inkscape::UI::Toolbar::NodeToolbar::setDesktop().

◆ connect_gradient_stop_selected()

sigc::connection SPDesktop::connect_gradient_stop_selected ( sigc::slot< void(SPStop *)> const & slot )

Definition at line 1349 of file desktop.cpp.

References _gradient_stop_selected.

Referenced by Inkscape::UI::Tools::GradientTool::GradientTool(), Inkscape::UI::Widget::FillNStroke::setDesktop(), and Inkscape::UI::Toolbar::GradientToolbar::setDesktop().

◆ connect_text_cursor_moved()

sigc::connection SPDesktop::connect_text_cursor_moved ( sigc::slot< void(Inkscape::UI::Tools::TextTool *)> const & slot )

Definition at line 1357 of file desktop.cpp.

References _text_cursor_moved.

Referenced by Inkscape::UI::Widget::FillNStroke::setDesktop(), and Inkscape::UI::Toolbar::TextToolbar::setDesktop().

◆ connectDestroy()

template<typename F >

sigc::connection SPDesktop::connectDestroy ( F && slot )

inline

Definition at line 253 of file desktop.h.

References _destroy_signal.

Referenced by Inkscape::Extension::Implementation::Script::execute(), Inkscape::UI::Tools::PenTool::PenTool(), and Inkscape::UI::Dialog::DialogBase::setDesktop().

◆ connectDocumentReplaced()

template<typename F >

sigc::connection SPDesktop::connectDocumentReplaced ( F && slot )

inline

Definition at line 257 of file desktop.h.

References _document_replaced_signal.

Referenced by Inkscape::UI::Widget::ColorNotebook::ColorNotebook(), Inkscape::Extension::Implementation::Script::execute(), Inkscape::LayerManager::LayerManager(), Inkscape::UI::Tools::PagesTool::PagesTool(), Inkscape::UI::Widget::PageSelector::setDesktop(), Inkscape::UI::Widget::StrokeStyle::setDesktop(), Inkscape::UI::Toolbar::PageToolbar::setDesktop(), and Inkscape::UI::Dialog::DialogBase::setDesktop().

◆ connectEventContextChanged()

template<typename F >

sigc::connection SPDesktop::connectEventContextChanged ( F && slot )

inline

Definition at line 261 of file desktop.h.

References _event_context_changed_signal.

Referenced by Inkscape::UI::Dialog::AlignAndDistribute::desktop_changed(), Inkscape::UI::Widget::FillNStroke::setDesktop(), and SPDesktopWidget::switchDesktop().

◆ connectQueryStyle()

template<typename F >

sigc::connection SPDesktop::connectQueryStyle ( F && slot )

inline

Definition at line 269 of file desktop.h.

References _query_style_signal.

Referenced by GrDrag::GrDrag(), and Inkscape::UI::Tools::TextTool::TextTool().

◆ connectSetStyle()

template<typename F >

sigc::connection SPDesktop::connectSetStyle ( F && slot )

inline

Definition at line 265 of file desktop.h.

References _set_style_signal.

Referenced by GrDrag::GrDrag(), Inkscape::UI::Tools::TextTool::TextTool(), and Inkscape::UI::Tools::TweakTool::TweakTool().

◆ current_center()

Geom::Point SPDesktop::current_center ( ) const

Definition at line 660 of file desktop.cpp.

References _current_affine, canvas, Geom::GenericRect< C >::midpoint(), and SPDesktop::DesktopAffine::w2d().

Referenced by Inkscape::UI::Tools::TextTool::_updateCursor(), InkscapeApplication::document_revert(), Inkscape::UI::Dialog::SpellCheck::nextWord(), set_display_width(), sp_namedview_document_from_window(), and sp_namedview_zoom_and_view_from_document().

◆ current_rotation()

Geom::Rotate const & SPDesktop::current_rotation ( ) const

inline

Definition at line 366 of file desktop.h.

References _current_affine, and SPDesktop::DesktopAffine::getRotation().

Referenced by Inkscape::UI::Tools::ToolBase::_keyboardMove(), Inkscape::UI::ControlPointSelection::_keyboardMove(), Inkscape::UI::Tools::PenTool::_lastpointMove(), Inkscape::ObjectSet::move(), Inkscape::ObjectSet::moveScreen(), GrDrag::selected_move(), sp_namedview_document_from_window(), and Inkscape::UI::Widget::StatusBar::update_rotate().

◆ current_zoom()

double SPDesktop::current_zoom ( ) const

inline

Definition at line 335 of file desktop.h.

References _current_affine, and SPDesktop::DesktopAffine::getZoom().

◆ d2w() [1/2]

Geom::Affine const & SPDesktop::d2w ( ) const

inline

Transformation from desktop to window coordinates.

Definition at line 419 of file desktop.h.

References _current_affine, and SPDesktop::DesktopAffine::d2w().

Referenced by Inkscape::UI::Tools::TextTool::_updateCursor(), Inkscape::UI::PathManipulator::_updateDragPoint(), Inkscape::UI::PathManipulator::_updateOutline(), Inkscape::UI::Tools::CalligraphicTool::brush(), Inkscape::UI::Tools::calculate_intersections(), Inkscape::UI::CurveDragPoint::doubleclicked(), GrDrag::dropColor(), Inkscape::UI::Tools::fit_item(), flip_absolute_keep_point(), flip_relative_keep_point(), Inkscape::GridSnapper::get_snap_lines(), Inkscape::GridSnapper::getSnapLinesAxonom(), Inkscape::UI::Node::grabbed(), Inkscape::UI::Tools::TextTool::root_handler(), rotate_absolute_keep_point(), rotate_relative_keep_point(), scroll_to_point(), scroll_to_show_item(), set_display_area(), Inkscape::UI::Tools::MeasureTool::showCanvasItems(), Inkscape::UI::Tools::sp_flood_do_flood_fill(), Inkscape::UI::CurveDragPoint::ungrabbed(), Inkscape::UI::Widget::CanvasGrid::updateRulers(), and zoom_absolute().

◆ d2w() [2/2]

Geom::Point SPDesktop::d2w ( Geom::Point const & p ) const

inline

Definition at line 420 of file desktop.h.

References _current_affine, and SPDesktop::DesktopAffine::d2w().

◆ doc()

SPDocument * SPDesktop::doc ( ) const

inline

Definition at line 159 of file desktop.h.

References document.

◆ doc2dt() [1/2]

Geom::Affine const & SPDesktop::doc2dt ( ) const

Definition at line 1337 of file desktop.cpp.

References SPDocument::doc2dt(), and document.

◆ doc2dt() [2/2]

Geom::Point SPDesktop::doc2dt ( Geom::Point const & p ) const

inline

Definition at line 423 of file desktop.h.

References doc2dt().

Referenced by doc2dt().

◆ drawing_handler()

bool SPDesktop::drawing_handler	(	Inkscape::CanvasEvent const &	event,
		Inkscape::DrawingItem *	item
	)

private

Calls event handler of current event context.

Definition at line 1283 of file desktop.cpp.

References Inkscape::UI::Tools::get_latin_keyval(), Inkscape::DrawingItem::getItem(), getTool(), Inkscape::KEY_PRESS, and Inkscape::CanvasEvent::type().

Referenced by _setupCanvasItems().

◆ dt2doc() [1/2]

Geom::Affine const & SPDesktop::dt2doc ( ) const

Definition at line 1343 of file desktop.cpp.

References document, and SPDocument::dt2doc().

◆ dt2doc() [2/2]

Geom::Point SPDesktop::dt2doc ( Geom::Point const & p ) const

inline

Definition at line 424 of file desktop.h.

References dt2doc().

Referenced by dt2doc().

◆ emit_control_point_selected()

void SPDesktop::emit_control_point_selected ( Inkscape::UI::ControlPointSelection * selection )

Definition at line 1365 of file desktop.cpp.

References _control_point_selected.

Referenced by Inkscape::UI::Tools::NodeTool::NodeTool().

◆ emit_gradient_stop_selected()

void SPDesktop::emit_gradient_stop_selected ( SPStop * stop )

Definition at line 1361 of file desktop.cpp.

References _gradient_stop_selected.

Referenced by GrDrag::deselectAll(), Inkscape::UI::Widget::FillNStroke::FillNStroke(), GrDrag::setDeselected(), and GrDrag::setSelected().

◆ emit_text_cursor_moved()

void SPDesktop::emit_text_cursor_moved ( Inkscape::UI::Tools::TextTool * tool )

Definition at line 1369 of file desktop.cpp.

References _text_cursor_moved.

Referenced by Inkscape::UI::Tools::TextTool::_updateCursor(), Inkscape::UI::Tools::TextTool::item_handler(), and Inkscape::UI::Tools::TextTool::root_handler().

◆ flip_absolute_center_point()

void SPDesktop::flip_absolute_center_point	(	Geom::Point const &	c,
		CanvasFlip	flip
	)

Set new flip direction, aligning the point 'c' to the center of desktop window.

Parameters

c	Point in desktop coordinates
flip	Direction the canvas will be set as.

Definition at line 823 of file desktop.cpp.

References _current_affine, c, canvas, Geom::GenericRect< C >::midpoint(), set_display_area(), and SPDesktop::DesktopAffine::setFlip().

Referenced by canvas_transform().

◆ flip_absolute_keep_point()

void SPDesktop::flip_absolute_keep_point	(	Geom::Point const &	c,
		CanvasFlip	flip
	)

Set new flip direction, keeping the point 'c' fixed in the desktop window.

Parameters

c	Point in desktop coordinates
flip	Direction the canvas will be set as.

Definition at line 795 of file desktop.cpp.

References _current_affine, c, d2w(), set_display_area(), SPDesktop::DesktopAffine::setFlip(), and w.

◆ flip_relative_center_point()

void SPDesktop::flip_relative_center_point	(	Geom::Point const &	c,
		CanvasFlip	flip
	)

Flip direction, aligning the point 'c' to the center of desktop window.

Parameters

c	Point in desktop coordinates
flip	Direction to flip canvas

Definition at line 837 of file desktop.cpp.

References _current_affine, SPDesktop::DesktopAffine::addFlip(), c, canvas, Geom::GenericRect< C >::midpoint(), and set_display_area().

Referenced by canvas_transform().

◆ flip_relative_keep_point()

void SPDesktop::flip_relative_keep_point	(	Geom::Point const &	c,
		CanvasFlip	flip
	)

Flip direction, keeping the point 'c' fixed in the desktop window.

Parameters

c	Point in desktop coordinates
flip	Direction to flip canvas

Definition at line 809 of file desktop.cpp.

References _current_affine, SPDesktop::DesktopAffine::addFlip(), c, d2w(), set_display_area(), and w.

◆ focusMode()

void SPDesktop::focusMode ( bool mode = true )

Changes whether the user is in focus mode or not.

Parameters

mode	Which mode the view should be in.

Definition at line 949 of file desktop.cpp.

References _focusMode, layoutWidget(), and mode.

Referenced by view_focus_toggle(), and view_full_screen_focus().

◆ get_display_area()

Geom::Parallelogram SPDesktop::get_display_area ( ) const

Return canvas viewbox in desktop coordinates.

Definition at line 521 of file desktop.cpp.

References canvas, and w2d().

Referenced by SnapManager::_findCandidates(), Inkscape::UI::Tools::TextTool::_updateCursor(), SnapManager::findBestSnap(), Inkscape::UI::Tools::DynamicBase::getNormalizedPoint(), Inkscape::UI::Tools::DynamicBase::getViewPoint(), Box3D::Line::intersection_with_viewbox(), isWithinViewport(), Inkscape::UI::Tools::TextTool::root_handler(), and scroll_to_show_item().

◆ get_rotation_lock()

bool SPDesktop::get_rotation_lock ( ) const

inline

Definition at line 345 of file desktop.h.

References rotation_locked.

◆ get_toolbar_by_name()

Gtk::Widget * SPDesktop::get_toolbar_by_name ( Glib::ustring const & name )

Definition at line 1139 of file desktop.cpp.

References _widget, SPDesktopWidget::get_toolbar_by_name(), and name.

Referenced by Inkscape::UI::Tools::sp_spray_switch_mode(), Inkscape::UI::Tools::sp_tweak_switch_mode(), and Inkscape::UI::Tools::sp_tweak_switch_mode_temporarily().

◆ getCanvas()

Inkscape::UI::Widget::Canvas * SPDesktop::getCanvas ( ) const

inline

Definition at line 190 of file desktop.h.

References canvas.

◆ getCanvasCatchall()

Inkscape::CanvasItemCatchall * SPDesktop::getCanvasCatchall ( ) const

inline

Definition at line 203 of file desktop.h.

References _canvas_catchall.

◆ getCanvasControls()

Inkscape::CanvasItemGroup * SPDesktop::getCanvasControls ( ) const

inline

Definition at line 196 of file desktop.h.

References _canvas_group_controls.

◆ getCanvasDrawing()

Inkscape::CanvasItemDrawing * SPDesktop::getCanvasDrawing ( ) const

inline

Definition at line 204 of file desktop.h.

References _canvas_drawing.

Referenced by Inkscape::UI::Tools::CalligraphicTool::brush(), canvas_color_mode_gray(), Inkscape::UI::Tools::getPickerData(), Inkscape::UI::Tools::DropperTool::root_handler(), and Inkscape::UI::Tools::InteractiveBooleansTool::set_opacity().

◆ getCanvasGrids()

Inkscape::CanvasItemGroup * SPDesktop::getCanvasGrids ( ) const

inline

Definition at line 199 of file desktop.h.

References _canvas_group_grids.

Referenced by SPGrid::getAssociatedView(), SPGrid::hide(), and SPGrid::show().

◆ getCanvasGuides()

Inkscape::CanvasItemGroup * SPDesktop::getCanvasGuides ( ) const

inline

Definition at line 200 of file desktop.h.

References _canvas_group_guides.

Referenced by Inkscape::UI::Widget::CanvasGrid::_createGuideItem(), Inkscape::SelCue::_newItemLines(), and SPNamedView::show().

◆ getCanvasPagesBg()

Inkscape::CanvasItemGroup * SPDesktop::getCanvasPagesBg ( ) const

inline

Definition at line 197 of file desktop.h.

References _canvas_group_pages_bg.

Referenced by SPNamedView::show().

◆ getCanvasPagesFg()

Inkscape::CanvasItemGroup * SPDesktop::getCanvasPagesFg ( ) const

inline

Definition at line 198 of file desktop.h.

References _canvas_group_pages_fg.

Referenced by SPNamedView::show().

◆ getCanvasSketch()

Inkscape::CanvasItemGroup * SPDesktop::getCanvasSketch ( ) const

inline

Definition at line 201 of file desktop.h.

References _canvas_group_sketch.

◆ getCanvasTemp()

Inkscape::CanvasItemGroup * SPDesktop::getCanvasTemp ( ) const

inline

Definition at line 202 of file desktop.h.

References _canvas_group_temp.

◆ getContainer()

Inkscape::UI::Dialog::DialogContainer * SPDesktop::getContainer ( )

Definition at line 335 of file desktop.cpp.

References _widget, and SPDesktopWidget::getDialogContainer().

Referenced by Inkscape::UI::Widget::LayerSelector::_layerChoose(), Inkscape::UI::Dialog::ColorItem::action_edit(), Inkscape::UI::Dialog::DialogNotebook::build_dialog_menu(), dialog_open(), dialog_toggle(), get_clone_tiler_panel(), Inkscape::UI::Widget::get_fill_and_stroke_panel(), Inkscape::UI::Dialog::TextEdit::on_fcm_button_clicked(), Inkscape::UI::Toolbar::TextToolbar::on_fcm_button_pressed(), Inkscape::UI::Toolbar::LPEToolbar::open_lpe_dialog(), select_object_link(), Inkscape::UI::Toolbar::SprayToolbar::toggle_picker(), tool_preferences(), and updateDialogs().

◆ getDesktopWidget()

SPDesktopWidget * SPDesktop::getDesktopWidget ( ) const

inline

Definition at line 192 of file desktop.h.

References _widget.

Referenced by InkscapeApplication::desktopClose(), and Inkscape::UI::Widget::StatusBar::set_desktop().

◆ getDocument()

SPDocument * SPDesktop::getDocument ( ) const

inline

Definition at line 189 of file desktop.h.

References document.

◆ getGroupAtPoint()

SPItem * SPDesktop::getGroupAtPoint ( Geom::Point const & p ) const

See also: SPDocument::getGroupAtPoint()

Definition at line 368 of file desktop.cpp.

References dkey, doc(), and SPDocument::getGroupAtPoint().

◆ getInkscapeWindow() [1/2]

InkscapeWindow * SPDesktop::getInkscapeWindow ( )

Definition at line 980 of file desktop.cpp.

References _widget, and SPDesktopWidget::get_window().

◆ getInkscapeWindow() [2/2]

InkscapeWindow const * SPDesktop::getInkscapeWindow ( ) const

Definition at line 975 of file desktop.cpp.

References _widget, and SPDesktopWidget::get_window().

Referenced by Inkscape::UI::Dialog::DocumentProperties::browseExternalScript(), change_document(), ContextMenu::ContextMenu(), InkscapeApplication::create_window(), Inkscape::Extension::ExecutionEnv::createWorkingDialog(), InkscapeApplication::desktopClose(), InkscapeApplication::detachDesktopToNewWindow(), document_check_for_data_loss(), get_active_tool(), get_active_tool_enum(), is_darktheme(), is_fullscreen(), is_maximized(), isMinimised(), Inkscape::UI::Dialog::BatchExport::onExport(), Inkscape::UI::Widget::PrefEntryFileButtonHBox::onRelatedButtonClickedCallback(), onWindowStateChanged(), InkscapeApplication::process_document(), Inkscape::UI::Tools::TextTool::root_handler(), set_active_tool(), set_active_tool(), sp_namedview_window_from_document(), Inkscape::UI::ThemeContext::themechangecallback(), updateDialogs(), and window_set_geometry().

◆ getItemAtPoint()

SPItem * SPDesktop::getItemAtPoint	(	Geom::Point const &	p,
		bool	into_groups,
		SPItem *	upto = `nullptr`
	)		const

See also: SPDocument::getItemAtPoint()

Definition at line 352 of file desktop.cpp.

References dkey, doc(), and SPDocument::getItemAtPoint().

Referenced by Inkscape::UI::Tools::calculate_intersections(), Inkscape::UI::Tools::get_item_at(), Inkscape::UI::Tools::NodeTool::item_handler(), Inkscape::UI::Tools::TextTool::item_handler(), Inkscape::UI::Tools::TextTool::root_handler(), Inkscape::UI::Tools::MeasureTool::showInfoBox(), Inkscape::UI::Tools::sp_event_context_find_item(), and Inkscape::UI::Tools::sp_tweak_dilate().

◆ getItemFromListAtPointBottom()

SPItem * SPDesktop::getItemFromListAtPointBottom	(	std::vector< SPItem * > const &	list,
		Geom::Point const &	p
	)		const

See also: SPDocument::getItemFromListAtPointBottom()

Definition at line 343 of file desktop.cpp.

References dkey, doc(), and SPDocument::getItemFromListAtPointBottom().

Referenced by Inkscape::UI::Tools::sp_event_context_find_item(), and Inkscape::UI::Tools::sp_event_context_over_item().

◆ getItemsAtPoints()

std::vector< SPItem * > SPDesktop::getItemsAtPoints	(	std::vector< Geom::Point >	ps,
		bool	all_layers = `true`,
		bool	topmost_only = `true`,
		size_t	limit = `0`,
		bool	active_only = `true`
	)		const

Definition at line 358 of file desktop.cpp.

References dkey, doc(), SPDocument::getItemsAtPoints(), and limit.

◆ getNamedView()

SPNamedView * SPDesktop::getNamedView ( ) const

inline

Definition at line 191 of file desktop.h.

References namedview.

◆ getSelection()

Inkscape::Selection * SPDesktop::getSelection ( ) const

inline

Definition at line 188 of file desktop.h.

References _selection.

◆ getSnapIndicator()

Inkscape::Display::SnapIndicator * SPDesktop::getSnapIndicator ( ) const

inline

Definition at line 193 of file desktop.h.

References _snapindicator.

Referenced by Inkscape::UI::Tools::PencilTool::_endpointSnap(), Inkscape::UI::ControlPointSelection::_pointUngrabbed(), SnapManager::constrainedSnap(), SnapManager::displaySnapsource(), SnapManager::findBestSnap(), KnotHolder::knot_ungrabbed_handler(), SnapManager::multipleOfGridPitch(), SnapManager::preSnap(), Inkscape::snap_rectangular_box(), and SnapManager::snapTransformed().

◆ getTool()

Inkscape::UI::Tools::ToolBase * SPDesktop::getTool ( ) const

inline

Definition at line 187 of file desktop.h.

References _tool.

◆ getTranslucencyGroup()

Inkscape::Display::TranslucencyGroup & SPDesktop::getTranslucencyGroup ( ) const

inline

Definition at line 297 of file desktop.h.

References _translucency_group.

Referenced by Inkscape::UI::Dialog::ObjectsPanel::_handleTransparentHover().

◆ getWindowSize()

Geom::IntPoint SPDesktop::getWindowSize ( ) const

Definition at line 960 of file desktop.cpp.

References _widget, and SPDesktopWidget::getWindowSize().

Referenced by sp_namedview_document_from_window(), and window_query_geometry().

◆ guidesMessageContext()

Inkscape::MessageContext * SPDesktop::guidesMessageContext ( ) const

inline

Definition at line 290 of file desktop.h.

References _guides_message_context.

Referenced by Inkscape::UI::Widget::CanvasGrid::CanvasGrid().

◆ handle_y_axis_flip()

void SPDesktop::handle_y_axis_flip ( double yshift )

private

Definition at line 1326 of file desktop.cpp.

References _current_affine, _selection, SPDesktop::DesktopAffine::getOffset(), SPDesktop::DesktopAffine::getZoom(), offset, set_display_area(), SPDesktop::DesktopAffine::setOffset(), SPDesktop::DesktopAffine::setScale(), and yaxisdir().

Referenced by _attachDocument().

◆ is_darktheme()

bool SPDesktop::is_darktheme ( ) const

Definition at line 919 of file desktop.cpp.

References getInkscapeWindow().

◆ is_flipped()

bool SPDesktop::is_flipped ( CanvasFlip flip )

Definition at line 845 of file desktop.cpp.

References _current_affine, and SPDesktop::DesktopAffine::isFlipped().

◆ is_focusMode()

bool SPDesktop::is_focusMode ( ) const

Checks to see if the user is working in focused mode.

Returns: the value of _focusMode.

Definition at line 939 of file desktop.cpp.

References _focusMode.

Referenced by canvas_interface_mode(), getLayoutPrefPath(), SPDesktopWidget::layoutWidgets(), view_focus_toggle(), and view_set_gui().

◆ is_fullscreen()

bool SPDesktop::is_fullscreen ( ) const

Definition at line 929 of file desktop.cpp.

References getInkscapeWindow(), and InkscapeWindow::isFullscreen().

Referenced by canvas_interface_mode(), getLayoutPrefPath(), SPDesktopWidget::layoutWidgets(), and view_set_gui().

◆ is_maximized()

bool SPDesktop::is_maximized ( ) const

Definition at line 924 of file desktop.cpp.

References getInkscapeWindow(), and InkscapeWindow::isMaximised().

Referenced by sp_namedview_document_from_window(), and window_set_geometry().

◆ is_yaxisdown()

bool SPDesktop::is_yaxisdown ( ) const

inline

Definition at line 427 of file desktop.h.

References yaxisdir().

Referenced by Inkscape::UI::Widget::CanvasGrid::_createGuide(), Inkscape::CanvasItemGuideLine::_render(), Inkscape::UI::Tools::PenTool::_setAngleDistanceStatusMessage(), Inkscape::UI::Dialog::Transformation::desktopReplaced(), Inkscape::UI::Toolbar::NodeToolbar::edit_add_bottommost(), Inkscape::UI::Toolbar::NodeToolbar::edit_add_topmost(), Inkscape::GridSnapper::getSnapLinesAxonom(), GrDragger::highlightNode(), object_align(), Inkscape::UI::Tools::MeasureTool::setGuide(), Inkscape::UI::Tools::MeasureTool::toMarkDimension(), Inkscape::UI::TransformHandleSet::TransformHandleSet(), and Inkscape::UI::Widget::CanvasGrid::updateRulers().

◆ isMinimised()

bool SPDesktop::isMinimised ( ) const

Definition at line 914 of file desktop.cpp.

References getInkscapeWindow(), and InkscapeWindow::isMinimised().

Referenced by InkscapeWindow::on_size_changed().

◆ isToolboxButtonActive()

bool SPDesktop::isToolboxButtonActive ( char const * id ) const

Definition at line 1145 of file desktop.cpp.

References _widget, and SPDesktopWidget::isToolboxButtonActive().

◆ isWaitingCursor()

bool SPDesktop::isWaitingCursor ( ) const

inline

Definition at line 402 of file desktop.h.

References waiting_cursor.

◆ isWithinViewport()

bool SPDesktop::isWithinViewport ( SPItem const * item ) const

True if desktop viewport intersects item's bbox.

Definition at line 253 of file desktop.cpp.

References SPItem::desktopVisualBounds(), get_display_area(), and item.

Referenced by next_item(), and next_item_from_list().

◆ itemIsHidden()

bool SPDesktop::itemIsHidden ( SPItem const * item ) const

Definition at line 264 of file desktop.cpp.

References dkey, SPItem::isHidden(), and item.

Referenced by SnapManager::_findCandidates(), Inkscape::UI::Dialog::Find::all_items(), Inkscape::UI::Dialog::Find::all_selection_items(), Inkscape::UI::Dialog::SpellCheck::allTextItems(), get_all_items_recursive(), get_avoided_items_rec(), Inkscape::have_viable_layer(), Inkscape::have_viable_layer(), next_item(), sp_edit_select_all_full(), and unhide().

◆ layerManager() [1/2]

Inkscape::LayerManager & SPDesktop::layerManager ( )

inline

Definition at line 287 of file desktop.h.

References _layer_manager.

◆ layerManager() [2/2]

Inkscape::LayerManager const & SPDesktop::layerManager ( ) const

inline

Definition at line 288 of file desktop.h.

References _layer_manager.

◆ layoutWidget()

void SPDesktop::layoutWidget ( )

Definition at line 1086 of file desktop.cpp.

References _widget, and SPDesktopWidget::layoutWidgets().

Referenced by focusMode(), onWindowStateChanged(), and toggleToolbar().

◆ messageStack()

Inkscape::MessageStack * SPDesktop::messageStack ( ) const

inline

Definition at line 160 of file desktop.h.

References _message_stack.

◆ next_transform()

void SPDesktop::next_transform ( )

Set transform to next in list.

Definition at line 416 of file desktop.cpp.

References _current_affine, Inkscape::MessageStack::flash(), messageStack(), set_display_area(), transforms_future, transforms_past, and Inkscape::WARNING_MESSAGE.

Referenced by canvas_transform().

◆ on_zoom_begin()

void SPDesktop::on_zoom_begin ( Gdk::EventSequence * sequence )

private

Definition at line 1377 of file desktop.cpp.

References _begin_zoom, and current_zoom().

Referenced by SPDesktop().

◆ on_zoom_end()

void SPDesktop::on_zoom_end ( Gdk::EventSequence * sequence )

private

Definition at line 1393 of file desktop.cpp.

References _begin_zoom.

Referenced by SPDesktop().

◆ on_zoom_scale()

void SPDesktop::on_zoom_scale ( double scale )

private

Definition at line 1382 of file desktop.cpp.

References _begin_zoom, canvas, scale, w2d(), and zoom_absolute().

Referenced by SPDesktop().

◆ onStatusMessage()

void SPDesktop::onStatusMessage	(	Inkscape::MessageType	type,
		char const *	message
	)

private

Definition at line 1273 of file desktop.cpp.

References _widget, SPDesktopWidget::get_desktop(), and SPDesktopWidget::setMessage().

Referenced by SPDesktop().

◆ onWindowStateChanged()

void SPDesktop::onWindowStateChanged	(	Gdk::Toplevel::State	changed,
		Gdk::Toplevel::State	new_toplevel_state
	)

onWindowStateChanged

Called when the window changes its maximize/fullscreen/iconify/pinned state.

Definition at line 1097 of file desktop.cpp.

References getInkscapeWindow(), Inkscape::Util::has_flag(), layoutWidget(), and view_set_gui().

Referenced by InkscapeWindow::on_toplevel_state_changed().

◆ operator=() [1/2]

SPDesktop & SPDesktop::operator= ( SPDesktop && )

delete

◆ operator=() [2/2]

SPDesktop & SPDesktop::operator= ( SPDesktop const & )

delete

◆ point()

Geom::Point SPDesktop::point ( ) const

Returns the mouse point in desktop coordinates; if mouse is outside the canvas, returns the center of canvas viewpoint.

Definition at line 378 of file desktop.cpp.

References canvas, and w2d().

Referenced by file_import(), Inkscape::UI::Tools::SprayTool::root_handler(), scroll_absolute(), sp_import_document(), Inkscape::UI::Tools::sp_spray_update_area(), and Inkscape::UI::Tools::sp_tweak_update_area().

◆ presentWindow()

void SPDesktop::presentWindow ( )

Definition at line 986 of file desktop.cpp.

References _widget, and SPDesktopWidget::presentWindow().

Referenced by Inkscape::Application::switch_desktops_next(), and Inkscape::Application::switch_desktops_prev().

◆ prev_transform()

void SPDesktop::prev_transform ( )

Revert back to previous transform if possible.

Note: current transform is always at front of stack.

Definition at line 390 of file desktop.cpp.

References _current_affine, Inkscape::MessageStack::flash(), messageStack(), set_display_area(), transforms_future, transforms_past, and Inkscape::WARNING_MESSAGE.

Referenced by canvas_transform().

◆ quick_preview()

void SPDesktop::quick_preview ( bool activate )

Definition at line 1067 of file desktop.cpp.

References activate(), canvas, SPNamedView::clip_to_page, namedview, and setTempHideOverlays().

◆ quick_zoomed()

bool SPDesktop::quick_zoomed ( ) const

inline

Returns whether the desktop is in quick zoom mode or not.

Definition at line 340 of file desktop.h.

References _quick_zoom_enabled.

◆ reconstruction_finish()

void SPDesktop::reconstruction_finish ( )

private

Called when document rebuild is finished.

Definition at line 1313 of file desktop.cpp.

References _reconstruction_old_layer_id, document, getNamedView(), SPDocument::getObjectById(), layerManager(), and Inkscape::LayerManager::setCurrentLayer().

Referenced by _attachDocument().

◆ reconstruction_start()

void SPDesktop::reconstruction_start ( )

private

Called when document is starting to be rebuilt.

Definition at line 1303 of file desktop.cpp.

References _reconstruction_old_layer_id, Inkscape::ObjectSet::clear(), Inkscape::LayerManager::currentLayer(), SPObject::getId(), getSelection(), layerManager(), and Inkscape::LayerManager::reset().

Referenced by _attachDocument().

◆ remove_temporary_canvasitem()

void SPDesktop::remove_temporary_canvasitem ( Inkscape::Display::TemporaryItem * tempitem )

It is perfectly safe to call this function while the object has already been deleted due to a timeout.

Definition at line 242 of file desktop.cpp.

References _temporary_item_list.

Referenced by Inkscape::LivePathEffect::Parameter::param_higlight(), Inkscape::Display::SnapIndicator::remove_debugging_points(), Inkscape::Display::SnapIndicator::remove_snapsource(), Inkscape::Display::SnapIndicator::remove_snaptarget(), Inkscape::UI::Tools::NodeTool::root_handler(), Inkscape::UI::Tools::sp_update_helperpath(), Inkscape::UI::Tools::NodeTool::~NodeTool(), and Inkscape::LivePathEffect::Parameter::~Parameter().

◆ rotate_absolute_center_point()

void SPDesktop::rotate_absolute_center_point	(	Geom::Point const &	c,
		double	rotate
	)

Set new rotation, aligning the point 'c' to the center of desktop window.

Parameters

c	Point in desktop coordinates
rotate	Angle in clockwise direction

Definition at line 768 of file desktop.cpp.

References _current_affine, c, canvas, set_display_area(), and SPDesktop::DesktopAffine::setRotate().

Referenced by canvas_rotate_absolute_degrees(), canvas_rotate_absolute_radians(), and canvas_transform().

◆ rotate_absolute_keep_point()

void SPDesktop::rotate_absolute_keep_point	(	Geom::Point const &	c,
		double	rotate
	)

Set new rotation, keeping the point 'c' fixed in the desktop window.

Parameters

c	Point in desktop coordinates
rotate	Angle in clockwise direction

Definition at line 742 of file desktop.cpp.

References _current_affine, c, d2w(), set_display_area(), SPDesktop::DesktopAffine::setRotate(), and w.

Referenced by sp_namedview_zoom_and_view_from_document().

◆ rotate_grab_focus()

void SPDesktop::rotate_grab_focus ( )

Tell widget to let rotate widget grab keyboard focus.

Definition at line 731 of file desktop.cpp.

References _widget, and SPDesktopWidget::letRotateGrabFocus().

◆ rotate_relative_center_point()

void SPDesktop::rotate_relative_center_point	(	Geom::Point const &	c,
		double	rotate
	)

Rotate aligning the point 'c' to the center of desktop window.

Parameters

c	Point in desktop coordinates
rotate	Angle in clockwise direction

Definition at line 781 of file desktop.cpp.

References _current_affine, SPDesktop::DesktopAffine::addRotate(), c, canvas, and set_display_area().

Referenced by canvas_rotate_relative_degrees(), canvas_rotate_relative_radians(), and canvas_transform().

◆ rotate_relative_keep_point()

void SPDesktop::rotate_relative_keep_point	(	Geom::Point const &	c,
		double	rotate
	)

Rotate keeping the point 'c' fixed in the desktop window.

Parameters

c	Point in desktop coordinates
rotate	Angle in clockwise direction

Definition at line 755 of file desktop.cpp.

References _current_affine, SPDesktop::DesktopAffine::addRotate(), c, d2w(), set_display_area(), and w.

◆ schedule_zoom_from_document()

void SPDesktop::schedule_zoom_from_document ( )

Schedule the zoom/view settings from the document to be applied to the desktop just after the canvas is first allocated a size, but before any drawing has started.

We do things at this point because we need to know the canvas size in order to center the page correctly, and the page needs to be centered correctly before we start drawing!

Note that during startup, GTK is supposed to allocate each widget once. In the past, it was observed doing multiple wrong allocations first, but this no longer happens. This would be a symptom of a widget (like ToolbarWidget) that tries to change its size upon being allocated a size.

Definition at line 648 of file desktop.cpp.

References _schedule_zoom_from_document_connection, canvas, and sp_namedview_zoom_and_view_from_document().

Referenced by SPDesktop().

◆ scroll_absolute()

void SPDesktop::scroll_absolute ( Geom::Point const & point )

Scroll canvas by to a particular point (window coordinates).

Definition at line 854 of file desktop.cpp.

References _current_affine, _tool, _widget, canvas, SPDesktopWidget::get_canvas_grid(), SPDesktop::DesktopAffine::getZoom(), point(), SPDesktop::DesktopAffine::setOffset(), Inkscape::UI::Widget::CanvasGrid::updateRulers(), and Inkscape::UI::Widget::CanvasGrid::updateScrollbars().

Referenced by Inkscape::UI::Widget::CanvasGrid::_adjustmentChanged(), and scroll_relative().

◆ scroll_relative()

void SPDesktop::scroll_relative ( Geom::Point const & delta )

Scroll canvas by specific coordinate amount (window coordinates).

Definition at line 872 of file desktop.cpp.

References canvas, delta, Geom::GenericRect< C >::min(), and scroll_absolute().

Referenced by scroll_relative_in_svg_coords(), scroll_to_point(), and scroll_to_show_item().

◆ scroll_relative_in_svg_coords()

void SPDesktop::scroll_relative_in_svg_coords	(	double	dx,
		double	dy
	)

Scroll canvas by specific coordinate amount in svg coordinates.

Definition at line 882 of file desktop.cpp.

References _current_affine, SPDesktop::DesktopAffine::getZoom(), scale, and scroll_relative().

◆ scroll_to_point()

bool SPDesktop::scroll_to_point	(	Geom::Point const &	p,
		double	autoscrollspeed = `0`
	)

Scroll screen so as to keep point 'p' visible in window.

(Used, for example, during spellcheck.) 'p': The point in desktop coordinates.

Definition at line 894 of file desktop.cpp.

References c, canvas, d2w(), Inkscape::Preferences::get(), scroll_relative(), and w.

Referenced by Inkscape::UI::Tools::TextTool::_updateCursor(), Inkscape::UI::Dialog::SpellCheck::nextWord(), Inkscape::UI::Tools::GradientTool::select_next(), Inkscape::UI::Tools::MeshTool::select_next(), Inkscape::UI::Tools::GradientTool::select_prev(), and Inkscape::UI::Tools::MeshTool::select_prev().

◆ set_coordinate_status()

void SPDesktop::set_coordinate_status ( Geom::Point const & p )

Sets the coordinate status to a given point.

Definition at line 331 of file desktop.cpp.

References _widget, and SPDesktopWidget::setCoordinateStatus().

Referenced by Inkscape::UI::Widget::CanvasGrid::_rulerButtonRelease(), SPKnot::handler_request_position(), Inkscape::UI::Widget::CanvasGrid::rulerMotion(), and Inkscape::UI::Tools::set_event_location().

◆ set_display_area() [1/3]

void SPDesktop::set_display_area ( bool log = true )

Does all the dirty work in setting the display area.

_current_affine must already be full updated (including offset). log: if true, save transform in transform stack for reuse.

Definition at line 448 of file desktop.cpp.

References _current_affine, _tool, _widget, canvas, SPDesktop::DesktopAffine::d2w(), SPDesktopWidget::get_canvas_grid(), SPDesktop::DesktopAffine::getOffset(), SPDesktop::DesktopAffine::getZoom(), log(), signal_zoom_changed, transforms_future, transforms_past, SPDesktopWidget::update_rotation(), SPDesktopWidget::update_zoom(), Inkscape::UI::Widget::CanvasGrid::updateRulers(), and Inkscape::UI::Widget::CanvasGrid::updateScrollbars().

Referenced by flip_absolute_center_point(), flip_absolute_keep_point(), flip_relative_center_point(), flip_relative_keep_point(), handle_y_axis_flip(), next_transform(), prev_transform(), Inkscape::UI::Tools::ZoomTool::root_handler(), rotate_absolute_center_point(), rotate_absolute_keep_point(), rotate_relative_center_point(), rotate_relative_keep_point(), set_display_area(), set_display_area(), set_display_width(), zoom_absolute(), zoom_drawing(), zoom_quick(), zoom_selection(), and Inkscape::PageManager::zoomToPage().

◆ set_display_area() [2/3]

void SPDesktop::set_display_area	(	Geom::Point const &	c,
		Geom::Point const &	w,
		bool	log = `true`
	)

Map the drawing to the window so that 'c' lies at 'w' where where 'c' is a point on the canvas and 'w' is position in window in screen pixels.

Definition at line 479 of file desktop.cpp.

References _current_affine, SPDesktop::DesktopAffine::addOffset(), c, d2w(), log(), offset, set_display_area(), and w.

◆ set_display_area() [3/3]

void SPDesktop::set_display_area	(	Geom::Rect const &	r,
		Geom::Coord	border,
		bool	log = `true`
	)

Map the center of rectangle 'r' (which specifies a non-rotated region of the drawing) to lie at the center of the window.

The zoom factor is calculated such that the edges of 'r' closest to 'w' are 'border' length inside of the window (if there is no rotation). 'r' is in document pixel units, 'border' is in screen pixels.

Definition at line 493 of file desktop.cpp.

References _current_affine, border, canvas, Geom::GenericRect< C >::height(), log(), Geom::GenericRect< C >::midpoint(), set_display_area(), SPDesktop::DesktopAffine::setOffset(), SPDesktop::DesktopAffine::setScale(), SP_DESKTOP_ZOOM_MAX, SP_DESKTOP_ZOOM_MIN, w, Geom::GenericRect< C >::width(), and yaxisdir().

◆ set_display_center()

void SPDesktop::set_display_center ( Geom::Rect const & a )

Centre Rect, without zooming.

Definition at line 593 of file desktop.cpp.

References Geom::GenericRect< C >::midpoint(), and zoom_absolute().

Referenced by Inkscape::PageManager::centerToPage().

◆ set_display_width()

void SPDesktop::set_display_width	(	Geom::Rect const &	a,
		Geom::Coord	border
	)

Set display area in only the width dimension.

Definition at line 580 of file desktop.cpp.

References border, current_center(), Geom::GenericRect< C >::left(), set_display_area(), Geom::GenericRect< C >::width(), and Geom::Point::y().

Referenced by Inkscape::PageManager::zoomToPage().

◆ set_rotation_lock()

void SPDesktop::set_rotation_lock ( bool lock )

inline

Definition at line 344 of file desktop.h.

References rotation_locked.

Referenced by apply_preferences_canvas_transform(), and canvas_rotate_lock().

◆ setColorMode()

void SPDesktop::setColorMode ( Inkscape::ColorMode mode )

Definition at line 1010 of file desktop.cpp.

References _widget, canvas, SPDesktopWidget::desktopChangedTitle(), and mode.

Referenced by canvas_color_mode_toggle().

◆ setDesktopWidget()

void SPDesktop::setDesktopWidget ( SPDesktopWidget * dtw )

Definition at line 208 of file desktop.cpp.

References _widget.

Referenced by SPDesktopWidget::addDesktop(), and SPDesktopWidget::removeDesktop().

◆ setDocument()

void SPDesktop::setDocument ( SPDocument * doc )

Associate document with desktop.

Definition at line 1183 of file desktop.cpp.

References _attachDocument(), _detachDocument(), _selection, doc(), and document.

Referenced by change_document(), and SPDesktop().

◆ setRenderMode()

void SPDesktop::setRenderMode ( Inkscape::RenderMode mode )

Definition at line 1002 of file desktop.cpp.

References _widget, canvas, SPDesktopWidget::desktopChangedTitle(), and mode.

Referenced by apply_preferences_canvas_mode(), and canvas_set_display_mode().

◆ setTempHideOverlays()

void SPDesktop::setTempHideOverlays ( bool hide )

Shows or hides the on-canvas overlays and controls, such as grids, guides, manipulation handles, knots, selection cues, etc.

Parameters

hide	- whether the aforementioned UI elements should be hidden

Definition at line 1039 of file desktop.cpp.

References _canvas_group_controls, _canvas_group_grids, _overlays_visible, _saved_guides_visible, canvas, SPNamedView::getShowGuides(), namedview, Inkscape::CanvasItem::set_visible(), and SPNamedView::temporarily_show_guides().

Referenced by quick_preview().

◆ setTool()

void SPDesktop::setTool ( std::string const & toolName )

Replaces the currently active tool with a new one.

Pass the empty string to unset and free the current tool.

Parameters

toolName The preferences path for the new tool. Note that if you are calling this to reset the currently active tool, you must copy the string from _tool->getPrefsPath(), so we do not keep a ref to string in reset tool. e.g. setTool(std::string{_tool->getPrefsPath()})

Definition at line 308 of file desktop.cpp.

References _event_context_changed_signal, _tool, ToolFactory::createObject(), delete_then_null(), and set_active_tool().

Referenced by change_document(), SPDesktop(), and tool_switch().

◆ setToolboxAdjustmentValue()

void SPDesktop::setToolboxAdjustmentValue	(	char const *	id,
		double	val
	)

Definition at line 1134 of file desktop.cpp.

References _widget, and SPDesktopWidget::setToolboxAdjustmentValue().

Referenced by Inkscape::UI::Tools::SprayTool::root_handler(), and Inkscape::UI::Tools::TweakTool::root_handler().

◆ setToolboxFocusTo()

void SPDesktop::setToolboxFocusTo ( char const * label )

Definition at line 1128 of file desktop.cpp.

References _widget, label, and SPDesktopWidget::setToolboxFocusTo().

Referenced by Inkscape::UI::Tools::ArcTool::root_handler(), Inkscape::UI::Tools::Box3dTool::root_handler(), Inkscape::UI::Tools::RectTool::root_handler(), Inkscape::UI::Tools::SpiralTool::root_handler(), Inkscape::UI::Tools::SprayTool::root_handler(), Inkscape::UI::Tools::StarTool::root_handler(), Inkscape::UI::Tools::TextTool::root_handler(), and Inkscape::UI::Tools::TweakTool::root_handler().

◆ setWaitingCursor()

void SPDesktop::setWaitingCursor ( )

Definition at line 1155 of file desktop.cpp.

References canvas, and waiting_cursor.

Referenced by Inkscape::UI::Dialog::CloneTiler::apply(), Inkscape::ObjectSet::breakApart(), Inkscape::ObjectSet::combine(), Inkscape::ObjectSet::createBitmapCopy(), Inkscape::UI::Tools::InteractiveBooleansTool::InteractiveBooleansTool(), Inkscape::ObjectSet::pathReverse(), Inkscape::Extension::ExecutionEnv::run(), Inkscape::ObjectSet::simplifyPaths(), and Inkscape::ObjectSet::toCurves().

◆ setWindowSize()

void SPDesktop::setWindowSize ( Geom::IntPoint const & size )

Definition at line 965 of file desktop.cpp.

References _widget, SPDesktopWidget::setWindowSize(), and size.

Referenced by sp_namedview_window_from_document(), and window_set_geometry().

◆ setWindowTransient()

void SPDesktop::setWindowTransient	(	Gtk::Window &	window,
		int	transient_policy = `1`
	)

Definition at line 970 of file desktop.cpp.

References _widget, and SPDesktopWidget::setWindowTransient().

Referenced by Inkscape::UI::Dialog::GuidelinePropertiesDialog::_setup(), Inkscape::UI::Dialog::LayerPropertiesDialog::_showDialog(), Inkscape::UI::Dialog::CalligraphicProfileRename::show(), Inkscape::UI::Dialog::FilletChamferPropertiesDialog::showDialog(), Inkscape::UI::Dialog::PowerstrokePropertiesDialog::showDialog(), and Inkscape::UI::Dialog::KnotPropertiesDialog::showDialog().

◆ showInfoDialog()

void SPDesktop::showInfoDialog ( Glib::ustring const & message )

Definition at line 991 of file desktop.cpp.

References _widget, and SPDesktopWidget::showInfoDialog().

Referenced by InkscapeApplication::document_fix().

◆ showNotice()

void SPDesktop::showNotice	(	Glib::ustring const &	msg,
		int	timeout = `0`
	)

Definition at line 1268 of file desktop.cpp.

References _widget, msg, SPDesktopWidget::showNotice(), and timeout.

Referenced by Inkscape::UI::Dialog::PolarArrangeTab::arrange(), Inkscape::UI::Tools::InteractiveBooleansTool::is_ready(), and Inkscape::UI::Dialog::SwatchesPanel::load_swatches().

◆ tipsMessageContext()

Inkscape::MessageContext * SPDesktop::tipsMessageContext ( ) const

inline

Definition at line 161 of file desktop.h.

References _tips_message_context.

Referenced by Inkscape::UI::Dialog::ColorItem::on_motion_enter(), Inkscape::UI::Dialog::ColorItem::on_motion_leave(), and tool_switch().

◆ toggleCommandPalette()

void SPDesktop::toggleCommandPalette ( )

Definition at line 1019 of file desktop.cpp.

References _widget, and SPDesktopWidget::toggle_command_palette().

◆ toggleLockGuides()

void SPDesktop::toggleLockGuides ( )

Definition at line 1172 of file desktop.cpp.

References namedview, and SPNamedView::toggleLockGuides().

◆ toggleRulers()

void SPDesktop::toggleRulers ( )

Definition at line 1023 of file desktop.cpp.

References _widget, and SPDesktopWidget::toggle_rulers().

◆ toggleScrollbars()

void SPDesktop::toggleScrollbars ( )

Definition at line 1029 of file desktop.cpp.

References _widget, and SPDesktopWidget::toggle_scrollbars().

◆ toggleToolbar()

void SPDesktop::toggleToolbar ( char const * toolbar_name )

Definition at line 1074 of file desktop.cpp.

References Inkscape::Preferences::get(), Inkscape::Preferences::getBool(), getLayoutPrefPath(), layoutWidget(), Inkscape::Preferences::setBool(), and visible.

Referenced by canvas_commands_bar_toggle(), canvas_palette_toggle(), canvas_rulers_toggle(), canvas_scroll_bars(), canvas_snap_controls_bar_toggle(), canvas_statusbar_toggle(), canvas_tool_control_bar_toggle(), and canvas_toolbox_toggle().

◆ updateDialogs()

void SPDesktop::updateDialogs ( )

Definition at line 1150 of file desktop.cpp.

References getContainer(), getInkscapeWindow(), and Inkscape::UI::Dialog::DialogContainer::set_inkscape_window().

Referenced by InkscapeWindow::update_dialogs().

◆ viewNumber()

int SPDesktop::viewNumber ( ) const

inline

Definition at line 194 of file desktop.h.

References _view_number.

Referenced by SPDesktopWidget::_updateTitle().

◆ w2d() [1/2]

Geom::Affine const & SPDesktop::w2d ( ) const

inline

Transformation from window to desktop coordinates (zoom/rotate).

Definition at line 416 of file desktop.h.

References _current_affine, and SPDesktop::DesktopAffine::w2d().

◆ w2d() [2/2]

Geom::Point SPDesktop::w2d ( Geom::Point const & p ) const

inline

Definition at line 417 of file desktop.h.

References _current_affine, and SPDesktop::DesktopAffine::w2d().

◆ warnDialog()

bool SPDesktop::warnDialog ( Glib::ustring const & text )

Definition at line 997 of file desktop.cpp.

References _widget, and SPDesktopWidget::warnDialog().

Referenced by sp_file_revert_dialog().

◆ yaxisdir()

double SPDesktop::yaxisdir ( ) const

inline

Definition at line 426 of file desktop.h.

References doc2dt().

Referenced by Inkscape::UI::Widget::CanvasGrid::_createGuideItem(), Inkscape::UI::Tools::PenTool::_lastpointMove(), Inkscape::UI::Tools::CalligraphicTool::apply(), Inkscape::UI::Dialog::Transformation::applyPageMove(), Inkscape::UI::Dialog::Transformation::applyPageSkew(), Inkscape::UI::Dialog::PolarArrangeTab::arrange(), Inkscape::UI::ControlPointSelection::event(), Inkscape::UI::MultiPathManipulator::event(), handle_y_axis_flip(), is_yaxisdown(), GrDrag::key_press_handler(), Inkscape::UI::Widget::Canvas::paint_widget(), Inkscape::UI::Tools::Box3dTool::root_handler(), Inkscape::UI::Tools::TextTool::root_handler(), set_display_area(), Inkscape::UI::Tools::MeasureTool::showInfoBox(), Inkscape::UI::Tools::sp_tweak_dilate_recursive(), Inkscape::UI::Widget::CanvasGrid::updateScrollbars(), and zoom_absolute().

◆ zoom_absolute()

void SPDesktop::zoom_absolute	(	Geom::Point const &	center,
		double	zoom,
		bool	keep_point = `true`
	)

Zoom to the given absolute zoom level.

Parameters

center	- Point we want to zoom in on
zoom	- Absolute amount of zoom (1.0 is 100%)
keep_point	- Keep center fixed in the desktop window.

Definition at line 538 of file desktop.cpp.

References _current_affine, canvas, d2w(), Geom::GenericRect< C >::midpoint(), set_display_area(), SPDesktop::DesktopAffine::setScale(), SP_DESKTOP_ZOOM_MAX, SP_DESKTOP_ZOOM_MIN, w, and yaxisdir().

Referenced by InkscapeApplication::document_revert(), on_zoom_scale(), set_display_center(), Inkscape::UI::Widget::Canvas::size_allocate_vfunc(), sp_namedview_zoom_and_view_from_document(), zoom_realworld(), and zoom_relative().

◆ zoom_drawing()

void SPDesktop::zoom_drawing ( )

Zoom to whole drawing.

Definition at line 602 of file desktop.cpp.

References SPItem::bbox_valid, SPItem::desktopVisualBounds(), doc(), SPDocument::getRoot(), and set_display_area().

Referenced by canvas_transform().

◆ zoom_grab_focus()

void SPDesktop::zoom_grab_focus ( )

Tell widget to let zoom widget grab keyboard focus.

Definition at line 722 of file desktop.cpp.

References _widget, and SPDesktopWidget::letZoomGrabFocus().

◆ zoom_quick()

void SPDesktop::zoom_quick ( bool enable = true )

Performs a quick zoom into what the user is working on.

Parameters

enable Whether we're going in or out of quick zoom.

Definition at line 669 of file desktop.cpp.

References _current_affine, _quick_zoom_affine, _quick_zoom_enabled, _selection, _tool, Geom::are_near(), Geom::GenericRect< C >::area(), canvas, Geom::GenericRect< C >::midpoint(), set_display_area(), w2d(), and zoom_relative().

◆ zoom_realworld()

void SPDesktop::zoom_realworld	(	Geom::Point const &	center,
		double	ratio
	)

Zoom in to an absolute realworld ratio, e.g.

1:1 physical screen units

Parameters

center	- Point we want to zoom in on.
ratio	- Absolute physical zoom ratio.

Definition at line 570 of file desktop.cpp.

References Inkscape::Preferences::get(), Inkscape::Preferences::getDouble(), and zoom_absolute().

Referenced by canvas_transform().

◆ zoom_relative()

void SPDesktop::zoom_relative	(	Geom::Point const &	center,
		double	zoom,
		bool	keep_point = `true`
	)

Zoom in or out relatively to the current zoom.

Parameters

center	- Point we want to zoom in on
zoom	- Relative amount of zoom. at 50% + 50% -> 25% zoom
keep_point	- Keep center fixed in the desktop window.

Definition at line 557 of file desktop.cpp.

References _current_affine, SPDesktop::DesktopAffine::getZoom(), and zoom_absolute().

Referenced by canvas_zoom_helper(), canvas_zoom_relative(), Inkscape::UI::Tools::ZoomTool::root_handler(), and zoom_quick().

◆ zoom_selection()

void SPDesktop::zoom_selection ( )

Zoom to selection.

Definition at line 625 of file desktop.cpp.

References _selection, and set_display_area().

Referenced by canvas_transform().

Member Data Documentation

◆ _begin_zoom

std::optional<double> SPDesktop::_begin_zoom

private

Definition at line 560 of file desktop.h.

Referenced by on_zoom_begin(), on_zoom_end(), and on_zoom_scale().

◆ _canvas_catchall

Inkscape::CanvasItemCatchall* SPDesktop::_canvas_catchall = nullptr

private

The bottom item for unclaimed events.

Definition at line 220 of file desktop.h.

Referenced by _setupCanvasItems(), and getCanvasCatchall().

◆ _canvas_drawing

Inkscape::CanvasItemDrawing* SPDesktop::_canvas_drawing = nullptr

private

The actual SVG drawing (a.k.a. arena).

Definition at line 221 of file desktop.h.

Referenced by _attachDocument(), _setupCanvasItems(), and getCanvasDrawing().

◆ _canvas_group_controls

Inkscape::CanvasItemGroup* SPDesktop::_canvas_group_controls = nullptr

private

Handles, knots, nodes, etc.

Definition at line 211 of file desktop.h.

Referenced by _setupCanvasItems(), getCanvasControls(), and setTempHideOverlays().

◆ _canvas_group_drawing

Inkscape::CanvasItemGroup* SPDesktop::_canvas_group_drawing = nullptr

private

SVG Drawing.

Definition at line 212 of file desktop.h.

Referenced by _setupCanvasItems().

◆ _canvas_group_grids

Inkscape::CanvasItemGroup* SPDesktop::_canvas_group_grids = nullptr

private

Grids.

Definition at line 213 of file desktop.h.

Referenced by _setupCanvasItems(), getCanvasGrids(), and setTempHideOverlays().

◆ _canvas_group_guides

Inkscape::CanvasItemGroup* SPDesktop::_canvas_group_guides = nullptr

private

Guide lines.

Definition at line 214 of file desktop.h.

Referenced by _setupCanvasItems(), and getCanvasGuides().

◆ _canvas_group_pages_bg

Inkscape::CanvasItemGroup* SPDesktop::_canvas_group_pages_bg = nullptr

private

Page background.

Definition at line 217 of file desktop.h.

Referenced by _setupCanvasItems(), and getCanvasPagesBg().

◆ _canvas_group_pages_fg

Inkscape::CanvasItemGroup* SPDesktop::_canvas_group_pages_fg = nullptr

private

Page border + shadow.

Definition at line 218 of file desktop.h.

Referenced by _setupCanvasItems(), and getCanvasPagesFg().

◆ _canvas_group_sketch

Inkscape::CanvasItemGroup* SPDesktop::_canvas_group_sketch = nullptr

private

Temporary items before becoming permanent.

Definition at line 215 of file desktop.h.

Referenced by _setupCanvasItems(), and getCanvasSketch().

◆ _canvas_group_temp

Inkscape::CanvasItemGroup* SPDesktop::_canvas_group_temp = nullptr

private

Temporary items that self-destruct.

Definition at line 216 of file desktop.h.

Referenced by _setupCanvasItems(), and getCanvasTemp().

◆ _control_point_selected

sigc::signal<void (Inkscape::UI::ControlPointSelection *)> SPDesktop::_control_point_selected

private

Definition at line 546 of file desktop.h.

Referenced by connect_control_point_selected(), and emit_control_point_selected().

◆ _current_affine

DesktopAffine SPDesktop::_current_affine

private

◆ _destroy_signal

sigc::signal<void (SPDesktop *)> SPDesktop::_destroy_signal

private

Definition at line 542 of file desktop.h.

Referenced by connectDestroy(), and ~SPDesktop().

◆ _document_replaced_signal

sigc::signal<void (SPDesktop *, SPDocument *)> SPDesktop::_document_replaced_signal

private

Definition at line 543 of file desktop.h.

Referenced by _attachDocument(), and connectDocumentReplaced().

◆ _document_uri_set_connection

sigc::connection SPDesktop::_document_uri_set_connection

private

Definition at line 173 of file desktop.h.

Referenced by _attachDocument(), and _detachDocument().

◆ _event_context_changed_signal

sigc::signal<void (SPDesktop *, Inkscape::UI::Tools::ToolBase *)> SPDesktop::_event_context_changed_signal

private

Definition at line 544 of file desktop.h.

Referenced by connectEventContextChanged(), and setTool().

◆ _focusMode

bool SPDesktop::_focusMode = false

Whether we're focused working or general working.

Definition at line 227 of file desktop.h.

Referenced by focusMode(), and is_focusMode().

◆ _gradient_stop_selected

sigc::signal<void (SPStop *)> SPDesktop::_gradient_stop_selected

private

Definition at line 545 of file desktop.h.

Referenced by connect_gradient_stop_selected(), and emit_gradient_stop_selected().

◆ _guides_message_context

std::unique_ptr<Inkscape::MessageContext> SPDesktop::_guides_message_context

private

Definition at line 169 of file desktop.h.

Referenced by guidesMessageContext(), SPDesktop(), and ~SPDesktop().

◆ _layer_manager

std::unique_ptr<Inkscape::LayerManager> SPDesktop::_layer_manager

private

Definition at line 540 of file desktop.h.

Referenced by layerManager(), layerManager(), and SPDesktop().

◆ _message_changed_connection

sigc::scoped_connection SPDesktop::_message_changed_connection

private

Definition at line 171 of file desktop.h.

Referenced by SPDesktop().

◆ _message_idle_connection

sigc::scoped_connection SPDesktop::_message_idle_connection

private

Definition at line 172 of file desktop.h.

Referenced by SPDesktop().

◆ _message_stack

std::unique_ptr<Inkscape::MessageStack> SPDesktop::_message_stack

private

Definition at line 167 of file desktop.h.

Referenced by messageStack(), and SPDesktop().

◆ _overlays_visible

bool SPDesktop::_overlays_visible = true

private

Whether the overlays are temporarily hidden.

Definition at line 537 of file desktop.h.

Referenced by setTempHideOverlays().

◆ _query_style_signal

sigc::signal<int (SPStyle *, int)>::accumulated<StopOnNonZero> SPDesktop::_query_style_signal

Definition at line 247 of file desktop.h.

Referenced by connectQueryStyle(), and sp_desktop_query_style().

◆ _quick_zoom_affine

DesktopAffine SPDesktop::_quick_zoom_affine

private

The transform of the screen before quick zoom.

Definition at line 535 of file desktop.h.

Referenced by zoom_quick().

◆ _quick_zoom_enabled

bool SPDesktop::_quick_zoom_enabled = false

private

Signifies that currently we're in quick zoom mode.

Definition at line 534 of file desktop.h.

Referenced by quick_zoomed(), and zoom_quick().

◆ _reconstruction_finish_connection

sigc::scoped_connection SPDesktop::_reconstruction_finish_connection

private

Definition at line 550 of file desktop.h.

Referenced by _attachDocument(), and _detachDocument().

◆ _reconstruction_old_layer_id

Glib::ustring SPDesktop::_reconstruction_old_layer_id

Definition at line 244 of file desktop.h.

Referenced by _attachDocument(), reconstruction_finish(), and reconstruction_start().

◆ _reconstruction_start_connection

sigc::scoped_connection SPDesktop::_reconstruction_start_connection

private

Definition at line 549 of file desktop.h.

Referenced by _attachDocument(), and _detachDocument().

◆ _saved_guides_visible

bool SPDesktop::_saved_guides_visible = false

private

Remembers guides' visibility when hiding overlays.

Definition at line 538 of file desktop.h.

Referenced by setTempHideOverlays().

◆ _saved_or_modified_conn

sigc::connection SPDesktop::_saved_or_modified_conn

private

Definition at line 174 of file desktop.h.

Referenced by _attachDocument(), and _detachDocument().

◆ _schedule_zoom_from_document_connection

sigc::scoped_connection SPDesktop::_schedule_zoom_from_document_connection

private

Definition at line 551 of file desktop.h.

Referenced by _detachDocument(), and schedule_zoom_from_document().

◆ _selection

std::unique_ptr<Inkscape::Selection> SPDesktop::_selection

private

current selection; will never generally be NULL

Definition at line 208 of file desktop.h.

Referenced by change_document(), getSelection(), handle_y_axis_flip(), setDocument(), SPDesktop(), zoom_quick(), zoom_selection(), and ~SPDesktop().

◆ _set_style_signal

sigc::signal<bool (SPCSSAttr const *, bool)>::accumulated<StopOnTrue> SPDesktop::_set_style_signal

Definition at line 246 of file desktop.h.

Referenced by connectSetStyle(), and sp_desktop_set_style().

◆ _snapindicator

std::unique_ptr<Inkscape::Display::SnapIndicator> SPDesktop::_snapindicator

private

Definition at line 179 of file desktop.h.

Referenced by getSnapIndicator(), SPDesktop(), and ~SPDesktop().

◆ _temporary_item_list

std::unique_ptr<Inkscape::Display::TemporaryItemList> SPDesktop::_temporary_item_list

private

Definition at line 177 of file desktop.h.

Referenced by add_temporary_canvasitem(), remove_temporary_canvasitem(), SPDesktop(), and ~SPDesktop().

◆ _text_cursor_moved

sigc::signal<void (Inkscape::UI::Tools::TextTool *)> SPDesktop::_text_cursor_moved

private

Definition at line 547 of file desktop.h.

Referenced by connect_text_cursor_moved(), and emit_text_cursor_moved().

◆ _tips_message_context

std::unique_ptr<Inkscape::MessageContext> SPDesktop::_tips_message_context

private

Definition at line 168 of file desktop.h.

Referenced by SPDesktop(), and tipsMessageContext().

◆ _tool

std::unique_ptr<Inkscape::UI::Tools::ToolBase> SPDesktop::_tool

private

Definition at line 176 of file desktop.h.

Referenced by change_document(), clearWaitingCursor(), getTool(), scroll_absolute(), set_display_area(), setTool(), zoom_quick(), and ~SPDesktop().

◆ _translucency_group

std::unique_ptr<Inkscape::Display::TranslucencyGroup> SPDesktop::_translucency_group

private

Definition at line 178 of file desktop.h.

Referenced by getTranslucencyGroup(), and SPDesktop().

◆ _view_number

int SPDesktop::_view_number {}

private

Definition at line 182 of file desktop.h.

Referenced by _attachDocument(), and viewNumber().

◆ _widget

SPDesktopWidget* SPDesktop::_widget = nullptr

private

◆ _y_axis_flipped

sigc::scoped_connection SPDesktop::_y_axis_flipped

private

Definition at line 552 of file desktop.h.

Referenced by _attachDocument().

◆ canvas

std::unique_ptr<Inkscape::UI::Widget::Canvas> SPDesktop::canvas

private

◆ current

SPCSSAttr* SPDesktop::current = nullptr

Current style.

Definition at line 226 of file desktop.h.

Referenced by sp_desktop_get_color(), sp_desktop_get_color_tool(), sp_desktop_get_master_opacity_tool(), sp_desktop_get_opacity_tool(), sp_desktop_get_style(), sp_desktop_set_style(), and SPDesktop().

◆ dkey

unsigned SPDesktop::dkey = 0

Definition at line 229 of file desktop.h.

Referenced by _attachDocument(), _detachDocument(), Inkscape::LayerManager::_layer_activated(), Inkscape::LayerManager::_layer_deactivated(), Inkscape::UI::Tools::fit_item(), getGroupAtPoint(), getItemAtPoint(), getItemFromListAtPointBottom(), getItemsAtPoints(), Inkscape::PageManager::getOverlappingItems(), Inkscape::UI::Tools::InteractiveBooleansTool::hide_selected_objects(), Inkscape::LayerManager::isLayer(), itemIsHidden(), Inkscape::Application::maximum_dkey(), Inkscape::UI::Tools::NodeTool::select_area(), Inkscape::UI::Tools::MeasureTool::showCanvasItems(), and SPDesktop().

◆ document

SPDocument* SPDesktop::document = nullptr

private

Definition at line 166 of file desktop.h.

Referenced by _attachDocument(), _detachDocument(), doc(), doc2dt(), dt2doc(), getDocument(), reconstruction_finish(), setDocument(), SPDesktop(), and ~SPDesktop().

◆ gr_fill_or_stroke

Inkscape::PaintTarget SPDesktop::gr_fill_or_stroke = Inkscape::FOR_FILL

Definition at line 241 of file desktop.h.

Referenced by GrDrag::GrDrag(), and GrDrag::~GrDrag().

◆ gr_item

SPItem* SPDesktop::gr_item = nullptr

Definition at line 238 of file desktop.h.

Referenced by GrDrag::GrDrag(), and GrDrag::~GrDrag().

◆ gr_point_i

unsigned SPDesktop::gr_point_i = 0

Definition at line 240 of file desktop.h.

Referenced by GrDrag::GrDrag(), and GrDrag::~GrDrag().

◆ gr_point_type

GrPointType SPDesktop::gr_point_type = POINT_LG_BEGIN

Definition at line 239 of file desktop.h.

Referenced by GrDrag::GrDrag(), and GrDrag::~GrDrag().

◆ guides_active

bool SPDesktop::guides_active = false

Todo:: Fixme: This has to be implemented in different way

Definition at line 235 of file desktop.h.

Referenced by activate_guides(), and SPNamedView::show().

◆ interaction_disabled_counter

unsigned SPDesktop::interaction_disabled_counter = 0

Definition at line 230 of file desktop.h.

◆ namedview

SPNamedView* SPDesktop::namedview = nullptr

private

Definition at line 181 of file desktop.h.

Referenced by _attachDocument(), _detachDocument(), activate_guides(), getNamedView(), quick_preview(), setTempHideOverlays(), SPDesktop(), and toggleLockGuides().

◆ rotation_locked

bool SPDesktop::rotation_locked = false

Definition at line 233 of file desktop.h.

Referenced by get_rotation_lock(), and set_rotation_lock().

◆ showing_dialogs

bool SPDesktop::showing_dialogs = false

Definition at line 232 of file desktop.h.

◆ signal_zoom_changed

sigc::signal<void (double)> SPDesktop::signal_zoom_changed

Emitted when the zoom factor changes (not emitted when scrolling).

The parameter is the new zoom factor

Definition at line 251 of file desktop.h.

Referenced by Inkscape::UI::Tools::ObjectPickerTool::ObjectPickerTool(), Inkscape::UI::Tools::PagesTool::PagesTool(), Inkscape::UI::PathManipulator::PathManipulator(), and set_display_area().

◆ transforms_future

std::list<DesktopAffine> SPDesktop::transforms_future

private

Definition at line 533 of file desktop.h.

Referenced by clear_transform_history(), next_transform(), prev_transform(), and set_display_area().

◆ transforms_past

std::list<DesktopAffine> SPDesktop::transforms_past

private

Definition at line 532 of file desktop.h.

Referenced by clear_transform_history(), next_transform(), prev_transform(), and set_display_area().

◆ waiting_cursor

bool SPDesktop::waiting_cursor = false

Definition at line 231 of file desktop.h.

Referenced by clearWaitingCursor(), isWaitingCursor(), setWaitingCursor(), and Inkscape::UI::Tools::ToolBase::use_tool_cursor().

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

/builds/inkscape/inkscape/src/desktop.h
/builds/inkscape/inkscape/src/desktop.cpp

Classes

Public Types

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ CanvasFlip

Constructor & Destructor Documentation

◆ SPDesktop() [1/3]

◆ ~SPDesktop()

◆ SPDesktop() [2/3]

◆ SPDesktop() [3/3]

Member Function Documentation

◆ _attachDocument()

◆ _detachDocument()

◆ _setupCanvasItems()

◆ activate_guides()

◆ add_temporary_canvasitem()

◆ applyCurrentOrToolStyle()

◆ change_document()

◆ clear_transform_history()

◆ clearWaitingCursor()

◆ connect_control_point_selected()

◆ connect_gradient_stop_selected()

◆ connect_text_cursor_moved()

◆ connectDestroy()

◆ connectDocumentReplaced()

◆ connectEventContextChanged()

◆ connectQueryStyle()

◆ connectSetStyle()

◆ current_center()

◆ current_rotation()

◆ current_zoom()

◆ d2w() [1/2]

◆ d2w() [2/2]

◆ doc()

◆ doc2dt() [1/2]

◆ doc2dt() [2/2]

◆ drawing_handler()

◆ dt2doc() [1/2]

◆ dt2doc() [2/2]

◆ emit_control_point_selected()

◆ emit_gradient_stop_selected()

◆ emit_text_cursor_moved()

◆ flip_absolute_center_point()

◆ flip_absolute_keep_point()

◆ flip_relative_center_point()

◆ flip_relative_keep_point()

◆ focusMode()

◆ get_display_area()

◆ get_rotation_lock()

◆ get_toolbar_by_name()

◆ getCanvas()

◆ getCanvasCatchall()

◆ getCanvasControls()

◆ getCanvasDrawing()

◆ getCanvasGrids()

◆ getCanvasGuides()

◆ getCanvasPagesBg()

◆ getCanvasPagesFg()

◆ getCanvasSketch()

◆ getCanvasTemp()

◆ getContainer()

◆ getDesktopWidget()

◆ getDocument()

◆ getGroupAtPoint()

◆ getInkscapeWindow() [1/2]

◆ getInkscapeWindow() [2/2]

◆ getItemAtPoint()

◆ getItemFromListAtPointBottom()

◆ getItemsAtPoints()

◆ getNamedView()

◆ getSelection()

◆ getSnapIndicator()

◆ getTool()

◆ getTranslucencyGroup()

◆ getWindowSize()

◆ guidesMessageContext()