GtkHelper.vala

Go to the documentation of this file.

 
 
using TeeJee.Logging;
using TeeJee.FileSystem;
using TeeJee.JsonHelper;
using TeeJee.ProcessHelper;
using TeeJee.System;
using TeeJee.Misc;
 
namespace TeeJee.GtkHelper{
 
    using Gtk;
 
    // messages -----------
    
    public void gtk_do_events (){
 
        /* Do pending events */
 
        while (GLib.MainContext.default().pending())
            GLib.MainContext.default().iteration(false);
    }
 
    public void gtk_set_busy (bool busy, Gtk.Window win) {
 
        /* Show or hide busy cursor on window */
        if (busy)
            win.set_cursor_from_name("wait");
        else
            win.set_cursor_from_name(null);
 
        gtk_do_events ();
    }
 
    public static void gtk_messagebox(string title, string message, Gtk.Window? parent_win, bool is_error = false){
 
        /* Shows a simple message box */
 
        Gtk.MessageType type = is_error ? Gtk.MessageType.ERROR : Gtk.MessageType.INFO;
 
        var dlg = new CustomMessageDialog(title,message,type,parent_win, Gtk.ButtonsType.OK);
        dlg.present();
        dlg.destroy();
    }
 
    public string? gtk_inputbox(string title, string message, Gtk.Window? parent_win, bool mask_password = false){
 
        Gtk.Box vbox_main = new Gtk.Box(Orientation.VERTICAL, 0);
        vbox_main.margin_start = 0;
        vbox_main.margin_end = 0;
        vbox_main.margin_top = 0;
        vbox_main.margin_bottom = 0;
 
        Gtk.Label lbl_input = new Gtk.Label(title);
        lbl_input.xalign = (float) 0.0;
        lbl_input.label = message;
 
        Gtk.Entry txt_input = new Gtk.Entry();
        txt_input.margin_top = 3;
        txt_input.set_visibility(!mask_password);
 
        var dlg = new Gtk.Dialog.with_buttons(title, parent_win, DialogFlags.MODAL);
        dlg.title = title;
        dlg.set_default_size (300, -1);
        if (parent_win != null){
            dlg.set_transient_for(parent_win);
            dlg.set_modal(true);
        }
 
        var content = (Box) dlg.get_content_area ();
        vbox_main.append (lbl_input);
        vbox_main.append (txt_input);
        content.append(vbox_main);
        content.margin_start = 6;
        content.margin_end = 6;
        content.margin_top = 6;
        content.margin_bottom = 6;
        dlg.add_button(_("OK"),Gtk.ResponseType.OK);
        dlg.add_button(_("Cancel"),Gtk.ResponseType.CANCEL);
        txt_input.activate.connect (() => { dlg.response(Gtk.ResponseType.OK); });
 
        int response = gtk_dialog_run(dlg);
        string input_text = txt_input.text;
        dlg.destroy();
 
        if (response == Gtk.ResponseType.CANCEL){
            return null;
        }
        else{
            return input_text;
        }
    }
 
    public void wait_and_close_window(int milliseconds, Gtk.Window window){
        gtk_do_events();
        int millis = 0;
        while(millis < milliseconds){
            sleep(200);
            millis += 200;
            gtk_do_events();
        }
        window.destroy();
    }
    
    // combo ---------
    
    
    public int gtk_dialog_run(Gtk.Dialog dlg){
        int result = Gtk.ResponseType.CLOSE;
        var loop = new GLib.MainLoop(null, false);
        dlg.response.connect((response_id) => { result = response_id; loop.quit(); });
        dlg.close_request.connect(() => { result = Gtk.ResponseType.CLOSE; if (loop.is_running()) loop.quit(); return false; });
        dlg.present();
        loop.run();
        return result;
    }
 
    public bool gtk_combobox_set_value (Gtk.ComboBoxText combo, int index, string val){
 
        /* Convenience function to set combobox value */
 
        for (int i = 0; ; i++) {
            combo.active = i;
            var text = combo.get_active_text();
            if (text == null) {
                combo.active = -1;
                return false;
            }
            if (text == val) {
                return true;
            }
        }
    }
 
    public string gtk_combobox_get_value (Gtk.ComboBoxText combo, int index, string default_value){
 
        /* Convenience function to get combobox value */
 
        var text = combo.get_active_text();
        return (text != null) ? text : default_value;
    }
 
    // utility ------------------
 
    // add_stack
    public static Gtk.Stack add_notebook(Gtk.Box box, bool show_tabs = true, bool show_border = true){
 
        var stack = new Gtk.Stack();
        stack.margin_start = 0;
        stack.margin_end = 0;
        stack.margin_top = 0;
        stack.margin_bottom = 0;
        stack.hexpand = true;
        stack.vexpand = true;
        box.append(stack);
 
        return stack;
    }
 
    // add_listbox
    public static Gtk.ListBox add_treeview(Gtk.Box box, Gtk.SelectionMode selection_mode = Gtk.SelectionMode.SINGLE){
 
        var listbox = new Gtk.ListBox();
        listbox.selection_mode = selection_mode;
 
        var scrollwin = new Gtk.ScrolledWindow();
        scrollwin.set_child(listbox);
        scrollwin.hexpand = true;
        scrollwin.vexpand = true;
        box.append(scrollwin);
 
        return listbox;
    }
 
