#include "widgets/scroll_wrap.h"
#include "system/macros.h"
#include "system/mem_alloc.h"
#include "widgets/resize_handle.h"
#include "widgets/widget_settings.h"
#include "widgets/widget_style.h"
#include <glib/gi18n.h>
#include "widgets/container.h"

Include dependency graph for scroll_wrap.c:

Data Structures
struct	dt_ui_resizable_area_t

Typedefs
typedef struct dt_ui_resizable_area_t	dt_ui_resizable_area_t

Functions
static gboolean	_treeview_fit_rows (GtkTreeView treeview, GtkTreeModel model, GtkTreeIter parent, const gint nominal, const gint limit, gint used)

static gint	_get_container_row_heigth (GtkWidget *w)

static GtkWidget *	_search_parent_scrolled_window (GtkWidget *w)

static int	_treeview_visible_height (GtkTreeView treeview, GtkTreeModel model, GtkTreeIter *parent, const gint nominal)

static int	_textview_count_visible_rows (GtkWidget *textview)

static void	_widget_auto_disconnect_model (dt_gui_widget_auto_height_t state, GtkWidget treeview)

static void	_widget_auto_disconnect_buffer (dt_gui_widget_auto_height_t *state)

static gint	_resizable_scroll_max_height (void)
	Window-height ceiling shared by the auto-size rule and the drag handle.

static void	_resizable_scroll_apply (GtkWidget *w)
	The single sizing rule for every dt_ui_scroll_wrap area.

static void	_widget_auto_update (GtkWidget *widget)

static gboolean	_resizable_scroll_draw (GtkWidget w, cairo_t cr, gpointer user_data)

static void	_resizable_scroll_realize (GtkWidget *w, gpointer user_data)

static int	_resizable_scroll_handle_get_size (gpointer user_data)

static int	_resizable_scroll_handle_resize (int requested_size, gboolean finished, gpointer user_data)

static void	_widget_auto_model_row_inserted (GtkTreeModel model, GtkTreePath path, GtkTreeIter *iter, gpointer user_data)

static void	_widget_auto_model_row_deleted (GtkTreeModel model, GtkTreePath path, gpointer user_data)

static void	_widget_auto_model_row_changed (GtkTreeModel model, GtkTreePath path, GtkTreeIter *iter, gpointer user_data)

static void	_widget_auto_model_rows_reordered (GtkTreeModel model, GtkTreePath path, GtkTreeIter iter, gint new_order, gpointer user_data)

static void	_widget_auto_model_row_expanded (GtkTreeView tree_view, GtkTreeIter expanded_iter, GtkTreePath *path, gpointer user_data)

static void	_widget_auto_model_row_collapsed (GtkTreeView tree_view, GtkTreeIter collapsed_iter, GtkTreePath *path, gpointer user_data)

static void	_widget_auto_text_buffer_changed (GtkTextBuffer *buffer, gpointer user_data)

static void	_widget_auto_connect_model (GtkWidget *treeview)

static void	_widget_auto_connect_buffer (GtkWidget *textview)

static void	_widget_auto_on_model_changed (GObject treeview, GParamSpec pspec, gpointer user_data)

static void	_widget_auto_on_buffer_changed (GObject textview, GParamSpec pspec, gpointer user_data)

static void	_widget_auto_height_free (gpointer data)

GtkWidget *	dt_ui_scroll_wrap (GtkWidget w, gint min_size, const char config_str, dt_ui_resize_mode_t mode)
	Wrap a scrollable content widget in a recessed, vertically resizable scrolled window.

GtkWidget *	dt_ui_scroll_wrap_get_scrolled_window (GtkWidget *wrapper)
	Return the inner scrolled window of a dt_ui_scroll_wrap() wrapper, or NULL.

void	dt_ui_scroll_wrap_reserve_trailing_row (GtkWidget *content_widget)
	Make a DT_UI_RESIZE_DYNAMIC list or text view ask for one blank row past its content.

static void	_resizable_area_free (gpointer data)

static int	_resizable_area_get_size (gpointer user_data)

