Add the ability to set and export the title of the app indicator

7 files changed, 124 insertions, 6 deletions

diff --git a/docs/reference/libappindicator-sections.txt b/docs/reference/libappindicator-sections.txt
index 6f09364..d9e1196 100644
--- a/docs/reference/libappindicator-sections.txt
+++ b/docs/reference/libappindicator-sections.txt
@@ -32,6 +32,7 @@ app_indicator_set_icon_theme_path
 app_indicator_set_label
 app_indicator_set_ordering_index
 app_indicator_set_secondary_activate_target
+app_indicator_set_title
 app_indicator_get_id
 app_indicator_get_category
 app_indicator_get_status
@@ -45,6 +46,7 @@ app_indicator_get_label
 app_indicator_get_label_guide
 app_indicator_get_ordering_index
 app_indicator_get_secondary_activate_target
+app_indicator_get_title
 app_indicator_build_menu_from_desktop
 </SECTION>
 
diff --git a/example/simple-client-vala.vala b/example/simple-client-vala.vala
index 8d661ce..1b8bad9 100644
--- a/example/simple-client-vala.vala
+++ b/example/simple-client-vala.vala
@@ -46,6 +46,7 @@ class SimpleClient {
 		ci.set_status(IndicatorStatus.ACTIVE);
 		ci.set_attention_icon("indicator-messages-new");
 		ci.set_label("1%", "100%");
+		ci.set_title("Test Indicator (vala)");
 
 		active = true;
 		can_haz_label = true;
diff --git a/example/simple-client.c b/example/simple-client.c
index dcee81b..6d67955 100644
--- a/example/simple-client.c
+++ b/example/simple-client.c
@@ -167,6 +167,7 @@ main (int argc, char ** argv)
     app_indicator_set_status (ci, APP_INDICATOR_STATUS_ACTIVE);
     app_indicator_set_attention_icon_full(ci, "indicator-messages-new", "System Messages Icon Highlighted");
     app_indicator_set_label (ci, "1%", "100%");
+	app_indicator_set_title (ci, "Test Inidcator");
 
     g_signal_connect (ci, "scroll-event",
                       G_CALLBACK (scroll_event_cb), NULL);
diff --git a/src/app-indicator.c b/src/app-indicator.c
index f885cc7..6c693e8 100644
--- a/src/app-indicator.c
+++ b/src/app-indicator.c
@@ -78,6 +78,7 @@ struct _AppIndicatorPrivate {
 	GtkWidget            *sec_activate_target;
 	gboolean              sec_activate_enabled;
 	guint32               ordering_index;
+	gchar *               title;
 	gchar *               label;
 	gchar *               label_guide;
 	gchar *               accessible_desc;
@@ -127,7 +128,8 @@ enum {
 	PROP_LABEL,
 	PROP_LABEL_GUIDE,
 	PROP_ORDERING_INDEX,
-	PROP_DBUS_MENU_SERVER
+	PROP_DBUS_MENU_SERVER,
+	PROP_TITLE
 };
 
 /* The strings so that they can be slowly looked up. */
@@ -144,6 +146,7 @@ enum {
 #define PROP_LABEL_GUIDE_S           "label-guide"
 #define PROP_ORDERING_INDEX_S        "ordering-index"
 #define PROP_DBUS_MENU_SERVER_S      "dbus-menu-server"
+#define PROP_TITLE_S                 "title"
 
 /* Private macro, shhhh! */
 #define APP_INDICATOR_GET_PRIVATE(o) \
@@ -251,7 +254,7 @@ app_indicator_class_init (AppIndicatorClass *klass)
                                                               G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS | G_PARAM_CONSTRUCT_ONLY));
 
 	/**
-	 * AppIndicator:
+	 * AppIndicator:status:
 	 *
 	 * Whether the indicator is shown or requests attention. Defaults to
 	 * 'Passive'.
@@ -410,6 +413,21 @@ app_indicator_class_init (AppIndicatorClass *klass)
 	                                                     "DBusmenu server which is available for testing the application indicators.",
 	                                                     DBUSMENU_TYPE_SERVER,
 	                                                     G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
+	/**
+	 * AppIndicator:title:
+	 *
+	 * Provides a way to refer to this application indicator in a human
+	 * readable form.  This is used in the Unity desktop in the HUD as
+	 * the first part of the menu entries to distinguish them from the
+	 * focused application's entries.
+	 */
+	g_object_class_install_property(object_class,
+	                                PROP_TITLE,
+	                                g_param_spec_string (PROP_TITLE_S,
+	                                                     "Title of the application indicator",
+	                                                     "A human readable way to refer to this application indicator in the UI.",
+	                                                     NULL,
+	                                                     G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
 
 	/* Signals */
 
@@ -575,6 +593,7 @@ app_indicator_init (AppIndicator *self)
 	priv->menu = NULL;
 	priv->menuservice = NULL;
 	priv->ordering_index = 0;
+	priv->title = NULL;
 	priv->label = NULL;
 	priv->label_guide = NULL;
 	priv->label_change_idle = 0;
@@ -716,6 +735,11 @@ app_indicator_finalize (GObject *object)
 		priv->icon_theme_path = NULL;
 	}
 	
+	if (priv->title != NULL) {
+		g_free(priv->title);
+		priv->title = NULL;
+	}
+
 	if (priv->label != NULL) {
 		g_free(priv->label);
 		priv->label = NULL;
@@ -830,20 +854,51 @@ app_indicator_set_property (GObject * object, guint prop_id, const GValue * valu
 		  gchar * oldlabel = priv->label;
 		  priv->label = g_value_dup_string(value);
 
-		  if (g_strcmp0(oldlabel, priv->label) != 0) {
-		    signal_label_change(APP_INDICATOR(object));
-		  }
-
 		  if (priv->label != NULL && priv->label[0] == '\0') {
 		  	g_free(priv->label);
 			priv->label = NULL;
 		  }
 
+		  if (g_strcmp0(oldlabel, priv->label) != 0) {
+		    signal_label_change(APP_INDICATOR(object));
+		  }
+
 		  if (oldlabel != NULL) {
 		  	g_free(oldlabel);
 		  }
 		  break;
 		}
+		case PROP_TITLE: {
+		  gchar * oldtitle = priv->title;
+		  priv->title = g_value_dup_string(value);
+
+		  if (priv->title != NULL && priv->title[0] == '\0') {
+		  	g_free(priv->title);
+			priv->title = NULL;
+		  }
+
+		  if (g_strcmp0(oldtitle, priv->title) != 0 && self->priv->connection != NULL) {
+			GError * error = NULL;
+
+			g_dbus_connection_emit_signal(self->priv->connection,
+										  NULL,
+										  self->priv->path,
+										  NOTIFICATION_ITEM_DBUS_IFACE,
+										  "NewTitle",
+										  NULL,
+										  &error);
+
+			if (error != NULL) {
+				g_warning("Unable to send signal for NewTitle: %s", error->message);
+				g_error_free(error);
+			}
+		  }
+
+		  if (oldtitle != NULL) {
+		  	g_free(oldtitle);
+		  }
+		  break;
+		}
 		case PROP_LABEL_GUIDE: {
 		  gchar * oldguide = priv->label_guide;
 		  priv->label_guide = g_value_dup_string(value);
@@ -956,6 +1011,10 @@ app_indicator_get_property (GObject * object, guint prop_id, GValue * value, GPa
 			g_value_set_object(value, priv->menuservice);
 			break;
 
+		case PROP_TITLE:
+			g_value_set_string(value, priv->title);
+			break;
+
         default:
           G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
           break;
@@ -1062,6 +1121,8 @@ bus_get_prop (GDBusConnection * connection, const gchar * sender, const gchar *
 		return g_variant_new_string(priv->icon_name ? priv->icon_name : "");
 	} else if (g_strcmp0(property, "AttentionIconName") == 0) {
 		return g_variant_new_string(priv->attention_icon_name ? priv->attention_icon_name : "");
+	} else if (g_strcmp0(property, "Title") == 0) {
+		return g_variant_new_string(priv->title ? priv->title : "");
 	} else if (g_strcmp0(property, "IconThemePath") == 0) {
 		return g_variant_new_string(priv->icon_theme_path ? priv->icon_theme_path : "");
 	} else if (g_strcmp0(property, "Menu") == 0) {
@@ -2127,6 +2188,33 @@ app_indicator_set_secondary_activate_target (AppIndicator *self, GtkWidget *menu
 }
 
 /**
+ * app_indicator_set_title:
+ * @self: The #AppIndicator
+ * @title: (allow-none): Title of the app indicator
+ *
+ * Sets the title of the application indicator, or how it should be referred
+ * in a human readable form.  This string should be UTF-8 and localized as it
+ * expected that users will set it.
+ *
+ * In the Unity desktop the most prominent place that this is show will be
+ * in the HUD.  HUD listings for this application indicator will start with
+ * the title as the first part of the line for the menu items.
+ *
+ * Setting @title to %NULL removes the title.
+ */
+void
+app_indicator_set_title (AppIndicator *self, const gchar * title)
+{
+	g_return_if_fail (IS_APP_INDICATOR (self));
+
+	g_object_set(G_OBJECT(self),
+	             PROP_TITLE_S, title == NULL ? "": title,
+	             NULL);
+
+	return;
+}
+
+/**
  * app_indicator_get_id:
  * @self: The #AppIndicator object to use
  *
@@ -2255,6 +2343,24 @@ app_indicator_get_attention_icon_desc (AppIndicator *self)
 }
 
 /**
+ * app_indicator_get_title:
+ * @self: The #AppIndicator object to use
+ *
+ * Gets the title of the application indicator.  See the function
+ * app_indicator_set_title() for information on the title.
+ *
+ * Return value: The current title.
+ */
+const gchar *
+app_indicator_get_title (AppIndicator *self)
+{
+	g_return_val_if_fail (IS_APP_INDICATOR (self), NULL);
+
+	return self->priv->title;
+}
+
+
+/**
  * app_indicator_get_menu:
  * @self: The #AppIndicator object to use
  *
diff --git a/src/app-indicator.h b/src/app-indicator.h
index 6922248..8ae20b0 100644
--- a/src/app-indicator.h
+++ b/src/app-indicator.h
@@ -285,6 +285,8 @@ void                            app_indicator_set_ordering_index (AppIndicator
                                                                   guint32             ordering_index);
 void                            app_indicator_set_secondary_activate_target (AppIndicator *self,
                                                                              GtkWidget    *menuitem);
+void                            app_indicator_set_title          (AppIndicator       *self,
+                                                                  const gchar        *title);
 
 /* Get properties */
 const gchar *                   app_indicator_get_id                   (AppIndicator *self);
@@ -295,6 +297,7 @@ const gchar *                   app_indicator_get_icon_desc            (AppIndic
 const gchar *                   app_indicator_get_icon_theme_path      (AppIndicator *self);
 const gchar *                   app_indicator_get_attention_icon       (AppIndicator *self);
 const gchar *                   app_indicator_get_attention_icon_desc  (AppIndicator *self);
+const gchar *                   app_indicator_get_title                (AppIndicator *self);
 
 GtkMenu *                       app_indicator_get_menu                 (AppIndicator *self);
 const gchar *                   app_indicator_get_label                (AppIndicator *self);
diff --git a/src/notification-item.xml b/src/notification-item.xml
index 589a438..c93afd7 100644
--- a/src/notification-item.xml
+++ b/src/notification-item.xml
@@ -10,6 +10,7 @@
 		<property name="IconAccessibleDesc" type="s" access="read" />
 		<property name="AttentionIconName" type="s" access="read" />
 		<property name="AttentionAccessibleDesc" type="s" access="read" />
+		<property name="Title" type="s" access="read" />
 		<!-- An additional path to add to the theme search path
 		     to find the icons specified above. -->
 		<property name="IconThemePath" type="s" access="read" />
@@ -46,6 +47,8 @@
 			<arg type="s" name="label" direction="out" />
 			<arg type="s" name="guide" direction="out" />
 		</signal>
+		<signal name="NewTitle">
+		</signal>
 
 	</interface>
 </node>
diff --git a/tests/test-libappindicator.c b/tests/test-libappindicator.c
index cadf783..7afd3ba 100644
--- a/tests/test-libappindicator.c
+++ b/tests/test-libappindicator.c
@@ -123,10 +123,12 @@ test_libappindicator_init_set_props (void)
 
 	app_indicator_set_status(ci, APP_INDICATOR_STATUS_ACTIVE);
 	app_indicator_set_attention_icon(ci, "my-attention-name");
+	app_indicator_set_title(ci, "My Title");
 
 	g_assert(!g_strcmp0("my-id", app_indicator_get_id(ci)));
 	g_assert(!g_strcmp0("my-name", app_indicator_get_icon(ci)));
 	g_assert(!g_strcmp0("my-attention-name", app_indicator_get_attention_icon(ci)));
+	g_assert(!g_strcmp0("My Title", app_indicator_get_title(ci)));
 	g_assert(app_indicator_get_status(ci) == APP_INDICATOR_STATUS_ACTIVE);
 	g_assert(app_indicator_get_category(ci) == APP_INDICATOR_CATEGORY_APPLICATION_STATUS);