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_3DBOX,
 140     SP_VERB_CONTEXT_ARC,
 141     SP_VERB_CONTEXT_STAR,
 142     SP_VERB_CONTEXT_SPIRAL,
 143     SP_VERB_CONTEXT_PENCIL,
 144     SP_VERB_CONTEXT_PEN,
 145     SP_VERB_CONTEXT_CALLIGRAPHIC,
 146     SP_VERB_CONTEXT_TEXT,
 147     SP_VERB_CONTEXT_GRADIENT,
 148     SP_VERB_CONTEXT_ZOOM,
 149     SP_VERB_CONTEXT_DROPPER,
 150     SP_VERB_CONTEXT_CONNECTOR,
 151     SP_VERB_CONTEXT_PAINTBUCKET,
 152     /* Tool preferences */
 153     SP_VERB_CONTEXT_SELECT_PREFS,
 154     SP_VERB_CONTEXT_NODE_PREFS,
 155     SP_VERB_CONTEXT_RECT_PREFS,
 156     SP_VERB_CONTEXT_3DBOX_PREFS,
 157     SP_VERB_CONTEXT_ARC_PREFS,
 158     SP_VERB_CONTEXT_STAR_PREFS,
 159     SP_VERB_CONTEXT_SPIRAL_PREFS,
 160     SP_VERB_CONTEXT_PENCIL_PREFS,
 161     SP_VERB_CONTEXT_PEN_PREFS,
 162     SP_VERB_CONTEXT_CALLIGRAPHIC_PREFS,
 163     SP_VERB_CONTEXT_TEXT_PREFS,
 164     SP_VERB_CONTEXT_GRADIENT_PREFS,
 165     SP_VERB_CONTEXT_ZOOM_PREFS,
 166     SP_VERB_CONTEXT_DROPPER_PREFS,
 167     SP_VERB_CONTEXT_CONNECTOR_PREFS,
 168     SP_VERB_CONTEXT_PAINTBUCKET_PREFS,
 169     /* Zooming and desktop settings */
 170     SP_VERB_ZOOM_IN,
 171     SP_VERB_ZOOM_OUT,
 172     SP_VERB_TOGGLE_RULERS,
 173     SP_VERB_TOGGLE_SCROLLBARS,
 174     SP_VERB_TOGGLE_GRID,
 175     SP_VERB_TOGGLE_GUIDES,
 176     SP_VERB_ZOOM_NEXT,
 177     SP_VERB_ZOOM_PREV,
 178     SP_VERB_ZOOM_1_1,
 179     SP_VERB_ZOOM_1_2,
 180     SP_VERB_ZOOM_2_1,
 181 #ifdef HAVE_GTK_WINDOW_FULLSCREEN
 182     SP_VERB_FULLSCREEN,
 183 #endif /* HAVE_GTK_WINDOW_FULLSCREEN */
 184     SP_VERB_VIEW_NEW,
 185     SP_VERB_VIEW_NEW_PREVIEW,
 186     SP_VERB_VIEW_MODE_NORMAL,
 187     SP_VERB_VIEW_MODE_OUTLINE,
 188     SP_VERB_VIEW_MODE_TOGGLE,
 189     SP_VERB_VIEW_ICON_PREVIEW,
 190     SP_VERB_ZOOM_PAGE,
 191     SP_VERB_ZOOM_PAGE_WIDTH,
 192     SP_VERB_ZOOM_DRAWING,
 193     SP_VERB_ZOOM_SELECTION,
 194     /* Dialogs */
 195     SP_VERB_DIALOG_DISPLAY,
 196     SP_VERB_DIALOG_NAMEDVIEW,
 197     SP_VERB_DIALOG_METADATA,
 198     SP_VERB_DIALOG_FILL_STROKE,
 199     SP_VERB_DIALOG_SWATCHES,
 200     SP_VERB_DIALOG_TRANSFORM,
 201     SP_VERB_DIALOG_ALIGN_DISTRIBUTE,
 202     SP_VERB_DIALOG_UNDO_HISTORY,
 203     SP_VERB_DIALOG_TEXT,
 204     SP_VERB_DIALOG_XML_EDITOR,
 205     SP_VERB_DIALOG_FIND,
 206     SP_VERB_DIALOG_DEBUG,
 207     SP_VERB_DIALOG_SCRIPT,
 208     SP_VERB_DIALOG_TOGGLE,
 209     SP_VERB_DIALOG_CLONETILER,
 210     SP_VERB_DIALOG_ITEM,
 211 #ifdef WITH_INKBOARD
 212     SP_VERB_XMPP_CLIENT,
 213 #endif
 214     SP_VERB_DIALOG_INPUT,
 215     SP_VERB_DIALOG_EXTENSIONEDITOR,
 216     SP_VERB_DIALOG_LAYERS,
 217     SP_VERB_DIALOG_FILTER_EFFECTS,
 218     /* Help */
 219     SP_VERB_HELP_KEYS,
 220     SP_VERB_HELP_ABOUT_EXTENSIONS,
 221     SP_VERB_HELP_MEMORY,
 222     SP_VERB_HELP_ABOUT,
 223     //SP_VERB_SHOW_LICENSE,
 224     /* Tutorials */
 225     SP_VERB_TUTORIAL_BASIC,
 226     SP_VERB_TUTORIAL_SHAPES,
 227     SP_VERB_TUTORIAL_ADVANCED,
 228     SP_VERB_TUTORIAL_TRACING,
 229     SP_VERB_TUTORIAL_CALLIGRAPHY,
 230     SP_VERB_TUTORIAL_DESIGN,
 231     SP_VERB_TUTORIAL_TIPS,
 232     /* Effects */
 233     SP_VERB_EFFECT_LAST,
 234     SP_VERB_EFFECT_LAST_PREF,
 235     /* Fit Canvas */
 236     SP_VERB_FIT_CANVAS_TO_SELECTION,
 237     SP_VERB_FIT_CANVAS_TO_DRAWING,
 238     SP_VERB_FIT_CANVAS_TO_SELECTION_OR_DRAWING,
 239     /* LockAndHide */
 240     SP_VERB_UNLOCK_ALL,
 241     SP_VERB_UNLOCK_ALL_IN_ALL_LAYERS,
 242     SP_VERB_UNHIDE_ALL,
 243     SP_VERB_UNHIDE_ALL_IN_ALL_LAYERS,
 244     /* Footer */
 245     SP_VERB_LAST
 246 };
 247
 248 gchar *sp_action_get_title (const SPAction *action);
 249
 250 #include <map>
 251
 252 namespace Inkscape {
 253
 254 /** \brief A class to represent things the user can do.  In many ways
 255            these are 'action factories' as they are used to create
 256            individual actions that are based on a given view.
 257 */
 258 class Verb {
 259 private:
 260     /** \brief An easy to use defition of the table of verbs by code. */
 261     typedef std::map<unsigned int, Inkscape::Verb *> VerbTable;
 262     /** \brief A table of all the dynamically created verbs. */
 263     static VerbTable _verbs;
 264     /** \brief The table of statically created verbs which are mostly
 265                'base verbs'. */
 266     static Verb * _base_verbs[SP_VERB_LAST + 1];
 267     /* Plus one because there is an entry for SP_VERB_LAST */
 268     /** A string comparison function to be used in the Verb ID lookup
 269         to find the different verbs in the hash map. */
 270     struct ltstr {
 271         bool operator()(const char* s1, const char* s2) const {
 272             if ( (s1 == NULL) && (s2 != NULL) ) {
 273                 return true;
 274             } else if (s1 == NULL || s2 == NULL) {
 275                 return false;
 276             } else {
 277                 return strcmp(s1, s2) < 0;
 278             }
 279         }
 280     };
 281     /** \brief An easy to use definition of the table of verbs by ID. */
 282     typedef std::map<gchar const *, Verb *, ltstr> VerbIDTable;
 283     /** \brief Quick lookup of verbs by ID */
 284     static VerbIDTable _verb_ids;
 285
 286     /** \brief A simple typedef to make using the action table easier. */
 287     typedef std::map<Inkscape::UI::View::View *, SPAction *> ActionTable;
 288     /** \brief A list of all the actions that have been created for this
 289                verb.  It is referenced by the view that they are created for. */
 290     ActionTable * _actions;
 291
 292     /** \brief A unique textual ID for the verb. */
 293     gchar const * _id;
 294     /** \brief The full name of the verb.  (shown on menu entries) */
 295     gchar const * _name;
 296     /** \brief Tooltip for the verb. */
 297     gchar const * _tip;
 298     /** \brief Name of the image that represents the verb. */
 299     gchar const * _image;
 300     /** \brief Unique numerical representation of the verb.  In most cases
 301                it is a value from the anonymous enum at the top of this
 302                file. */
 303     unsigned int  _code;
 304
 305     /** \brief Whether this verb is set to default to sensitive or
 306                insensitive when new actions are created. */
 307     bool _default_sensitive;
 308 protected:
 309     /** \brief Allows for preliminary setting of the \c _default_sensitive
 310                value without effecting existing actions
 311         \param in_val New value
 312
 313         This function is mostly used at initialization where there are
 314         not actions to effect.  I can't think of another case where it
 315         should be used.
 316     */
 317     bool set_default_sensitive (bool in_val) { return _default_sensitive = in_val; }
 318 public:
 319     /** \brief Accessor to get the \c _default_sensitive value */
 320     bool get_default_sensitive (void) { return _default_sensitive; }
 321
 322 public:
 323     /** \brief Accessor to get the internal variable. */
 324     unsigned int get_code (void) { return _code; }
 325     /** \brief Accessor to get the internal variable. */
 326     gchar const * get_id (void) { return _id; }
 327     /** \brief Accessor to get the internal variable. */
 328     gchar const * get_name (void) { return _name; }
 329     /** \brief Accessor to get the internal variable. */
 330     gchar const * get_tip (void) { return _tip; }
 331     /** \brief Accessor to get the internal variable. */
 332     gchar const * get_image (void) { return _image; }
 333
 334     /** \brief Set the name after initialization. */
 335     gchar const * set_name (gchar const * name) { _name = name; return _name; }
 336     /** \brief Set the tooltip after initialization. */
 337     gchar const * set_tip (gchar const * tip) { _tip = tip; return _tip; }
 338
 339 protected:
 340     SPAction * make_action_helper (Inkscape::UI::View::View * view, SPActionEventVector * vector, void * in_pntr = NULL);
 341     virtual SPAction * make_action (Inkscape::UI::View::View * view);
 342
 343 public:
 344     /** \brief Inititalizes the Verb with the parameters
 345         \param code  Goes to \c _code
 346         \param id    Goes to \c _id
 347         \param name  Goes to \c _name
 348         \param tip   Goes to \c _tip
 349         \param image Goes to \c _image
 350
 351         This function also sets \c _actions to NULL.
 352
 353         \warning NO DATA IS COPIED BY CALLING THIS FUNCTION.
 354
 355         In many respects this is very bad object oriented design, but it
 356         is done for a reason.  All verbs today are of two types: 1) static
 357         or 2) created for extension.  In the static case all of the
 358         strings are constants in the code, and thus don't really need to
 359         be copied.  In the extensions case the strings are identical to
 360         the ones already created in the extension object, copying them
 361         would be a waste of memory.
 362     */
 363     Verb(const unsigned int code,
 364          gchar const * id,
 365          gchar const * name,
 366          gchar const * tip,
 367          gchar const * image) :
 368         _actions(NULL), _id(id), _name(name), _tip(tip), _image(image), _code(code), _default_sensitive(true) {
 369         _verbs.insert(VerbTable::value_type(_code, this));
 370         _verb_ids.insert(VerbIDTable::value_type(_id, this));
 371     }
 372     Verb (gchar const * id, gchar const * name, gchar const * tip, gchar const * image);
 373     virtual ~Verb (void);
 374
 375     SPAction * get_action(Inkscape::UI::View::View * view);
 376
 377 private:
 378     static Verb * get_search (unsigned int code);
 379 public:
 380     /** \brief A function to turn a code into a verb.
 381         \param  code  The code to be translated
 382         \return A pointer to a verb object or a NULL if not found.
 383
 384         This is an inline function to translate the codes which are
 385         static quickly.  This should optimize into very quick code
 386         everywhere which hard coded \c codes are used.  In the case
 387         where the \c code is not static the \c get_search function
 388         is used.
 389     */
 390     static Verb * get (unsigned int code) {
 391         if (code <= SP_VERB_LAST) {
 392             return _base_verbs[code];
 393         } else {
 394             return get_search(code);
 395         }
 396     }
 397     static Verb * getbyid (gchar const * id);
 398
 399     static void delete_all_view (Inkscape::UI::View::View * view);
 400     void delete_view (Inkscape::UI::View::View * view);
 401
 402     void sensitive (SPDocument * in_doc = NULL, bool in_sensitive = true);
 403     void name (SPDocument * in_doc = NULL, Glib::ustring in_name = "");
 404
 405 // Yes, multiple public, protected and private sections are bad. We'll clean that up later
 406 protected:
 407     /** \brief Returns the size of the internal base verb array.
 408         \return The size in elements of the internal base array.
 409
 410         This is an inline function intended for testing. This should normally not be used.
 411         For testing, a subclass that returns this value can be created to verify that the
 412         length matches the enum values, etc.
 413     */
 414     static int _getBaseListSize(void) {return G_N_ELEMENTS(_base_verbs);}
 415
 416 public:
 417     static void list (void);
 418 }; /* Verb class */
 419
 420
 421 }  /* Inkscape namespace */
 422
 423 #endif // SEEN_SP_VERBS_H
 424
 425 /*
 426   Local Variables:
 427   mode:c++
 428   c-file-style:"stroustrup"
 429   c-file-offsets:((innamespace . 0)(inline-open . 0))
 430   indent-tabs-mode:nil
 431   fill-column:99
 432   End:
 433 */
 434 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4 :