From edcd67e602c43de358839b9d277d25e049e9951b Mon Sep 17 00:00:00 2001
From: Ted Gould <ted@gould.cx>
Date: Wed, 16 Feb 2011 22:16:20 -0600
Subject: Some enum type templates

---
 libdbusmenu-glib/enum-types.h.in | 53 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 53 insertions(+)
 create mode 100644 libdbusmenu-glib/enum-types.h.in

(limited to 'libdbusmenu-glib/enum-types.h.in')

diff --git a/libdbusmenu-glib/enum-types.h.in b/libdbusmenu-glib/enum-types.h.in
new file mode 100644
index 0000000..83b4bd2
--- /dev/null
+++ b/libdbusmenu-glib/enum-types.h.in
@@ -0,0 +1,53 @@
+/*** BEGIN file-header ***/
+/*
+Enums from the dbusmenu headers
+
+Copyright 2011 Canonical Ltd.
+
+Authors:
+    Ted Gould <ted@canonical.com>
+
+This program is free software: you can redistribute it and/or modify it 
+under the terms of either or both of the following licenses:
+
+1) the GNU Lesser General Public License version 3, as published by the 
+   Free Software Foundation; and/or
+2) the GNU Lesser General Public License version 2.1, as published by 
+   the Free Software Foundation.
+
+This program is distributed in the hope that it will be useful, but 
+WITHOUT ANY WARRANTY; without even the implied warranties of 
+MERCHANTABILITY, SATISFACTORY QUALITY or FITNESS FOR A PARTICULAR 
+PURPOSE.  See the applicable version of the GNU Lesser General Public 
+License for more details.
+
+You should have received a copy of both the GNU Lesser General Public 
+License version 3 and version 2.1 along with this program.  If not, see 
+<http://www.gnu.org/licenses/>
+*/
+
+#ifndef __DBUSMENU_ENUM_TYPES_H__
+#define __DBUSMENU_ENUM_TYPES_H__
+
+#include <glib-object.h>
+
+G_BEGIN_DECLS
+
+/*** END file-header ***/
+
+/*** BEGIN file-tail ***/
+
+G_END_DECLS
+
+#endif /* __DBUSMENU_ENUM_TYPES_H__ */
+/*** END file-tail ***/
+
+/*** BEGIN file-production ***/
+/* Enumerations from file: "@filename@" */
+/*** END file-production ***/
+
+/*** BEGIN value-header ***/
+GType @enum_name@_get_type (void) G_GNUC_CONST;
+#define DBUSMENU_TYPE_@ENUMSHORT@ (@enum_name@_get_type())
+
+/*** END value-header ***/
-- 
cgit v1.2.3


From 5c0f6f04e9be75e273049bf5b4134185c12d32c1 Mon Sep 17 00:00:00 2001
From: Ted Gould <ted@gould.cx>
Date: Thu, 17 Feb 2011 23:24:41 -0600
Subject: Adding a get_nick function for our enums

---
 libdbusmenu-glib/enum-types.c.in | 25 +++++++++++++++++++++++++
 libdbusmenu-glib/enum-types.h.in |  2 ++
 2 files changed, 27 insertions(+)

(limited to 'libdbusmenu-glib/enum-types.h.in')

diff --git a/libdbusmenu-glib/enum-types.c.in b/libdbusmenu-glib/enum-types.c.in
index d572d44..b0756d9 100644
--- a/libdbusmenu-glib/enum-types.c.in
+++ b/libdbusmenu-glib/enum-types.c.in
@@ -64,4 +64,29 @@ GType
 	return etype;
 }
 
+/**
+	@enum_name@_get_nick:
+	@value: The value of @EnumName@ to get the nick of
+
+	Looks up in the enum table for the nick of @value.
+
+	Return value: The nick for the given value or #NULL on error
+*/
+const gchar *
+@enum_name@_get_nick (@EnumName@ value)
+{
+	GEnumClass * class = G_ENUM_CLASS(g_type_class_ref(@enum_name@_get_type()));
+	g_return_val_if_fail(class != NULL, NULL);
+
+	const gchar * ret = NULL;
+	GEnumValue * val = g_enum_get_value(class, value);
+	if (val != NULL) {
+		ret = val->value_nick;
+	}
+
+	g_type_class_unref(class);
+	return ret;
+}
+
+
 /*** END value-tail ***/
