Commit db34b1ae authored by Matthias Clasen's avatar Matthias Clasen Committed by Allison Karlitskaya

Rename exporter APIs

There are no public 'exporter' objects, so don't allude to them
in the function names. At the same time, we want to make it clear
that these functions are D-Bus specific.

The new APIs are
g_action_group_dbus_export_start
g_action_group_dbus_export_query
g_action_group_dbus_export_stop
g_menu_model_dbus_export_start
g_menu_model_dbus_export_query
g_menu_model_dbus_export_stop
parent 435b2418
......@@ -2909,9 +2909,9 @@ G_ACTION_GROUP
<SECTION>
<FILE>gactiongroupexporter</FILE>
g_action_group_exporter_export
g_action_group_exporter_stop
g_action_group_exporter_query
g_action_group_dbus_export_start
g_action_group_dbus_export_stop
g_action_group_dbus_export_query
</SECTION>
<SECTION>
......@@ -3545,9 +3545,9 @@ G_NETWORK_MONITOR_GET_INTERFACE
<SECTION>
<FILE>gmenuexporter</FILE>
g_menu_exporter_export
g_menu_exporter_stop
g_menu_exporter_query
g_menu_model_dbus_export_start
g_menu_model_dbus_export_stop
g_menu_model_dbus_export_query
</SECTION>
<SECTION>
......
......@@ -455,7 +455,7 @@ org_gtk_Actions_method_call (GDBusConnection *connection,
}
/**
* g_action_group_exporter_export:
* g_action_group_dbus_export_start:
* @connection: a #GDBusConnection
* @object_path: a D-Bus object path
* @action_group: a #GActionGroup
......@@ -467,19 +467,19 @@ org_gtk_Actions_method_call (GDBusConnection *connection,
* subject to change in the future.
*
* A given action group can only be exported on one object path and an
* object_path can only have one action group exported on it. If either
* object path can only have one action group exported on it. If either
* constraint is violated, the export will fail and %FALSE will be
* returned (with @error set accordingly).
*
* Use g_action_group_exporter_stop() to stop exporting @action_group,
* or g_action_group_exporter_query() to find out if and where a given
* Use g_action_group_dbus_export_stop() to stop exporting @action_group,
* or g_action_group_dbus_export_query() to find out if and where a given
* action group is exported.
*
* Returns: %TRUE if the export is successful, or %FALSE (with @error
* set) in the event of a failure.
**/
gboolean
g_action_group_exporter_export (GDBusConnection *connection,
g_action_group_dbus_export_start (GDBusConnection *connection,
const gchar *object_path,
GActionGroup *action_group,
GError **error)
......@@ -547,19 +547,19 @@ g_action_group_exporter_export (GDBusConnection *connection,
}
/**
* g_action_group_exporter_stop:
* g_action_group_dbus_export_stop:
* @action_group: a #GActionGroup
*
* Stops the export of @action_group.
*
* This reverses the effect of a previous call to
* g_action_group_exporter_export() for @action_group.
* g_action_group_dbus_export_start() for @action_group.
*
* Returns: %TRUE if an export was stopped or %FALSE if @action_group
* was not exported in the first place
**/
gboolean
g_action_group_exporter_stop (GActionGroup *action_group)
g_action_group_dbus_export_stop (GActionGroup *action_group)
{
GActionGroupExporter *exporter;
gint i;
......@@ -584,7 +584,7 @@ g_action_group_exporter_stop (GActionGroup *action_group)
}
/**
* g_action_group_exporter_query:
* g_action_group_dbus_export_query:
* @action_group: a #GActionGroup
* @connection: (out): the #GDBusConnection used for exporting
* @object_path: (out): the object path used for exporting
......@@ -601,7 +601,7 @@ g_action_group_exporter_stop (GActionGroup *action_group)
* Returns: %TRUE if @action_group was exported, else %FALSE
**/
gboolean
g_action_group_exporter_query (GActionGroup *action_group,
g_action_group_dbus_export_query (GActionGroup *action_group,
GDBusConnection **connection,
const gchar **object_path)
{
......
......@@ -32,14 +32,14 @@
G_BEGIN_DECLS
gboolean g_action_group_exporter_export (GDBusConnection *connection,
gboolean g_action_group_dbus_export_start (GDBusConnection *connection,
const gchar *object_path,
GActionGroup *action_group,
GError **error);
gboolean g_action_group_exporter_stop (GActionGroup *action_group);
gboolean g_action_group_dbus_export_stop (GActionGroup *action_group);
gboolean g_action_group_exporter_query (GActionGroup *action_group,
gboolean g_action_group_dbus_export_query (GActionGroup *action_group,
GDBusConnection **connection,
const gchar **object_path);
......
......@@ -239,9 +239,9 @@ g_application_impl_destroy (GApplicationImpl *impl)
g_dbus_connection_unregister_object (impl->session_bus,
impl->object_id);
if (impl->actions_exported)
g_action_group_exporter_stop (impl->app);
g_action_group_dbus_export_stop (impl->app);
if (impl->menu_exported)
g_menu_exporter_stop (g_application_get_menu (impl->app));
g_menu_model_dbus_export_stop (g_application_get_menu (impl->app));
g_dbus_connection_call (impl->session_bus,
"org.freedesktop.DBus",
......@@ -324,7 +324,7 @@ g_application_impl_register (GApplication *application,
return NULL;
}
if (!g_action_group_exporter_export (impl->session_bus,
if (!g_action_group_dbus_export_start (impl->session_bus,
impl->object_path,
impl->app, error))
{
......@@ -343,12 +343,12 @@ g_application_impl_register (GApplication *application,
if (g_application_get_menu (impl->app))
{
if (!g_menu_exporter_export (impl->session_bus,
if (!g_menu_model_dbus_export_start (impl->session_bus,
impl->object_path,
g_application_get_menu (impl->app),
error))
{
g_action_group_exporter_stop (impl->app);
g_action_group_dbus_export_stop (impl->app);
impl->actions_exported = FALSE;
g_dbus_connection_unregister_object (impl->session_bus,
......@@ -383,12 +383,12 @@ g_application_impl_register (GApplication *application,
impl->object_id);
impl->object_id = 0;
g_action_group_exporter_stop (impl->app);
g_action_group_dbus_export_stop (impl->app);
impl->actions_exported = FALSE;
if (impl->menu_exported)
{
g_menu_exporter_stop (g_application_get_menu (impl->app));
g_menu_model_dbus_export_stop (g_application_get_menu (impl->app));
impl->menu_exported = FALSE;
}
......@@ -424,11 +424,11 @@ g_application_impl_register (GApplication *application,
g_dbus_connection_unregister_object (impl->session_bus,
impl->object_id);
impl->object_id = 0;
g_action_group_exporter_stop (impl->app);
g_action_group_dbus_export_stop (impl->app);
impl->actions_exported = FALSE;
if (impl->menu_exported)
{
g_menu_exporter_stop (g_application_get_menu (impl->app));
g_menu_model_dbus_export_stop (g_application_get_menu (impl->app));
impl->menu_exported = FALSE;
}
......
......@@ -37,7 +37,7 @@
*
* #GDBusActionGroup is an implementation of the #GActionGroup
* interface that can be used as a proxy for an action group
* that is exported over D-Bus with g_action_group_exporter_export().
* that is exported over D-Bus with g_action_group_dbus_export_start().
*/
struct _GDBusActionGroup
......
......@@ -1413,9 +1413,9 @@ g_action_group_has_action
g_action_group_list_actions
g_action_group_query_action
g_action_group_change_action_state
g_action_group_exporter_export
g_action_group_exporter_query
g_action_group_exporter_stop
g_action_group_dbus_export_start
g_action_group_dbus_export_query
g_action_group_dbus_export_stop
g_action_activate
g_action_get_enabled
g_action_get_name
......@@ -1615,9 +1615,9 @@ g_menu_attribute_iter_get_next
g_menu_attribute_iter_get_type
g_menu_attribute_iter_get_value
g_menu_attribute_iter_next
g_menu_exporter_export
g_menu_exporter_query
g_menu_exporter_stop
g_menu_model_dbus_export_start
g_menu_model_dbus_export_query
g_menu_model_dbus_export_stop
g_menu_freeze
g_menu_get_type
g_menu_insert
......
......@@ -759,7 +759,7 @@ g_menu_exporter_new (GDBusConnection *connection,
static GHashTable *g_menu_exporter_exported_menus;
/**
* g_menu_exporter_export:
* g_menu_model_dbus_export_start:
* @connection: a #GDBusConnection
* @object_path: a D-Bus object path
* @menu: a #GMenuModel
......@@ -771,19 +771,19 @@ static GHashTable *g_menu_exporter_exported_menus;
* It is subject to change in the future.
*
* A given menu model can only be exported on one object path
* and an object_path can only have one action group exported
* and an object path can only have one action group exported
* on it. If either constraint is violated, the export will
* fail and %FALSE will be returned (with @error set accordingly).
*
* Use g_menu_exporter_stop() to stop exporting @menu
* or g_menu_exporter_query() to find out if and where a given
* menu model is exported.
* Use g_menu_model_dbus_export_stop() to stop exporting @menu
* or g_menu_model_dbus_export_query() to find out if and where
* a given menu model is exported.
*
* Returns: %TRUE if the export is successful, or %FALSE (with
* @error set) in the event of a failure.
*/
gboolean
g_menu_exporter_export (GDBusConnection *connection,
g_menu_model_dbus_export_start (GDBusConnection *connection,
const gchar *object_path,
GMenuModel *menu,
GError **error)
......@@ -810,19 +810,19 @@ g_menu_exporter_export (GDBusConnection *connection,
}
/**
* g_menu_exporter_stop:
* g_menu_model_dbus_export_stop:
* @menu: a #GMenuModel
*
* Stops the export of @menu.
*
* This reverses the effect of a previous call to
* g_menu_exporter_export() for @menu.
* g_menu_model_dbus_export_start() for @menu.
*
* Returns: %TRUE if an export was stopped or %FALSE
* if @menu was not exported in the first place
*/
gboolean
g_menu_exporter_stop (GMenuModel *menu)
g_menu_model_dbus_export_stop (GMenuModel *menu)
{
GMenuExporter *exporter;
......@@ -840,7 +840,7 @@ g_menu_exporter_stop (GMenuModel *menu)
}
/**
* g_menu_exporter_query:
* g_menu_model_dbus_export_query:
* @menu: a #GMenuModel
* @connection: (out): the #GDBusConnection used for exporting
* @object_path: (out): the object path used for exporting
......@@ -858,7 +858,7 @@ g_menu_exporter_stop (GMenuModel *menu)
* Returns: %TRUE if @menu was exported, else %FALSE
*/
gboolean
g_menu_exporter_query (GMenuModel *menu,
g_menu_model_dbus_export_query (GMenuModel *menu,
GDBusConnection **connection,
const gchar **object_path)
{
......
......@@ -27,16 +27,14 @@
G_BEGIN_DECLS
gboolean g_menu_exporter_export (GDBusConnection *connection,
gboolean g_menu_model_dbus_export_start (GDBusConnection *connection,
const gchar *object_path,
GMenuModel *menu,
GError **error);
gboolean g_menu_exporter_stop (GMenuModel *menu);
gboolean g_menu_model_dbus_export_stop (GMenuModel *menu);
gboolean g_menu_exporter_query (GMenuModel *menu,
gboolean g_menu_model_dbus_export_query (GMenuModel *menu,
GDBusConnection **connection,
const gchar **object_path);
......
......@@ -33,7 +33,7 @@
*
* #GMenuProxy is an implementation of #GMenuModel that can be used
* as a proxy for a menu model that is exported over D-Bus with
* g_menu_exporter_export().
* g_menu_model_dbus_export_start().
*/
/*
......
......@@ -590,7 +590,7 @@ test_roundtrip (void)
state.rand = g_rand_new_with_seed (g_test_rand_int ());
state.random = random_menu_new (state.rand, TOP_ORDER);
g_menu_exporter_export (bus, "/", G_MENU_MODEL (state.random), NULL);
g_menu_model_dbus_export_start (bus, "/", G_MENU_MODEL (state.random), NULL);
state.proxy = g_menu_proxy_get (bus, g_dbus_connection_get_unique_name (bus), "/");
state.count = 0;
state.success = 0;
......@@ -602,7 +602,7 @@ test_roundtrip (void)
g_main_loop_unref (state.loop);
g_object_unref (state.proxy);
g_menu_exporter_stop (G_MENU_MODEL (state.random));
g_menu_model_dbus_export_stop (G_MENU_MODEL (state.random));
g_object_unref (state.random);
g_rand_free (state.rand);
g_object_unref (bus);
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment