From 59c214159f0017b5c623772d4d6f34f940ac1113 Mon Sep 17 00:00:00 2001 From: Ted Gould Date: Wed, 9 Jun 2010 15:08:32 -0500 Subject: Autogen and adding new Makefiles --- .../reference/xml/api-index-deprecated.xml | 8 + .../reference/xml/api-index-full.xml | 53 +++++ docs/libdbusmenu-gtk/reference/xml/client.xml | 191 +++++++++++++++ .../reference/xml/genericmenuitem.xml | 256 +++++++++++++++++++++ docs/libdbusmenu-gtk/reference/xml/menu.xml | 115 +++++++++ docs/libdbusmenu-gtk/reference/xml/menuitem.xml | 89 +++++++ 6 files changed, 712 insertions(+) create mode 100644 docs/libdbusmenu-gtk/reference/xml/api-index-deprecated.xml create mode 100644 docs/libdbusmenu-gtk/reference/xml/api-index-full.xml create mode 100644 docs/libdbusmenu-gtk/reference/xml/client.xml create mode 100644 docs/libdbusmenu-gtk/reference/xml/genericmenuitem.xml create mode 100644 docs/libdbusmenu-gtk/reference/xml/menu.xml create mode 100644 docs/libdbusmenu-gtk/reference/xml/menuitem.xml (limited to 'docs/libdbusmenu-gtk/reference/xml') diff --git a/docs/libdbusmenu-gtk/reference/xml/api-index-deprecated.xml b/docs/libdbusmenu-gtk/reference/xml/api-index-deprecated.xml new file mode 100644 index 0000000..8ec0fe4 --- /dev/null +++ b/docs/libdbusmenu-gtk/reference/xml/api-index-deprecated.xml @@ -0,0 +1,8 @@ + + +]> + + diff --git a/docs/libdbusmenu-gtk/reference/xml/api-index-full.xml b/docs/libdbusmenu-gtk/reference/xml/api-index-full.xml new file mode 100644 index 0000000..4f2e63d --- /dev/null +++ b/docs/libdbusmenu-gtk/reference/xml/api-index-full.xml @@ -0,0 +1,53 @@ + + +]> + + +GENERICMENUITEM, macro in Genericmenuitem +Genericmenuitem, struct in Genericmenuitem + +C +GenericmenuitemCheckType, enum in Genericmenuitem +GENERICMENUITEM_CLASS, macro in Genericmenuitem +GenericmenuitemClass, struct in Genericmenuitem + +D +DbusmenuGtkClientClass, struct in DbusmenuGtkClient +DbusmenuGtkMenuClass, struct in DbusmenuGtkMenu +dbusmenu_gtkclient_menuitem_get, function in DbusmenuGtkClient +dbusmenu_gtkclient_menuitem_get_submenu, function in DbusmenuGtkClient +dbusmenu_gtkclient_new, function in DbusmenuGtkClient +dbusmenu_gtkclient_newitem_base, function in DbusmenuGtkClient +DBUSMENU_GTKCLIENT_SIGNAL_ROOT_CHANGED, macro in DbusmenuGtkClient +DBUSMENU_GTKCLIENT_TYPE, macro in DbusmenuGtkClient +dbusmenu_gtkmenu_get_client, function in DbusmenuGtkMenu +dbusmenu_gtkmenu_new, function in DbusmenuGtkMenu +DBUSMENU_GTKMENU_TYPE, macro in DbusmenuGtkMenu +dbusmenu_menuitem_property_get_image, function in menuitem +dbusmenu_menuitem_property_set_image, function in menuitem + +G +GENERICMENUITEM_GET_CLASS, macro in Genericmenuitem +genericmenuitem_get_image, function in Genericmenuitem +genericmenuitem_get_type, function in Genericmenuitem + +I +IS_GENERICMENUITEM, macro in Genericmenuitem +IS_GENERICMENUITEM_CLASS, macro in Genericmenuitem + +P +GenericmenuitemPrivate, struct in Genericmenuitem + +S +genericmenuitem_set_check_type, function in Genericmenuitem +genericmenuitem_set_image, function in Genericmenuitem +genericmenuitem_set_state, function in Genericmenuitem +GenericmenuitemState, enum in Genericmenuitem + +T +GENERICMENUITEM_TYPE, macro in Genericmenuitem + + diff --git a/docs/libdbusmenu-gtk/reference/xml/client.xml b/docs/libdbusmenu-gtk/reference/xml/client.xml new file mode 100644 index 0000000..7519298 --- /dev/null +++ b/docs/libdbusmenu-gtk/reference/xml/client.xml @@ -0,0 +1,191 @@ + + +]> + + +DbusmenuGtkClient +3 + + LIBDBUSMENU-GTK Library + + + +DbusmenuGtkClient + + + + +Synopsis + +#define DBUSMENU_GTKCLIENT_TYPE +#define DBUSMENU_GTKCLIENT_SIGNAL_ROOT_CHANGED + DbusmenuGtkClientClass; +DbusmenuGtkClient * dbusmenu_gtkclient_new (gchar *dbus_name, + gchar *dbus_object); +GtkMenuItem * dbusmenu_gtkclient_menuitem_get (DbusmenuGtkClient *client, + DbusmenuMenuitem *item); +GtkMenu * dbusmenu_gtkclient_menuitem_get_submenu + (DbusmenuGtkClient *client, + DbusmenuMenuitem *item); +void dbusmenu_gtkclient_newitem_base (DbusmenuGtkClient *client, + DbusmenuMenuitem *item, + GtkMenuItem *gmi, + DbusmenuMenuitem *parent); + + + + +Description + + + + +Details + +DBUSMENU_GTKCLIENT_TYPE +DBUSMENU_GTKCLIENT_TYPE +#define DBUSMENU_GTKCLIENT_TYPE (dbusmenu_gtkclient_get_type ()) + + + + +DBUSMENU_GTKCLIENT_SIGNAL_ROOT_CHANGED +DBUSMENU_GTKCLIENT_SIGNAL_ROOT_CHANGED +#define DBUSMENU_GTKCLIENT_SIGNAL_ROOT_CHANGED DBUSMENU_CLIENT_SIGNAL_ROOT_CHANGED + + + + +DbusmenuGtkClientClass +DbusmenuGtkClientClass +typedef struct { + DbusmenuClientClass parent_class; + + /* Signals */ + void (*root_changed) (DbusmenuMenuitem * newroot); + + /* Reserved */ + void (*reserved1) (void); + void (*reserved2) (void); + void (*reserved3) (void); + void (*reserved4) (void); +} DbusmenuGtkClientClass; + + +DbusmenuClientClass parent_class; +GtkMenuClass + + +root_changed () + + + +reserved1 () +Reserved for future use. + + +reserved2 () +Reserved for future use. + + +reserved3 () +Reserved for future use. + + +reserved4 () +Reserved for future use. + + + + +dbusmenu_gtkclient_new () +dbusmenu_gtkclient_new +DbusmenuGtkClient * dbusmenu_gtkclient_new (gchar *dbus_name, + gchar *dbus_object); + +Creates a new DbusmenuGtkClient object and creates a DbusmenuClient + that connects across DBus to a DbusmenuServer. + +dbus_name : +Name of the DbusmenuServer on DBus + +dbus_object : + + +Returns : A new DbusmenuGtkClient sync'd with a server + + + +dbusmenu_gtkclient_menuitem_get () +dbusmenu_gtkclient_menuitem_get +GtkMenuItem * dbusmenu_gtkclient_menuitem_get (DbusmenuGtkClient *client, + DbusmenuMenuitem *item); + +This grabs the GtkMenuItem that is associated with the + DbusmenuMenuitem. + +client : +A DbusmenuGtkClient with the item in it. + +item : +DbusmenuMenuitem to get associated GtkMenuItem on. + +Returns : The GtkMenuItem that can be played with. + + + +dbusmenu_gtkclient_menuitem_get_submenu () +dbusmenu_gtkclient_menuitem_get_submenu +GtkMenu * dbusmenu_gtkclient_menuitem_get_submenu + (DbusmenuGtkClient *client, + DbusmenuMenuitem *item); + +This grabs the submenu associated with the menuitem. + +client : +A DbusmenuGtkClient with the item in it. + +item : +DbusmenuMenuitem to get associated GtkMenu on. + +Returns : The GtkMenu if there is one. + + + +dbusmenu_gtkclient_newitem_base () +dbusmenu_gtkclient_newitem_base +void dbusmenu_gtkclient_newitem_base (DbusmenuGtkClient *client, + DbusmenuMenuitem *item, + GtkMenuItem *gmi, + DbusmenuMenuitem *parent); + +This function provides some of the basic connectivity for being in + the GTK world. Things like visibility and sensitivity of the item are + handled here so that the subclasses don't have to. If you're building + your on GTK menu item you can use this function to apply those basic + attributes so that you don't have to deal with them either. + + + This also handles passing the "activate" signal back to the + DbusmenuMenuitem side of thing. + +client : +The client handling everything on this connection + +item : +The DbusmenuMenuitem to attach the GTK-isms to + +gmi : +A GtkMenuItem representing the GTK world's view of this menuitem + +parent : +The parent DbusmenuMenuitem + + + + + + diff --git a/docs/libdbusmenu-gtk/reference/xml/genericmenuitem.xml b/docs/libdbusmenu-gtk/reference/xml/genericmenuitem.xml new file mode 100644 index 0000000..1ecb04c --- /dev/null +++ b/docs/libdbusmenu-gtk/reference/xml/genericmenuitem.xml @@ -0,0 +1,256 @@ + + +]> + + +Genericmenuitem +3 + + LIBDBUSMENU-GTK Library + + + +Genericmenuitem + + + + +Synopsis + +#define GENERICMENUITEM_TYPE +#define GENERICMENUITEM (obj) +#define GENERICMENUITEM_CLASS (klass) +#define IS_GENERICMENUITEM (obj) +#define IS_GENERICMENUITEM_CLASS (klass) +#define GENERICMENUITEM_GET_CLASS (obj) + Genericmenuitem; + GenericmenuitemClass; + GenericmenuitemPrivate; +enum GenericmenuitemCheckType; +enum GenericmenuitemState; +GType genericmenuitem_get_type (void); +void genericmenuitem_set_check_type (Genericmenuitem *item, + GenericmenuitemCheckType check_type); +void genericmenuitem_set_state (Genericmenuitem *item, + GenericmenuitemState state); +void genericmenuitem_set_image (Genericmenuitem *item, + GtkWidget *image); +GtkWidget * genericmenuitem_get_image (Genericmenuitem *item); + + + +Object Hierarchy + + GObject + +----GInitiallyUnowned + +----GtkObject + +----GtkWidget + +----GtkContainer + +----GtkBin + +----GtkItem + +----GtkMenuItem + +----GtkCheckMenuItem + +----Genericmenuitem + + + +Implemented Interfaces + +Genericmenuitem implements + AtkImplementorIface, GtkBuildable and GtkActivatable. + + + +Description + + + + +Details + +GENERICMENUITEM_TYPE +GENERICMENUITEM_TYPE +#define GENERICMENUITEM_TYPE (genericmenuitem_get_type ()) + + + + +GENERICMENUITEM() +GENERICMENUITEM +#define GENERICMENUITEM(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GENERICMENUITEM_TYPE, Genericmenuitem)) + + + +obj : + + + + +GENERICMENUITEM_CLASS() +GENERICMENUITEM_CLASS +#define GENERICMENUITEM_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GENERICMENUITEM_TYPE, GenericmenuitemClass)) + + + +klass : + + + + +IS_GENERICMENUITEM() +IS_GENERICMENUITEM +#define IS_GENERICMENUITEM(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GENERICMENUITEM_TYPE)) + + + +obj : + + + + +IS_GENERICMENUITEM_CLASS() +IS_GENERICMENUITEM_CLASS +#define IS_GENERICMENUITEM_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GENERICMENUITEM_TYPE)) + + + +klass : + + + + +GENERICMENUITEM_GET_CLASS() +GENERICMENUITEM_GET_CLASS +#define GENERICMENUITEM_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GENERICMENUITEM_TYPE, GenericmenuitemClass)) + + + +obj : + + + + +Genericmenuitem +Genericmenuitem +typedef struct _Genericmenuitem Genericmenuitem; + + + +GenericmenuitemClass +GenericmenuitemClass +typedef struct { + GtkCheckMenuItemClass parent_class; +} GenericmenuitemClass; + + +GtkCheckMenuItemClass parent_class; +Our parent GtkCheckMenuItemClass + + + + +GenericmenuitemPrivate +GenericmenuitemPrivate +typedef struct _GenericmenuitemPrivate GenericmenuitemPrivate; + + + +enum GenericmenuitemCheckType +GenericmenuitemCheckType +enum GenericmenuitemCheckType { + GENERICMENUITEM_CHECK_TYPE_NONE, + GENERICMENUITEM_CHECK_TYPE_CHECKBOX, + GENERICMENUITEM_CHECK_TYPE_RADIO +}; + + + + +enum GenericmenuitemState +GenericmenuitemState +enum GenericmenuitemState { + GENERICMENUITEM_STATE_UNCHECKED, + GENERICMENUITEM_STATE_CHECKED, + GENERICMENUITEM_STATE_INDETERMINATE +}; + + + + +genericmenuitem_get_type () +genericmenuitem_get_type +GType genericmenuitem_get_type (void); + + +Returns : + + + +genericmenuitem_set_check_type () +genericmenuitem_set_check_type +void genericmenuitem_set_check_type (Genericmenuitem *item, + GenericmenuitemCheckType check_type); + +This function changes the type of the checkmark that + appears in the left hand gutter for the menuitem. + +item : +Genericmenuitem to set the type on + +check_type : +Which type of check should be displayed + + + +genericmenuitem_set_state () +genericmenuitem_set_state +void genericmenuitem_set_state (Genericmenuitem *item, + GenericmenuitemState state); + +Sets the state of the check in the menu item. It does + not require, but isn't really useful if the type of + check that the menuitem is set to GENERICMENUITEM_CHECK_TYPE_NONE. + +item : +Genericmenuitem to set the type on + +state : + + + + +genericmenuitem_set_image () +genericmenuitem_set_image +void genericmenuitem_set_image (Genericmenuitem *item, + GtkWidget *image); + +Sets the image of the menu item. + +item : +A Genericmenuitem + +image : +The image to set as the image of item + + + +genericmenuitem_get_image () +genericmenuitem_get_image +GtkWidget * genericmenuitem_get_image (Genericmenuitem *item); + +Returns the image if there is one. + +item : +A Genericmenuitem + +Returns : A pointer to the image of the item or NULL + if there isn't one. + + + + + + diff --git a/docs/libdbusmenu-gtk/reference/xml/menu.xml b/docs/libdbusmenu-gtk/reference/xml/menu.xml new file mode 100644 index 0000000..5074b52 --- /dev/null +++ b/docs/libdbusmenu-gtk/reference/xml/menu.xml @@ -0,0 +1,115 @@ + + +]> + + +DbusmenuGtkMenu +3 + + LIBDBUSMENU-GTK Library + + + +DbusmenuGtkMenu + + + + +Synopsis + +#define DBUSMENU_GTKMENU_TYPE + DbusmenuGtkMenuClass; +DbusmenuGtkMenu * dbusmenu_gtkmenu_new (gchar *dbus_name, + gchar *dbus_object); +DbusmenuGtkClient * dbusmenu_gtkmenu_get_client (DbusmenuGtkMenu *menu); + + + + +Description + + + + +Details + +DBUSMENU_GTKMENU_TYPE +DBUSMENU_GTKMENU_TYPE +#define DBUSMENU_GTKMENU_TYPE (dbusmenu_gtkmenu_get_type ()) + + + + +DbusmenuGtkMenuClass +DbusmenuGtkMenuClass +typedef struct { + GtkMenuClass parent_class; + + /* Reserved */ + void (*reserved1) (void); + void (*reserved2) (void); + void (*reserved3) (void); + void (*reserved4) (void); +} DbusmenuGtkMenuClass; + + +GtkMenuClass parent_class; +GtkMenuClass + + +reserved1 () +Reserved for future use. + + +reserved2 () +Reserved for future use. + + +reserved3 () +Reserved for future use. + + +reserved4 () +Reserved for future use. + + + + +dbusmenu_gtkmenu_new () +dbusmenu_gtkmenu_new +DbusmenuGtkMenu * dbusmenu_gtkmenu_new (gchar *dbus_name, + gchar *dbus_object); + +Creates a new DbusmenuGtkMenu object and creates a DbusmenuClient + that connects across DBus to a DbusmenuServer. + +dbus_name : +Name of the DbusmenuServer on DBus + +dbus_object : + + +Returns : A new DbusmenuGtkMenu sync'd with a server + + + +dbusmenu_gtkmenu_get_client () +dbusmenu_gtkmenu_get_client +DbusmenuGtkClient * dbusmenu_gtkmenu_get_client (DbusmenuGtkMenu *menu); + +An accessor for the client that this menu is using to + communicate with the server. + +menu : +The DbusmenuGtkMenu to get the client from + +Returns : A valid DbusmenuGtkClient or NULL on error. + + + + + + diff --git a/docs/libdbusmenu-gtk/reference/xml/menuitem.xml b/docs/libdbusmenu-gtk/reference/xml/menuitem.xml new file mode 100644 index 0000000..b9bd4b6 --- /dev/null +++ b/docs/libdbusmenu-gtk/reference/xml/menuitem.xml @@ -0,0 +1,89 @@ + + +]> + + +menuitem +3 + + LIBDBUSMENU-GTK Library + + + +menuitem + + + + +Synopsis + +gboolean dbusmenu_menuitem_property_set_image + (DbusmenuMenuitem *menuitem, + const gchar *property, + const GdkPixbuf *data); +GdkPixbuf * dbusmenu_menuitem_property_get_image + (DbusmenuMenuitem *menuitem, + const gchar *property); + + + + +Description + + + + +Details + +dbusmenu_menuitem_property_set_image () +dbusmenu_menuitem_property_set_image +gboolean dbusmenu_menuitem_property_set_image + (DbusmenuMenuitem *menuitem, + const gchar *property, + const GdkPixbuf *data); + +This function takes the pixbuf that is stored in data and + turns it into a base64 encoded PNG so that it can be placed + onto a standard DbusmenuMenuitem property. + +menuitem : +The DbusmenuMenuitem to set the property on. + +property : +Name of the property to set. + +data : +The image to place on the property. + +Returns : Whether the function was able to set the property + or not. + + + +dbusmenu_menuitem_property_get_image () +dbusmenu_menuitem_property_get_image +GdkPixbuf * dbusmenu_menuitem_property_get_image + (DbusmenuMenuitem *menuitem, + const gchar *property); + +This function looks on the menu item for a property by the + name of property. If one exists it tries to turn it into + a GdkPixbuf. It assumes that the property is a base64 encoded + PNG file like the one created by dbusmenu_menuite_property_set_image. + +menuitem : +The DbusmenuMenuite to look for the property on + +property : +The name of the property to look for. + +Returns : A pixbuf or NULL to signal error. + + + + + + -- cgit v1.2.3