diff --git a/libdbusmenu-glib/enum-types.h.in b/libdbusmenu-glib/enum-types.h.in
index 83b4bd2..eb24453 100644
--- a/libdbusmenu-glib/enum-types.h.in
+++ b/libdbusmenu-glib/enum-types.h.in
@@ -44,10 +44,12 @@ G_END_DECLS
 
 /*** BEGIN file-production ***/
 /* Enumerations from file: "@filename@" */
+#include "@filename@"
 /*** END file-production ***/
 
 /*** BEGIN value-header ***/
 GType @enum_name@_get_type (void) G_GNUC_CONST;
+const gchar * @enum_name@_get_nick (@EnumName@ value) G_GNUC_CONST;
 #define DBUSMENU_TYPE_@ENUMSHORT@ (@enum_name@_get_type())
 
 /*** END value-header ***/
-- 
cgit v1.2.3


From b7434b48401a4049facc3eb455bb1075e1ad78ca Mon Sep 17 00:00:00 2001
From: Ted Gould <ted@gould.cx>
Date: Fri, 18 Feb 2011 12:48:23 -0600
Subject: Adding a nick to value translator

---
 libdbusmenu-glib/enum-types.c.in | 24 ++++++++++++++++++++++++
 libdbusmenu-glib/enum-types.h.in |  1 +
 2 files changed, 25 insertions(+)

(limited to 'libdbusmenu-glib/enum-types.h.in')

diff --git a/libdbusmenu-glib/enum-types.c.in b/libdbusmenu-glib/enum-types.c.in
index b0756d9..9395f5f 100644
--- a/libdbusmenu-glib/enum-types.c.in
+++ b/libdbusmenu-glib/enum-types.c.in
@@ -88,5 +88,29 @@ const gchar *
 	return ret;
 }
 
+/**
+	@enum_name@_get_value_from_nick:
+	@nick: The enum nick to lookup
+
+	Looks up in the enum table for the value of @nick.
+
+	Return value: The value for the given @nick
+*/
+@EnumName@
+@enum_name@_get_value_from_nick (const gchar * nick)
+{
+	GEnumClass * class = G_ENUM_CLASS(g_type_class_ref(@enum_name@_get_type()));
+	g_return_val_if_fail(class != NULL, 0);
+
+	@EnumName@ ret = 0;
+	GEnumValue * val = g_enum_get_value_by_nick(class, nick);
+	if (val != NULL) {
+		ret = val->value;
+	}
+
+	g_type_class_unref(class);
+	return ret;
+}
+
 
 /*** END value-tail ***/
diff --git a/libdbusmenu-glib/enum-types.h.in b/libdbusmenu-glib/enum-types.h.in
index eb24453..8c5f463 100644
--- a/libdbusmenu-glib/enum-types.h.in
+++ b/libdbusmenu-glib/enum-types.h.in
@@ -50,6 +50,7 @@ G_END_DECLS
 /*** BEGIN value-header ***/
 GType @enum_name@_get_type (void) G_GNUC_CONST;
 const gchar * @enum_name@_get_nick (@EnumName@ value) G_GNUC_CONST;
+@EnumName@ @enum_name@_get_value_from_nick (const gchar * nick) G_GNUC_CONST;
 #define DBUSMENU_TYPE_@ENUMSHORT@ (@enum_name@_get_type())
 
 /*** END value-header ***/
-- 
cgit v1.2.3


From 76b4e15adaf273d765fb9ef1f4e19c58fac67831 Mon Sep 17 00:00:00 2001
From: Ted Gould <ted@gould.cx>
Date: Thu, 24 Feb 2011 09:38:18 -0600
Subject: Documentation fixes

---
 docs/libdbusmenu-glib/reference/Makefile.am        |  1 +
 .../reference/libdbusmenu-glib-docs.sgml           |  1 +
 .../reference/libdbusmenu-glib-sections.txt        | 29 ++++++++++++++++++++++
 libdbusmenu-glib/client.h                          | 15 +++++++++++
 libdbusmenu-glib/defaults.c                        |  8 +++---
 libdbusmenu-glib/defaults.h                        |  4 +--
 libdbusmenu-glib/enum-types.h.in                   |  6 +++++
 libdbusmenu-glib/server.c                          |  2 ++
 libdbusmenu-glib/server.h                          | 10 ++++++++
 libdbusmenu-glib/types.h                           | 11 ++++++++
 10 files changed, 81 insertions(+), 6 deletions(-)

