DBUSMENU_CLIENT_SIGNAL_LAYOUT_UPDATED

#define DBUSMENU_CLIENT_SIGNAL_LAYOUT_UPDATED  "layout-updated"

DBUSMENU_CLIENT_SIGNAL_ROOT_CHANGED

#define DBUSMENU_CLIENT_SIGNAL_ROOT_CHANGED    "root-changed"

DBUSMENU_CLIENT_SIGNAL_NEW_MENUITEM

#define DBUSMENU_CLIENT_SIGNAL_NEW_MENUITEM    "new-menuitem"

DBUSMENU_CLIENT_PROP_DBUS_NAME

#define DBUSMENU_CLIENT_PROP_DBUS_NAME     "dbus-name"

DBUSMENU_CLIENT_PROP_DBUS_OBJECT

#define DBUSMENU_CLIENT_PROP_DBUS_OBJECT   "dbus-object"

DBUSMENU_CLIENT_TYPES_DEFAULT

#define DBUSMENU_CLIENT_TYPES_DEFAULT      "standard"

DBUSMENU_CLIENT_TYPES_SEPARATOR

#define DBUSMENU_CLIENT_TYPES_SEPARATOR    "separator"

DBUSMENU_CLIENT_TYPES_IMAGE

#define DBUSMENU_CLIENT_TYPES_IMAGE        "standard"

DbusmenuClient

typedef struct _DbusmenuClient DbusmenuClient;

The client for a DbusmenuServer creating a shared object set of DbusmenuMenuitem objects.

struct DbusmenuClientClass

struct DbusmenuClientClass {
	GObjectClass parent_class;

	void (*layout_updated)(void);
	void (*root_changed) (DbusmenuMenuitem * newroot);
	void (*new_menuitem) (DbusmenuMenuitem * newitem);
	void (*item_activate) (DbusmenuMenuitem * item, guint timestamp);
	void (*event_result) (DbusmenuMenuitem * item, gchar * event, GVariant * data, guint timestamp, GError * error);

	/*< Private >*/
	void (*reserved1) (void);
	void (*reserved2) (void);
	void (*reserved3) (void);
	void (*reserved4) (void);
	void (*reserved5) (void);
	void (*reserved6) (void);
};

A simple class that takes all of the information from a DbusmenuServer over DBus and makes the same set of DbusmenuMenuitem objects appear on the other side.

DbusmenuClientTypeHandler ()

gboolean            (*DbusmenuClientTypeHandler)        (DbusmenuMenuitem *newitem,
                                                         DbusmenuMenuitem *parent,
                                                         DbusmenuClient *client,
                                                         gpointer user_data);

The type handler is called when a dbusmenu item is created with a matching type as setup in dbusmenu_client_add_type_handler

dbusmenu_client_new ()

DbusmenuClient *      dbusmenu_client_new               (const gchar *name,
                                                         const gchar *object);

This function creates a new client that connects to a specific server on DBus. That server is at a specific location sharing a known object. The interface is assumed by the code to be the DBus menu interface. The newly created client will start sending out events as it syncs up with the server.

dbusmenu_client_get_root ()

DbusmenuMenuitem *    dbusmenu_client_get_root          (DbusmenuClient *client);

Grabs the root node for the specified client client. This function may block. It will block if there is currently a call to update the layout, it will block on that layout updated and then return the newly updated layout. Chances are that this update is in the queue for the mainloop as it would have been requested some time ago, but in theory it could block longer.

dbusmenu_client_add_type_handler ()

gboolean            dbusmenu_client_add_type_handler    (DbusmenuClient *client,
                                                         const gchar *type,
                                                         DbusmenuClientTypeHandler newfunc);

This function connects into the type handling of the DbusmenuClient. Every new menuitem that comes in immediately gets asked for it's properties. When we get those properties we check the 'type' property and look to see if it matches a handler that is known by the client. If so, the newfunc function is executed on that DbusmenuMenuitem. If not, then the DbusmenuClient::new-menuitem signal is sent.

In the future the known types will be sent to the server so that it can make choices about the menu item types availble.

dbusmenu_client_send_event ()

void                dbusmenu_client_send_event          (DbusmenuClient *client,
                                                         gint id,
                                                         const gchar *name,
                                                         GVariant *variant,
                                                         guint timestamp);

dbusmenu_client_send_about_to_show ()

void                dbusmenu_client_send_about_to_show  (DbusmenuClient *client,
                                                         gint id,
                                                         void (*cb) (gpointer user_data),
                                                         gpointer cb_data);