src/verbs.h

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