(limited to 'libdbusmenu-glib/enum-types.h.in')

diff --git a/docs/libdbusmenu-glib/reference/Makefile.am b/docs/libdbusmenu-glib/reference/Makefile.am
index 1c8dfa8..2af5ec3 100644
--- a/docs/libdbusmenu-glib/reference/Makefile.am
+++ b/docs/libdbusmenu-glib/reference/Makefile.am
@@ -51,6 +51,7 @@ IGNORE_HFILES= \
 	dbus-menu-clean.xml.h \
 	client-menuitem.h \
 	client-private.h \
+	defaults.h \
 	menuitem-marshal.h \
 	server-marshal.h \
 	menuitem-private.h
diff --git a/docs/libdbusmenu-glib/reference/libdbusmenu-glib-docs.sgml b/docs/libdbusmenu-glib/reference/libdbusmenu-glib-docs.sgml
index 16ed624..53a0ceb 100644
--- a/docs/libdbusmenu-glib/reference/libdbusmenu-glib-docs.sgml
+++ b/docs/libdbusmenu-glib/reference/libdbusmenu-glib-docs.sgml
@@ -18,6 +18,7 @@
     <xi:include href="xml/client-menuitem.xml"/>
     <xi:include href="xml/dbusmenu-client.xml"/>
     <xi:include href="xml/dbusmenu-server.xml"/>
+    <xi:include href="xml/types.xml"/>
 
   </chapter>
   <chapter id="object-tree">
diff --git a/docs/libdbusmenu-glib/reference/libdbusmenu-glib-sections.txt b/docs/libdbusmenu-glib/reference/libdbusmenu-glib-sections.txt
index b6a6902..9c69fb7 100644
--- a/docs/libdbusmenu-glib/reference/libdbusmenu-glib-sections.txt
+++ b/docs/libdbusmenu-glib/reference/libdbusmenu-glib-sections.txt
@@ -6,8 +6,11 @@ DBUSMENU_CLIENT_SIGNAL_ROOT_CHANGED
 DBUSMENU_CLIENT_SIGNAL_NEW_MENUITEM
 DBUSMENU_CLIENT_SIGNAL_EVENT_RESULT
 DBUSMENU_CLIENT_SIGNAL_ITEM_ACTIVATE
+DBUSMENU_CLIENT_SIGNAL_TEXT_DIRECTION_CHANGED
 DBUSMENU_CLIENT_PROP_DBUS_NAME
 DBUSMENU_CLIENT_PROP_DBUS_OBJECT
+DBUSMENU_CLIENT_PROP_STATUS
+DBUSMENU_CLIENT_PROP_TEXT_DIRECTION
 DBUSMENU_CLIENT_TYPES_DEFAULT
 DBUSMENU_CLIENT_TYPES_SEPARATOR
 DBUSMENU_CLIENT_TYPES_IMAGE
@@ -17,6 +20,8 @@ DbusmenuClientTypeHandler
 DbusmenuClientTypeDestroyHandler
 dbusmenu_client_new
 dbusmenu_client_get_root
+dbusmenu_client_get_status
+dbusmenu_client_get_text_direction
 dbusmenu_client_add_type_handler
 dbusmenu_client_add_type_handler_full
 <SUBSECTION Standard>
@@ -122,11 +127,17 @@ DBUSMENU_SERVER_SIGNAL_LAYOUT_UPDATE
 DBUSMENU_SERVER_SIGNAL_ITEM_ACTIVATION
 DBUSMENU_SERVER_PROP_DBUS_OBJECT
 DBUSMENU_SERVER_PROP_ROOT_NODE
+DBUSMENU_SERVER_PROP_STATUS
+DBUSMENU_SERVER_PROP_TEXT_DIRECTION
 DBUSMENU_SERVER_PROP_VERSION
 DbusmenuServer
 DbusmenuServerClass
 dbusmenu_server_new
+dbusmenu_server_get_status
+dbusmenu_server_get_text_direction
 dbusmenu_server_set_root
+dbusmenu_server_set_status
+dbusmenu_server_set_text_direction
 <SUBSECTION Standard>
 DBUSMENU_SERVER
 DBUSMENU_IS_SERVER
@@ -158,3 +169,21 @@ DbusmenuMenuitemProxyPrivate
 dbusmenu_menuitem_proxy_get_type
 </SECTION>
 
