10#ifndef __UTILS_GTK_H__
11#define __UTILS_GTK_H__
13#include "zrythm-config.h"
19# include <gdk/x11/gdkx.h>
23# include <gdk/win32/gdkwin32.h>
26#pragma GCC diagnostic push
27#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
28#include <gtksourceview/gtksource.h>
29#pragma GCC diagnostic pop
31#include <cyaml/cyaml.h>
39#define DEFAULT_CLIPBOARD gdk_display_get_clipboard (gdk_display_get_default ())
41#define CREATE_MIDI_LEARN_MENU_ITEM(action) \
42 z_gtk_create_menu_item (_ ("MIDI learn"), "signal-midi", action)
44#define CREATE_CUT_MENU_ITEM(action) \
45 z_gtk_create_menu_item (_ ("Cu_t"), "edit-cut", action)
47#define CREATE_COPY_MENU_ITEM(action) \
48 z_gtk_create_menu_item (_ ("_Copy"), "edit-copy", action)
50#define CREATE_PASTE_MENU_ITEM(action) \
51 z_gtk_create_menu_item (_ ("_Paste"), "edit-paste", action)
53#define CREATE_DELETE_MENU_ITEM(action) \
54 z_gtk_create_menu_item (_ ("_Delete"), "edit-delete", action)
56#define CREATE_CLEAR_SELECTION_MENU_ITEM(action) \
57 z_gtk_create_menu_item ( \
58 _ ("Cle_ar Selection"), "edit-clear", action)
60#define CREATE_SELECT_ALL_MENU_ITEM(action) \
61 z_gtk_create_menu_item (_ ("Select A_ll"), "edit-select-all", action)
63#define CREATE_DUPLICATE_MENU_ITEM(action) \
64 z_gtk_create_menu_item (_ ("Duplicate"), "edit-duplicate", action)
66#define CREATE_MUTE_MENU_ITEM(action) \
67 z_gtk_create_menu_item (_ ("Mute"), "mute", action)
69#define CREATE_UNMUTE_MENU_ITEM(action) \
70 z_gtk_create_menu_item (_ ("Unmute"), NULL, action)
72#define z_gtk_assistant_set_current_page_complete(assistant, complete) \
73 gtk_assistant_set_page_complete ( \
74 GTK_ASSISTANT (assistant), \
75 gtk_assistant_get_nth_page ( \
76 GTK_ASSISTANT (assistant), \
77 gtk_assistant_get_current_page (GTK_ASSISTANT (assistant))), \
80#define Z_GDK_RGBA_INIT(r, g, b, a) \
83 .red = (float) (r), .green = (float) (g), .blue = (float) (b), \
84 .alpha = (float) (a) \
87#define Z_GDK_RECTANGLE_INIT(_x, _y, _w, _h) \
90 .x = _x, .y = _y, .width = _w, .height = _h \
93#define Z_GDK_RECTANGLE_INIT_UNIT(_x, _y) \
96 .x = _x, .y = _y, .width = 1, .height = 1 \
99typedef enum IconType IconType;
105typedef struct _ZGObjectImpl
107 GTypeInstance g_type_instance;
126static inline GtkWidget *
127z_gtk_notebook_get_current_page_widget (GtkNotebook * notebook)
129 return gtk_notebook_get_nth_page (
130 notebook, gtk_notebook_get_current_page (notebook));
133static inline GtkWidget *
134z_gtk_notebook_get_current_tab_label_widget (GtkNotebook * notebook)
136 return gtk_notebook_get_tab_label (
137 notebook, z_gtk_notebook_get_current_page_widget (notebook));
141z_gtk_get_primary_monitor (
void);
144z_gtk_get_primary_monitor_scale_factor (
void);
147z_gtk_get_primary_monitor_refresh_rate (
void);
150z_gtk_is_wayland (
void);
153z_gtk_tree_view_remove_all_columns (GtkTreeView * treeview);
156z_gtk_column_view_remove_all_columnes (GtkColumnView * column_view);
159z_gtk_column_view_get_list_store (GtkColumnView * column_view);
169z_gtk_widget_remove_all_children (GtkWidget * widget);
172z_gtk_widget_destroy_all_children (GtkWidget * widget);
175z_gtk_widget_remove_children_of_type (GtkWidget * widget, GType type);
178z_gtk_overlay_add_if_not_exists (GtkOverlay * overlay, GtkWidget * widget);
189 GtkOrientation orientation,
206 GtkOrientation orientation,
218 GtkOrientation orientation,
221#define z_gtk_create_menu_item(lbl_name, icn_name, action_name) \
222 z_gtk_create_menu_item_full (lbl_name, icn_name, action_name)
229 const gchar * label_name,
230 const gchar * icon_name,
231 const char * detailed_action);
256 const char * detailed_action,
257 const char * tooltip);
265 GtkActionable * actionable,
266 const char * tooltip);
273z_gtk_tool_button_set_icon_size (
274 GtkToolButton * toolbutton,
275 GtkIconSize icon_size);
281static inline GdkDevice *
282z_gtk_widget_get_device (GtkWidget * widget)
284 return (gdk_seat_get_pointer (
285 gdk_display_get_default_seat (gtk_widget_get_display (widget))));
289static inline GdkWindow *
290z_gtk_widget_get_root_gdk_window (
294 z_gtk_widget_get_screen (widget);
296 gdk_screen_get_root_window (screen);
302z_gtk_widget_get_global_coordinates (
308 z_gtk_widget_get_device (widget);
310 z_gtk_widget_get_root_gdk_window (widget);
311 gdk_window_get_device_position (
312 win, dev, x, y, NULL);
316z_gtk_widget_get_global_coordinates_double (
322 z_gtk_widget_get_device (widget);
324 z_gtk_widget_get_root_gdk_window (widget);
325 gdk_window_get_device_position_double (
326 win, dev, x, y, NULL);
333z_gtk_warp_cursor_to (
334 GtkWidget * widget,
int x,
int y)
337 z_gtk_widget_get_device (widget);
339 z_gtk_widget_get_screen (widget);
340 gdk_device_warp (dev, screen, x, y);
344static inline GdkSurface *
345z_gtk_widget_get_surface (GtkWidget * widget)
347 GtkNative * native = gtk_widget_get_native (widget);
348 return gtk_native_get_surface (native);
358z_gtk_widget_get_mask (GtkWidget * widget, GdkModifierType * mask)
360 gdk_surface_get_device_position (
361 z_gtk_widget_get_surface (widget), z_gtk_widget_get_device (widget), NULL,
369z_gtk_keyval_is_alt (
const guint keyval)
371 return keyval == GDK_KEY_Alt_L || keyval == GDK_KEY_Alt_R
372 || keyval == GDK_KEY_Meta_L || keyval == GDK_KEY_Meta_R;
379z_gtk_keyval_is_ctrl (
const guint keyval)
381 return keyval == GDK_KEY_Control_L || keyval == GDK_KEY_Control_R;
388z_gtk_keyval_is_arrow (
const guint keyval)
390 return keyval == GDK_KEY_Left || keyval == GDK_KEY_Right
391 || keyval == GDK_KEY_Down || keyval == GDK_KEY_Up;
398z_gtk_keyval_is_shift (
const guint keyval)
400 return keyval == GDK_KEY_Shift_L || keyval == GDK_KEY_Shift_R;
404z_gtk_keyval_is_menu (
const guint keyval)
406 return keyval == GDK_KEY_Menu;
438z_gtk_flow_box_get_selected_child (GtkFlowBox * self);
446GtkSourceLanguageManager *
447z_gtk_source_language_manager_get (
void);
455 GtkNotebook * notebook,
456 GtkWindow * parent_window);
485 char ** option_values,
488 bool accept_fallback);
499 GtkActionable * actionable,
500 GSettings * settings,
504z_gtk_is_event_button (GdkEvent * ev);
512 GtkScrolledWindow * scroll,
513 graphene_rect_t * rect);
516z_gtk_graphene_rect_t_to_gdk_rectangle (
518 graphene_rect_t * grect);
521z_gdk_rectangle_to_graphene_rect_t (graphene_rect_t * grect, GdkRectangle * rect);
524z_gdk_rectangle_print (
const GdkRectangle * rect);
544 GtkPopoverMenu * popover_menu,
557z_gtk_icon_theme_get_default (
void);
570z_gtk_window_get_x11_xid (GtkWindow * window);
575z_gtk_window_get_windows_hwnd (GtkWindow * window);
580z_gtk_window_get_nsview (GtkWindow * window);
592 const char * icon_name,
607 const char * icon_name,
613z_gtk_print_graphene_rect (graphene_rect_t * rect);
622z_gtk_get_gsk_renderer_type (
void);
644z_gtk_list_box_remove_all_children (GtkListBox * list_box);
647z_graphene_rect_print (
const graphene_rect_t * rect);
650z_gtk_string_list_new_from_cyaml_strvals (
651 const cyaml_strval_t * strvals,
656z_gtk_get_first_focusable_child (GtkWidget * parent);
659z_gtk_descendant_has_focus (GtkWidget * parent);
662z_gtk_window_make_escapable (GtkWindow * self);
669 GtkSignalListItemFactory * factory,
674z_gtk_drop_down_factory_setup_common (
675 GtkSignalListItemFactory * factory,
680z_gtk_drop_down_factory_setup_common_ellipsized (
681 GtkSignalListItemFactory * factory,
void z_gtk_setup_foldable_notebook(GtkNotebook *notebook)
Makes the given notebook foldable.
void z_gtk_generate_screenshot_image(GtkWidget *widget, const char *type, char **option_keys, char **option_values, char **ret_dir, char **ret_path, bool accept_fallback)
Generates a screenshot image for the given widget.
void z_gtk_list_store_splice(GListStore *store, GPtrArray *ptr_array)
Removes all items and re-populates the list store.
void z_gtk_notebook_make_detachable(GtkNotebook *notebook, GtkWindow *parent_window)
Makes the given GtkNotebook detachable to a new window.
bool z_gtk_activate_dir_link_func(GtkLabel *label, char *uri, void *data)
Callback to use for simple directory links.
int z_gtk_dialog_run(GtkDialog *dialog, bool destroy_on_close)
Mimics the blocking behavior.
char * z_gdk_clipboard_get_text(GdkClipboard *clipboard)
Returns the text on the clipboard, or NULL if there is nothing or the content is not text.
void z_gtk_button_set_emblem(GtkButton *btn, const char *emblem_icon)
Sets the given emblem to the button, or unsets the emblem if emblem_icon is NULL.
GtkToggleButton * z_gtk_toggle_button_new_with_icon(const char *name)
Creates a toggle button with the given icon name.
void z_gtk_actionable_set_action_from_setting(GtkActionable *actionable, GSettings *settings, const char *key)
Sets the action target of the given GtkActionable to be binded to the given setting.
void z_gtk_show_context_menu_from_g_menu(GtkPopoverMenu *popover_menu, double x, double y, GMenu *menu)
The popover must already exist as a children of its intended widget (or a common parent).
GtkButton * z_gtk_button_new_with_icon_and_text(const char *name, const char *text, bool icon_first, GtkOrientation orientation, int spacing)
Creates a button with the given icon name and text.
void z_gtk_widget_set_tooltip_for_action(GtkWidget *widget, const char *detailed_action, const char *tooltip)
Sets the tooltip for the given action on the given widget.
void z_gtk_widget_set_margin(GtkWidget *widget, int margin)
Sets the margin on all 4 sides on the widget.
GtkWidget * z_gtk_widget_find_child_of_type(GtkWidget *widget, GType type)
Recursively searches the children of widget for a child of type type.
gboolean z_gtk_simple_action_shortcut_func(GtkWidget *widget, GVariant *args, gpointer user_data)
A shortcut callback to use for simple actions.
GdkTexture * z_gdk_texture_new_from_icon_name(const char *icon_name, int width, int height, int scale)
Creates a new texture for the given icon scaled at the given width/height.
GdkDragAction z_gtk_drop_target_get_selected_action(GtkDropTarget *drop_target)
Returns the bitmask of the selected action during a drop (eg, GDK_ACTION_COPY).
char * z_gtk_get_tooltip_for_action(const char *detailed_action, const char *tooltip)
Gets the tooltip for the given action on the given widget.
GdkPixbuf * z_gdk_pixbuf_new_from_icon_name(const char *icon_name, int width, int height, int scale, GError **error)
Creates a new pixbuf for the given icon scaled at the given width/height.
void z_gtk_drop_down_list_item_header_setup_common(GtkSignalListItemFactory *factory, GObject *list_item, gpointer user_data)
A common "setup" signal handler for GtkDropDown header factories.
GMenuItem * z_gtk_create_menu_item_full(const gchar *label_name, const gchar *icon_name, const char *detailed_action)
Creates a menu item.
void z_gtk_scrolled_window_get_visible_rect(GtkScrolledWindow *scroll, graphene_rect_t *rect)
Gets the visible rectangle from the scrolled window's adjustments.
GtkWidget * z_gtk_widget_get_nth_child(GtkWidget *widget, int index)
Returns the nth child of a container.
void z_gtk_button_set_icon_name_and_text(GtkButton *btn, const char *name, const char *text, bool icon_first, GtkOrientation orientation, int spacing)
Sets the icon name and optionally text.
void z_gtk_widget_print_hierarchy(GtkWidget *widget)
Prints the widget's hierarchy (parents).
void z_gtk_set_tooltip_for_actionable(GtkActionable *actionable, const char *tooltip)
Sets the tooltip and finds the accel keys and appends them to the tooltip in small text.
GtkToggleButton * z_gtk_toggle_button_new_with_icon_and_text(const char *name, const char *text, bool icon_first, GtkOrientation orientation, int spacing)
Creates a toggle button with the given icon name.
char * z_gtk_text_buffer_get_full_text(GtkTextBuffer *buffer)
Returns the full text contained in the text buffer.
GObject struct (from GObject source code), used where hacks are needed.