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