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

From: subversion at stage.maemo.org subversion at stage.maemo.org
Date: Wed Oct 17 23:02:35 EEST 2007 
Author: elmarco
Date: 2007-10-17 23:02:17 +0300 (Wed, 17 Oct 2007)
New Revision: 14491

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

* doc/hildon-desktop-docs.sgml: add package version number.
* libhildondesktop/hildon-desktop-panel-item.[ch]: add
HildonDesktopPanelItem documentation.


Modified: projects/haf/trunk/hildon-desktop/ChangeLog
===================================================================
--- projects/haf/trunk/hildon-desktop/ChangeLog	2007-10-17 19:15:22 UTC (rev 14490)
+++ projects/haf/trunk/hildon-desktop/ChangeLog	2007-10-17 20:02:17 UTC (rev 14491)
@@ -1,5 +1,11 @@
 2007-10-17  Marc-Andre Lureau  <marc-andre.lureau at nokia.com>
 
+	* doc/hildon-desktop-docs.sgml: add package version number.
+	* libhildondesktop/hildon-desktop-panel-item.[ch]: add
+	HildonDesktopPanelItem documentation.
+
+2007-10-17  Marc-Andre Lureau  <marc-andre.lureau at nokia.com>
+
 	* doc/hildon-desktop-docs.sgml: make the index.html more elegant.
 	* doc/hildon-desktop.types: introspect PopupWindow and PopupMenu
 	too.

Modified: projects/haf/trunk/hildon-desktop/doc/hildon-desktop-docs.sgml
===================================================================
--- projects/haf/trunk/hildon-desktop/doc/hildon-desktop-docs.sgml	2007-10-17 19:15:22 UTC (rev 14490)
+++ projects/haf/trunk/hildon-desktop/doc/hildon-desktop-docs.sgml	2007-10-17 20:02:17 UTC (rev 14491)
@@ -1,14 +1,18 @@
 <?xml version="1.0"?>
 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
-               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
+               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
+[
+  <!ENTITY version SYSTEM "version.xml">
+]>
+
 <book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
   <bookinfo>
     <title>libhildondesktop 2.0 Reference Manual</title>
+    <releaseinfo>For Hildon Desktop &version;</releaseinfo>
   </bookinfo>
 
   <chapter>
     <title>Overview</title>
-    <xi:include href="xml/tree_index.sgml"/>
     <xi:include href="xml/libhildondesktop.xml"/>
   </chapter>
 
@@ -27,7 +31,11 @@
     <xi:include href="xml/hildon-desktop-popup-menu.xml"/>
   </chapter>
 
-  <index>
+  <index id="symbols">
     <title>Index</title>
   </index>
+  <index role="hierarchy" id="hierarchy">
+    <title>Object Hierarchy</title>
+    <xi:include href="xml/tree_index.sgml"/>
+  </index>
 </book>

Modified: projects/haf/trunk/hildon-desktop/libhildondesktop/hildon-desktop-panel-item.c
===================================================================
--- projects/haf/trunk/hildon-desktop/libhildondesktop/hildon-desktop-panel-item.c	2007-10-17 19:15:22 UTC (rev 14490)
+++ projects/haf/trunk/hildon-desktop/libhildondesktop/hildon-desktop-panel-item.c	2007-10-17 20:02:17 UTC (rev 14491)
@@ -25,7 +25,11 @@
 
 #include "hildon-desktop-panel-item.h"
 
-/* static declarations */
+/**
+ * SECTION:hildon-desktop-panel-item
+ * @short_description: base class from which panel items are derived.
+ * @see_also: #StatusbarItem and #TaskNavigatorItem
+ */
 
 static void hildon_desktop_panel_item_class_init (HildonDesktopPanelItemClass *item_class);
 static void hildon_desktop_panel_item_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec);
@@ -61,20 +65,25 @@
                                                   "HildonDesktopPanelItem",
                                                   &panel_item_info,0);
     }
-    
+
     return panel_item_type;
 }
 
