'libs/evoral' - cast the returned pointers from malloc() / g_ptr_array_index() etc...
[ardour.git] / libs / gtkmm2ext / utils.cc
index a5768fad5ca05ed519019056eb5e8ce06e8201eb..f0a09d56857a2dbfa3adfdbc2aeb7d98e0669c5e 100644 (file)
 #include <gtk/gtkpaned.h>
 #include <gtk/gtk.h>
 
-#include <gtkmm2ext/utils.h>
 #include <gtkmm/widget.h>
 #include <gtkmm/button.h>
 #include <gtkmm/window.h>
 #include <gtkmm/paned.h>
+#include <gtkmm/label.h>
 #include <gtkmm/comboboxtext.h>
+#include <gtkmm/tooltip.h>
+
+#include "gtkmm2ext/utils.h"
 
 #include "i18n.h"
 
 using namespace std;
 
 void
-Gtkmm2ext::init ()
+Gtkmm2ext::init (const char* localedir)
 {
-       // Necessary for gettext
-       (void) bindtextdomain(PACKAGE, LOCALEDIR);
+#ifdef ENABLE_NLS
+       (void) bindtextdomain(PACKAGE, localedir);
+#endif
 }
 
 void
@@ -63,7 +67,6 @@ get_pixel_size (Glib::RefPtr<Pango::Layout> layout,
 void
 Gtkmm2ext::set_size_request_to_display_given_text (Gtk::Widget &w, const gchar *text,
                                                   gint hpadding, gint vpadding)
-       
 {
        int width, height;
        w.ensure_style ();
@@ -76,7 +79,6 @@ void
 Gtkmm2ext::set_size_request_to_display_given_text (Gtk::Widget &w, 
                                                   const std::vector<std::string>& strings,
                                                   gint hpadding, gint vpadding)
-       
 {
        int width, height;
        int width_max = 0;
@@ -94,7 +96,7 @@ Gtkmm2ext::set_size_request_to_display_given_text (Gtk::Widget &w,
         }
        
         if (i == strings.end()) {
-                /* make a copy of the strings then add one that has a descener */
+                /* make a copy of the strings then add one that has a descender */
                 copy = strings;
                 copy.push_back ("g");
                 to_use = &copy;
@@ -220,16 +222,12 @@ Gtkmm2ext::pixbuf_from_string(const string& name, const Pango::FontDescription&
 }
 
 void
-Gtkmm2ext::set_popdown_strings (Gtk::ComboBoxText& cr, const vector<string>& strings, bool set_size, gint hpadding, gint vpadding)
+Gtkmm2ext::set_popdown_strings (Gtk::ComboBoxText& cr, const vector<string>& strings)
 {
        vector<string>::const_iterator i;
 
        cr.clear ();
 
-       if (set_size) {
-                set_size_request_to_display_given_text (cr, strings, COMBO_FUDGE+10+hpadding, 15+vpadding); 
-       }
-
        for (i = strings.begin(); i != strings.end(); ++i) {
                cr.append_text (*i);
        }
@@ -387,87 +385,141 @@ Gtkmm2ext::container_clear (Gtk::Container& c)
         }
 }
 
-#if 1
 void
 Gtkmm2ext::rounded_rectangle (Cairo::RefPtr<Cairo::Context> context, double x, double y, double w, double h, double r)
 {
-        /* renders small shapes better than most others */
+       rounded_rectangle (context->cobj(), x, y, w, h, r);
+}
+void
+Gtkmm2ext::rounded_top_rectangle (Cairo::RefPtr<Cairo::Context> context, double x, double y, double w, double h, double r)
+{
+       rounded_top_rectangle (context->cobj(), x, y, w, h, r);
+}
+void
+Gtkmm2ext::rounded_top_left_rectangle (Cairo::RefPtr<Cairo::Context> context, double x, double y, double w, double h, double r)
+{
+       rounded_top_left_rectangle (context->cobj(), x, y, w, h, r);
+}
+void
+Gtkmm2ext::rounded_top_right_rectangle (Cairo::RefPtr<Cairo::Context> context, double x, double y, double w, double h, double r)
+{
+       rounded_top_right_rectangle (context->cobj(), x, y, w, h, r);
+}
+void
+Gtkmm2ext::rounded_top_half_rectangle (Cairo::RefPtr<Cairo::Context> context, double x, double y, double w, double h, double r)
+{
+       rounded_top_half_rectangle (context->cobj(), x, y, w, h, r);
+}
+void
+Gtkmm2ext::rounded_bottom_half_rectangle (Cairo::RefPtr<Cairo::Context> context, double x, double y, double w, double h, double r)
+{
+       rounded_bottom_half_rectangle (context->cobj(), x, y, w, h, r);
+}
+void
+Gtkmm2ext::rounded_right_half_rectangle (Cairo::RefPtr<Cairo::Context> context, double x, double y, double w, double h, double r)
+{
+       rounded_right_half_rectangle (context->cobj(), x, y, w, h, r);
+}
 
-/*    A****BQ
-      H    C
-      *    *
-      G    D
-      F****E
-*/
-        context->move_to(x+r,y); // Move to A
-        context->line_to(x+w-r,y); // Straight line to B
-        context->curve_to(x+w,y,x+w,y,x+w,y+r); // Curve to C, Control points are both at Q
-        context->line_to(x+w,y+h-r); // Move to D
-        context->curve_to(x+w,y+h,x+w,y+h,x+w-r,y+h); // Curve to E
-        context->line_to(x+r,y+h); // Line to F
-        context->curve_to(x,y+h,x,y+h,x,y+h-r); // Curve to G
-        context->line_to(x,y+r); // Line to H
-        context->curve_to(x,y,x,y,x+r,y); // Curve to A
+void
+Gtkmm2ext::rounded_rectangle (cairo_t* cr, double x, double y, double w, double h, double r)
+{
+       double degrees = M_PI / 180.0;
+
+       cairo_new_sub_path (cr);
+       cairo_arc (cr, x + w - r, y + r, r, -90 * degrees, 0 * degrees);  //tr
+       cairo_arc (cr, x + w - r, y + h - r, r, 0 * degrees, 90 * degrees);  //br
+       cairo_arc (cr, x + r, y + h - r, r, 90 * degrees, 180 * degrees);  //bl
+       cairo_arc (cr, x + r, y + r, r, 180 * degrees, 270 * degrees);  //tl
+       cairo_close_path (cr);
 }
 
-#else
+void
+Gtkmm2ext::rounded_right_half_rectangle (cairo_t* cr, double x, double y, double w, double h, double r)
+{
+       double degrees = M_PI / 180.0;
+
+       cairo_new_sub_path (cr);
+       cairo_arc (cr, x + w - r, y + r, r, -90 * degrees, 0 * degrees);  //tr
+       cairo_arc (cr, x + w - r, y + h - r, r, 0 * degrees, 90 * degrees);  //br
+       cairo_line_to (cr, x, y + h); // bl
+       cairo_line_to (cr, x, y); // tl
+       cairo_close_path (cr);
+}
 
 void
-Gtkmm2ext::rounded_rectangle (Cairo::RefPtr<Cairo::Context> context, double x, double y, double width, double height, double radius)
-{
-        /* doesn't render small shapes well at all, and does not absolutely honor width & height */
-
-        double x0          = x+radius/2.0;
-        double y0          = y+radius/2.0;
-        double rect_width  = width - radius;
-        double rect_height = height - radius;
-
-        context->save();
-
-        double x1=x0+rect_width;
-        double y1=y0+rect_height;
-
-        if (rect_width/2<radius) {
-                if (rect_height/2<radius) {
-                        context->move_to  (x0, (y0 + y1)/2);
-                        context->curve_to (x0 ,y0, x0, y0, (x0 + x1)/2, y0);
-                        context->curve_to (x1, y0, x1, y0, x1, (y0 + y1)/2);
-                        context->curve_to (x1, y1, x1, y1, (x1 + x0)/2, y1);
-                        context->curve_to (x0, y1, x0, y1, x0, (y0 + y1)/2);
-                } else {
-                        context->move_to  (x0, y0 + radius);
-                        context->curve_to (x0 ,y0, x0, y0, (x0 + x1)/2, y0);
-                        context->curve_to (x1, y0, x1, y0, x1, y0 + radius);
-                        context->line_to (x1 , y1 - radius);
-                        context->curve_to (x1, y1, x1, y1, (x1 + x0)/2, y1);
-                        context->curve_to (x0, y1, x0, y1, x0, y1- radius);
-                }
-        } else {
-                if (rect_height/2<radius) {
-                        context->move_to  (x0, (y0 + y1)/2);
-                        context->curve_to (x0 , y0, x0 , y0, x0 + radius, y0);
-                        context->line_to (x1 - radius, y0);
-                        context->curve_to (x1, y0, x1, y0, x1, (y0 + y1)/2);
-                        context->curve_to (x1, y1, x1, y1, x1 - radius, y1);
-                        context->line_to (x0 + radius, y1);
-                        context->curve_to (x0, y1, x0, y1, x0, (y0 + y1)/2);
-                } else {
-                        context->move_to  (x0, y0 + radius);
-                        context->curve_to (x0 , y0, x0 , y0, x0 + radius, y0);
-                        context->line_to (x1 - radius, y0);
-                        context->curve_to (x1, y0, x1, y0, x1, y0 + radius);
-                        context->line_to (x1 , y1 - radius);
-                        context->curve_to (x1, y1, x1, y1, x1 - radius, y1);
-                        context->line_to (x0 + radius, y1);
-                        context->curve_to (x0, y1, x0, y1, x0, y1- radius);
-                }
-        }
+Gtkmm2ext::rounded_top_half_rectangle (cairo_t* cr, double x, double y, double w, double h, double r)
+{
+       double degrees = M_PI / 180.0;
+
+       cairo_new_sub_path (cr);
+       cairo_move_to (cr, x+w, y+h);
+       cairo_line_to (cr, x, y+h);
+       cairo_arc (cr, x + r, y + r, r, 180 * degrees, 270 * degrees);  //tl
+       cairo_arc (cr, x + w - r, y + r, r, -90 * degrees, 0 * degrees);  //tr
+       cairo_close_path (cr);
+}
 
-        context->close_path ();
-        context->restore();
+void
+Gtkmm2ext::rounded_bottom_half_rectangle (cairo_t* cr, double x, double y, double w, double h, double r)
+{
+       double degrees = M_PI / 180.0;
+
+       cairo_new_sub_path (cr);
+       cairo_move_to (cr, x, y);
+       cairo_line_to (cr, x+w, y);
+       cairo_arc (cr, x + w - r, y + h - r, r, 0 * degrees, 90 * degrees);  //br
+       cairo_arc (cr, x + r, y + h - r, r, 90 * degrees, 180 * degrees);  //bl
+       cairo_close_path (cr);
 }
 
-#endif
+
+void
+Gtkmm2ext::rounded_top_rectangle (cairo_t* cr, double x, double y, double w, double h, double r)
+{
+       double degrees = M_PI / 180.0;
+
+       cairo_new_sub_path (cr);
+       cairo_move_to (cr, x+w, y+h);
+       cairo_line_to (cr, x, y+h);
+       cairo_arc (cr, x + r, y + r, r, 180 * degrees, 270 * degrees);  //tl
+       cairo_arc (cr, x + w - r, y + r, r, -90 * degrees, 0 * degrees);  //tr
+       cairo_close_path (cr);
+}
+
+void
+Gtkmm2ext::rounded_top_left_rectangle (cairo_t* cr, double x, double y, double w, double h, double r)
+{
+/*    A****B
+      H    *
+      *    *
+      *    *
+      F****E
+*/
+       cairo_move_to (cr, x+r,y); // Move to A
+       cairo_line_to (cr, x+w,y); // Straight line to B
+       cairo_line_to (cr, x+w,y+h); // Move to E
+       cairo_line_to (cr, x,y+h); // Line to F
+       cairo_line_to (cr, x,y+r); // Line to H
+       cairo_curve_to (cr, x,y,x,y,x+r,y); // Curve to A
+}
+
+void
+Gtkmm2ext::rounded_top_right_rectangle (cairo_t* cr, double x, double y, double w, double h, double r)
+{
+/*    A****BQ
+      *    C
+      *    *
+      *    *
+      F****E
+*/
+       cairo_move_to (cr, x,y); // Move to A
+       cairo_line_to (cr, x+w-r,y); // Straight line to B
+       cairo_curve_to (cr, x+w,y,x+w,y,x+w,y+r); // Curve to C, Control points are both at Q
+       cairo_line_to (cr, x+w,y+h); // Move to E
+       cairo_line_to (cr, x,y+h); // Line to F
+       cairo_line_to (cr, x,y); // Line to A
+}
 
 Glib::RefPtr<Gdk::Window>
 Gtkmm2ext::window_to_draw_on (Gtk::Widget& w, Gtk::Widget** parent)
@@ -488,3 +540,124 @@ Gtkmm2ext::window_to_draw_on (Gtk::Widget& w, Gtk::Widget** parent)
        return Glib::RefPtr<Gdk::Window> ();
 }
 
+int
+Gtkmm2ext::pixel_width (const string& str, Pango::FontDescription& font)
+{
+       Gtk::Label foo;
+       Glib::RefPtr<Pango::Layout> layout = foo.create_pango_layout ("");
+
+       layout->set_font_description (font);
+       layout->set_text (str);
+
+       int width, height;
+       Gtkmm2ext::get_ink_pixel_size (layout, width, height);
+       return width;
+}
+
+#if 0
+string
+Gtkmm2ext::fit_to_pixels (const string& str, int pixel_width, Pango::FontDescription& font, int& actual_width, bool with_ellipses)
+{
+       /* DECEMBER 2011: THIS PROTOTYPE OF fit_to_pixels() IS NOT USED
+          ANYWHERE AND HAS NOT BEEN TESTED.
+       */
+       Gtk::Label foo;
+       Glib::RefPtr<Pango::Layout> layout = foo.create_pango_layout (str);
+       Glib::RefPtr<const Pango::LayoutLine> line;
+
+       layout->set_font_description (font);
+       layout->set_width (pixel_width * PANGO_SCALE);
+
+       if (with_ellipses) {
+               layout->set_ellipsize (Pango::ELLIPSIZE_END);
+       } else {
+               layout->set_wrap (Pango::WRAP_CHAR);
+       }
+
+       line = layout->get_line (0);
+
+       /* XXX: might need special care to get the ellipsis character, not sure
+           how that works 
+       */      
+
+       string s = string (layout->get_text ().substr(line->get_start_index(), line->get_length()));
+       
+       cerr << "fit to pixels of " << str << " returns " << s << endl;
+
+       return s;
+}
+#endif
+
+/** Try to fit a string into a given horizontal space by ellipsizing it.
+ *  @param cr Cairo context in which the text will be plotted.
+ *  @param name Text.
+ *  @param avail Available horizontal space.
+ *  @return (Text, possibly ellipsized) and (horizontal size of text)
+ */
+
+std::pair<std::string, double>
+Gtkmm2ext::fit_to_pixels (cairo_t* cr, std::string name, double avail)
+{
+       /* XXX hopefully there exists a more efficient way of doing this */
+
+       bool abbreviated = false;
+       uint32_t width = 0;
+
+       while (1) {
+               cairo_text_extents_t ext;
+               cairo_text_extents (cr, name.c_str(), &ext);
+
+               if (ext.width < avail || name.length() <= 4) {
+                       width = ext.width;
+                       break;
+               }
+
+               if (abbreviated) {
+                       name = name.substr (0, name.length() - 4) + "...";
+               } else {
+                       name = name.substr (0, name.length() - 3) + "...";
+                       abbreviated = true;
+               }
+       }
+
+       return std::make_pair (name, width);
+}
+
+Gtk::Label *
+Gtkmm2ext::left_aligned_label (string const & t)
+{
+       Gtk::Label* l = new Gtk::Label (t);
+       l->set_alignment (0, 0.5);
+       return l;
+}
+
+static bool
+make_null_tooltip (int, int, bool, const Glib::RefPtr<Gtk::Tooltip>& t)
+{
+       t->set_tip_area (Gdk::Rectangle (0, 0, 0, 0));
+       return true;
+}
+
+/** Hackily arrange for the provided widget to have no tooltip,
+ *  and also to stop any other widget from providing one while
+ * the mouse is over w.
+ */
+void
+Gtkmm2ext::set_no_tooltip_whatsoever (Gtk::Widget& w)
+{
+       w.property_has_tooltip() = true;
+       w.signal_query_tooltip().connect (sigc::ptr_fun (make_null_tooltip));
+}
+
+void
+Gtkmm2ext::enable_tooltips ()
+{
+       gtk_rc_parse_string ("gtk-enable-tooltips = 1");
+}
+
+void
+Gtkmm2ext::disable_tooltips ()
+{
+       gtk_rc_parse_string ("gtk-enable-tooltips = 0");
+}
+