+<SECTION>
+<FILE>types</FILE>
+<TITLE>Types</TITLE>
+DBUSMENU_TYPE_STATUS
+DBUSMENU_TYPE_TEXT_DIRECTION
+DbusmenuStatus
+DbusmenuTextDirection
+dbusmenu_status_get_nick
+dbusmenu_status_get_type
+dbusmenu_status_get_value_from_nick
+dbusmenu_text_direction_get_nick
+dbusmenu_text_direction_get_type
+dbusmenu_text_direction_get_value_from_nick
+<SUBSECTION Private>
+DbusmenuServerPrivate
+dbusmenu_server_get_type
+</SECTION>
+
diff --git a/libdbusmenu-glib/client.h b/libdbusmenu-glib/client.h
index 0b94eb2..28d4dd3 100644
--- a/libdbusmenu-glib/client.h
+++ b/libdbusmenu-glib/client.h
@@ -74,6 +74,11 @@ G_BEGIN_DECLS
  * String to attach to signal #DbusmenuClient::event-result
  */
 #define DBUSMENU_CLIENT_SIGNAL_EVENT_RESULT    "event-result"
+/**
+ * DBUSMENU_CLIENT_SIGNAL_TEXT_DIRECTION_CHANGED:
+ *
+ * String to attach to signal #DbusmenuClient::text-direction-changed
+ */
 #define DBUSMENU_CLIENT_SIGNAL_TEXT_DIRECTION_CHANGED    "text-direction-changed"
 
 /**
@@ -88,7 +93,17 @@ G_BEGIN_DECLS
  * String to access property #DbusmenuClient:dbus-object
  */
 #define DBUSMENU_CLIENT_PROP_DBUS_OBJECT   "dbus-object"
+/**
+ * DBUSMENU_CLIENT_PROP_STATUS:
+ *
+ * String to access property #DbusmenuClient:status
+ */
 #define DBUSMENU_CLIENT_PROP_STATUS        "status"
+/**
+ * DBUSMENU_CLIENT_PROP_TEXT_DIRECTION:
+ *
+ * String to access property #DbusmenuClient:text-direction
+ */
 #define DBUSMENU_CLIENT_PROP_TEXT_DIRECTION "text-direction"
 
 /**
diff --git a/libdbusmenu-glib/defaults.c b/libdbusmenu-glib/defaults.c
index 3ad5d76..c05ef38 100644
--- a/libdbusmenu-glib/defaults.c
+++ b/libdbusmenu-glib/defaults.c
@@ -156,7 +156,7 @@ entry_destroy (gpointer entry)
 
 static DbusmenuDefaults * default_defaults = NULL;
 
-/**
+/*
  * dbusmenu_defaults_ref_default:
  *
  * Get a reference to the default instance.  If it doesn't exist this
@@ -177,7 +177,7 @@ dbusmenu_defaults_ref_default (void)
 	return default_defaults;
 }
 
-/**
+/*
  * dbusmenu_defaults_default_set:
  * @defaults: The #DbusmenuDefaults object to add to
  * @type: (allow-none): The #DbusmenuMenuitem type for this default if #NULL will default to #DBUSMENU_CLIENT_TYPE_DEFAULT
@@ -216,7 +216,7 @@ dbusmenu_defaults_default_set (DbusmenuDefaults * defaults, const gchar * type,
 	return;
 }
 
-/**
+/*
  * dbusmenu_defaults_default_get:
  * @defaults: The default database to use
  * @type: (allow-none): The #DbusmenuMenuitem type for this default if #NULL will default to #DBUSMENU_CLIENT_TYPE_DEFAULT
@@ -253,7 +253,7 @@ dbusmenu_defaults_default_get (DbusmenuDefaults * defaults, const gchar * type,
 	return entry->value;
 }
 
-/**
+/*
  * dbusmenu_defaults_default_get_type:
  * @defaults: The default database to use
  * @type: (allow-none): The #DbusmenuMenuitem type for this default if #NULL will default to #DBUSMENU_CLIENT_TYPE_DEFAULT
diff --git a/libdbusmenu-glib/defaults.h b/libdbusmenu-glib/defaults.h
index ab377f7..a1a8158 100644
--- a/libdbusmenu-glib/defaults.h
+++ b/libdbusmenu-glib/defaults.h
@@ -45,7 +45,7 @@ typedef struct _DbusmenuDefaults        DbusmenuDefaults;
 typedef struct _DbusmenuDefaultsClass   DbusmenuDefaultsClass;
 typedef struct _DbusmenuDefaultsPrivate DbusmenuDefaultsPrivate;
 
-/**
+/*
  * DbusmenuDefaultsClass:
  *
  * All of the signals and functions for #DbusmenuDefaults
@@ -54,7 +54,7 @@ struct _DbusmenuDefaultsClass {
 	GObjectClass parent_class;
 };
 
-/**
+/*
  * DbusmenuDefaults:
  *
  * A singleton to hold all of the defaults for the menuitems
diff --git a/libdbusmenu-glib/enum-types.h.in b/libdbusmenu-glib/enum-types.h.in
index 8c5f463..488b615 100644
--- a/libdbusmenu-glib/enum-types.h.in
+++ b/libdbusmenu-glib/enum-types.h.in
@@ -51,6 +51,12 @@ G_END_DECLS
 GType @enum_name@_get_type (void) G_GNUC_CONST;
 const gchar * @enum_name@_get_nick (@EnumName@ value) G_GNUC_CONST;
 @EnumName@ @enum_name@_get_value_from_nick (const gchar * nick) G_GNUC_CONST;
+/**
+	DBUSMENU_TYPE_@ENUMSHORT@:
+
+	Gets the #GType value for the type associated with the
+	#@EnumName@ enumerated type.
+*/
 #define DBUSMENU_TYPE_@ENUMSHORT@ (@enum_name@_get_type())
 
 /*** END value-header ***/
