[maemo-commits] [maemo-commits] r14489 - in projects/haf/trunk/hildon-desktop: . libhildondesktop

[From: subversion at stage.maemo.org]

Author: elmarco
Date: 2007-10-17 21:42:52 +0300 (Wed, 17 Oct 2007)
New Revision: 14489

Modified:
   projects/haf/trunk/hildon-desktop/ChangeLog
   projects/haf/trunk/hildon-desktop/libhildondesktop/statusbar-item.c
   projects/haf/trunk/hildon-desktop/libhildondesktop/statusbar-item.h
Log:
2007-10-17  Marc-Andre Lureau  <marc-andre.lureau at nokia.com>

* libhildondesktop/statusbar-item.[ch]: fix StatusbarItem


Modified: projects/haf/trunk/hildon-desktop/ChangeLog
===================================================================
--- projects/haf/trunk/hildon-desktop/ChangeLog	2007-10-17 17:47:50 UTC (rev 14488)
+++ projects/haf/trunk/hildon-desktop/ChangeLog	2007-10-17 18:42:52 UTC (rev 14489)
@@ -1,18 +1,18 @@
-2007-10-17  Marc-Andre Lureau  <marcandre.lureau at nokia.com>
+2007-10-17  Marc-Andre Lureau  <marc-andre.lureau at nokia.com>
 
-	* libhildondesktop/hildon-log.c:
-	* libhildondesktop/hildon-log.h:
-	* libhildondesktop/statusbar-item-binding.c:
-	* libhildondesktop/statusbar-item-binding.h:
-	* libhildondesktop/statusbar-item-socket.h:
-	* libhildondesktop/statusbar-item-socket.c:
-	* libhildondesktop/statusbar-item-wrapper.c:
-	* libhildondesktop/statusbar-item-wrapper.h:
-	* libhildondesktop/tasknavigator-item-socket.c:
-	* libhildondesktop/tasknavigator-item-socket.h:
+	* libhildondesktop/statusbar-item.[ch]: fix StatusbarItem
+	documentation (mainly state things as private).
+
+2007-10-17  Marc-Andre Lureau  <marc-andre.lureau at nokia.com>
+
+	* libhildondesktop/hildon-log.[ch]:
+	* libhildondesktop/statusbar-item-binding.[ch]:
+	* libhildondesktop/statusbar-item-socket.[ch]:
+	* libhildondesktop/statusbar-item-wrapper.[ch]:
+	* libhildondesktop/tasknavigator-item-socket.[ch]:
 	remove _PRIVATE macros from public headers.
 
-2007-10-17  Marc-Andre Lureau  <marcandre.lureau at nokia.com>
+2007-10-17  Marc-Andre Lureau  <marc-andre.lureau at nokia.com>
 
 	* doc/Makefile.am:
 	fix GtkDoc documentation build.

Modified: projects/haf/trunk/hildon-desktop/libhildondesktop/statusbar-item.c
===================================================================
--- projects/haf/trunk/hildon-desktop/libhildondesktop/statusbar-item.c	2007-10-17 17:47:50 UTC (rev 14488)
+++ projects/haf/trunk/hildon-desktop/libhildondesktop/statusbar-item.c	2007-10-17 18:42:52 UTC (rev 14489)
@@ -32,6 +32,14 @@
 }
 SBItemSignals;
 
+/**
+ * SECTION:statusbar-item
+ * @short_description: base class from which statusbar items are derived.
+ * @see_also: #HildonDesktopPanelItem
+ *
+ * FIXME: give a short example of a button-item that inherits from #StatusbarItem.
+ */
+
 enum
 {
   SB_PROP_0,
@@ -40,19 +48,12 @@
 
 static gint statusbar_signals[SB_ITEM_SIGNALS];
 
-/* static declarations */
-
 static void statusbar_item_class_init      (StatusbarItemClass *item_class);
 static void statusbar_item_init            (StatusbarItem *item);
 static void statusbar_item_update_condition (StatusbarItem *item, gboolean condition);
 static void statusbar_item_get_property    (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec);
 static void statusbar_item_set_property    (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec);
-/*
-static void statusbar_finalize		   (GObject *object);
-static void statusbar_destroy		   (GtkObject *object);*/
 
-/*static DesktopItem *parent_class;*/
-
 GType statusbar_item_get_type (void)
 {
     static GType item_type = 0;
@@ -76,29 +77,42 @@
                                              &item_info,
                                              0);
     }
