Inkscape: Inkscape::UI::Tools::FloodTool Class Reference

Searching...

No Matches

#include <flood-tool.h>

Inheritance diagram for Inkscape::UI::Tools::FloodTool:

Public Member Functions
	FloodTool (SPDesktop *desktop)

	~FloodTool () override

bool	root_handler (CanvasEvent const &event) override

bool	item_handler (SPItem *item, CanvasEvent const &event) override
	Handles item specific events.

Public Member Functions inherited from Inkscape::UI::Tools::ToolBase
	ToolBase (SPDesktop *desktop, std::string &&prefs_path, std::string &&cursor_filename, bool uses_snap=true)

virtual	~ToolBase ()

virtual void	set (Preferences::Entry const &val)
	Called by our pref_observer if a preference has been changed.

virtual void	menu_popup (CanvasEvent const &event, SPObject *obj=nullptr)
	Create popup menu and tell Gtk to show it.

virtual bool	can_undo (bool redo=false)

virtual bool	is_ready () const

virtual void	switching_away (std::string const &new_tool)

std::string const &	getPrefsPath () const

void	enableSelectionCue (bool enable=true)
	Enables/disables the ToolBase's SelCue.

MessageContext *	defaultMessageContext () const

SPDesktop *	getDesktop () const

SPGroup *	currentLayer () const

void	set_last_active_tool (Glib::ustring last_tool)

const Glib::ustring &	get_last_active_tool () const

bool	start_root_handler (CanvasEvent const &event)
	Handles snapping events for all tools and then passes to tool_root_handler.

bool	tool_root_handler (CanvasEvent const &event)
	Calls the right tool's event handler, depending on the selected tool and state.

bool	start_item_handler (SPItem *item, CanvasEvent const &event)
	Starts handling item snapping and pass to virtual_item_handler afterwards.

bool	virtual_item_handler (SPItem *item, CanvasEvent const &event)

bool	is_panning () const
	True if we're panning with any method (space bar, middle-mouse, right-mouse+Ctrl)

bool	is_space_panning () const
	True if we're panning with the space bar.

void	snap_delay_handler (gpointer item, gpointer item2, MotionEvent const &event, DelayedSnapEvent::Origin origin)
	Analyses the current event, calculates the mouse speed, turns snapping off (temporarily) if the mouse speed is above a threshold, and stores the current event such that it can be re-triggered when needed (re-triggering is controlled by a timeout).

void	process_delayed_snap_event ()
	When the delayed snap event timer expires, this method will be called and will re-inject the last motion event in an appropriate place, with snapping being turned on again.

void	discard_delayed_snap_event ()
	If a delayed snap event has been scheduled, this function will cancel it.

void	set_cursor (std::string filename)
	Sets the current cursor to the given filename.

void	use_cursor (Glib::RefPtr< Gdk::Cursor > cursor)
	Set the cursor to this specific one, don't remember it.

Glib::RefPtr< Gdk::Cursor >	get_cursor (Gtk::Widget &widget, std::string const &filename) const
	Returns the Gdk Cursor for the given filename.

void	use_tool_cursor ()
	Uses the saved cursor, based on the saved filename.

void	enableGrDrag (bool enable=true)

bool	deleteSelectedDrag (bool just_one)
	Delete a selected GrDrag point.

bool	hasGradientDrag () const
	Return true if there is a gradient drag.

GrDrag *	get_drag ()

Static Public Member Functions
static void	set_channels (int channels)

Public Attributes
SPItem *	item = nullptr

sigc::connection	sel_changed_connection

Public Attributes inherited from Inkscape::UI::Tools::ToolBase
std::unique_ptr< MessageContext >	message_context

SelCue *	_selcue = nullptr

GrDrag *	_grdrag = nullptr

ShapeEditor *	shape_editor = nullptr

bool	_uses_snap = false

Static Public Attributes
static std::vector< char const * > const	channel_list

static std::vector< char const * > const	gap_list

Private Member Functions
void	selection_changed (Selection *selection)
	Callback that processes the "changed" signal on the selection; destroys old and creates new knotholder.

void	finishItem ()

Additional Inherited Members
Protected Member Functions inherited from Inkscape::UI::Tools::ToolBase
void	setup_for_drag_start (ButtonPressEvent const &ev)

void	saveDragOrigin (Geom::Point const &pos)

bool	checkDragMoved (Geom::Point const &pos)
	Analyse the current position and return true once it has moved farther than tolerance from the drag origin (indicating they intend to move the object, not click).

void	grabCanvasEvents (EventMask mask=EventType::KEY_PRESS\|EventType::BUTTON_RELEASE\|EventType::MOTION\|EventType::BUTTON_PRESS)
	Grab events from the Canvas Catchall.

void	ungrabCanvasEvents ()
	Ungrab events from the Canvas Catchall.

bool	sp_event_context_knot_mouseover () const
	Returns true if we're hovering above a knot (needed because we don't want to pre-snap in that case).

void	set_high_motion_precision (bool high_precision=true)
	Enable (or disable) high precision for motion events.

Protected Attributes inherited from Inkscape::UI::Tools::ToolBase
Glib::RefPtr< Gdk::Cursor >	_cursor

std::string	_cursor_filename = "select.svg"

std::string	_cursor_default = "select.svg"

Geom::IntPoint	xyp
	where drag started

bool	dragging = false
	are we dragging?

int	tolerance = 0

bool	within_tolerance = false
	are we still within tolerance of origin