diff --git a/libdbusmenu-glib/server.c b/libdbusmenu-glib/server.c
index c3faa6b..e3fd2cd 100644
--- a/libdbusmenu-glib/server.c
+++ b/libdbusmenu-glib/server.c
@@ -1635,6 +1635,7 @@ dbusmenu_server_get_text_direction (DbusmenuServer * server)
 /**
 	dbusmenu_server_set_text_direction:
 	@server: The #DbusmenuServer object to set the text direction on
+	@dir: Direction of the text
 
 	Sets the text direction that should be exported over DBus for
 	this server.  If the value is set to #DBUSMENU_TEXT_DIRECTION_NONE
@@ -1682,6 +1683,7 @@ dbusmenu_server_get_status (DbusmenuServer * server)
 /**
 	dbusmenu_server_set_status:
 	@server: The #DbusmenuServer to set the status on
+	@status: Status value to set on the server
 
 	Changes the status of the server.
 */
diff --git a/libdbusmenu-glib/server.h b/libdbusmenu-glib/server.h
index 3e07395..80b7abb 100644
--- a/libdbusmenu-glib/server.h
+++ b/libdbusmenu-glib/server.h
@@ -93,7 +93,17 @@ G_BEGIN_DECLS
  * String to access property #DbusmenuServer:version
  */
 #define DBUSMENU_SERVER_PROP_VERSION           "version"
+/**
+ * DBUSMENU_SERVER_PROP_TEXT_DIRECTION:
+ *
+ * String to access property #DbusmenuServer:text-direction
+ */
 #define DBUSMENU_SERVER_PROP_TEXT_DIRECTION    "text-direction"
+/**
+ * DBUSMENU_SERVER_PROP_STATUS:
+ *
+ * String to access property #DbusmenuServer:status
+ */
 #define DBUSMENU_SERVER_PROP_STATUS            "status"
 
 typedef struct _DbusmenuServerPrivate DbusmenuServerPrivate;
diff --git a/libdbusmenu-glib/types.h b/libdbusmenu-glib/types.h
index e573476..03ae801 100644
--- a/libdbusmenu-glib/types.h
+++ b/libdbusmenu-glib/types.h
@@ -59,6 +59,17 @@ typedef enum { /*< prefix=DBUSMENU_STATUS >*/
 	DBUSMENU_STATUS_NOTICE    /*< nick=notice >*/
 } DbusmenuStatus;
 
+/**
+	SECTION:types
+	@short_description: Types that are used by both client and
+		server.
+	@stability: Unstable
+	@include: libdbusmenu-glib/types.h
+
+	Enums that are used to describe states of the server across the
+	bus.  They are sent over dbus using their nicks but then turned
+	back into enums by the client.
+*/
 G_END_DECLS
 
 #endif /* __DBUSMENU_TYPES_H__ */
-- 
cgit v1.2.3