libs/gtkmm2ext/gtkmm2ext/cairo_widget.h

   1 /*
   2     Copyright (C) 2009 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifndef __gtk2_ardour_cairo_widget_h__
  21 #define __gtk2_ardour_cairo_widget_h__
  22
  23 #include <cairomm/context.h>
  24 #include <cairomm/surface.h>
  25 #include <gtkmm/eventbox.h>
  26
  27 #include "gtkmm2ext/visibility.h"
  28 #include "gtkmm2ext/cairo_canvas.h"
  29 #include "gtkmm2ext/widget_state.h"
  30
  31 /** A parent class for widgets that are rendered using Cairo.
  32  */
  33
  34 class LIBGTKMM2EXT_API CairoWidget : public Gtk::EventBox, public Gtkmm2ext::CairoCanvas
  35 {
  36 public:
  37         CairoWidget ();
  38         virtual ~CairoWidget ();
  39
  40         void set_canvas_widget ();
  41         void use_nsglview ();
  42
  43         /* swizzle Gtk::Widget methods for Canvas::Widget */
  44         void queue_draw ();
  45         void queue_resize ();
  46         int get_width () const;
  47         int get_height () const;
  48         void size_allocate (Gtk::Allocation&);
  49
  50         void set_dirty (cairo_rectangle_t *area = 0);
  51
  52         Gtkmm2ext::ActiveState active_state() const { return _active_state; }
  53         Gtkmm2ext::VisualState visual_state() const { return _visual_state; }
  54
  55         /* derived widgets can override these two to catch
  56            changes in active & visual state
  57         */
  58
  59         virtual void set_active_state (Gtkmm2ext::ActiveState);
  60         virtual void set_visual_state (Gtkmm2ext::VisualState);
  61
  62         void unset_active_state () { set_active_state (Gtkmm2ext::Off); }
  63         void unset_visual_state () { set_visual_state (Gtkmm2ext::NoVisualState); }
  64
  65         /* this is an API simplification for widgets
  66            that only use the Active and Normal active states.
  67         */
  68         void set_active (bool);
  69         bool get_active () const { return active_state() != Gtkmm2ext::Off; }
  70
  71         /* widgets can be told to only draw their "foreground, and thus leave
  72            in place whatever background is drawn by their parent. the default
  73            is that the widget will fill its event window with the background
  74            color of the parent container.
  75         */
  76
  77         void set_draw_background (bool yn);
  78
  79         sigc::signal<void> StateChanged;
  80         sigc::signal<bool> QueueDraw;
  81         sigc::signal<bool> QueueResize;
  82
  83         static void provide_background_for_cairo_widget (Gtk::Widget& w, const Gdk::Color& bg);
  84
  85         uint32_t background_color ();
  86
  87         static void set_flat_buttons (bool yn);
  88         static bool flat_buttons() { return _flat_buttons; }
  89
  90         static void set_widget_prelight (bool yn);
  91         static bool widget_prelight() { return _widget_prelight; }
  92
  93         static void set_source_rgb_a( cairo_t* cr, Gdk::Color, float a=1.0 );
  94
  95         /* set_focus_handler() will cause all button-press events on any
  96            CairoWidget to invoke this slot/functor/function/method/callback.
  97
  98            We do this because in general, CairoWidgets do not grab
  99            keyboard focus, but a button press on them should
 100            clear focus from any active text entry.
 101
 102            This is global to all CairoWidgets and derived types.
 103
 104            However, derived types can override the behaviour by defining their
 105            own on_button_press_event() handler which returns true under all
 106            conditions (which will block this handler from being called). If
 107            they wish to invoke any existing focus handler from their own
 108            button press handler, they can just use: focus_handler();
 109         */
 110         static void set_focus_handler (sigc::slot<void,Gtk::Widget*>);
 111
 112 protected:
 113         /** Render the widget to the given Cairo context */
 114         virtual bool on_expose_event (GdkEventExpose *);
 115         void on_size_allocate (Gtk::Allocation &);
 116         void on_state_changed (Gtk::StateType);
 117         void on_style_changed (const Glib::RefPtr<Gtk::Style>&);
 118         void on_realize ();
 119         bool on_button_press_event (GdkEventButton*);
 120         Gdk::Color get_parent_bg ();
 121         void on_map();
 122         void on_unmap();
 123
 124         /* this is an additional virtual "on_..." method. Glibmm does not
 125            provide a direct signal for name changes, so this acts as a proxy.
 126         */
 127
 128         virtual void on_name_changed () {};
 129
 130         Gtkmm2ext::ActiveState _active_state;
 131         Gtkmm2ext::VisualState _visual_state;
 132         bool                   _need_bg;
 133
 134         static bool     _flat_buttons;
 135         static bool     _widget_prelight;
 136         bool            _grabbed;
 137
 138         static sigc::slot<void,Gtk::Widget*> focus_handler;
 139
 140   private:
 141         Cairo::RefPtr<Cairo::Surface> image_surface;
 142         Glib::SignalProxyProperty _name_proxy;
 143         sigc::connection _parent_style_change;
 144         Widget * _current_parent;
 145         bool _canvas_widget;
 146         void* _nsglview;
 147         Gdk::Rectangle _allocation;
 148
 149 };
 150
 151 #endif