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