bool	_button1on = false

bool	_button2on = false

bool	_button3on = false

SPItem *	item_to_select = nullptr
	the item where mouse_press occurred, to be selected if this is a click not drag

SPDesktop *	_desktop = nullptr

Util::ActionAccel	_acc_undo

Util::ActionAccel	_acc_redo

Util::ActionAccel	_acc_quick_preview

Util::ActionAccel	_acc_quick_zoom

Util::ActionAccel	_acc_quick_pan

Detailed Description

Definition at line 21 of file flood-tool.h.

Constructor & Destructor Documentation

◆ FloodTool()

Inkscape::UI::Tools::FloodTool::FloodTool ( SPDesktop * desktop )

Definition at line 84 of file flood-tool.cpp.

References Inkscape::Selection::connectChanged(), desktop, Inkscape::UI::Tools::ToolBase::enableSelectionCue(), Inkscape::Preferences::get(), SPDesktop::getSelection(), item, sel_changed_connection, selection_changed(), Inkscape::UI::ShapeEditor::set_item(), Inkscape::UI::Tools::ToolBase::shape_editor, Inkscape::ObjectSet::singleItem(), and Inkscape::UI::Tools::ToolBase::tolerance.

◆ ~FloodTool()

Inkscape::UI::Tools::FloodTool::~FloodTool ( )

override

Definition at line 106 of file flood-tool.cpp.

References finishItem(), item, sel_changed_connection, and Inkscape::UI::Tools::ToolBase::shape_editor.

Member Function Documentation

◆ finishItem()

void Inkscape::UI::Tools::FloodTool::finishItem ( )

private

Definition at line 1123 of file flood-tool.cpp.

References Inkscape::DocumentUndo::done(), item, and SPObject::updateRepr().

Referenced by ~FloodTool().

◆ item_handler()

bool Inkscape::UI::Tools::FloodTool::item_handler	(	SPItem *	item,
		CanvasEvent const &	event
	)

overridevirtual

Handles item specific events.

Gets called from Gdk.

Only reacts to right mouse button at the moment.

Todo:: Fixme: do context sensitive popup menu on items.

Reimplemented from Inkscape::UI::Tools::ToolBase.

Definition at line 1007 of file flood-tool.cpp.

References Inkscape::inspect_event(), item, Inkscape::UI::Tools::ToolBase::item_handler(), and Inkscape::CanvasEvent::modifiers.

◆ root_handler()

bool Inkscape::UI::Tools::FloodTool::root_handler ( CanvasEvent const & event )

overridevirtual

Reimplemented from Inkscape::UI::Tools::ToolBase.

Definition at line 1031 of file flood-tool.cpp.

References Inkscape::inspect_event(), and Inkscape::CanvasEvent::modifiers.

◆ selection_changed()

void Inkscape::UI::Tools::FloodTool::selection_changed ( Selection * selection )

private

Callback that processes the "changed" signal on the selection; destroys old and creates new knotholder.

Definition at line 123 of file flood-tool.cpp.

References Inkscape::UI::ShapeEditor::set_item(), Inkscape::UI::Tools::ToolBase::shape_editor, Inkscape::ObjectSet::singleItem(), and Inkscape::UI::ShapeEditor::unset_item().

Referenced by FloodTool().

◆ set_channels()

void Inkscape::UI::Tools::FloodTool::set_channels ( int channels )

static

Definition at line 1137 of file flood-tool.cpp.

References Inkscape::Preferences::get().

Referenced by Inkscape::UI::Toolbar::PaintbucketToolbar::channels_changed().

Member Data Documentation

◆ channel_list

std::vector< char const * > const Inkscape::UI::Tools::FloodTool::channel_list

static

Initial value:

= {
    N_("Visible Colors"),
    N_("Red"),
    N_("Green"),
    N_("Blue"),
    N_("Hue"),
    N_("Saturation"),
    N_("Lightness"),
    N_("Alpha")
}

Definition at line 36 of file flood-tool.h.

Referenced by Inkscape::UI::Toolbar::PaintbucketToolbar::PaintbucketToolbar().

◆ gap_list

std::vector< char const * > const Inkscape::UI::Tools::FloodTool::gap_list

static

Initial value:

= {
    NC_("Flood autogap", "None"),
    NC_("Flood autogap", "Small"),
    NC_("Flood autogap", "Medium"),
    NC_("Flood autogap", "Large")
}

Definition at line 37 of file flood-tool.h.

Referenced by Inkscape::UI::Toolbar::PaintbucketToolbar::PaintbucketToolbar().

◆ item

SPItem* Inkscape::UI::Tools::FloodTool::item = nullptr

Definition at line 27 of file flood-tool.h.

Referenced by FloodTool(), item_handler(), and ~FloodTool().

◆ sel_changed_connection

sigc::connection Inkscape::UI::Tools::FloodTool::sel_changed_connection

Definition at line 29 of file flood-tool.h.

Referenced by FloodTool(), and ~FloodTool().

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

/builds/inkscape/inkscape/src/ui/tools/flood-tool.h
/builds/inkscape/inkscape/src/ui/tools/flood-tool.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FloodTool()

◆ ~FloodTool()

Member Function Documentation

◆ finishItem()

◆ item_handler()

◆ root_handler()

◆ selection_changed()

◆ set_channels()

Member Data Documentation

◆ channel_list

◆ gap_list

◆ item

◆ sel_changed_connection