Adding interface verbs - Revision history

Doctormo: Replaced content with "{{Deleted}}"

2023-03-13T14:51:57Z

Replaced content with "{{Deleted}}"

← Older revision		Revision as of 14:51, 13 March 2023
Line 1:		Line 1:
	Commands in Inkscape are called 'Verbs'. They permit invoking internal functionality through menus and keyboard shortcuts. For example, they could allow you to assign a shortcut key to a set of actions you use a lot.		{{Deleted}}

	Verbs are not terribly difficult to add. You don't need to have much coding know-how in order to add a verb, and only a minimal knowledge of Inkscape internals. The aim of this page is to provide novice coders with a "paint by numbers" process that can be followed to add a new verb to Inkscape.

	~~== How to Add a Verb ==~~

	~~First, add IDs for your new verbs to verbs.h:~~

	~~[http://bazaar.launchpad.net/~inkscape.dev/inkscape/trunk/files/head%3A/src/verbs.h verbs.h]~~

	~~The place of the ID in the list determines to which group it belongs~~
	~~(EditVerbs, FileVerbs, etc) - however, this is pretty arbitrary, so~~
	~~don't sweat if you can't find a perfect group for your verb, just use~~
	~~whichever makes most sense.~~

	~~Then is the meat of the matter. In verbs.cpp, fill in the verb structure with the name,~~
	~~description, action ID, etc; also in the same file, write the actual~~
	~~commands that the verb will do, in a switch case in one of ::perform~~
	~~methods:~~

	~~[http://bazaar.launchpad.net/~inkscape.dev/inkscape/trunk/files/head%3A/src/verbs.cpp verbs.cpp]~~

	~~As you see, these verbs do different things depending on which tool~~
	~~you are in. Before verbification, this was coded into tool context~~
	~~files, and now we can remove that:~~

	~~[http://bazaar.launchpad.net/~inkscape.dev/inkscape/trunk/files/head%3A/src/node-context.cpp node-context.cpp]~~
	~~[http://bazaar.launchpad.net/~inkscape.dev/inkscape/trunk/files/head%3A/src/select-context.cpp select-context.cpp]~~
	~~[http://bazaar.launchpad.net/~inkscape.dev/inkscape/trunk/files/head%3A/src/draw-context.cpp draw-context.cpp]~~
	~~[http://bazaar.launchpad.net/~inkscape.dev/inkscape/trunk/files/head%3A/src/draw-context.cpp draw-context.cpp]~~

	~~(the last one required writing two functions that will be called by the~~
	~~verb).~~

	~~Now assign the keys to the newly created verbs:~~

	~~[http://bazaar.launchpad.net/~inkscape.dev/inkscape/trunk/files/11093/share/keys/inkscape.xml inkscape.xml]~~

	~~and then copy inkscape.xml to default.xml.~~

	~~Note: even if you are not assigning any key, you MUST list the new~~
	~~verb in inkscape.xml, using a <bind> without a key. Not only this file~~
	~~is a keymap, but it's also a reference for keymap writers, so it must~~
	~~have all verbs, assigned or not.~~

	~~If you added a shortcut which didn't exist before, update also doc/keys.xml.~~

	~~If you want the new verb in the menu, edit menus-skeleton.h and~~
	~~insert it there in an appropriate place.~~

	~~Also review the other keymaps to see if you can assign the new verb to~~
	~~some key that would make sense. So in adobe-illustrator.xml, I~~
	~~assigned the new verbs to Alt+Ctrl+[], which seems to be the same~~
	~~thing according to the comments:~~

	~~[http://bazaar.launchpad.net/~inkscape.dev/inkscape/trunk/files/11093/share/keys/adobe-illustrator-cs2.xml adobe-illustrator-cs2.xml]~~

	~~Finally update the [[Release Notes\|release notes]] with your new work! :-)~~

	~~== Node context is gone ==~~
	~~As of revision 8976.~~

	~~== Candidates for New Verbs ==~~

	~~A couple words on what might be good candidates for verification:~~

	* anything that all tools do but which is still not a verb, such as Esc for deselection

	* anything that is needed for more complete keymaps emulating other editors, for example as listed [http://sourceforge.net/tracker/index.php?func=detail&aid=1532158&group_id=93438&atid=604309 in this bug report].
	** the bug report requests includes various suggestions including: additional Zoom percentages; increase text, size and decrease text size; bold, italic, underline, text.
	**See also the alternate keyboard shortcut layouts found in inkscape/share/keys/ which contain comments about missing features or verbs.

	* any global action (i.e. which is not limited to some tool's context) for which it just makes sense to have a quick shortcut, even if it is already available via a dialog, a tool control, or some other more complicated way (example: centering selected objects; increasing/decreasing blur/opacity/stroke width in selection, etc.).

	~~== Requests for New Verbs ==~~

	~~If the above sounds like something you're interested in doing, here is a listing of actions that have been requested, that we'll need verbs for.~~

	* Align-middle-and-center: Need a shortcut key for aligning selected objects to their centers (horizontally and vertically). [https://sourceforge.net/mailarchive/message.php?msg_id=37258028]

	* Hide Selected/Unselected & Lock Selected/Unselected: Some shortcuts keys to hide any objects that are selected or objects that aren't and a similar system for locking.

	~~If you'd like to see a verb added for a new action, but can't implement it yourself, you can add it to the above list.~~

Frigory: Frigory moved page AddingInterfaceVerbs to Adding interface verbs: Separated words

2016-07-13T05:37:43Z

Frigory moved page AddingInterfaceVerbs to Adding interface verbs: Separated words

← Older revision

Revision as of 05:37, 13 July 2016

Frigory: Corrected headings

2016-07-13T05:37:04Z

Corrected headings

← Older revision		Revision as of 05:37, 13 July 2016
Line 1:		Line 1:
	~~=Introduction to Verbs=~~

	Commands in Inkscape are called 'Verbs'. They permit invoking internal functionality through menus and keyboard shortcuts. For example, they could allow you to assign a shortcut key to a set of actions you use a lot.		Commands in Inkscape are called 'Verbs'. They permit invoking internal functionality through menus and keyboard shortcuts. For example, they could allow you to assign a shortcut key to a set of actions you use a lot.

	Verbs are not terribly difficult to add. You don't need to have much coding know-how in order to add a verb, and only a minimal knowledge of Inkscape internals. The aim of this page is to provide novice coders with a "paint by numbers" process that can be followed to add a new verb to Inkscape.		Verbs are not terribly difficult to add. You don't need to have much coding know-how in order to add a verb, and only a minimal knowledge of Inkscape internals. The aim of this page is to provide novice coders with a "paint by numbers" process that can be followed to add a new verb to Inkscape.

			== How to Add a Verb ==
	=How to Add a Verb=

	First, add IDs for your new verbs to verbs.h:		First, add IDs for your new verbs to verbs.h:
Line 61:		Line 58:
	Finally update the [[Release Notes\|release notes]] with your new work! :-)		Finally update the [[Release Notes\|release notes]] with your new work! :-)

	= Node context is gone =		== Node context is gone ==
	As of revision 8976.		As of revision 8976.

	=Candidates for New Verbs=		== Candidates for New Verbs ==

	A couple words on what might be good candidates for ~~verbification~~:		A couple words on what might be good candidates for verification:

	* anything that all tools do but which is still not a verb, such as Esc for deselection		* anything that all tools do but which is still not a verb, such as Esc for deselection
Line 73:		Line 70:
	** the bug report requests includes various suggestions including: additional Zoom percentages; increase text, size and decrease text size; bold, italic, underline, text.		** the bug report requests includes various suggestions including: additional Zoom percentages; increase text, size and decrease text size; bold, italic, underline, text.
	**See also the alternate keyboard shortcut layouts found in inkscape/share/keys/ which contain comments about missing features or verbs.		**See also the alternate keyboard shortcut layouts found in inkscape/share/keys/ which contain comments about missing features or verbs.


	* any global action (i.e. which is not limited to some tool's context) for which it just makes sense to have a quick shortcut, even if it is already available via a dialog, a tool control, or some other more complicated way (example: centering selected objects; increasing/decreasing blur/opacity/stroke width in selection, etc.).		* any global action (i.e. which is not limited to some tool's context) for which it just makes sense to have a quick shortcut, even if it is already available via a dialog, a tool control, or some other more complicated way (example: centering selected objects; increasing/decreasing blur/opacity/stroke width in selection, etc.).

	=Requests for New Verbs=		== Requests for New Verbs ==

	If the above sounds like something you're interested in doing, here is a listing of actions that have been requested, that we'll need verbs for.		If the above sounds like something you're interested in doing, here is a listing of actions that have been requested, that we'll need verbs for.

Romain2Boss: Updating SVN links to Bazaar links

2012-03-18T19:48:20Z

Updating SVN links to Bazaar links

← Older revision		Revision as of 19:48, 18 March 2012
Line 10:		Line 10:
	First, add IDs for your new verbs to verbs.h:		First, add IDs for your new verbs to verbs.h:

	[http://~~svn~~.~~sourceforge~~.net/~~viewvc/~~inkscape/inkscape/trunk/src/verbs.h~~?r1=13280&r2=13309&sortby=date~~ verbs.h]		[http://bazaar.launchpad.net/~inkscape.dev/inkscape/trunk/files/head%3A/src/verbs.h verbs.h]

	The place of the ID in the list determines to which group it belongs		The place of the ID in the list determines to which group it belongs
Line 22:		Line 22:
	methods:		methods:

	[http://~~svn~~.~~sourceforge~~.net/~~viewvc/~~inkscape/inkscape/trunk/src/verbs.cpp~~?r1=13281&r2=13311&sortby=date~~ verbs.cpp]		[http://bazaar.launchpad.net/~inkscape.dev/inkscape/trunk/files/head%3A/src/verbs.cpp verbs.cpp]

	As you see, these verbs do different things depending on which tool		As you see, these verbs do different things depending on which tool
Line 28:		Line 28:
	files, and now we can remove that:		files, and now we can remove that:

	[http://~~svn~~.~~sourceforge~~.net/~~viewvc/~~inkscape/inkscape/trunk/src/node-context.cpp~~?r1=13296&r2=13309&sortby=date~~ node-context.cpp]		[http://bazaar.launchpad.net/~inkscape.dev/inkscape/trunk/files/head%3A/src/node-context.cpp node-context.cpp]
	[http://~~svn~~.~~sourceforge~~.net/~~viewvc/~~inkscape/inkscape/trunk/src/select-context.cpp~~?r1=13200&r2=13309&sortby=date~~ select-context.cpp]		[http://bazaar.launchpad.net/~inkscape.dev/inkscape/trunk/files/head%3A/src/select-context.cpp select-context.cpp]
	[http://~~svn~~.~~sourceforge~~.net/~~viewvc/~~inkscape/inkscape/trunk/src/draw-context.cpp~~?r1=13148&r2=13310&sortby=date~~ draw-context.cpp]		[http://bazaar.launchpad.net/~inkscape.dev/inkscape/trunk/files/head%3A/src/draw-context.cpp draw-context.cpp]
	[http://~~svn~~.~~sourceforge~~.net/~~viewvc/~~inkscape/inkscape/trunk/src/draw-context.cpp~~?r1=13148&r2=13310&sortby=date~~ draw-context.cpp]		[http://bazaar.launchpad.net/~inkscape.dev/inkscape/trunk/files/head%3A/src/draw-context.cpp draw-context.cpp]

	(the last one required writing two functions that will be called by the		(the last one required writing two functions that will be called by the
Line 38:		Line 38:
	Now assign the keys to the newly created verbs:		Now assign the keys to the newly created verbs:

	[http://~~svn~~.~~sourceforge~~.net/~~viewvc/~~inkscape/inkscape/trunk/share/keys/inkscape.xml~~?r1=13302&r2=13307&sortby=date~~ inkscape.xml]		[http://bazaar.launchpad.net/~inkscape.dev/inkscape/trunk/files/11093/share/keys/inkscape.xml inkscape.xml]

	and then copy inkscape.xml to default.xml.		and then copy inkscape.xml to default.xml.
Line 57:		Line 57:
	thing according to the comments:		thing according to the comments:

	[http://~~svn~~.~~sourceforge~~.net/~~viewvc/~~inkscape/inkscape/trunk/share/keys/adobe-illustrator-cs2.xml~~?r1=13304&r2=13308&sortby=date~~ adobe-illustrator-cs2.xml]		[http://bazaar.launchpad.net/~inkscape.dev/inkscape/trunk/files/11093/share/keys/adobe-illustrator-cs2.xml adobe-illustrator-cs2.xml]

	Finally update the [[Release Notes\|release notes]] with your new work! :-)		Finally update the [[Release Notes\|release notes]] with your new work! :-)

Sandra at 18:28, 8 January 2012

2012-01-08T18:28:24Z

← Older revision		Revision as of 18:28, 8 January 2012
Line 60:		Line 60:

	Finally update the [[Release Notes\|release notes]] with your new work! :-)		Finally update the [[Release Notes\|release notes]] with your new work! :-)

			= Node context is gone =
			As of revision 8976.

	=Candidates for New Verbs=		=Candidates for New Verbs=

~suv: Undo revision 68353 by Afamefula (Talk)

2011-03-29T18:02:02Z

Undo revision 68353 by Afamefula (Talk)

← Older revision		Revision as of 18:02, 29 March 2011
Line 23:		Line 23:

	[http://svn.sourceforge.net/viewvc/inkscape/inkscape/trunk/src/verbs.cpp?r1=13281&r2=13311&sortby=date verbs.cpp]		[http://svn.sourceforge.net/viewvc/inkscape/inkscape/trunk/src/verbs.cpp?r1=13281&r2=13311&sortby=date verbs.cpp]
	~~[http://www.essaywriters.net/ online jobs]~~

	As you see, these verbs do different things depending on which tool		As you see, these verbs do different things depending on which tool

Afamefula at 15:50, 29 March 2011

2011-03-29T15:50:07Z

← Older revision		Revision as of 15:50, 29 March 2011
Line 23:		Line 23:

	[http://svn.sourceforge.net/viewvc/inkscape/inkscape/trunk/src/verbs.cpp?r1=13281&r2=13311&sortby=date verbs.cpp]		[http://svn.sourceforge.net/viewvc/inkscape/inkscape/trunk/src/verbs.cpp?r1=13281&r2=13311&sortby=date verbs.cpp]
			[http://www.essaywriters.net/ online jobs]

	As you see, these verbs do different things depending on which tool		As you see, these verbs do different things depending on which tool

Wahooney: /* Requests for New Verbs */

2007-10-05T09:53:17Z

Requests for New Verbs

← Older revision		Revision as of 09:53, 5 October 2007
Line 79:		Line 79:

	* Align-middle-and-center: Need a shortcut key for aligning selected objects to their centers (horizontally and vertically). [https://sourceforge.net/mailarchive/message.php?msg_id=37258028]		* Align-middle-and-center: Need a shortcut key for aligning selected objects to their centers (horizontally and vertically). [https://sourceforge.net/mailarchive/message.php?msg_id=37258028]

			* Hide Selected/Unselected & Lock Selected/Unselected: Some shortcuts keys to hide any objects that are selected or objects that aren't and a similar system for locking.

	If you'd like to see a verb added for a new action, but can't implement it yourself, you can add it to the above list.		If you'd like to see a verb added for a new action, but can't implement it yourself, you can add it to the above list.

Colin Marquardt: Reverted edits by AdkX5u (Talk); changed back to last version by DavidHOzAu

2007-04-20T15:49:22Z

Reverted edits by AdkX5u (Talk); changed back to last version by DavidHOzAu

← Older revision		Revision as of 15:49, 20 April 2007
Line 10:		Line 10:
	First, add IDs for your new verbs to verbs.h:		First, add IDs for your new verbs to verbs.h:

	[http://svn.sourceforge.net/viewvc/inkscape/inkscape/trunk/src/verbs.h?r1=13280		[http://svn.sourceforge.net/viewvc/inkscape/inkscape/trunk/src/verbs.h?r1=13280&r2=13309&sortby=date verbs.h]

			The place of the ID in the list determines to which group it belongs
			(EditVerbs, FileVerbs, etc) - however, this is pretty arbitrary, so
			don't sweat if you can't find a perfect group for your verb, just use
			whichever makes most sense.

			Then is the meat of the matter. In verbs.cpp, fill in the verb structure with the name,
			description, action ID, etc; also in the same file, write the actual
			commands that the verb will do, in a switch case in one of ::perform
			methods:

			[http://svn.sourceforge.net/viewvc/inkscape/inkscape/trunk/src/verbs.cpp?r1=13281&r2=13311&sortby=date verbs.cpp]

			As you see, these verbs do different things depending on which tool
			you are in. Before verbification, this was coded into tool context
			files, and now we can remove that:

			[http://svn.sourceforge.net/viewvc/inkscape/inkscape/trunk/src/node-context.cpp?r1=13296&r2=13309&sortby=date node-context.cpp]
			[http://svn.sourceforge.net/viewvc/inkscape/inkscape/trunk/src/select-context.cpp?r1=13200&r2=13309&sortby=date select-context.cpp]
			[http://svn.sourceforge.net/viewvc/inkscape/inkscape/trunk/src/draw-context.cpp?r1=13148&r2=13310&sortby=date draw-context.cpp]
			[http://svn.sourceforge.net/viewvc/inkscape/inkscape/trunk/src/draw-context.cpp?r1=13148&r2=13310&sortby=date draw-context.cpp]

			(the last one required writing two functions that will be called by the
			verb).

			Now assign the keys to the newly created verbs:

			[http://svn.sourceforge.net/viewvc/inkscape/inkscape/trunk/share/keys/inkscape.xml?r1=13302&r2=13307&sortby=date inkscape.xml]

			and then copy inkscape.xml to default.xml.

			Note: even if you are not assigning any key, you MUST list the new
			verb in inkscape.xml, using a <bind> without a key. Not only this file
			is a keymap, but it's also a reference for keymap writers, so it must
			have all verbs, assigned or not.

			If you added a shortcut which didn't exist before, update also doc/keys.xml.

			If you want the new verb in the menu, edit menus-skeleton.h and
			insert it there in an appropriate place.

			Also review the other keymaps to see if you can assign the new verb to
			some key that would make sense. So in adobe-illustrator.xml, I
			assigned the new verbs to Alt+Ctrl+[], which seems to be the same
			thing according to the comments:

			[http://svn.sourceforge.net/viewvc/inkscape/inkscape/trunk/share/keys/adobe-illustrator-cs2.xml?r1=13304&r2=13308&sortby=date adobe-illustrator-cs2.xml]

			Finally update the [[Release Notes\|release notes]] with your new work! :-)

			=Candidates for New Verbs=

			A couple words on what might be good candidates for verbification:

			* anything that all tools do but which is still not a verb, such as Esc for deselection

			* anything that is needed for more complete keymaps emulating other editors, for example as listed [http://sourceforge.net/tracker/index.php?func=detail&aid=1532158&group_id=93438&atid=604309 in this bug report].
			** the bug report requests includes various suggestions including: additional Zoom percentages; increase text, size and decrease text size; bold, italic, underline, text.
			**See also the alternate keyboard shortcut layouts found in inkscape/share/keys/ which contain comments about missing features or verbs.


			* any global action (i.e. which is not limited to some tool's context) for which it just makes sense to have a quick shortcut, even if it is already available via a dialog, a tool control, or some other more complicated way (example: centering selected objects; increasing/decreasing blur/opacity/stroke width in selection, etc.).

			=Requests for New Verbs=

			If the above sounds like something you're interested in doing, here is a listing of actions that have been requested, that we'll need verbs for.

			* Align-middle-and-center: Need a shortcut key for aligning selected objects to their centers (horizontally and vertically). [https://sourceforge.net/mailarchive/message.php?msg_id=37258028]

			If you'd like to see a verb added for a new action, but can't implement it yourself, you can add it to the above list.

AdkX5u at 06:22, 12 April 2007

2007-04-12T06:22:54Z

← Older revision		Revision as of 06:22, 12 April 2007
Line 10:		Line 10:
	First, add IDs for your new verbs to verbs.h:		First, add IDs for your new verbs to verbs.h:

	[http://svn.sourceforge.net/viewvc/inkscape/inkscape/trunk/src/verbs.h?r1=13280~~&r2=13309&sortby=date verbs.h]~~		[http://svn.sourceforge.net/viewvc/inkscape/inkscape/trunk/src/verbs.h?r1=13280

	~~The place of the ID in the list determines to which group it belongs~~
	~~(EditVerbs, FileVerbs, etc) - however, this is pretty arbitrary, so~~
	~~don't sweat if you can't find a perfect group for your verb, just use~~
	~~whichever makes most sense.~~

	~~Then is the meat of the matter. In verbs.cpp, fill in the verb structure with the name,~~
	~~description, action ID, etc; also in the same file, write the actual~~
	~~commands that the verb will do, in a switch case in one of ::perform~~
	~~methods:~~

	~~[http://svn.sourceforge.net/viewvc/inkscape/inkscape/trunk/src/verbs.cpp?r1=13281&r2=13311&sortby=date verbs.cpp]~~

	~~As you see, these verbs do different things depending on which tool~~
	~~you are in. Before verbification, this was coded into tool context~~
	~~files, and now we can remove that:~~

	~~[http://svn.sourceforge.net/viewvc/inkscape/inkscape/trunk/src/node-context.cpp?r1=13296&r2=13309&sortby=date node-context.cpp]~~
	~~[http://svn.sourceforge.net/viewvc/inkscape/inkscape/trunk/src/select-context.cpp?r1=13200&r2=13309&sortby=date select-context.cpp]~~
	~~[http://svn.sourceforge.net/viewvc/inkscape/inkscape/trunk/src/draw-context.cpp?r1=13148&r2=13310&sortby=date draw-context.cpp]~~
	~~[http://svn.sourceforge.net/viewvc/inkscape/inkscape/trunk/src/draw-context.cpp?r1=13148&r2=13310&sortby=date draw-context.cpp]~~

	~~(the last one required writing two functions that will be called by the~~
	~~verb).~~

	~~Now assign the keys to the newly created verbs:~~

	~~[http://svn.sourceforge.net/viewvc/inkscape/inkscape/trunk/share/keys/inkscape.xml?r1=13302&r2=13307&sortby=date inkscape.xml]~~

	~~and then copy inkscape.xml to default.xml.~~

	~~Note: even if you are not assigning any key, you MUST list the new~~
	~~verb in inkscape.xml, using a <bind> without a key. Not only this file~~
	~~is a keymap, but it's also a reference for keymap writers, so it must~~
	~~have all verbs, assigned or not.~~

	~~If you added a shortcut which didn't exist before, update also doc/keys.xml.~~

	~~If you want the new verb in the menu, edit menus-skeleton.h and~~
	~~insert it there in an appropriate place.~~

	~~Also review the other keymaps to see if you can assign the new verb to~~
	~~some key that would make sense. So in adobe-illustrator.xml, I~~
	~~assigned the new verbs to Alt+Ctrl+[], which seems to be the same~~
	~~thing according to the comments:~~

	~~[http://svn.sourceforge.net/viewvc/inkscape/inkscape/trunk/share/keys/adobe-illustrator-cs2.xml?r1=13304&r2=13308&sortby=date adobe-illustrator-cs2.xml]~~

	~~Finally update the [[Release Notes\|release notes]] with your new work! :-)~~

	~~=Candidates for New Verbs=~~

	~~A couple words on what might be good candidates for verbification:~~

	* anything that all tools do but which is still not a verb, such as Esc for deselection

	* anything that is needed for more complete keymaps emulating other editors, for example as listed [http://sourceforge.net/tracker/index.php?func=detail&aid=1532158&group_id=93438&atid=604309 in this bug report].
	** the bug report requests includes various suggestions including: additional Zoom percentages; increase text, size and decrease text size; bold, italic, underline, text.
	**See also the alternate keyboard shortcut layouts found in inkscape/share/keys/ which contain comments about missing features or verbs.


	* any global action (i.e. which is not limited to some tool's context) for which it just makes sense to have a quick shortcut, even if it is already available via a dialog, a tool control, or some other more complicated way (example: centering selected objects; increasing/decreasing blur/opacity/stroke width in selection, etc.).

	~~=Requests for New Verbs=~~

	~~If the above sounds like something you're interested in doing, here is a listing of actions that have been requested, that we'll need verbs for.~~

	* Align-middle-and-center: Need a shortcut key for aligning selected objects to their centers (horizontally and vertically). [https://sourceforge.net/mailarchive/message.php?msg_id=37258028]

	~~If you'd like to see a verb added for a new action, but can't implement it yourself, you can add it to the above list.~~