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