-static void 
+static void
 hildon_desktop_panel_item_class_init (HildonDesktopPanelItemClass *item_class)
 {
   GObjectClass *object_class = G_OBJECT_CLASS (item_class);
 
   object_class->get_property = hildon_desktop_panel_item_get_property;
   object_class->set_property = hildon_desktop_panel_item_set_property;
-  
+
   item_class->get_position = hildon_desktop_panel_item_get_position;
 
+  /**
+   * HildonDesktopPanelItem:position:
+   *
+   * Position within the panel.
+   **/
   g_object_class_install_property (object_class,
                                    DESKTOP_P_ITEM_POS_PROP,
                                    g_param_spec_int("position",
@@ -85,9 +94,14 @@
 						       -1,
                                                        G_PARAM_CONSTRUCT | G_PARAM_READWRITE));
 
+  /**
+   * HildonDesktopPanelItem:orientation:
+   *
+   * The orientation of the item.
+   **/
   g_object_class_install_property (object_class,
                                    DESKTOP_P_ITEM_POS_ORIENTATION,
-                                   g_param_spec_uint("orientation",
+                                   g_param_spec_uint("orientation", /* FIXME: make it enum */
                                                      "orientation",
                                                      "Orientation",
                                                      GTK_ORIENTATION_HORIZONTAL,
@@ -97,7 +111,7 @@
 
 }
 
-static void 
+static void
 hildon_desktop_panel_item_set_property (GObject *object,
                                         guint prop_id,
                                         const GValue *value,
@@ -112,7 +126,7 @@
 
   switch (prop_id)
   {
-    case DESKTOP_P_ITEM_POS_PROP:	   
+    case DESKTOP_P_ITEM_POS_PROP:
       item->position = g_value_get_int (value);
       break;
 
@@ -122,14 +136,14 @@
       if (old_orientation == item->orientation)
 	g_object_notify (object,"orientation");
       break;
-      
+
     default:
       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
       break;
-  } 
+  }
 }
 
-static void 
+static void
 hildon_desktop_panel_item_get_property (GObject *object,
                                         guint prop_id,
                                         GValue *value,
@@ -151,11 +165,19 @@
       break;
     default:
       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
-      break;						
+      break;
   }
 }
 
-gint 
+/**
+ * hildon_desktop_panel_item_get_position:
+ * @item: A #HildonDesktopItem object.
+ *
+ * Returns: item position (>= 0 if the operation succeeded, else -1).
+ *
+ * Deprecated: 2.0: use #HildonDesktopPanelItem:position property instead.
+ **/
+gint
 hildon_desktop_panel_item_get_position (HildonDesktopPanelItem *item)
 {
   g_return_val_if_fail (item && HILDON_DESKTOP_IS_PANEL_ITEM (item),-1);

Modified: projects/haf/trunk/hildon-desktop/libhildondesktop/hildon-desktop-panel-item.h
===================================================================
--- projects/haf/trunk/hildon-desktop/libhildondesktop/hildon-desktop-panel-item.h	2007-10-17 19:15:22 UTC (rev 14490)
+++ projects/haf/trunk/hildon-desktop/libhildondesktop/hildon-desktop-panel-item.h	2007-10-17 20:02:17 UTC (rev 14491)
@@ -36,13 +36,14 @@
 #define HILDON_DESKTOP_IS_PANEL_ITEM(obj) (GTK_CHECK_TYPE (obj, HILDON_DESKTOP_TYPE_PANEL_ITEM))
 #define HILDON_DESKTOP_IS_PANEL_ITEM_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), HILDON_DESKTOP_TYPE_PANEL_ITEM))
 
-typedef struct _HildonDesktopPanelItem HildonDesktopPanelItem; 
+typedef struct _HildonDesktopPanelItem HildonDesktopPanelItem;
 typedef struct _HildonDesktopPanelItemClass HildonDesktopPanelItemClass;
 
 struct _HildonDesktopPanelItem
 {
   HildonDesktopItem parent;
-	
+
+  /*< private >*/
   gint              position;
 
   GtkOrientation    orientation;
@@ -52,15 +53,13 @@
 {
   HildonDesktopItemClass parent_class;
 
+  /*< private >*/
   gint (*get_position) (HildonDesktopPanelItem *item);
-  
-  /* padding */
-  /* padding */  
 };
 
 GType hildon_desktop_panel_item_get_type (void);
 
-gint 
+gint
 hildon_desktop_panel_item_get_position (HildonDesktopPanelItem *item);
 
 G_END_DECLS
More information about the maemo-commits mailing list