Code

Provide knotholder for LPEPerpBisector; TODO: this replaces the usual nodepath in...
[inkscape.git] / src / verbs.h
1 #ifndef SEEN_SP_VERBS_H
2 #define SEEN_SP_VERBS_H
4 /** \file
5  * \brief Frontend to actions
6  *
7  * Author:
8  *   Lauris Kaplinski <lauris@kaplinski.com>
9  *   Ted Gould <ted@gould.cx>
10  *   David Yip <yipdw@rose-hulman.edu>
11  *
12  *  Copyright (C) 2006 Johan Engelen <johan@shouraizou.nl>
13  *  Copyright (C) (date unspecified) Authors
15  * This code is in public domain if done by Lauris
16  * This code is GPL if done by Ted or David
17  */
19 #include <cstring>
20 #include <string>
21 #include <string.h>
22 #include "require-config.h"   /* HAVE_GTK_WINDOW_FULLSCREEN */
23 #include "helper/helper-forward.h"
24 #include "forward.h"
25 #include <glibmm/ustring.h>
27 /** \brief This anonymous enum is used to provide a list of the Verbs
28            which are defined staticly in the verb files.  There may be
29            other verbs which are defined dynamically also. */
30 enum {
31     /* Header */
32     SP_VERB_INVALID,               /**< A dummy verb to represent doing something wrong. */
33     SP_VERB_NONE,                  /**< A dummy verb to represent not having a verb. */
34     /* File */
35     SP_VERB_FILE_NEW,              /**< A new file in a new window. */
36     SP_VERB_FILE_OPEN,             /**< Open a file. */
37     SP_VERB_FILE_REVERT,           /**< Revert this file to its original state. */
38     SP_VERB_FILE_SAVE,             /**< Save the current file with its saved filename */
39     SP_VERB_FILE_SAVE_AS,          /**< Save the current file with a new filename */
40     SP_VERB_FILE_SAVE_A_COPY,      /**< Save a copy of the current file */ 
41     SP_VERB_FILE_PRINT,
42     SP_VERB_FILE_VACUUM,
43     SP_VERB_FILE_PRINT_PREVIEW,
44     SP_VERB_FILE_IMPORT,
45     SP_VERB_FILE_EXPORT,
46     SP_VERB_FILE_IMPORT_FROM_OCAL, /**< Import the file from Open Clip Art Library */
47     SP_VERB_FILE_EXPORT_TO_OCAL, /**< Export the file to Open Clip Art  Library */
48     SP_VERB_FILE_NEXT_DESKTOP,
49     SP_VERB_FILE_PREV_DESKTOP,
50     SP_VERB_FILE_CLOSE_VIEW,
51     SP_VERB_FILE_QUIT,
52     /* Edit */
53     SP_VERB_EDIT_UNDO,
54     SP_VERB_EDIT_REDO,
55     SP_VERB_EDIT_CUT,
56     SP_VERB_EDIT_COPY,
57     SP_VERB_EDIT_PASTE,
58     SP_VERB_EDIT_PASTE_STYLE,
59     SP_VERB_EDIT_PASTE_SIZE,
60     SP_VERB_EDIT_PASTE_SIZE_X,
61     SP_VERB_EDIT_PASTE_SIZE_Y,
62     SP_VERB_EDIT_PASTE_SIZE_SEPARATELY,
63     SP_VERB_EDIT_PASTE_SIZE_SEPARATELY_X,
64     SP_VERB_EDIT_PASTE_SIZE_SEPARATELY_Y,
65     SP_VERB_EDIT_PASTE_IN_PLACE,
66     SP_VERB_EDIT_PASTE_LIVEPATHEFFECT,
67     SP_VERB_EDIT_REMOVE_LIVEPATHEFFECT,
68     SP_VERB_EDIT_DELETE,
69     SP_VERB_EDIT_DUPLICATE,
70     SP_VERB_EDIT_CLONE,
71     SP_VERB_EDIT_UNLINK_CLONE,
72     SP_VERB_EDIT_CLONE_SELECT_ORIGINAL,
73     SP_VERB_EDIT_SELECTION_2_MARKER,
74     SP_VERB_EDIT_SELECTION_2_GUIDES,
75     SP_VERB_EDIT_TILE,
76     SP_VERB_EDIT_UNTILE,
77     SP_VERB_EDIT_CLEAR_ALL,
78     SP_VERB_EDIT_SELECT_ALL,
79     SP_VERB_EDIT_SELECT_ALL_IN_ALL_LAYERS,
80     SP_VERB_EDIT_INVERT,
81     SP_VERB_EDIT_INVERT_IN_ALL_LAYERS,
82     SP_VERB_EDIT_SELECT_NEXT,
83     SP_VERB_EDIT_SELECT_PREV,
84     SP_VERB_EDIT_DESELECT,
85     SP_VERB_EDIT_GUIDES_AROUND_PAGE,
86     SP_VERB_EDIT_NEXT_PATHEFFECT_PARAMETER,
87     /* Selection */
88     SP_VERB_SELECTION_TO_FRONT,
89     SP_VERB_SELECTION_TO_BACK,
90     SP_VERB_SELECTION_RAISE,
91     SP_VERB_SELECTION_LOWER,
92     SP_VERB_SELECTION_GROUP,
93     SP_VERB_SELECTION_UNGROUP,
94     SP_VERB_SELECTION_TEXTTOPATH,
95     SP_VERB_SELECTION_TEXTFROMPATH,
96     SP_VERB_SELECTION_REMOVE_KERNS,
97     SP_VERB_SELECTION_UNION,
98     SP_VERB_SELECTION_INTERSECT,
99     SP_VERB_SELECTION_DIFF,
100     SP_VERB_SELECTION_SYMDIFF,
101     SP_VERB_SELECTION_CUT,
102     SP_VERB_SELECTION_SLICE,
103     SP_VERB_SELECTION_OFFSET,
104     SP_VERB_SELECTION_OFFSET_SCREEN,
105     SP_VERB_SELECTION_OFFSET_SCREEN_10,
106     SP_VERB_SELECTION_INSET,
107     SP_VERB_SELECTION_INSET_SCREEN,
108     SP_VERB_SELECTION_INSET_SCREEN_10,
109     SP_VERB_SELECTION_DYNAMIC_OFFSET,
110     SP_VERB_SELECTION_LINKED_OFFSET,
111     SP_VERB_SELECTION_OUTLINE,
112     SP_VERB_SELECTION_SIMPLIFY,
113     SP_VERB_SELECTION_REVERSE,
114     SP_VERB_SELECTION_TRACE,
115     SP_VERB_SELECTION_CREATE_BITMAP,
116     SP_VERB_SELECTION_COMBINE,
117     SP_VERB_SELECTION_BREAK_APART,
118     SP_VERB_SELECTION_GRIDTILE,
119     /* Layer */
120     SP_VERB_LAYER_NEW,
121     SP_VERB_LAYER_RENAME,
122     SP_VERB_LAYER_NEXT,
123     SP_VERB_LAYER_PREV,
124     SP_VERB_LAYER_MOVE_TO_NEXT,
125     SP_VERB_LAYER_MOVE_TO_PREV,
126     SP_VERB_LAYER_TO_TOP,
127     SP_VERB_LAYER_TO_BOTTOM,
128     SP_VERB_LAYER_RAISE,
129     SP_VERB_LAYER_LOWER,
130     SP_VERB_LAYER_DELETE,
131     /* Object */
132     SP_VERB_OBJECT_ROTATE_90_CW,
133     SP_VERB_OBJECT_ROTATE_90_CCW,
134     SP_VERB_OBJECT_FLATTEN,
135     SP_VERB_OBJECT_TO_CURVE,
136     SP_VERB_OBJECT_FLOW_TEXT,
137     SP_VERB_OBJECT_UNFLOW_TEXT,
138     SP_VERB_OBJECT_FLOWTEXT_TO_TEXT,
139     SP_VERB_OBJECT_FLIP_HORIZONTAL,
140     SP_VERB_OBJECT_FLIP_VERTICAL,
141     SP_VERB_OBJECT_SET_MASK,
142     SP_VERB_OBJECT_EDIT_MASK,
143     SP_VERB_OBJECT_UNSET_MASK,
144     SP_VERB_OBJECT_SET_CLIPPATH,
145     SP_VERB_OBJECT_EDIT_CLIPPATH,
146     SP_VERB_OBJECT_UNSET_CLIPPATH,
147     /* Tools */
148     SP_VERB_CONTEXT_SELECT,
149     SP_VERB_CONTEXT_NODE,
150     SP_VERB_CONTEXT_TWEAK,
151     SP_VERB_CONTEXT_RECT,
152     SP_VERB_CONTEXT_3DBOX,
153     SP_VERB_CONTEXT_ARC,
154     SP_VERB_CONTEXT_STAR,
155     SP_VERB_CONTEXT_SPIRAL,
156     SP_VERB_CONTEXT_PENCIL,
157     SP_VERB_CONTEXT_PEN,
158     SP_VERB_CONTEXT_CALLIGRAPHIC,
159     SP_VERB_CONTEXT_TEXT,
160     SP_VERB_CONTEXT_GRADIENT,
161     SP_VERB_CONTEXT_ZOOM,
162     SP_VERB_CONTEXT_DROPPER,
163     SP_VERB_CONTEXT_CONNECTOR,
164     SP_VERB_CONTEXT_PAINTBUCKET,
165     SP_VERB_CONTEXT_LPE, /* not really a tool but used for editing LPE parameters on-canvas for example */
166     SP_VERB_CONTEXT_ERASER,
167     /* Tool preferences */
168     SP_VERB_CONTEXT_SELECT_PREFS,
169     SP_VERB_CONTEXT_NODE_PREFS,
170     SP_VERB_CONTEXT_TWEAK_PREFS,
171     SP_VERB_CONTEXT_RECT_PREFS,
172     SP_VERB_CONTEXT_3DBOX_PREFS,
173     SP_VERB_CONTEXT_ARC_PREFS,
174     SP_VERB_CONTEXT_STAR_PREFS,
175     SP_VERB_CONTEXT_SPIRAL_PREFS,
176     SP_VERB_CONTEXT_PENCIL_PREFS,
177     SP_VERB_CONTEXT_PEN_PREFS,
178     SP_VERB_CONTEXT_CALLIGRAPHIC_PREFS,
179     SP_VERB_CONTEXT_TEXT_PREFS,
180     SP_VERB_CONTEXT_GRADIENT_PREFS,
181     SP_VERB_CONTEXT_ZOOM_PREFS,
182     SP_VERB_CONTEXT_DROPPER_PREFS,
183     SP_VERB_CONTEXT_CONNECTOR_PREFS,
184     SP_VERB_CONTEXT_PAINTBUCKET_PREFS,
185     SP_VERB_CONTEXT_ERASER_PREFS,
186     /* Zooming and desktop settings */
187     SP_VERB_ZOOM_IN,
188     SP_VERB_ZOOM_OUT,
189     SP_VERB_TOGGLE_RULERS,
190     SP_VERB_TOGGLE_SCROLLBARS,
191     SP_VERB_TOGGLE_GRID,
192     SP_VERB_TOGGLE_GUIDES,
193     SP_VERB_TOGGLE_SNAPPING,
194     SP_VERB_ZOOM_NEXT,
195     SP_VERB_ZOOM_PREV,
196     SP_VERB_ZOOM_1_1,
197     SP_VERB_ZOOM_1_2,
198     SP_VERB_ZOOM_2_1,
199 #ifdef HAVE_GTK_WINDOW_FULLSCREEN
200     SP_VERB_FULLSCREEN,
201 #endif /* HAVE_GTK_WINDOW_FULLSCREEN */
202     SP_VERB_VIEW_NEW,
203     SP_VERB_VIEW_NEW_PREVIEW,
204     SP_VERB_VIEW_MODE_NORMAL,
205     SP_VERB_VIEW_MODE_NO_FILTERS,
206     SP_VERB_VIEW_MODE_OUTLINE,
207     SP_VERB_VIEW_MODE_TOGGLE,
208     SP_VERB_VIEW_CMS_TOGGLE,
209     SP_VERB_VIEW_ICON_PREVIEW,
210     SP_VERB_ZOOM_PAGE,
211     SP_VERB_ZOOM_PAGE_WIDTH,
212     SP_VERB_ZOOM_DRAWING,
213     SP_VERB_ZOOM_SELECTION,
214     /* Dialogs */
215     SP_VERB_DIALOG_DISPLAY,
216     SP_VERB_DIALOG_NAMEDVIEW,
217     SP_VERB_DIALOG_METADATA,
218     SP_VERB_DIALOG_FILL_STROKE,
219     SP_VERB_DIALOG_SWATCHES,
220     SP_VERB_DIALOG_TRANSFORM,
221     SP_VERB_DIALOG_ALIGN_DISTRIBUTE,
222     SP_VERB_DIALOG_UNDO_HISTORY,
223     SP_VERB_DIALOG_TEXT,
224     SP_VERB_DIALOG_XML_EDITOR,
225     SP_VERB_DIALOG_FIND,
226     SP_VERB_DIALOG_DEBUG,
227     SP_VERB_DIALOG_SCRIPT,
228     SP_VERB_DIALOG_TOGGLE,
229     SP_VERB_DIALOG_CLONETILER,
230     SP_VERB_DIALOG_ITEM,
231 #ifdef WITH_INKBOARD
232     SP_VERB_XMPP_CLIENT,
233 #endif
234     SP_VERB_DIALOG_INPUT,
235     SP_VERB_DIALOG_INPUT2,
236     SP_VERB_DIALOG_EXTENSIONEDITOR,
237     SP_VERB_DIALOG_LAYERS,
238     SP_VERB_DIALOG_LIVE_PATH_EFFECT,
239     SP_VERB_DIALOG_FILTER_EFFECTS,
240     /* Help */
241     SP_VERB_HELP_ABOUT_EXTENSIONS,
242     SP_VERB_HELP_MEMORY,
243     SP_VERB_HELP_ABOUT,
244     //SP_VERB_SHOW_LICENSE,
245     /* Tutorials */
246     SP_VERB_TUTORIAL_BASIC,
247     SP_VERB_TUTORIAL_SHAPES,
248     SP_VERB_TUTORIAL_ADVANCED,
249     SP_VERB_TUTORIAL_TRACING,
250     SP_VERB_TUTORIAL_CALLIGRAPHY,
251     SP_VERB_TUTORIAL_DESIGN,
252     SP_VERB_TUTORIAL_TIPS,
253     /* Effects */
254     SP_VERB_EFFECT_LAST,
255     SP_VERB_EFFECT_LAST_PREF,
256     /* Fit Canvas */
257     SP_VERB_FIT_CANVAS_TO_SELECTION,
258     SP_VERB_FIT_CANVAS_TO_DRAWING,
259     SP_VERB_FIT_CANVAS_TO_SELECTION_OR_DRAWING,
260     /* LockAndHide */
261     SP_VERB_UNLOCK_ALL,
262     SP_VERB_UNLOCK_ALL_IN_ALL_LAYERS,
263     SP_VERB_UNHIDE_ALL,
264     SP_VERB_UNHIDE_ALL_IN_ALL_LAYERS,
265     /* Footer */
266     SP_VERB_LAST
267 };
269 gchar *sp_action_get_title (const SPAction *action);
271 #include <map>
273 namespace Inkscape {
275 /** \brief A class to represent things the user can do.  In many ways
276            these are 'action factories' as they are used to create
277            individual actions that are based on a given view.
278 */
279 class Verb {
280 private:
281     /** \brief An easy to use defition of the table of verbs by code. */
282     typedef std::map<unsigned int, Inkscape::Verb *> VerbTable;
283     /** \brief A table of all the dynamically created verbs. */
284     static VerbTable _verbs;
285     /** \brief The table of statically created verbs which are mostly
286                'base verbs'. */
287     static Verb * _base_verbs[SP_VERB_LAST + 1];
288     /* Plus one because there is an entry for SP_VERB_LAST */
289     /** A string comparison function to be used in the Verb ID lookup
290         to find the different verbs in the hash map. */
291     struct ltstr {
292         bool operator()(const char* s1, const char* s2) const {
293             if ( (s1 == NULL) && (s2 != NULL) ) {
294                 return true;
295             } else if (s1 == NULL || s2 == NULL) {
296                 return false;
297             } else {
298                 return strcmp(s1, s2) < 0;
299             }
300         }
301     };
302     /** \brief An easy to use definition of the table of verbs by ID. */
303     typedef std::map<gchar const *, Verb *, ltstr> VerbIDTable;
304     /** \brief Quick lookup of verbs by ID */
305     static VerbIDTable _verb_ids;
307     /** \brief A simple typedef to make using the action table easier. */
308     typedef std::map<Inkscape::UI::View::View *, SPAction *> ActionTable;
309     /** \brief A list of all the actions that have been created for this
310                verb.  It is referenced by the view that they are created for. */
311     ActionTable * _actions;
313     /** \brief A unique textual ID for the verb. */
314     gchar const * _id;
315     /** \brief The full name of the verb.  (shown on menu entries) */
316     gchar const * _name;
317     /** \brief Tooltip for the verb. */
318     gchar const * _tip;
319     /** \brief Name of the image that represents the verb. */
320     gchar const * _image;
321     /** \brief Unique numerical representation of the verb.  In most cases
322                it is a value from the anonymous enum at the top of this
323                file. */
324     unsigned int  _code;
326     /** \brief Whether this verb is set to default to sensitive or
327                insensitive when new actions are created. */
328     bool _default_sensitive;
329 protected:
330     /** \brief Allows for preliminary setting of the \c _default_sensitive
331                value without effecting existing actions
332         \param in_val New value
334         This function is mostly used at initialization where there are
335         not actions to effect.  I can't think of another case where it
336         should be used.
337     */
338     bool set_default_sensitive (bool in_val) { return _default_sensitive = in_val; }
339 public:
340     /** \brief Accessor to get the \c _default_sensitive value */
341     bool get_default_sensitive (void) { return _default_sensitive; }
343 public:
344     /** \brief Accessor to get the internal variable. */
345     unsigned int get_code (void) { return _code; }
346     /** \brief Accessor to get the internal variable. */
347     gchar const * get_id (void) { return _id; }
348     /** \brief Accessor to get the internal variable. */
349     gchar const * get_name (void) { return _name; }
350     /** \brief Accessor to get the internal variable. */
351     gchar const * get_tip (void) ;
352     /** \brief Accessor to get the internal variable. */
353     gchar const * get_image (void) { return _image; }
355     /** \brief Set the name after initialization. */
356     gchar const * set_name (gchar const * name) { _name = name; return _name; }
357     /** \brief Set the tooltip after initialization. */
358     gchar const * set_tip (gchar const * tip) { _tip = tip; return _tip; }
360 protected:
361     SPAction * make_action_helper (Inkscape::UI::View::View * view, SPActionEventVector * vector, void * in_pntr = NULL);
362     virtual SPAction * make_action (Inkscape::UI::View::View * view);
364 public:
365     /** \brief Inititalizes the Verb with the parameters
366         \param code  Goes to \c _code
367         \param id    Goes to \c _id
368         \param name  Goes to \c _name
369         \param tip   Goes to \c _tip
370         \param image Goes to \c _image
372         This function also sets \c _actions to NULL.
374         \warning NO DATA IS COPIED BY CALLING THIS FUNCTION.
376         In many respects this is very bad object oriented design, but it
377         is done for a reason.  All verbs today are of two types: 1) static
378         or 2) created for extension.  In the static case all of the
379         strings are constants in the code, and thus don't really need to
380         be copied.  In the extensions case the strings are identical to
381         the ones already created in the extension object, copying them
382         would be a waste of memory.
383     */
384     Verb(const unsigned int code,
385          gchar const * id,
386          gchar const * name,
387          gchar const * tip,
388          gchar const * image) :
389         _actions(NULL), _id(id), _name(name), _tip(tip), _image(image), _code(code), _default_sensitive(true) {
390         _verbs.insert(VerbTable::value_type(_code, this));
391         _verb_ids.insert(VerbIDTable::value_type(_id, this));
392     }
393     Verb (gchar const * id, gchar const * name, gchar const * tip, gchar const * image);
394     virtual ~Verb (void);
396     SPAction * get_action(Inkscape::UI::View::View * view);
398 private:
399     static Verb * get_search (unsigned int code);
400 public:
401     /** \brief A function to turn a code into a verb.
402         \param  code  The code to be translated
403         \return A pointer to a verb object or a NULL if not found.
405         This is an inline function to translate the codes which are
406         static quickly.  This should optimize into very quick code
407         everywhere which hard coded \c codes are used.  In the case
408         where the \c code is not static the \c get_search function
409         is used.
410     */
411     static Verb * get (unsigned int code) {
412         if (code <= SP_VERB_LAST) {
413             return _base_verbs[code];
414         } else {
415             return get_search(code);
416         }
417     }
418     static Verb * getbyid (gchar const * id);
420     static void delete_all_view (Inkscape::UI::View::View * view);
421     void delete_view (Inkscape::UI::View::View * view);
423     void sensitive (SPDocument * in_doc = NULL, bool in_sensitive = true);
424     void name (SPDocument * in_doc = NULL, Glib::ustring in_name = "");
426 // Yes, multiple public, protected and private sections are bad. We'll clean that up later
427 protected:
428     /** \brief Returns the size of the internal base verb array.
429         \return The size in elements of the internal base array.
431         This is an inline function intended for testing. This should normally not be used.
432         For testing, a subclass that returns this value can be created to verify that the
433         length matches the enum values, etc.
434     */
435     static int _getBaseListSize(void) {return G_N_ELEMENTS(_base_verbs);}
437 public:
438     static void list (void);
439 }; /* Verb class */
442 }  /* Inkscape namespace */
444 #endif // SEEN_SP_VERBS_H
446 /*
447   Local Variables:
448   mode:c++
449   c-file-style:"stroustrup"
450   c-file-offsets:((innamespace . 0)(inline-open . 0))
451   indent-tabs-mode:nil
452   fill-column:99
453   End:
454 */
455 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4 :