2009-03-04 Alberto Garcia <agarcia@igalia.com>
+ * doc/hildon-sections.txt
+ * src/hildon-program.c
+ * src/hildon-stackable-window.c
+ * src/hildon-window.c:
+ Documentation updates
+
+2009-03-04 Alberto Garcia <agarcia@igalia.com>
+
* src/hildon-window-stack.c (hildon_window_stack_get_default)
(hildon_window_stack_new, +hildon_window_stack_set_property)
(+hildon_window_stack_get_property)
<TITLE>HildonDateSelector</TITLE>
HildonDateSelector
hildon_date_selector_new
+hildon_date_selector_new_with_year_range
hildon_date_selector_select_month
hildon_date_selector_select_day
hildon_date_selector_select_current_date
<TITLE>HildonTimeButton</TITLE>
HildonTimeButton
hildon_time_button_new
+hildon_time_button_new_step
hildon_time_button_get_time
hildon_time_button_set_time
<SUBSECTION Standard>
hildon_touch_selector_set_active
hildon_touch_selector_get_active
hildon_touch_selector_get_selected
+hildon_touch_selector_center_on_selected
hildon_touch_selector_select_iter
hildon_touch_selector_unselect_iter
+hildon_touch_selector_unselect_all
hildon_touch_selector_get_selected_rows
hildon_touch_selector_set_model
hildon_touch_selector_get_model
<TITLE>HildonDateButton</TITLE>
HildonDateButton
hildon_date_button_new
+hildon_date_button_new_with_year_range
hildon_date_button_get_date
hildon_date_button_set_date
<SUBSECTION Standard>
<TITLE>HildonTimeSelector</TITLE>
HildonTimeSelector
hildon_time_selector_new
+hildon_time_selector_new_step
hildon_time_selector_set_time
hildon_time_selector_get_time
<SUBSECTION Standard>
hildon_touch_selector_entry_new_text
hildon_touch_selector_entry_set_text_column
hildon_touch_selector_entry_get_text_column
+hildon_touch_selector_entry_set_input_mode
+hildon_touch_selector_entry_get_input_mode
<SUBSECTION Standard>
HILDON_TOUCH_SELECTOR_ENTRY
HILDON_IS_TOUCH_SELECTOR_ENTRY
* @short_description: An object that represents an application running in the Hildon framework.
* @see_also: #HildonWindow, #HildonStackableWindow
*
- * The #HildonProgram is an object used to represent an application running
+ * #HildonProgram is an object used to represent an application running
* in the Hildon framework.
*
- * Such an application is thought to have one or more #HildonWindow. These
- * shall be registered to the #HildonProgram with hildon_program_add_window(),
+ * Applications can have one or more #HildonWindow<!-- -->s. These
+ * can be registered in the #HildonProgram with hildon_program_add_window(),
* and can be unregistered similarly with hildon_program_remove_window().
*
- * The #HildonProgram provides the programmer with commodities such
- * as applying a common toolbar and menu to all #HildonWindow<!-- -->s
- * registered to it. This is done with hildon_program_set_common_menu(),
+ * #HildonProgram provides the programmer with commodities such
+ * as applying a common toolbar and menu to all registered
+ * #HildonWindow<!-- -->s. This is done with hildon_program_set_common_menu(),
* hildon_program_set_common_app_menu() and hildon_program_set_common_toolbar().
*
- * The #HildonProgram is also used to apply program-wide properties that
+ * #HildonProgram is also used to apply program-wide properties that
* are specific to the Hildon framework. For instance
* hildon_program_set_can_hibernate() sets whether or not an application
* can be set to hibernate by the Hildon task navigator, in situations of
* Registers a #HildonWindow as belonging to a given #HildonProgram. This
* allows to apply program-wide settings as all the registered windows,
* such as hildon_program_set_common_menu(), hildon_program_set_common_app_menu()
- * and hildon_pogram_set_common_toolbar().
+ * and hildon_program_set_common_toolbar().
**/
void
hildon_program_add_window (HildonProgram *self,
/**
* hildon_program_remove_window:
* @self: The #HildonProgram to which the window should be unregistered
- * @window: The @HildonWindow to unregister
+ * @window: The #HildonWindow to unregister
*
* Used to unregister a window from the program. Subsequent calls to
* hildon_program_set_common_menu(), hildon_program_set_common_app_menu()
- * and hildon_pogram_set_common_toolbar() will not affect the window.
+ * and hildon_program_set_common_toolbar() will not affect the window.
**/
void
hildon_program_remove_window (HildonProgram *self,
/**
* hildon_program_set_common_toolbar:
* @self: The #HildonProgram in which the common toolbar should be used
- * @toolbar: A GtkToolbar to use as common toolbar for the program
+ * @toolbar: A #GtkToolbar to use as common toolbar for the program
*
- * Sets a GtkToolbar that will appear in all the #HildonWindow registered
- * to the #HildonProgram. Only one common GtkToolbar can be set, further
- * call will detach the previous common GtkToolbar. A #HildonWindow
- * can use its own GtkToolbar with hildon_window_add_toolbar(). Both
+ * Sets a #GtkToolbar that will appear in all the #HildonWindow registered
+ * to the #HildonProgram. Only one common #GtkToolbar can be set, further
+ * call will detach the previous common #GtkToolbar. A #HildonWindow
+ * can use its own #GtkToolbar with hildon_window_add_toolbar(). Both
* #HildonProgram and #HildonWindow specific toolbars will be shown
**/
void
/**
* SECTION:hildon-stackable-window
* @short_description: Widget representing a stackable, top-level window in the Hildon framework.
- * @see_also: #HildonWindowStack
+ * @see_also: #HildonWindowStack, #HildonProgram, #HildonWindow
*
* The #HildonStackableWindow is a GTK+ widget which represents a
* top-level window in the Hildon framework. It is derived from
/**
* SECTION:hildon-window
* @short_description: Widget representing a top-level window in the Hildon framework.
+ * @see_also: #HildonProgram, #HildonStackableWindow
*
- * The HildonWindow is a GTK widget which represents a top-level
- * window in the Hildon framework. It is derived from the GtkWindow
+ * #HildonWindow is a GTK widget which represents a top-level
+ * window in the Hildon framework. It is derived from #GtkWindow
* and provides additional commodities specific to the Hildon
* framework.
*
- * Among these windows in the Hildon framework can have a single menu
- * attached, which is toggled with a hardware key or by tapping a
- * custom button in the window frame. This menu can be either a
- * #GtkMenu or a #HildonAppMenu (set with
+ * #HildonWindow<!-- -->s can have a menu attached, which is toggled
+ * with a hardware key or by tapping on the window frame. This menu
+ * can be either a #GtkMenu or a #HildonAppMenu (set with
* hildon_window_set_main_menu() and hildon_window_set_app_menu()
* respectively). Only one type of menu can be used at the same time.
- *
* In Hildon 2.2, #HildonAppMenu is the recommended menu to use.
*
- * Similarly, a window in the Hildon framework can have several toolbars
- * attached. These can be added to the HildonWindow with
- * hildon_window_add_toolbar().
- *
- * A #HildonWindow can also have a #HildonEditToolbar. To add it to
- * the window use hildon_window_set_edit_toolbar().
+ * Similarly, a #HildonWindow can have several toolbars
+ * attached. These can be added with hildon_window_add_toolbar(). In
+ * addition to those, a #HildonWindow can also have a
+ * #HildonEditToolbar. To add it to the window use
+ * hildon_window_set_edit_toolbar().
*
* <example>
* <title>Creating a HildonWindow</title>
/**
* hildon_window_new:
*
- * Creates a new HildonWindow.
+ * Creates a new #HildonWindow.
*
- * Return value: A @HildonWindow.
+ * Return value: A #HildonWindow.
**/
GtkWidget*
hildon_window_new (void)
}
/**
- * hildon_window_add_with_scrollbar
- * @self : A @HildonWindow
- * @child : A @GtkWidget
+ * hildon_window_add_with_scrollbar:
+ * @self: A #HildonWindow
+ * @child: A #GtkWidget
*
- * Adds the @child to the HildonWindow and creates a scrollbar
- * for it. Similar as adding first a @GtkScrolledWindow and then the
- * @child to it.
+ * Adds @child to the #HildonWindow and creates a scrollbar for
+ * it. Similar to adding first a #GtkScrolledWindow and then @child to
+ * it.
*/
void
hildon_window_add_with_scrollbar (HildonWindow *self,
/**
* hildon_window_add_toolbar:
- * @self: A @HildonWindow
- * @toolbar: A #GtkToolbar to add to the HildonWindow
+ * @self: A #HildonWindow
+ * @toolbar: A #GtkToolbar to add to the #HildonWindow
*
* Adds a toolbar to the window. Note that the toolbar is not automatically
- * shown. You need to call #gtk_widget_show_all on it to make it visible.
+ * shown. You need to call gtk_widget_show_all() on it to make it visible.
* It's also possible to hide the toolbar (without removing it) by calling
- * #gtk_widget_hide.
+ * gtk_widget_hide()
**/
void
hildon_window_add_toolbar (HildonWindow *self,
/**
* hildon_window_remove_toolbar:
- * @self: A @HildonWindow
- * @toolbar: A #GtkToolbar to remove from the HildonWindow
+ * @self: A #HildonWindow
+ * @toolbar: A #GtkToolbar to remove from the #HildonWindow
*
* Removes a toolbar from the window. Note that this decreases the refference
- * count on the widget. If you want to keep the toolbar alive call #g_object_ref
+ * count on the widget. If you want to keep the toolbar alive call g_object_ref()
* before calling this function.
**/
void
/**
* hildon_window_get_main_menu:
- * @self : a #HildonWindow
- *
- * Gets the #GtMenu assigned to the #HildonAppview. Note that the
+ * @self: a #HildonWindow
+ *
+ * Gets the #GtkMenu assigned to the #HildonAppview. Note that the
* window is still the owner of the menu.
- *
+ *
* Note that if you're using a #HildonAppMenu rather than a #GtkMenu
* you should use hildon_window_get_app_menu() instead.
*
/**
* hildon_window_get_menu:
- * @self : a #HildonWindow
+ * @self: a #HildonWindow
*
* Return value: a #GtkMenu
*
* hildon_window_set_main_menu:
* @self: A #HildonWindow
* @menu: The #GtkMenu to be used for this #HildonWindow
- *
+ *
* Sets the menu to be used for this window. This menu overrides
* a program-wide menu that may have been set with
* hildon_program_set_common_menu(). Pass %NULL to remove the current
*
* Note that if you're using a #HildonAppMenu rather than a #GtkMenu
* you should use hildon_window_set_app_menu() instead.
- **/
+ **/
void
hildon_window_set_main_menu (HildonWindow* self,
GtkMenu * menu)
* hildon_window_set_menu:
* @self: A #HildonWindow
* @menu: The #GtkMenu to be used for this #HildonWindow
- *
+ *
* Sets the menu to be used for this window. This menu overrides
* a program-wide menu that may have been set with
* hildon_program_set_common_menu(). Pass %NULL to remove the current
* doesn't do this.
*
* Deprecated: Hildon 2.2: use hildon_window_set_main_menu()
- **/
+ **/
void
hildon_window_set_menu (HildonWindow *self,
GtkMenu *menu)
projects / hildon / commitdiff