2008-12-12 Claudio Saavedra <csaavedra@igalia.com>
+ Patch contributed by Iván Gómez (igomez@igalia.com)
+
+ * src/hildon-check-button.c:
+ * src/hildon-date-button.c:
+ * src/hildon-date-selector.c:
+ * src/hildon-dialog.c:
+ * src/hildon-edit-toolbar.c:
+ * src/hildon-entry.c:
+ * src/hildon-picker-button.c:
+ * src/hildon-program.c:
+ * src/hildon-text-view.c:
+ * src/hildon-time-button.c:
+ * src/hildon-touch-selector-entry.c:
+ * src/hildon-window-stack.c:
+
+ Add more "since" tags to the new API.
+
+2008-12-12 Claudio Saavedra <csaavedra@igalia.com>
+
* doc/hildon-sections.txt: Add below method.
* src/hildon-gtk.c: (+hildon_gtk_vscale_new): New vertical
version for the hildonized scale.
* @button: A #HildonCheckButton
*
* Emits the #HildonCheckButton::toggled signal on the #HildonCheckButton.
+ *
+ * Since: 2.2
*/
void
hildon_check_button_toggled (HildonCheckButton *button)
* @is_active: new state for the button
*
* Sets the state of @button to @is_active
+ *
+ * Since: 2.2
**/
void
hildon_check_button_set_active (HildonCheckButton *button,
* Gets the state of the button.
*
* Return value: %TRUE if @button is active, %FALSE otherwise.
+ *
+ * Since: 2.2
**/
gboolean
hildon_check_button_get_active (HildonCheckButton *button)
* This function creates a #HildonCheckButton.
*
* Return value: A newly created #HildonCheckButton
+ *
+ * Since: 2.2
**/
GtkWidget *
hildon_check_button_new (HildonSizeType size)
* HildonCheckButton::toggled
*
* Emitted when the #HildonCheckButton's state is changed
+ *
+ * Since: 2.2
*/
signals[TOGGLED] =
g_signal_new ("toggled",
* parameters.
*
* Returns: a new #HildonDateButton
+ *
+ * Since: 2.2
**/
GtkWidget *
hildon_date_button_new (HildonSizeType size,
* @day: return location for the selected day
*
* Retrieves currently selected date from @button.
+ *
+ * Since: 2.2
**/
void
hildon_date_button_get_date (HildonDateButton * button,
* Sets the date in @button. The date set will be displayed
* and will be the default selected option on the shown #HildonDateSelector.
*
+ * Since: 2.2
**/
void
hildon_date_button_set_date (HildonDateButton * button,
* Creates a new #HildonDateSelector
*
* Returns: a new #HildonDateSelector
+ *
+ * Since: 2.2
**/
GtkWidget *
hildon_date_selector_new ()
*
* Sets the current active date on the #HildonDateSelector widget
*
+ * Since: 2.2
**/
gboolean
hildon_date_selector_select_current_date (HildonDateSelector * selector,
*
* Gets the current active date on the #HildonDateSelector widget
*
- *
+ * Since: 2.2
**/
void
hildon_date_selector_get_date (HildonDateSelector * selector,
* Utility function, too keep this API more similar to the previously existing
* hildon-calendar widget.
*
- *
+ * Since: 2.2
**/
gboolean hildon_date_selector_select_month (HildonDateSelector *selector,
guint month, guint year)
* Utility function, too keep this API more similar to the previously existing
* hildon-calendar widget.
*
- *
+ * Since: 2.2
**/
void
hildon_date_selector_select_day (HildonDateSelector *selector, guint day)
* Creates a new #HildonDialog widget
*
* Returns: the newly created #HildonDialog
+ *
+ * Since: 2.2
*/
GtkWidget*
hildon_dialog_new (void)
* more information.
*
* Return value: a new #HildonDialog
+ *
+ * Since: 2.2
*/
GtkWidget*
hildon_dialog_new_with_buttons (const gchar *title,
* has finger size.
*
* Returns: the button widget that was added
+ *
+ * Since: 2.2
*/
GtkWidget *
hildon_dialog_add_button (HildonDialog *dialog,
* Adds several buttons to the dialog. Works exactly like
* gtk_dialog_add_buttons(), the only difference being that the
* buttons have finger size.
+ *
+ * Since: 2.2
*/
void
hildon_dialog_add_buttons (HildonDialog *dialog,
*
* Emitted when the toolbar button has been activated (pressed and released).
*
+ * Since: 2.2
*/
toolbar_signals[BUTTON_CLICKED] =
g_signal_new ("button_clicked",
* Emitted when the toolbar back button (arrow) has been activated
* (pressed and released).
*
+ * Since: 2.2
*/
toolbar_signals[ARROW_CLICKED] =
g_signal_new ("arrow_clicked",
*
* Sets the label of @toolbar to @label. This will clear any
* previously set value.
+ *
+ * Since: 2.2
*/
void
hildon_edit_toolbar_set_label (HildonEditToolbar *toolbar,
*
* Sets the label of the toolbar button to @label. This will clear any
* previously set value.
+ *
+ * Since: 2.2
*/
void
hildon_edit_toolbar_set_button_label (HildonEditToolbar *toolbar,
* Creates a new #HildonEditToolbar.
*
* Returns: a new #HildonEditToolbar
+ *
+ * Since: 2.2
*/
GtkWidget *
hildon_edit_toolbar_new (void)
* @label and the button label set to @button.
*
* Returns: a new #HildonEditToolbar
+ *
+ * Since: 2.2
*/
GtkWidget *
hildon_edit_toolbar_new_with_text (const gchar *label,
*
* Note that you must never use gtk_entry_set_text() to set the text
* of a #HildonEntry.
+ *
+ * Since: 2.2
*/
void
hildon_entry_set_text (HildonEntry *entry,
*
* Returns: the text in @entry. This text must not be modified or
* freed.
+ *
+ * Since: 2.2
*/
const gchar *
hildon_entry_get_text (HildonEntry *entry)
* @text: the new text
*
* Sets the placeholder text in @entry to @text.
+ *
+ * Since: 2.2
*/
void
hildon_entry_set_placeholder (HildonEntry *entry,
* Creates a new entry.
*
* Returns: a new #HildonEntry
+ *
+ * Since: 2.2
*/
GtkWidget *
hildon_entry_new (HildonSizeType size)
*
* The ::value-changed signal is emitted each time the user chooses a different
* item from the #HildonTouchSelector related, and the value label gets updated.
+ *
+ * Since: 2.2
*/
picker_button_signals[VALUE_CHANGED] =
g_signal_new ("value-changed",
* parameters.
*
* Returns: a newly created #HildonPickerButton
+ *
+ * Since: 2.2
**/
GtkWidget *
hildon_picker_button_new (HildonSizeType size,
*
* Sets @selector as the #HildonTouchSelector to be shown in the
* #HildonPickerDialog that @button brings up.
+ *
+ * Since: 2.2
**/
void
hildon_picker_button_set_selector (HildonPickerButton * button,
* Retrieves the #HildonTouchSelector associated to @button.
*
* Returns: a #HildonTouchSelector
+ *
+ * Since: 2.2
**/
HildonTouchSelector *
hildon_picker_button_get_selector (HildonPickerButton * button)
* one is used.
*
* Returns: an integer which is the index of the currently active item, or -1 if there's no active item.
+ *
+ * Since: 2.2
**/
gint
hildon_picker_button_get_active (HildonPickerButton * button)
* Sets the active item of the #HildonTouchSelector associated to
* @button to @index. If the selector has several columns, only the
* first one is used.
+ *
+ * Since: 2.2
**/
void
hildon_picker_button_set_active (HildonPickerButton * button,
*
* Returns: the custom string to be used, or %NULL if the default
* #HildonPickerDialog::done-button-text is to be used.
+ *
+ * Since: 2.2
**/
const gchar *
hildon_picker_button_get_done_button_text (HildonPickerButton *button)
* Sets a custom string to be used in the \"done\" button in the #HildonPickerDialog
* launched. If not set, the default HildonPickerButton::done-button-text property
* value will be used.
+ *
+ * Since: 2.2
**/
void
hildon_picker_button_set_done_button_text (HildonPickerButton *button,
* This method is not intented for #HildonStackableWindow<!-- -->s and
* does not support #HildonAppMenu objects. See
* hildon_program_set_common_app_menu() for that.
+ *
+ * Since: 2.2
**/
void
hildon_program_set_common_menu (HildonProgram *self,
*
* Note that you must never use gtk_text_view_set_buffer() to set the
* buffer of a #HildonTextView.
+ *
+ * Since: 2.2
*/
void
hildon_text_view_set_buffer (HildonTextView *text_view,
* buffer.
*
* Returns: a #GtkTextBuffer
+ *
+ * Since: 2.2
*/
GtkTextBuffer *
hildon_text_view_get_buffer (HildonTextView *text_view)
* @text: the new text
*
* Sets the placeholder text in @text_view to @text.
+ *
+ * Since: 2.2
*/
void
hildon_text_view_set_placeholder (HildonTextView *text_view,
* Creates a new text view.
*
* Returns: a new #HildonTextView
+ *
+ * Since: 2.2
*/
GtkWidget *
hildon_text_view_new (void)
* parameters.
*
* Returns: a new #HildonTimeButton
+ *
+ * Since: 2.2
**/
GtkWidget *
hildon_time_button_new (HildonSizeType size,
* @minutes: return location for the minutes of the time selected
*
* Retrieves the time from @button.
+ *
+ * Since: 2.2
**/
void
hildon_time_button_get_time (HildonTimeButton * button,
*
* Sets the time to be displayed in @button. This time will
* be selected by default on the #HildonTimeSelector.
+ *
+ * Since: 2.2
**/
void
hildon_time_button_set_time (HildonTimeButton * button,
* hildon_touch_selector_entry_set_text_column() and
* hildon_touch_selector_entry_get_text_column() to manage this.
*
+ * Since: 2.2
**/
g_object_class_install_property (G_OBJECT_CLASS (klass),
PROP_TEXT_COLUMN,
* hildon_touch_selector_prepend_text(), hildon_touch_selector_insert_text().
*
* Returns: A new #HildonTouchSelectorEntry
+ *
+ * Since: 2.2
**/
GtkWidget *
hildon_touch_selector_entry_new_text (void)
* Sets the model column which touch selector box should use to get strings
* from to be @text_column.
*
+ * Since: 2.2
**/
void
hildon_touch_selector_entry_set_text_column (HildonTouchSelectorEntry *selector,
*
* Returns: the number of the column used as a text column.
*
+ * Since: 2.2
**/
gint
hildon_touch_selector_entry_get_text_column (HildonTouchSelectorEntry *selector)
* doesn't need to be created by the application.
*
* Return value: the default #HildonWindowStack
+ *
+ * Since: 2.2
**/
HildonWindowStack *
hildon_window_stack_get_default (void)
* Creates a new #HildonWindowStack. The stack is initially empty.
*
* Return value: a new #HildonWindowStack
+ *
+ * Since: 2.2
**/
HildonWindowStack *
hildon_window_stack_new (void)
* Returns the number of windows in @stack
*
* Return value: Number of windows in @stack
+ *
+ * Since: 2.2
**/
gint
hildon_window_stack_size (HildonWindowStack *stack)
*
* Return value: the window on top of the stack, or %NULL if the stack
* is empty.
+ *
+ * Since: 2.2
**/
GtkWidget *
hildon_window_stack_peek (HildonWindowStack *stack)
*
* Adds @win to the top of @stack, and shows it. The window must not
* be already stacked.
+ *
+ * Since: 2.2
**/
void
hildon_window_stack_push_1 (HildonWindowStack *stack,
*
* Return value: the window on top of the stack, or %NULL if the stack
* is empty.
+ *
+ * Since: 2.2
**/
GtkWidget *
hildon_window_stack_pop_1 (HildonWindowStack *stack)
* them. Everything is done in a single transition, so the user will
* only see the last window in @list during this operation. None of
* the windows must be already stacked.
+ *
+ * Since: 2.2
**/
void
hildon_window_stack_push_list (HildonWindowStack *stack,
* Pushes all windows to the top of @stack, and shows them. Everything
* is done in a single transition, so the user will only see the last
* window. None of the windows must be already stacked.
+ *
+ * Since: 2.2
**/
void
hildon_window_stack_push (HildonWindowStack *stack,
* If @popped_windows is not %NULL, the list of popped windows is
* stored there (ordered bottom-up). That list must be freed by the
* user.
+ *
+ * Since: 2.2
**/
void
hildon_window_stack_pop (HildonWindowStack *stack,
* If @popped_windows is not %NULL, the list of popped windows is
* stored there (ordered bottom-up). That list must be freed by the
* user.
+ *
+ * Since: 2.2
**/
void
hildon_window_stack_pop_and_push_list (HildonWindowStack *stack,
* If @popped_windows is not %NULL, the list of popped windows is
* stored there (ordered bottom-up). That list must be freed by the
* user.
+ *
+ * Since: 2.2
**/
void
hildon_window_stack_pop_and_push (HildonWindowStack *stack,
projects / hildon / commitdiff