static int	_resizable_area_resize (int requested_size, gboolean finished, gpointer user_data)

GtkWidget *	dt_ui_resizable_drawing_area (GtkWidget area, char config_str, int default_height, int min_height)
	Make a self-drawing widget (typically a GtkDrawingArea graph or scope) vertically resizable.

Variables
static const char *const	DT_GUI_WIDGET_AUTO_HEIGHT_KEY = "dt-gui-widget-auto-height"

static const char *const	DT_UI_RESIZABLE_AREA_KEY = "dt-ui-resizable-area"

Typedef Documentation

◆ dt_ui_resizable_area_t

typedef struct dt_ui_resizable_area_t dt_ui_resizable_area_t

Function Documentation

◆ _get_container_row_heigth()

static gint _get_container_row_heigth ( GtkWidget * w )

static

Definition at line 91 of file scroll_wrap.c.

References dt_gui_container_first_child(), DT_PIXEL_APPLY_DPI, height, and L.

Referenced by _resizable_scroll_apply().

◆ _resizable_area_free()

static void _resizable_area_free ( gpointer data )

static

Definition at line 634 of file scroll_wrap.c.

References dt_free, IS_NULL_PTR, L, and state.

Referenced by dt_ui_resizable_drawing_area().

◆ _resizable_area_get_size()

static int _resizable_area_get_size ( gpointer user_data )

static

Definition at line 642 of file scroll_wrap.c.

References DT_UI_RESIZABLE_AREA_KEY, L, and state.

Referenced by dt_ui_resizable_drawing_area().

◆ _resizable_area_resize()

static int _resizable_area_resize	(	int	requested_size,
		gboolean	finished,
		gpointer	user_data
	)

static

Definition at line 650 of file scroll_wrap.c.

References _resizable_scroll_max_height(), DT_UI_RESIZABLE_AREA_KEY, dt_widget_store_int(), height, IS_NULL_PTR, L, MAX, and state.

Referenced by dt_ui_resizable_drawing_area().

◆ _resizable_scroll_apply()

static void _resizable_scroll_apply ( GtkWidget * w )

static

The single sizing rule for every dt_ui_scroll_wrap area.

Height = clamp(min(content, cap), min_size, 75% window), where the cap is the user's persisted height when set, otherwise the window ceiling so the area auto-grows to its content. This makes small content shrink to fit, lets nested lists grow and have their parent panel scroll until the user drags the handle to cap them, and snaps lists/textviews to whole rows to avoid clipped half-rows. The computed bare height – before the scrolled window's own padding and border are added back – is cached for the drag handle.

Definition at line 261 of file scroll_wrap.c.

References _get_container_row_heigth(), _resizable_scroll_max_height(), _search_parent_scrolled_window(), _textview_count_visible_rows(), _treeview_fit_rows(), _treeview_visible_height(), DT_GUI_WIDGET_AUTO_HEIGHT_KEY, DT_UI_RESIZE_STATIC, dt_widget_stored_int(), height, IS_NULL_PTR, L, MAX, MIN, and state.

Referenced by _resizable_scroll_draw(), _resizable_scroll_handle_resize(), _resizable_scroll_realize(), and _widget_auto_update().

◆ _resizable_scroll_draw()

static gboolean _resizable_scroll_draw	(	GtkWidget *	w,
		cairo_t *	cr,
		gpointer	user_data
	)

static

Definition at line 363 of file scroll_wrap.c.

References _resizable_scroll_apply(), and FALSE.

Referenced by dt_ui_scroll_wrap().

◆ _resizable_scroll_handle_get_size()

static int _resizable_scroll_handle_get_size ( gpointer user_data )

static

Definition at line 375 of file scroll_wrap.c.

References DT_GUI_WIDGET_AUTO_HEIGHT_KEY, L, and state.

Referenced by dt_ui_scroll_wrap().

◆ _resizable_scroll_handle_resize()

static int _resizable_scroll_handle_resize	(	int	requested_size,
		gboolean	finished,
		gpointer	user_data
	)

static

Definition at line 382 of file scroll_wrap.c.

