r3040 - in trunk/src/target/OM-2007.2/libraries/libmokoui2: . doc/reference doc/reference/tmpl libmokoui
thomas at sita.openmoko.org
thomas at sita.openmoko.org
Tue Sep 25 17:01:27 CEST 2007
Author: thomas
Date: 2007-09-25 17:01:25 +0200 (Tue, 25 Sep 2007)
New Revision: 3040
Added:
trunk/src/target/OM-2007.2/libraries/libmokoui2/doc/reference/tmpl/
trunk/src/target/OM-2007.2/libraries/libmokoui2/doc/reference/tmpl/moko-stock.sgml
Modified:
trunk/src/target/OM-2007.2/libraries/libmokoui2/ChangeLog
trunk/src/target/OM-2007.2/libraries/libmokoui2/libmokoui/moko-finger-scroll.c
trunk/src/target/OM-2007.2/libraries/libmokoui2/libmokoui/moko-hint-entry.c
trunk/src/target/OM-2007.2/libraries/libmokoui2/libmokoui/moko-search-bar.c
trunk/src/target/OM-2007.2/libraries/libmokoui2/libmokoui/moko-stock.c
Log:
* doc/reference/tmpl/moko-stock.sgml: Add stock item documentation
* libmokoui/moko-finger-scroll.c:
* libmokoui/moko-hint-entry.c:
* libmokoui/moko-search-bar.c:
* libmokoui/moko-stock.c:
Add section documentation
Modified: trunk/src/target/OM-2007.2/libraries/libmokoui2/ChangeLog
===================================================================
--- trunk/src/target/OM-2007.2/libraries/libmokoui2/ChangeLog 2007-09-25 14:11:24 UTC (rev 3039)
+++ trunk/src/target/OM-2007.2/libraries/libmokoui2/ChangeLog 2007-09-25 15:01:25 UTC (rev 3040)
@@ -1,5 +1,15 @@
2007-09-25 Thomas Wood <thomas at openedhand.com>
+ * doc/reference/tmpl/moko-stock.sgml: Add stock item documentation
+
+ * libmokoui/moko-finger-scroll.c:
+ * libmokoui/moko-hint-entry.c:
+ * libmokoui/moko-search-bar.c:
+ * libmokoui/moko-stock.c:
+ Add section documentation
+
+2007-09-25 Thomas Wood <thomas at openedhand.com>
+
* libmokoui/moko-finger-scroll.h: Remove redunent comment
* libmokoui/moko-hint-entry.c: (moko_hint_entry_class_init): Add missing
documentation
Added: trunk/src/target/OM-2007.2/libraries/libmokoui2/doc/reference/tmpl/moko-stock.sgml
===================================================================
--- trunk/src/target/OM-2007.2/libraries/libmokoui2/doc/reference/tmpl/moko-stock.sgml 2007-09-25 14:11:24 UTC (rev 3039)
+++ trunk/src/target/OM-2007.2/libraries/libmokoui2/doc/reference/tmpl/moko-stock.sgml 2007-09-25 15:01:25 UTC (rev 3040)
@@ -0,0 +1,271 @@
+<!-- ##### SECTION Title ##### -->
+moko-stock
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### MACRO MOKO_STOCK_CALL_ANSWER ##### -->
+<para>
+The "Answer" item
+</para>
+
+
+
+<!-- ##### MACRO MOKO_STOCK_CALL_DIAL ##### -->
+<para>
+The "Dial" item
+</para>
+
+
+
+<!-- ##### MACRO MOKO_STOCK_CALL_DIALED ##### -->
+<para>
+The "Dialed History" item
+</para>
+
+
+
+<!-- ##### MACRO MOKO_STOCK_CALL_HANGUP ##### -->
+<para>
+The "Hangup" item
+</para>
+
+
+
+<!-- ##### MACRO MOKO_STOCK_CALL_HISTORY ##### -->
+<para>
+The "Call History" item
+</para>
+
+
+
+<!-- ##### MACRO MOKO_STOCK_CALL_HOLD ##### -->
+<para>
+The "Hold" item
+</para>
+
+
+
+<!-- ##### MACRO MOKO_STOCK_CALL_IN ##### -->
+<para>
+The "Incoming Call" item
+</para>
+
+
+
+<!-- ##### MACRO MOKO_STOCK_CALL_MISSED ##### -->
+<para>
+The "Call Missed" item
+</para>
+
+
+
+<!-- ##### MACRO MOKO_STOCK_CALL_REDIAL ##### -->
+<para>
+The "Redial" item
+</para>
+
+
+
+<!-- ##### MACRO MOKO_STOCK_CALL_REJECT ##### -->
+<para>
+The "Reject Call" item
+</para>
+
+
+
+<!-- ##### MACRO MOKO_STOCK_CONTACT_ADDRESS ##### -->
+<para>
+The "Contact Address" item
+</para>
+
+
+
+<!-- ##### MACRO MOKO_STOCK_CONTACT_DELETE ##### -->
+<para>
+The "Delete Contact" item
+</para>
+
+
+
+<!-- ##### MACRO MOKO_STOCK_CONTACT_EMAIL ##### -->
+<para>
+The "Contact E-Mail" item
+</para>
+
+
+
+<!-- ##### MACRO MOKO_STOCK_CONTACT_GROUPS ##### -->
+<para>
+The "Contact Groups" item
+</para>
+
+
+
+<!-- ##### MACRO MOKO_STOCK_CONTACT_MODE ##### -->
+<para>
+The "Contact Mode" item
+</para>
+
+
+
+<!-- ##### MACRO MOKO_STOCK_CONTACT_NEW ##### -->
+<para>
+The "New Contact" item
+</para>
+
+
+
+<!-- ##### MACRO MOKO_STOCK_CONTACT_PHONE ##### -->
+<para>
+The "Contact Phone Number" item
+</para>
+
+
+
+<!-- ##### MACRO MOKO_STOCK_FOLDER_DELETE ##### -->
+<para>
+The "Delete Folder" item
+</para>
+
+
+
+<!-- ##### MACRO MOKO_STOCK_FOLDER_NEW ##### -->
+<para>
+The "New Folder" item
+</para>
+
+
+
+<!-- ##### MACRO MOKO_STOCK_HISTORY ##### -->
+<para>
+The "History" item
+</para>
+
+
+
+<!-- ##### MACRO MOKO_STOCK_MAIL_DELETE ##### -->
+<para>
+The "Delete Mail" item
+</para>
+
+
+
+<!-- ##### MACRO MOKO_STOCK_MAIL_FORWARD ##### -->
+<para>
+The "Forward Mail" item
+</para>
+
+
+
+<!-- ##### MACRO MOKO_STOCK_MAIL_MARK_READ ##### -->
+<para>
+The "Mark Read" item
+</para>
+
+
+
+<!-- ##### MACRO MOKO_STOCK_MAIL_NEW ##### -->
+<para>
+The "New Mail" item
+</para>
+
+
+
+<!-- ##### MACRO MOKO_STOCK_MAIL_READ ##### -->
+<para>
+The "Read Mail" item
+</para>
+
+
+
+<!-- ##### MACRO MOKO_STOCK_MAIL_REPLY_ALL ##### -->
+<para>
+The "Reply to All" item
+</para>
+
+
+
+<!-- ##### MACRO MOKO_STOCK_MAIL_REPLY_SENDER ##### -->
+<para>
+The "Reply to Sender" item
+</para>
+
+
+
+<!-- ##### MACRO MOKO_STOCK_MAIL_SEND ##### -->
+<para>
+The "Send Mail" item
+</para>
+
+
+
+<!-- ##### MACRO MOKO_STOCK_MAIL_SEND_RECEIVE ##### -->
+<para>
+The "Send and Receive" item
+</para>
+
+
+
+<!-- ##### MACRO MOKO_STOCK_PHONE_BOOK ##### -->
+<para>
+The "Phone Book" item
+</para>
+
+
+
+<!-- ##### MACRO MOKO_STOCK_SEARCH ##### -->
+<para>
+The "Search" item
+</para>
+
+
+
+<!-- ##### MACRO MOKO_STOCK_SMS_NEW ##### -->
+<para>
+The "New SMS" item
+</para>
+
+
+
+<!-- ##### MACRO MOKO_STOCK_SPEAKER ##### -->
+<para>
+The "Speaker" item
+</para>
+
+
+
+<!-- ##### MACRO MOKO_STOCK_HANDSET ##### -->
+<para>
+The "Handset" item
+</para>
+
+
+
+<!-- ##### MACRO MOKO_STOCK_VIEW ##### -->
+<para>
+The "View" item
+</para>
+
+
+
+<!-- ##### FUNCTION moko_stock_register ##### -->
+<para>
+
+</para>
+
+
+
Modified: trunk/src/target/OM-2007.2/libraries/libmokoui2/libmokoui/moko-finger-scroll.c
===================================================================
--- trunk/src/target/OM-2007.2/libraries/libmokoui2/libmokoui/moko-finger-scroll.c 2007-09-25 14:11:24 UTC (rev 3039)
+++ trunk/src/target/OM-2007.2/libraries/libmokoui2/libmokoui/moko-finger-scroll.c 2007-09-25 15:01:25 UTC (rev 3040)
@@ -17,6 +17,18 @@
* Current Version: $Rev$ ($Date$) [$Author$]
*/
+/**
+ * SECTION: moko-finger-scroll
+ * @short_description: A scrolling widget designed for touch screens
+ * @see_also: #GtkScrolledWindow
+ *
+ * #MokoFingerScroll implements a scrolled window designed to be used with a
+ * touch screen interface. The user scrolls the child widget by activating the
+ * pointing device and dragging it over the widget.
+ *
+ */
+
+
#include "moko-finger-scroll.h"
G_DEFINE_TYPE (MokoFingerScroll, moko_finger_scroll, GTK_TYPE_EVENT_BOX)
Modified: trunk/src/target/OM-2007.2/libraries/libmokoui2/libmokoui/moko-hint-entry.c
===================================================================
--- trunk/src/target/OM-2007.2/libraries/libmokoui2/libmokoui/moko-hint-entry.c 2007-09-25 14:11:24 UTC (rev 3039)
+++ trunk/src/target/OM-2007.2/libraries/libmokoui2/libmokoui/moko-hint-entry.c 2007-09-25 15:01:25 UTC (rev 3040)
@@ -1,5 +1,5 @@
/*
- * moko-hint-history.c - taken from koto-hint-history.c
+ * moko-hint-entry.c - taken from koto-hint-entry.c
* <http://svn.o-hand.com/repos/tasks/trunk/libkoto/koto-hint-entry.c>
*
* Copyright (C) 2007 OpenedHand Ltd
@@ -21,6 +21,20 @@
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
+/**
+ * SECTION: moko-hint-entry
+ * @short_description: An entry widget with an additional "hint" when no value
+ * is entered.
+ * @see_also: #GtkEntry
+ *
+ * #MokoHintEntry is a simple #GtkEntry subclass that displays "hint" text if
+ * the user has not entered a value. This is useful when there is not enough
+ * space in the user interface to add a label next to the entry. However, it
+ * should only be used where the meaning and context of the user entered value
+ * is obvious without a label.
+ */
+
+
#include <config.h>
#include <string.h>
#include <gtk/gtk.h>
Modified: trunk/src/target/OM-2007.2/libraries/libmokoui2/libmokoui/moko-search-bar.c
===================================================================
--- trunk/src/target/OM-2007.2/libraries/libmokoui2/libmokoui/moko-search-bar.c 2007-09-25 14:11:24 UTC (rev 3039)
+++ trunk/src/target/OM-2007.2/libraries/libmokoui2/libmokoui/moko-search-bar.c 2007-09-25 15:01:25 UTC (rev 3040)
@@ -17,6 +17,19 @@
* Current Version: $Rev$ ($Date$) [$Author$]
*/
+
+/**
+ * SECTION: moko-search-bar
+ * @short_description: An implementation of the OpenMoko "Search Bar"
+ * user interface
+ * @see_also: #GtkEntry, #GtkComboBox
+ *
+ * The #MokoSearchBar is a composite widget that implements the "Search Bar"
+ * user interface from OpenMoko. It comprises of a #GtkEntry, a #GtkComboBox
+ * and a #GtkToggleButton that toggles the visibility of the entry and combo box.
+ *
+ */
+
#include "moko-search-bar.h"
G_DEFINE_TYPE (MokoSearchBar, moko_search_bar, GTK_TYPE_HBOX)
Modified: trunk/src/target/OM-2007.2/libraries/libmokoui2/libmokoui/moko-stock.c
===================================================================
--- trunk/src/target/OM-2007.2/libraries/libmokoui2/libmokoui/moko-stock.c 2007-09-25 14:11:24 UTC (rev 3039)
+++ trunk/src/target/OM-2007.2/libraries/libmokoui2/libmokoui/moko-stock.c 2007-09-25 15:01:25 UTC (rev 3040)
@@ -18,6 +18,13 @@
*/
+/**
+ * SECTION: moko-stock
+ * @short_description: Stock items for OpenMoko
+ *
+ * Stock items for use with OpenMoko
+ */
+
#include <gtk/gtk.h>
#include <moko-stock.h>
#include <glib/gi18n.h>
More information about the commitlog
mailing list
