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