References _resizable_scroll_apply(), _resizable_scroll_max_height(), DT_GUI_WIDGET_AUTO_HEIGHT_KEY, dt_widget_store_int(), IS_NULL_PTR, L, MAX, state, and value.

Referenced by dt_ui_scroll_wrap().

◆ _resizable_scroll_max_height()

static gint _resizable_scroll_max_height ( void )

static

Window-height ceiling shared by the auto-size rule and the drag handle.

The full main-window height: a resizable area may grow as tall as the window (the parent panel scrolls to reach it). Content shorter than this still shrinks to fit, so this only bounds how far the user can drag.

Definition at line 245 of file scroll_wrap.c.

References DT_PIXEL_APPLY_DPI, dt_widget_root_window(), and L.

Referenced by _resizable_area_resize(), _resizable_scroll_apply(), _resizable_scroll_handle_resize(), and dt_ui_resizable_drawing_area().

◆ _resizable_scroll_realize()

static void _resizable_scroll_realize	(	GtkWidget *	w,
		gpointer	user_data
	)

static

Definition at line 369 of file scroll_wrap.c.

References _resizable_scroll_apply().

Referenced by dt_ui_scroll_wrap().

◆ _search_parent_scrolled_window()

static GtkWidget * _search_parent_scrolled_window ( GtkWidget * w )

static

Definition at line 131 of file scroll_wrap.c.

References L.

Referenced by _resizable_scroll_apply().

◆ _textview_count_visible_rows()

static int _textview_count_visible_rows ( GtkWidget * textview )

static

Definition at line 183 of file scroll_wrap.c.

References L, and MAX.

Referenced by _resizable_scroll_apply().

◆ _treeview_fit_rows()

static gboolean _treeview_fit_rows	(	GtkTreeView *	treeview,
		GtkTreeModel *	model,
		GtkTreeIter *	parent,
		const gint	nominal,
		const gint	limit,
		gint *	used
	)

static

Definition at line 53 of file scroll_wrap.c.

References _treeview_fit_rows(), FALSE, L, model, row, and TRUE.

Referenced by _resizable_scroll_apply(), and _treeview_fit_rows().

◆ _treeview_visible_height()

static int _treeview_visible_height	(	GtkTreeView *	treeview,
		GtkTreeModel *	model,
		GtkTreeIter *	parent,
		const gint	nominal
	)

static

Definition at line 153 of file scroll_wrap.c.

References _treeview_visible_height(), height, L, and model.

Referenced by _resizable_scroll_apply(), and _treeview_visible_height().

◆ _widget_auto_connect_buffer()

static void _widget_auto_connect_buffer ( GtkWidget * textview )

static

Definition at line 484 of file scroll_wrap.c.

References _widget_auto_disconnect_buffer(), _widget_auto_text_buffer_changed(), DT_GUI_WIDGET_AUTO_HEIGHT_KEY, IS_NULL_PTR, L, and state.

Referenced by _widget_auto_on_buffer_changed(), and dt_ui_scroll_wrap().

◆ _widget_auto_connect_model()

static void _widget_auto_connect_model ( GtkWidget * treeview )

static

Definition at line 455 of file scroll_wrap.c.

References _widget_auto_disconnect_model(), _widget_auto_model_row_changed(), _widget_auto_model_row_collapsed(), _widget_auto_model_row_deleted(), _widget_auto_model_row_expanded(), _widget_auto_model_row_inserted(), _widget_auto_model_rows_reordered(), DT_GUI_WIDGET_AUTO_HEIGHT_KEY, IS_NULL_PTR, L, model, and state.

Referenced by _widget_auto_on_model_changed(), and dt_ui_scroll_wrap().

◆ _widget_auto_disconnect_buffer()

static void _widget_auto_disconnect_buffer ( dt_gui_widget_auto_height_t * state )

static

Definition at line 223 of file scroll_wrap.c.

References IS_NULL_PTR, L, and state.

Referenced by _widget_auto_connect_buffer(), and _widget_auto_height_free().

◆ _widget_auto_disconnect_model()

