move show_gdk_event_state() utility function from gtk2_ardour to libs/gtkmm2ext
[ardour.git] / gtk2_ardour / utils.h
1 /*
2     Copyright (C) 2002 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 __ardour_gtk_utils_h__
21 #define __ardour_gtk_utils_h__
22
23 #include <string>
24 #include <cmath>
25 #include <vector>
26 #include <map>
27
28 #include "ardour/types.h"
29
30 #include <gdkmm/types.h>
31 #include <gtkmm/menushell.h>
32
33 #include "canvas/types.h"
34
35 namespace PBD {
36         class Controllable;
37         class ScopedConnectionList;
38 }
39
40 namespace Gtk {
41         class Window;
42         class ComboBoxText;
43         class Adjustment;
44 }
45
46 namespace ArdourCanvas {
47         class Item;
48 }
49
50 namespace ARDOUR_UI_UTILS {
51
52 gint   just_hide_it (GdkEventAny*, Gtk::Window*);
53 void add_item_with_sensitivity (Gtk::Menu_Helpers::MenuList &, Gtk::Menu_Helpers::MenuElem, bool);
54
55 unsigned char* xpm2rgb  (const char** xpm, uint32_t& w, uint32_t& h);
56 unsigned char* xpm2rgba (const char** xpm, uint32_t& w, uint32_t& h);
57
58 ArdourCanvas::Points* get_canvas_points (std::string who, uint32_t npoints);
59
60 Pango::FontDescription sanitized_font (std::string const&);
61 Pango::FontDescription get_font_for_style (std::string widgetname);
62
63 void decorate (Gtk::Window& w, Gdk::WMDecoration d);
64
65 Gdk::Color gdk_color_from_rgb (uint32_t);
66 Gdk::Color gdk_color_from_rgba (uint32_t);
67 uint32_t gdk_color_to_rgba (Gdk::Color const&);
68
69 void set_color_from_rgb (Gdk::Color&, uint32_t);
70 void set_color_from_rgba (Gdk::Color&, uint32_t);
71
72 uint32_t contrasting_text_color (uint32_t c);
73
74 bool relay_key_press (GdkEventKey* ev, Gtk::Window* win);
75 bool key_press_focus_accelerator_handler (Gtk::Window& window, GdkEventKey* ev);
76 bool emulate_key_event (unsigned int);
77
78 Glib::RefPtr<Gdk::Pixbuf> get_xpm (std::string);
79 std::vector<std::string> get_icon_sets ();
80 void get_color_themes (std::map<std::string,std::string>&);
81 std::string get_icon_path (const char*, std::string icon_set = std::string(), bool is_image = true);
82 Glib::RefPtr<Gdk::Pixbuf> get_icon (const char*, std::string icon_set = std::string());
83 static std::map<std::string, Glib::RefPtr<Gdk::Pixbuf> > xpm_map;
84 const char* const *get_xpm_data (std::string path);
85 std::string longest (std::vector<std::string>&);
86 bool key_is_legal_for_numeric_entry (guint keyval);
87
88 void resize_window_to_proportion_of_monitor (Gtk::Window*, int, int);
89
90 std::string escape_underscores (std::string const &);
91
92 Gdk::Color unique_random_color (std::list<Gdk::Color> &);
93
94 std::string rate_as_string (float r);
95
96 bool windows_overlap (Gtk::Window *a, Gtk::Window *b);
97
98 bool overwrite_file_dialog (Gtk::Window& parent, std::string title, std::string text);
99 bool running_from_source_tree ();
100
101 } // namespace
102 #endif /* __ardour_gtk_utils_h__ */