This is an automated email from the git hooks/post-receive script.
git pushed a commit to branch master
in repository evisum.
View the commit online.
commit 304ee5c35a08b6e4b36cab026e1412bc8d9eebd9
Author: Alastair Poole <[email protected]>
AuthorDate: Fri Mar 27 23:23:18 2026 +0000
doc: so we know wtf it's doing
---
src/bin/ui/evisum_ui_widget_exel.h | 35 +++++++++++++++--------------------
1 file changed, 15 insertions(+), 20 deletions(-)
diff --git a/src/bin/ui/evisum_ui_widget_exel.h b/src/bin/ui/evisum_ui_widget_exel.h
index 634b1c8..bbe9443 100644
--- a/src/bin/ui/evisum_ui_widget_exel.h
+++ b/src/bin/ui/evisum_ui_widget_exel.h
@@ -66,12 +66,11 @@ typedef struct {
const void *data;
} Evisum_Ui_Widget_Exel_Genlist_Params;
-/* Create and initialize the exel widget controller with behavior callbacks.
- * Use this once per view before registering fields so resize/menu behavior is managed centrally. */
+/* Create and initialize an exel widget controller.
+ * Call once per view before registering fields. */
Evisum_Ui_Widget_Exel *evisum_ui_widget_exel_add(const Evisum_Ui_Widget_Exel_Params *params);
-/* Release the exel widget controller and any menu state it owns.
- * Call this during view teardown to avoid leaked UI objects and stale pointers. */
+/* Release the exel widget controller and all owned UI/cache state. */
void evisum_ui_widget_exel_free(Evisum_Ui_Widget_Exel *wx);
/* Register a field and create/manage its header button internally in the widget context.
@@ -80,22 +79,22 @@ void evisum_ui_widget_exel_field_register(Evisum_Ui_Widget_Exel *wx, int id, con
int default_width, int min_width, Eina_Bool always_visible, double weight_x,
double align_x);
-/* Set the enabled field bitmask managed by the widget.
- * Bits map directly to field ids and are used for non-always-visible show/hide state. */
+/* Set widget-managed visible-field bitmask.
+ * Bits map directly to field ids; always-visible fields remain visible regardless of mask. */
void evisum_ui_widget_exel_fields_mask_set(Evisum_Ui_Widget_Exel *wx, unsigned int mask);
/* Return the current field bitmask managed by the widget. */
unsigned int evisum_ui_widget_exel_fields_mask_get(const Evisum_Ui_Widget_Exel *wx);
-/* Set header resize grab width in pixels for left/right edge hit-testing. */
+/* Set header resize grab width in pixels for left/right edge hit-testing (minimum 1). */
void evisum_ui_widget_exel_resize_hit_width_set(Evisum_Ui_Widget_Exel *wx, int width);
/* Query whether a field is currently enabled and should be visible in the active layout.
* Use this when building row content or packing headers so hidden fields stay consistent. */
Eina_Bool evisum_ui_widget_exel_field_enabled_get(const Evisum_Ui_Widget_Exel *wx, int id);
-/* Return true when `id` is the current trailing visible field in the active layout.
- * Use this to apply stretch behavior without keeping a mirrored `fields_max` in consumers. */
+/* Return true when `id` is the current trailing visible field.
+ * Use this to decide which row column should stretch. */
Eina_Bool evisum_ui_widget_exel_field_is_last_visible(const Evisum_Ui_Widget_Exel *wx, int id);
/* Return the current geometry width for a registered field header.
@@ -106,12 +105,11 @@ Evas_Coord evisum_ui_widget_exel_field_width_get(const Evisum_Ui_Widget_Exel *wx
* Use this when content outgrows header size so columns can expand consistently. */
void evisum_ui_widget_exel_field_min_width_set(Evisum_Ui_Widget_Exel *wx, int id, Evas_Coord width);
-/* Expand the command/title column width when content grows beyond the current width.
- * This updates internal width state and reapplies proportions without shrinking existing widths. */
+/* Grow a command/title column width when content exceeds current width.
+ * This does not shrink previously applied width. */
void evisum_ui_widget_exel_cmd_width_sync(Evisum_Ui_Widget_Exel *wx, int field_cmd_id, Evas_Coord width);
-/* Dismiss the show/hide-fields popup if it is visible.
- * Call this during view resize, focus changes, or tab switches to keep UI state clean. */
+/* Dismiss the show/hide-fields popup if visible. */
void evisum_ui_widget_exel_fields_menu_dismiss(Evisum_Ui_Widget_Exel *wx);
/* Build a full item row table from an ordered list of cell definitions.
@@ -120,8 +118,7 @@ Evas_Object *evisum_ui_widget_exel_item_row_add(Evisum_Ui_Widget_Exel *wx, Evas_
const Evisum_Ui_Widget_Exel_Item_Cell_Def *defs,
unsigned int count);
-/* Set a text object value only when it changed and return whether an update happened.
- * Use this when callers already have the target label/proxy object and should not do key lookups. */
+/* Set text only when changed and return whether an update occurred. */
Eina_Bool evisum_ui_widget_exel_item_text_object_if_changed_set(Evisum_Ui_Widget_Exel *wx, Evas_Object *obj,
const char *text);
@@ -170,8 +167,7 @@ Evas_Object *evisum_ui_widget_exel_icon_button_add(Evisum_Ui_Widget_Exel *wx, co
void evisum_ui_widget_exel_item_cache_attach(Evisum_Ui_Widget_Exel *wx, Evas_Object *(*create_cb)(Evas_Object *),
int size);
-/* Set a reusable declarative row template for widget-owned cache object creation.
- * This keeps row-factory details internal and lets callers define row layout once. */
+/* Set reusable row-template defs used by template-based item-cache creation. */
Eina_Bool evisum_ui_widget_exel_item_template_set(Evisum_Ui_Widget_Exel *wx,
const Evisum_Ui_Widget_Exel_Item_Cell_Def *defs,
unsigned int count);
@@ -219,7 +215,7 @@ void evisum_ui_widget_exel_genlist_clear(Evisum_Ui_Widget_Exel *wx);
void evisum_ui_widget_exel_genlist_items_ensure(Evisum_Ui_Widget_Exel *wx, unsigned int items,
Elm_Genlist_Item_Class *itc);
-/* Return the first item in the widg:et-owned genlist.
+/* Return the first item in the widget-owned genlist.
* Use this as the starting point when applying updated row data in order. */
Elm_Object_Item *evisum_ui_widget_exel_genlist_first_item_get(const Evisum_Ui_Widget_Exel *wx);
@@ -286,8 +282,7 @@ void *evisum_ui_widget_exel_object_item_data_get(Evisum_Ui_Widget_Exel *wx, Elm_
* Use this when replacing payloads during periodic list updates in the same way as `elm_object_item_data_set`. */
void evisum_ui_widget_exel_object_item_data_set(Evisum_Ui_Widget_Exel *wx, Elm_Object_Item *it, void *data);
-/* Cancel any pending widget-owned deferred callback.
- * Call this when abandoning pending UI work, though widget free also cancels it automatically. */
+/* Cancel pending widget-owned deferred timer state, if any. */
void evisum_ui_widget_exel_deferred_call_cancel(Evisum_Ui_Widget_Exel *wx);
#endif
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
