gtk2_ardour/cursor_context.h

   1 /*
   2     Copyright (C) 2014 Paul Davis
   3     Author: David Robillard
   4
   5     This program is free software; you can redistribute it and/or modify
   6     it under the terms of the GNU General Public License as published by
   7     the Free Software Foundation; either version 2 of the License, or
   8     (at your option) any later version.
   9
  10     This program is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13     GNU General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License
  16     along with this program; if not, write to the Free Software
  17     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18 */
  19
  20 #ifndef __ardour_gtk_cursor_context_h__
  21 #define __ardour_gtk_cursor_context_h__
  22
  23 #include <boost/shared_ptr.hpp>
  24 #include <gdkmm/cursor.h>
  25
  26 class Editor;
  27
  28 /**
  29    A scoped handle for changing the editor mouse cursor.
  30
  31    This is a safe way to change the cursor that ensures it is only modified in
  32    a strict stack-like fashion.  Whenever this handle goes out of scope, the
  33    cursor is restored to the previous one.
  34
  35    This is not quite entirely fool-proof, there is one case to be careful of:
  36    if a cursor context handle exists, to change it, you must first reset that
  37    handle (destroying the context) then set it.  Assigning a new context to a
  38    non-NULL handle will create the new context (pushing a cursor), then destroy
  39    the old one, which would attempt to pop a non-top context which is an
  40    error.  To account for this, when replacing a possibly existing context, use
  41    set() which will automatically do the right thing.
  42 */
  43 class CursorContext
  44 {
  45 public:
  46         /** A smart handle for a cursor change context. */
  47         typedef boost::shared_ptr<CursorContext> Handle;
  48
  49         ~CursorContext();
  50
  51         /** Change the editor cursor and return a cursor context handle.
  52          *
  53          * When the returned handle goes out of scope, the cursor will be reset to
  54          * the previous value.
  55          */
  56         static Handle create(Editor& editor, Gdk::Cursor* cursor);
  57
  58         /** Change the editor cursor of an existing cursor context. */
  59         void change(Gdk::Cursor* cursor);
  60
  61         /** Set a context handle to a new context.
  62          *
  63          * If the handle points to an existing context, it will first be reset
  64          * before the new context is created.
  65          */
  66         static void set(Handle* handle, Editor& editor, Gdk::Cursor* cursor);
  67
  68 private:
  69         Editor&      _editor;
  70         size_t       _index;
  71
  72         CursorContext(Editor& editor, Gdk::Cursor* cursor);
  73 };
  74
  75 #endif /* __ardour_gtk_cursor_context_h__ */