static void _widget_auto_disconnect_model	(	dt_gui_widget_auto_height_t *	state,
		GtkWidget *	treeview
	)

static

Definition at line 194 of file scroll_wrap.c.

References IS_NULL_PTR, L, model, and state.

Referenced by _widget_auto_connect_model(), and _widget_auto_height_free().

◆ _widget_auto_height_free()

static void _widget_auto_height_free ( gpointer data )

static

Definition at line 519 of file scroll_wrap.c.

References _widget_auto_disconnect_buffer(), _widget_auto_disconnect_model(), dt_free, IS_NULL_PTR, L, and state.

Referenced by dt_ui_scroll_wrap().

◆ _widget_auto_model_row_changed()

static void _widget_auto_model_row_changed	(	GtkTreeModel *	model,
		GtkTreePath *	path,
		GtkTreeIter *	iter,
		gpointer	user_data
	)

static

Definition at line 410 of file scroll_wrap.c.

References _widget_auto_update(), L, model, and void().

Referenced by _widget_auto_connect_model().

◆ _widget_auto_model_row_collapsed()

static void _widget_auto_model_row_collapsed	(	GtkTreeView *	tree_view,
		GtkTreeIter *	collapsed_iter,
		GtkTreePath *	path,
		gpointer	user_data
	)

static

Definition at line 438 of file scroll_wrap.c.

References _widget_auto_update(), L, and void().

Referenced by _widget_auto_connect_model().

◆ _widget_auto_model_row_deleted()

static void _widget_auto_model_row_deleted	(	GtkTreeModel *	model,
		GtkTreePath *	path,
		gpointer	user_data
	)

static

Definition at line 403 of file scroll_wrap.c.

References _widget_auto_update(), L, model, and void().

Referenced by _widget_auto_connect_model().

◆ _widget_auto_model_row_expanded()

static void _widget_auto_model_row_expanded	(	GtkTreeView *	tree_view,
		GtkTreeIter *	expanded_iter,
		GtkTreePath *	path,
		gpointer	user_data
	)

static

Definition at line 429 of file scroll_wrap.c.

References _widget_auto_update(), L, and void().

Referenced by _widget_auto_connect_model().

◆ _widget_auto_model_row_inserted()

static void _widget_auto_model_row_inserted	(	GtkTreeModel *	model,
		GtkTreePath *	path,
		GtkTreeIter *	iter,
		gpointer	user_data
	)

static

Definition at line 394 of file scroll_wrap.c.

References _widget_auto_update(), L, model, and void().

Referenced by _widget_auto_connect_model().

◆ _widget_auto_model_rows_reordered()

static void _widget_auto_model_rows_reordered	(	GtkTreeModel *	model,
		GtkTreePath *	path,
		GtkTreeIter *	iter,
		gint *	new_order,
		gpointer	user_data
	)

static

Definition at line 419 of file scroll_wrap.c.

References _widget_auto_update(), L, model, and void().

Referenced by _widget_auto_connect_model().

◆ _widget_auto_on_buffer_changed()

static void _widget_auto_on_buffer_changed	(	GObject *	textview,
		GParamSpec *	pspec,
		gpointer	user_data
	)

static

Definition at line 511 of file scroll_wrap.c.

References _widget_auto_connect_buffer(), _widget_auto_update(), L, and void().

Referenced by dt_ui_scroll_wrap().

◆ _widget_auto_on_model_changed()

static void _widget_auto_on_model_changed	(	GObject *	treeview,
		GParamSpec *	pspec,
		gpointer	user_data
	)

static

Definition at line 503 of file scroll_wrap.c.

References _widget_auto_connect_model(), _widget_auto_update(), L, and void().

Referenced by dt_ui_scroll_wrap().

◆ _widget_auto_text_buffer_changed()

static void _widget_auto_text_buffer_changed	(	GtkTextBuffer *	buffer,
		gpointer	user_data
	)

static

Definition at line 449 of file scroll_wrap.c.

References _widget_auto_update(), L, and void().

Referenced by _widget_auto_connect_buffer().

