src/ui/view/edit-widget-interface.h

   1 /**
   2  * \file
   3  *
   4  * Abstract base class for all EditWidget implementations.
   5  *
   6  * Authors:
   7  *     Ralf Stephan <ralf@ark.in-berlin.de>
   8  *     John Bintz <jcoswell@coswellproductions.org>
   9  *
  10  * Copyright (C) 2006 John Bintz
  11  * Copyright (C) 2005 Ralf Stephan
  12  *
  13  * Released under GNU GPL.  Read the file 'COPYING' for more information.
  14  */
  15
  16 #ifndef INKSCAPE_UI_VIEW_EDIT_WIDGET_IFACE_H
  17 #define INKSCAPE_UI_VIEW_EDIT_WIDGET_IFACE_H
  18
  19 #include "gdk/gdktypes.h"
  20 #include "libnr/nr-point.h"
  21 #include "message.h"
  22
  23 namespace Inkscape {
  24 namespace UI {
  25 namespace View {
  26
  27 struct EditWidgetInterface
  28 {
  29     EditWidgetInterface() {}
  30     virtual ~EditWidgetInterface() {}
  31
  32     /// Returns pointer to window UI object as void*
  33     virtual void *getWindow() = 0;
  34
  35     /// Set the widget's title
  36     virtual void setTitle (gchar const*) = 0;
  37
  38     /// Show all parts of widget the user wants to see.
  39     virtual void layout() = 0;
  40
  41     /// Present widget to user
  42     virtual void present() = 0;
  43
  44     /// Returns geometry of widget
  45     virtual void getGeometry (gint &x, gint &y, gint &w, gint &h) = 0;
  46
  47     /// Change the widget's size
  48     virtual void setSize (gint w, gint h) = 0;
  49
  50     /// Move widget to specified position
  51     virtual void setPosition (NR::Point p) = 0;
  52
  53     /// Transientize widget
  54     virtual void setTransient (void*, int) = 0;
  55
  56     /// Return mouse position in widget
  57     virtual NR::Point getPointer() = 0;
  58
  59     /// Make widget iconified
  60     virtual void setIconified() = 0;
  61
  62     /// Make widget maximized on screen
  63     virtual void setMaximized() = 0;
  64
  65     /// Make widget fill screen and show it if possible.
  66     virtual void setFullscreen() = 0;
  67
  68     /// Shuts down the desktop object for the view being closed.  It checks
  69     /// to see if the document has been edited, and if so prompts the user
  70     /// to save, discard, or cancel.  Returns TRUE if the shutdown operation
  71     /// is cancelled or if the save is cancelled or fails, FALSE otherwise.
  72     virtual bool shutdown() = 0;
  73
  74     /// Destroy and delete widget.
  75     virtual void destroy() = 0;
  76
  77
  78     /// Queue a redraw request with the canvas
  79     virtual void requestCanvasUpdate() = 0;
  80
  81     /// Force a redraw of the canvas
  82     virtual void requestCanvasUpdateAndWait() = 0;
  83
  84     /// Enable interaction on this desktop
  85     virtual void enableInteraction() = 0;
  86
  87     /// Disable interaction on this desktop
  88     virtual void disableInteraction() = 0;
  89
  90     /// Update the "active desktop" indicator
  91     virtual void activateDesktop() = 0;
  92
  93     /// Update the "inactive desktop" indicator
  94     virtual void deactivateDesktop() = 0;
  95
  96     /// Set rulers to position
  97     virtual void viewSetPosition (NR::Point p) = 0;
  98
  99     /// Update rulers from current values
 100     virtual void updateRulers() = 0;
 101
 102     /// Update scrollbars from current values
 103     virtual void updateScrollbars (double scale) = 0;
 104
 105     /// Toggle rulers on/off and set preference value accordingly
 106     virtual void toggleRulers() = 0;
 107
 108     /// Toggle scrollbars on/off and set preference value accordingly
 109     virtual void toggleScrollbars() = 0;
 110
 111     /// Temporarily block signals and update zoom display
 112     virtual void updateZoom() = 0;
 113
 114     /// The zoom display will get the keyboard focus.
 115     virtual void letZoomGrabFocus() = 0;
 116
 117     /// In auxiliary toolbox, set focus to widget having specific id
 118     virtual void setToolboxFocusTo (const gchar *) = 0;
 119
 120     /// In auxiliary toolbox, set value of adjustment with specific id
 121     virtual void setToolboxAdjustmentValue (const gchar *, double) = 0;
 122
 123     /// In auxiliary toolbox, return true if specific togglebutton is active
 124     virtual bool isToolboxButtonActive (gchar const*) = 0;
 125
 126     /// Set the coordinate display
 127     virtual void setCoordinateStatus (NR::Point p) = 0;
 128
 129     /// Message widget will get no content
 130     virtual void setMessage (Inkscape::MessageType type, gchar const* msg) = 0;
 131
 132     /// Open yes/no dialog with warning text and confirmation question.
 133     virtual bool warnDialog (gchar*) = 0;
 134 };
 135
 136 } // namespace View
 137 } // namespace UI
 138 } // namespace Inkscape
 139
 140 #endif // INKSCAPE_UI_VIEW_EDIT_WIDGET_IFACE_H
 141
 142 /*
 143   Local Variables:
 144   mode:c++
 145   c-file-style:"stroustrup"
 146   c-file-offsets:((innamespace . 0)(inline-open . 0)(case-label . +))
 147   indent-tabs-mode:nil
 148   fill-column:99
 149   End:
 150 */
 151 // vim: filetype=cpp:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=99 :