-    
+
     return item_type;
 }
 
-static void 
+static void
 statusbar_item_class_init (StatusbarItemClass *item_class)
 {
   GObjectClass *object_class = G_OBJECT_CLASS (item_class);
-  
+
   item_class->condition_update = statusbar_item_update_condition;
 
   object_class->get_property  = statusbar_item_get_property;
   object_class->set_property  = statusbar_item_set_property;
 
-  statusbar_signals[STATUSBAR_ITEM_CONDITION_LEGACY] = 
+  /**
+   * StatusbarItem::hildon-status-bar-update-conditional:
+   * Emitted when #StatusbarItem:condition property is changed.
+   *
+   * The default handler sets #StatusbarItem:condition property.
+   *
+   * Deprecated: 2.0.0: use "notify::condition" instead.
+   **/
+  statusbar_signals[STATUSBAR_ITEM_CONDITION_LEGACY] =
 	g_signal_new("hildon-status-bar-update-conditional",
 		     G_OBJECT_CLASS_TYPE(object_class),
 		     G_SIGNAL_RUN_FIRST,
 		     G_STRUCT_OFFSET (StatusbarItemClass,condition_update),
 		     NULL, NULL,
-		     g_cclosure_marshal_VOID__BOOLEAN, 
+		     g_cclosure_marshal_VOID__BOOLEAN,
 		     G_TYPE_NONE, 1, G_TYPE_BOOLEAN);
 
+  /**
+   * StatusbarItem:condition:
+   *
+   * Indicate if this statusbar item is active (visible).
+   **/
   g_object_class_install_property (object_class,
                                    SB_PROP_CONDITION,
                                    g_param_spec_boolean("condition",
@@ -109,7 +123,7 @@
 
 }
 
-static void 
+static void
 statusbar_item_init (StatusbarItem *item)
 {
   item->window = NULL;
@@ -118,13 +132,13 @@
   item->condition = TRUE;
 }
 
-static void 
+static void
 statusbar_item_update_condition (StatusbarItem *item, gboolean condition)
 {
   g_object_set (G_OBJECT (item), "condition", condition, NULL);
 }
 
-static void 
+static void
 statusbar_item_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
 {
   StatusbarItem *sbitem = STATUSBAR_ITEM (object);
@@ -138,10 +152,10 @@
     default:
       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
       break;
-  }	
+  }
 }
 
-static void 
+static void
 statusbar_item_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
 {
   StatusbarItem *sbitem = STATUSBAR_ITEM (object);

Modified: projects/haf/trunk/hildon-desktop/libhildondesktop/statusbar-item.h
===================================================================
--- projects/haf/trunk/hildon-desktop/libhildondesktop/statusbar-item.h	2007-10-17 17:47:50 UTC (rev 14488)
+++ projects/haf/trunk/hildon-desktop/libhildondesktop/statusbar-item.h	2007-10-17 18:42:52 UTC (rev 14489)
@@ -41,18 +41,23 @@
 #define STATUSBAR_IS_ITEM_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), STATUSBAR_TYPE_ITEM))
 
 
-typedef struct _StatusbarItem StatusbarItem; 
+typedef struct _StatusbarItem StatusbarItem;
 typedef struct _StatusbarItemClass StatusbarItemClass;
 
+/**
+ * StatusbarItem:
+ *
+ * A statusbar item must inherit from this base class.
+ **/
 struct _StatusbarItem
 {
     HildonDesktopPanelItem parent;
 
+    /*< private >*/
     GtkWindow	    *window;
     GtkVBox	    *vbox;
 
     gint position;
-    
     gboolean condition;
 };
 
@@ -60,6 +65,7 @@
 {
     HildonDesktopPanelItemClass parent_class;
 
+    /*< private >*/
     void (*condition_update) (StatusbarItem *item, gboolean condition);
 };