◆ _widget_auto_update()

static void _widget_auto_update ( GtkWidget * widget )

static

Definition at line 358 of file scroll_wrap.c.

References _resizable_scroll_apply().

Referenced by _widget_auto_model_row_changed(), _widget_auto_model_row_collapsed(), _widget_auto_model_row_deleted(), _widget_auto_model_row_expanded(), _widget_auto_model_row_inserted(), _widget_auto_model_rows_reordered(), _widget_auto_on_buffer_changed(), _widget_auto_on_model_changed(), _widget_auto_text_buffer_changed(), dt_ui_scroll_wrap(), and dt_ui_scroll_wrap_reserve_trailing_row().

◆ dt_ui_resizable_drawing_area()

GtkWidget * dt_ui_resizable_drawing_area	(	GtkWidget *	area,
		char *	config_str,
		int	default_height,
		int	min_height
	)

Make a self-drawing widget (typically a GtkDrawingArea graph or scope) vertically resizable.

The widget is given a fixed height-request (persisted under config_str) and a drag grip floating on its bottom edge – the same grip used by panels, scroll wrappers and the histogram scope. The content is not scrolled: it keeps drawing to its live allocation, only the height-request changes. Returns a wrapper overlay to pack in place of area.

Parameters

area	the drawing widget (its callbacks/refs stay valid; pack the returned overlay).
config_str	conf key persisting the user-chosen height (copied internally).
default_height	default height in device-independent px (rescaled by DT_PIXEL_APPLY_DPI).
min_height	minimum height floor in device-independent px.

Definition at line 663 of file scroll_wrap.c.

References _resizable_area_free(), _resizable_area_get_size(), _resizable_area_resize(), _resizable_scroll_max_height(), DT_PIXEL_APPLY_DPI, DT_UI_RESIZABLE_AREA_KEY, dt_widget_stored_int(), dtgtk_resize_handle_new(), FALSE, height, L, MAX, and state.

Referenced by gui_init(), gui_init(), and gui_init().

◆ dt_ui_scroll_wrap()

GtkWidget * dt_ui_scroll_wrap	(	GtkWidget *	w,
		gint	min_size,
		const char *	config_str,
		dt_ui_resize_mode_t	mode
	)

Wrap a scrollable content widget in a recessed, vertically resizable scrolled window.

Wrap a scrollable widget in a recessed, vertically resizable scrolled window with a drag handle.

Returns an overlay wrapping the scrolled window, with a themed drag grip floating on its bottom edge (the same grip primitive used by panels and the histogram scope). The grip takes no layout space and is invisible until hovered. Sizing follows mode: DT_UI_RESIZE_DYNAMIC auto-fits the content up to the user height, DT_UI_RESIZE_STATIC keeps a fixed height (see _resizable_scroll_apply).

The returned widget is the wrapper overlay, not the scrolled window; callers needing the inner scrolled window (e.g. to tweak its scroll policy) must use dt_ui_scroll_wrap_get_scrolled_window().

Parameters

w	content widget (treeview, textview or any container)
min_size	minimum height floor in device pixels (also the static default before the user drags)
config_str	conf key persisting the user-chosen height (copied internally)
mode	DT_UI_RESIZE_DYNAMIC (auto-fit) or DT_UI_RESIZE_STATIC (fixed height)

Definition at line 545 of file scroll_wrap.c.

References _resizable_scroll_draw(), _resizable_scroll_handle_get_size(), _resizable_scroll_handle_resize(), _resizable_scroll_realize(), _widget_auto_connect_buffer(), _widget_auto_connect_model(), _widget_auto_height_free(), _widget_auto_on_buffer_changed(), _widget_auto_on_model_changed(), _widget_auto_update(), dt_gui_add_class(), DT_GUI_WIDGET_AUTO_HEIGHT_KEY, DT_PIXEL_APPLY_DPI, DT_UI_RESIZE_DYNAMIC, dtgtk_resize_handle_new(), FALSE, L, MAX, and state.

Referenced by _modchooser_run(), dt_iop_gui_init_masks(), and gui_init().

◆ dt_ui_scroll_wrap_get_scrolled_window()

GtkWidget * dt_ui_scroll_wrap_get_scrolled_window ( GtkWidget * wrapper )

Return the inner scrolled window of a dt_ui_scroll_wrap() wrapper, or NULL.

Return the inner GtkScrolledWindow of a dt_ui_scroll_wrap() wrapper, or NULL.

Definition at line 607 of file scroll_wrap.c.

References L.

Referenced by gui_init().

◆ dt_ui_scroll_wrap_reserve_trailing_row()

void dt_ui_scroll_wrap_reserve_trailing_row ( GtkWidget * content_widget )

Make a DT_UI_RESIZE_DYNAMIC list or text view ask for one blank row past its content.

A list filled edge to edge cannot be told from one with more rows hidden below; the blank row says it ends there. Part of the sizing rule rather than a one-off resize of the window around it, so it holds through every content change and every re-layout. A list capped below its content still snaps to whole rows and scrolls, with no blank row.

Parameters

content_widget the widget passed to dt_ui_scroll_wrap(). Ignored when it was not wrapped.

Definition at line 624 of file scroll_wrap.c.

References _widget_auto_update(), DT_GUI_WIDGET_AUTO_HEIGHT_KEY, IS_NULL_PTR, L, state, and TRUE.

Referenced by gui_init().

Variable Documentation

◆ DT_GUI_WIDGET_AUTO_HEIGHT_KEY

const char* const DT_GUI_WIDGET_AUTO_HEIGHT_KEY = "dt-gui-widget-auto-height"

static

Definition at line 29 of file scroll_wrap.c.

Referenced by _resizable_scroll_apply(), _resizable_scroll_handle_get_size(), _resizable_scroll_handle_resize(), _widget_auto_connect_buffer(), _widget_auto_connect_model(), dt_ui_scroll_wrap(), and dt_ui_scroll_wrap_reserve_trailing_row().

◆ DT_UI_RESIZABLE_AREA_KEY

const char* const DT_UI_RESIZABLE_AREA_KEY = "dt-ui-resizable-area"

static

Definition at line 37 of file scroll_wrap.c.

Referenced by _resizable_area_get_size(), _resizable_area_resize(), and dt_ui_resizable_drawing_area().

Data Structures

Typedefs

Functions

Variables

Typedef Documentation

◆ dt_ui_resizable_area_t

Function Documentation

◆ _get_container_row_heigth()

◆ _resizable_area_free()

◆ _resizable_area_get_size()

◆ _resizable_area_resize()

◆ _resizable_scroll_apply()

◆ _resizable_scroll_draw()

◆ _resizable_scroll_handle_get_size()

◆ _resizable_scroll_handle_resize()

◆ _resizable_scroll_max_height()

◆ _resizable_scroll_realize()

◆ _search_parent_scrolled_window()

◆ _textview_count_visible_rows()

◆ _treeview_fit_rows()

◆ _treeview_visible_height()

◆ _widget_auto_connect_buffer()

◆ _widget_auto_connect_model()

◆ _widget_auto_disconnect_buffer()

◆ _widget_auto_disconnect_model()

◆ _widget_auto_height_free()

◆ _widget_auto_model_row_changed()

◆ _widget_auto_model_row_collapsed()

◆ _widget_auto_model_row_deleted()

◆ _widget_auto_model_row_expanded()

◆ _widget_auto_model_row_inserted()

◆ _widget_auto_model_rows_reordered()

◆ _widget_auto_on_buffer_changed()

◆ _widget_auto_on_model_changed()

◆ _widget_auto_text_buffer_changed()

◆ _widget_auto_update()

◆ dt_ui_resizable_drawing_area()

◆ dt_ui_scroll_wrap()

◆ dt_ui_scroll_wrap_get_scrolled_window()

◆ dt_ui_scroll_wrap_reserve_trailing_row()

Variable Documentation

◆ DT_GUI_WIDGET_AUTO_HEIGHT_KEY

◆ DT_UI_RESIZABLE_AREA_KEY