XesamGDBusSearcherStub

XesamGDBusSearcherStub — Helper class used to export a XesamGSearcher over DBus

Synopsis

                    XesamGDBusSearcherStubPrivate;
                    XesamGDBusSearcherStub;
XesamGDBusSearcherStub* xesam_g_dbus_searcher_stub_new  (XesamGSearcher *searcher);
void                xesam_g_dbus_searcher_stub_register_bus_name
                                                        (const gchar *bus_name,
                                                         GError **error);
void                xesam_g_dbus_searcher_stub_release_bus_name
                                                        (const gchar *bus_name,
                                                         GError **error);

Object Hierarchy

  GObject
   +----XesamGDBusSearcherStub

Signals

  "hits-added"                                     : Run Last
  "hits-modified"                                  : Run Last
  "hits-removed"                                   : Run Last
  "search-done"                                    : Run Last
  "state-changed"                                  : Run Last

Description

The XesamGDBusSearcherStub class connects a XesamGSearcher to DBus and exposes it as a Xesam Search 1.0 interface.

XesamGDBusSearcherStub is available since 1.0

Details

XesamGDBusSearcherStubPrivate

typedef struct _XesamGDBusSearcherStubPrivate XesamGDBusSearcherStubPrivate;

XesamGDBusSearcherStub

typedef struct _XesamGDBusSearcherStub XesamGDBusSearcherStub;

xesam_g_dbus_searcher_stub_new ()

XesamGDBusSearcherStub* xesam_g_dbus_searcher_stub_new  (XesamGSearcher *searcher);

Create a DBus stub object capable of exporting a XesamGSearcher over dbus. To complete the actual export call xesam_g_dbus_searcher_stub_export().

searcher :

 A XesamGSearcher to export over dbus

Returns :

 An object exporting the given searcher as a dbus object, or NULL on error.

xesam_g_dbus_searcher_stub_register_bus_name ()

void                xesam_g_dbus_searcher_stub_register_bus_name
                                                        (const gchar *bus_name,
                                                         GError **error);

Register a name on the session bus. The main Xesam searcher would register XESAM_G_SERVER_DBUS_NAME.

To unregister your bus name claimed this way use xesam_g_dbus_searcher_stub_release_bus_name().

bus_name :

error :

 GError to set if the name registration fails

xesam_g_dbus_searcher_stub_release_bus_name ()

void                xesam_g_dbus_searcher_stub_release_bus_name
                                                        (const gchar *bus_name,
                                                         GError **error);

Release a bus name obtained via xesam_g_dbus_searcher_stub_release_bus_name().

bus_name :

 Bus name to give up

error :

 GError to set if the name registration fails

Signal Details

The "hits-added" signal

void                user_function                      (XesamGDBusSearcherStub *xesamgdbussearcherstub,
                                                        gchar                  *arg1,
                                                        guint                   arg2,
                                                        gpointer                user_data)                   : Run Last

xesamgdbussearcherstub :

 the object which received the signal.

arg1 :

arg2 :

user_data :

 user data set when the signal handler was connected.

The "hits-modified" signal

void                user_function                      (XesamGDBusSearcherStub *xesamgdbussearcherstub,
                                                        gchar                  *arg1,
                                                        GArray_guint_          *arg2,
                                                        gpointer                user_data)                   : Run Last

xesamgdbussearcherstub :

 the object which received the signal.

arg1 :

arg2 :

user_data :

 user data set when the signal handler was connected.

The "hits-removed" signal

void                user_function                      (XesamGDBusSearcherStub *xesamgdbussearcherstub,
                                                        gchar                  *arg1,
                                                        GArray_guint_          *arg2,
                                                        gpointer                user_data)                   : Run Last

xesamgdbussearcherstub :

 the object which received the signal.

arg1 :

arg2 :

user_data :

 user data set when the signal handler was connected.

The "search-done" signal

void                user_function                      (XesamGDBusSearcherStub *xesamgdbussearcherstub,
                                                        gchar                  *arg1,
                                                        gpointer                user_data)                   : Run Last

xesamgdbussearcherstub :

 the object which received the signal.

arg1 :

user_data :

 user data set when the signal handler was connected.

The "state-changed" signal

void                user_function                      (XesamGDBusSearcherStub *xesamgdbussearcherstub,
                                                        GStrv                  *arg1,
                                                        gpointer                user_data)                   : Run Last

xesamgdbussearcherstub :

 the object which received the signal.

arg1 :

user_data :

 user data set when the signal handler was connected.
Generated by GTK-Doc V1.10