    // GTK4 compatibility shim: tree columns were removed.
    public static Gtk.Label add_column_text(Gtk.ListBox listbox, string title, out Gtk.Label cell){
        cell = new Gtk.Label(title);
        cell.xalign = 0.0f;
        return cell;
    }
 
    // GTK4 compatibility shim: tree columns/cell renderers were removed.
    public static Gtk.Box add_column_icon_radio_text(Gtk.ListBox listbox, string title,
        out Gtk.Image cell_pix, out Gtk.CheckButton cell_radio, out Gtk.Label cell_text){
        var row = new Gtk.Box(Gtk.Orientation.HORIZONTAL, 6);
        cell_pix = new Gtk.Image();
        cell_radio = new Gtk.CheckButton();
        cell_text = new Gtk.Label(title);
        cell_text.xalign = 0.0f;
        row.append(cell_pix);
        row.append(cell_radio);
        row.append(cell_text);
        return row;
    }
 
    // add_label_scrolled
    public static Gtk.Label add_label_scrolled(Gtk.Box box, string text, bool show_border = false, bool wrap = false, int ellipsize_chars = 40){
 
        // ScrolledWindow
        var scroll = new Gtk.ScrolledWindow();
        scroll.hscrollbar_policy = PolicyType.NEVER;
        scroll.vscrollbar_policy = PolicyType.ALWAYS;
        scroll.hexpand = true;
        scroll.vexpand = true;
        box.append(scroll);
        
        var label = new Gtk.Label(text);
        label.xalign = (float) 0.0;
        label.yalign = (float) 0.0;
        label.margin_start = 6;
        label.margin_end = 6;
        label.margin_top = 6;
        label.margin_bottom = 6;
        label.set_use_markup(true);
        scroll.set_child(label);
 
        if (wrap){
            label.wrap = true;
            label.wrap_mode = Pango.WrapMode.WORD;
        }
        else {
            label.wrap = false;
            label.ellipsize = Pango.EllipsizeMode.MIDDLE;
            label.max_width_chars = ellipsize_chars;
        }
 
        if (show_border){
        }
 
        return label;
    }
 
    // add_label
    private Gtk.Label add_label(Gtk.Box box, string text, bool bold = false, bool italic = false, bool large = false){
            
        string msg = "<span%s%s%s>%s</span>".printf(
            (bold ? " weight=\"bold\"" : ""),
            (italic ? " style=\"italic\"" : ""),
            (large ? " size=\"x-large\"" : ""),
            text);
            
        var label = new Gtk.Label(msg);
        label.set_use_markup(true);
        label.xalign = (float) 0.0;
        label.wrap = true;
        label.wrap_mode = Pango.WrapMode.WORD;
        box.append(label);
        return label;
    }
 
    public static string format_text(string text, bool bold = false, bool italic = false, bool large = false){
 
        string msg = "<span%s%s%s>%s</span>".printf(
            (bold ? " weight=\"bold\"" : ""),
            (italic ? " style=\"italic\"" : ""),
            (large ? " size=\"x-large\"" : ""),
            escape_html(text));
 
        return msg;
    }
 
    // add_label_header
    public static Gtk.Label add_label_header(Gtk.Box box, string text, bool large_heading = false){
 
        var label = add_label(box, escape_html(text), true, false, large_heading);
        label.margin_bottom = 12;
        return label;
    }
 
    // add_checkbox
    public static Gtk.CheckButton add_checkbox(Gtk.Box box, string text){
 
        var chk = new Gtk.CheckButton.with_label(text);
        chk.label = text;
        box.append(chk);
 
        
        /*
        chk.toggled.connect(()=>{
            chk.active;
        });
        */
 
        return chk;
    }
 
    // add_spin
    public static Gtk.SpinButton add_spin(Gtk.Box box, double min, double max, double val, int digits = 0, double step = 1, double step_page = 1){
 
        var adj = new Gtk.Adjustment(val, min, max, step, step_page, 0);
        var spin  = new Gtk.SpinButton(adj, step, digits);
        spin.xalign = (float) 0.5;
        box.append(spin);
 
        /*
        spin.value_changed.connect(()=>{
            label.sensitive = spin.sensitive;
        });
        */
 
        return spin;
    }
 
    // add_button
    public static Gtk.Button add_button(Gtk.Box box, string text, string tooltip, Gtk.SizeGroup? size_group, Gtk.Image? icon = null){
 
        var button = new Gtk.Button();
        box.append(button);
 
        button.set_label(text);
        button.set_tooltip_text(tooltip);
 
        if (icon != null){
            button.set_child(icon);
        }
 
        if (size_group != null){
            size_group.add_widget(button);
        }
 
        return button;
    }
    
    public static Gtk.Box add_button_box(Gtk.Box box, Gtk.Orientation orientation = Gtk.Orientation.HORIZONTAL,
        Gtk.Align halign = Gtk.Align.CENTER, int spacing = 6){
 
        var bbox = new Gtk.Box(orientation, spacing);
        bbox.halign = halign;
        box.append(bbox);
 
        return bbox;
    }
}