libs/gtkmm2ext/gtkmm2ext/gtk_ui.h

   1 /*
   2     Copyright (C) 1999 Paul Barton-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 __pbd_gtk_ui_h__
  21 #define __pbd_gtk_ui_h__
  22
  23 #include <string>
  24 #include <map>
  25
  26 #include <stdint.h>
  27 #include <setjmp.h>
  28 #include <pthread.h>
  29
  30 #include <glibmm/thread.h>
  31
  32 #include <gtkmm/widget.h>
  33 #include <gtkmm/style.h>
  34 #ifndef GTK_NEW_TOOLTIP_API
  35 #include <gtkmm/tooltips.h>
  36 #endif
  37 #include <gtkmm/textbuffer.h>
  38 #include <gtkmm/main.h>
  39 #include <gdkmm/color.h>
  40 #include <pbd/abstract_ui.h>
  41 #include <pbd/ringbufferNPT.h>
  42
  43 #include <pbd/pool.h>
  44 #include <pbd/error.h>
  45 #include <pbd/receiver.h>
  46
  47 class Touchable;
  48
  49 namespace Gtkmm2ext {
  50
  51 class TextViewer;
  52
  53 extern BaseUI::RequestType ErrorMessage;
  54 extern BaseUI::RequestType CallSlot;
  55 extern BaseUI::RequestType TouchDisplay;
  56 extern BaseUI::RequestType StateChange;
  57 extern BaseUI::RequestType SetTip;
  58 extern BaseUI::RequestType AddIdle;
  59 extern BaseUI::RequestType AddTimeout;
  60
  61 struct UIRequest : public BaseUI::BaseRequestObject {
  62
  63      /* this once used anonymous unions to merge elements
  64         that are never part of the same request. that makes
  65         the creation of a legal copy constructor difficult
  66         because of the semantics of the slot member.
  67      */
  68
  69     Touchable *display;
  70     const char *msg;
  71     Gtk::StateType new_state;
  72     int (*function)(void *);
  73     Gtk::Widget *widget;
  74     Transmitter::Channel chn;
  75     void *arg;
  76     const char *msg2;
  77
  78     ~UIRequest () {
  79             if (type == ErrorMessage && msg) {
  80                     /* msg was strdup()'ed */
  81                     free ((char *)msg);
  82             }
  83     }
  84 };
  85
  86 class UI : public Receiver, public AbstractUI<UIRequest>
  87 {
  88   public:
  89         UI (std::string name, int *argc, char **argv[]);
  90         virtual ~UI ();
  91
  92         static UI *instance() { return theGtkUI; }
  93
  94         /* receiver interface */
  95
  96         void receive (Transmitter::Channel, const char *);
  97
  98         /* Abstract UI interfaces */
  99
 100         bool caller_is_ui_thread ();
 101
 102         static Glib::Thread* thread_id() { return gui_thread; }
 103
 104         /* Gtk-UI specific interfaces */
 105
 106         bool running ();
 107         void quit    ();
 108         int  load_rcfile (std::string, bool themechange = false);
 109         void run (Receiver &old_receiver);
 110
 111         void set_state (Gtk::Widget *w, Gtk::StateType state);
 112         void popup_error (const char *text);
 113         void flush_pending ();
 114         void toggle_errors ();
 115         void touch_display (Touchable *);
 116         void set_tip (Gtk::Widget *w, const gchar *tip, const gchar *hlp);
 117         void idle_add (int (*func)(void *), void *arg);
 118
 119         Gtk::Main& main() const { return *theMain; }
 120
 121         template<class T> static bool idle_delete (T *obj) { delete obj; return false; }
 122         template<class T> static void delete_when_idle (T *obj) {
 123                 Glib::signal_idle().connect (bind (slot (&UI::idle_delete<T>), obj));
 124         }
 125
 126         Gdk::Color get_color (const std::string& prompt, bool& picked, const Gdk::Color *initial = 0);
 127
 128         /* starting is sent just before we enter the main loop,
 129            stopping just after we return from it (at the top level)
 130         */
 131
 132         sigc::signal<void> starting;
 133         sigc::signal<void> stopping;
 134
 135         sigc::signal<void> theme_changed;
 136
 137         static bool just_hide_it (GdkEventAny *, Gtk::Window *);
 138
 139         static Glib::Thread* the_gui_thread() { return gui_thread; }
 140
 141   protected:
 142         virtual void handle_fatal (const char *);
 143         virtual void display_message (const char *prefix, gint prefix_len,
 144                         Glib::RefPtr<Gtk::TextBuffer::Tag> ptag, Glib::RefPtr<Gtk::TextBuffer::Tag> mtag,
 145                         const char *msg);
 146
 147   private:
 148         static UI *theGtkUI;
 149         static Glib::Thread* gui_thread;
 150         bool _active;
 151         Gtk::Main *theMain;
 152 #ifndef GTK_NEW_TOOLTIP_API
 153         Gtk::Tooltips *tips;
 154 #endif
 155         TextViewer *errors;
 156         Glib::RefPtr<Gtk::TextBuffer::Tag> error_ptag;
 157         Glib::RefPtr<Gtk::TextBuffer::Tag> error_mtag;
 158         Glib::RefPtr<Gtk::TextBuffer::Tag> fatal_ptag;
 159         Glib::RefPtr<Gtk::TextBuffer::Tag> fatal_mtag;
 160         Glib::RefPtr<Gtk::TextBuffer::Tag> info_ptag;
 161         Glib::RefPtr<Gtk::TextBuffer::Tag> info_mtag;
 162         Glib::RefPtr<Gtk::TextBuffer::Tag> warning_ptag;
 163         Glib::RefPtr<Gtk::TextBuffer::Tag> warning_mtag;
 164
 165         static void signal_pipe_callback (void *, gint, GdkInputCondition);
 166         void process_error_message (Transmitter::Channel, const char *);
 167         void do_quit ();
 168
 169         void color_selection_done (bool status);
 170         bool color_selection_deleted (GdkEventAny *);
 171         bool color_picked;
 172
 173         void do_request (UIRequest*);
 174 };
 175
 176 } /* namespace */
 177
 178 #endif /* __pbd_gtk_ui_h__ */