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