[tepl] AmtkActionInfo: make mark_as_used() and has_been_used() public
- From: Sébastien Wilmet <swilmet src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [tepl] AmtkActionInfo: make mark_as_used() and has_been_used() public
- Date: Sun, 16 Jul 2017 17:39:46 +0000 (UTC)
commit ab59d32a50dda70495e490646a47510acb97b0b3
Author: Sébastien Wilmet <swilmet gnome org>
Date: Sun Jul 16 19:20:21 2017 +0200
AmtkActionInfo: make mark_as_used() and has_been_used() public
I didn't really like the name set_used(), because it didn't have a
gboolean param to set the value. mark_as_used() is clearer.
amtk/amtk-action-info-store.c | 2 +-
amtk/amtk-action-info.c | 33 +++++++++++++++++++++++++--------
amtk/amtk-action-info.h | 6 ++----
amtk/amtk-menu-factory.c | 5 ++---
docs/reference/tepl-3.0-sections.txt | 2 ++
5 files changed, 32 insertions(+), 16 deletions(-)
---
diff --git a/amtk/amtk-action-info-store.c b/amtk/amtk-action-info-store.c
index 873a368..9ed150b 100644
--- a/amtk/amtk-action-info-store.c
+++ b/amtk/amtk-action-info-store.c
@@ -198,7 +198,7 @@ check_used_cb (gpointer key,
const gchar *action_name = key;
const AmtkActionInfo *action_info = value;
- if (!_amtk_action_info_get_used (action_info))
+ if (!amtk_action_info_has_been_used (action_info))
{
g_warning ("AmtkActionInfo with action_name='%s' has not been used.",
action_name);
diff --git a/amtk/amtk-action-info.c b/amtk/amtk-action-info.c
index 92accd3..1f5dea1 100644
--- a/amtk/amtk-action-info.c
+++ b/amtk/amtk-action-info.c
@@ -390,18 +390,35 @@ amtk_action_info_set_accels (AmtkActionInfo *info,
info->accels = _amtk_utils_strv_copy (accels);
}
-gboolean
-_amtk_action_info_get_used (const AmtkActionInfo *info)
+/**
+ * amtk_action_info_mark_as_used:
+ * @info: an #AmtkActionInfo.
+ *
+ * Mark @info as used. A #GtkWidget factory function that uses an
+ * #AmtkActionInfo should call this function. See
+ * amtk_action_info_store_check_all_used().
+ *
+ * Since: 3.0
+ */
+void
+amtk_action_info_mark_as_used (AmtkActionInfo *info)
{
- g_return_val_if_fail (info != NULL, FALSE);
+ g_return_if_fail (info != NULL);
- return info->used;
+ info->used = TRUE;
}
-void
-_amtk_action_info_set_used (AmtkActionInfo *info)
+/**
+ * amtk_action_info_has_been_used:
+ * @info: an #AmtkActionInfo.
+ *
+ * Returns: whether @info has been used by a #GtkWidget factory function.
+ * Since: 3.0
+ */
+gboolean
+amtk_action_info_has_been_used (const AmtkActionInfo *info)
{
- g_return_if_fail (info != NULL);
+ g_return_val_if_fail (info != NULL, FALSE);
- info->used = TRUE;
+ return info->used;
}
diff --git a/amtk/amtk-action-info.h b/amtk/amtk-action-info.h
index d79dc9d..a0eb0e0 100644
--- a/amtk/amtk-action-info.h
+++ b/amtk/amtk-action-info.h
@@ -99,11 +99,9 @@ const gchar * const * amtk_action_info_get_accels (const AmtkActionInfo
*info);
void amtk_action_info_set_accels (AmtkActionInfo *info,
const gchar * const *accels);
-G_GNUC_INTERNAL
-gboolean _amtk_action_info_get_used (const AmtkActionInfo *info);
+void amtk_action_info_mark_as_used (AmtkActionInfo *info);
-G_GNUC_INTERNAL
-void _amtk_action_info_set_used (AmtkActionInfo *info);
+gboolean amtk_action_info_has_been_used (const AmtkActionInfo *info);
G_END_DECLS
diff --git a/amtk/amtk-menu-factory.c b/amtk/amtk-menu-factory.c
index 8cb61f8..b1cc527 100644
--- a/amtk/amtk-menu-factory.c
+++ b/amtk/amtk-menu-factory.c
@@ -284,10 +284,9 @@ amtk_menu_factory_create_menu_item (AmtkMenuFactory *factory,
}
/* FIXME: we are cheating a little here. Maybe the lookup functions
- * should not return const values. And _amtk_action_info_set_used()
- * should be public so factory functions can be written in apps.
+ * should not return const values.
*/
- _amtk_action_info_set_used ((AmtkActionInfo *) action_info);
+ amtk_action_info_mark_as_used ((AmtkActionInfo *) action_info);
return GTK_WIDGET (menu_item);
}
diff --git a/docs/reference/tepl-3.0-sections.txt b/docs/reference/tepl-3.0-sections.txt
index f70b9c5..71b8fb6 100644
--- a/docs/reference/tepl-3.0-sections.txt
+++ b/docs/reference/tepl-3.0-sections.txt
@@ -41,6 +41,8 @@ amtk_action_info_get_tooltip
amtk_action_info_set_tooltip
amtk_action_info_get_accels
amtk_action_info_set_accels
+amtk_action_info_mark_as_used
+amtk_action_info_has_been_used
<SUBSECTION Standard>
amtk_action_info_get_type
AMTK_TYPE_ACTION_INFO
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]