2009-04-06 Alberto Garcia <agarcia@igalia.com>
+ * src/hildon-animation-actor.c
+ * src/hildon-button.c
+ * src/hildon-main.c
+ * src/hildon-pannable-area.c
+ * src/hildon-picker-button.c
+ * src/hildon-program.c
+ * src/hildon-remote-texture.c
+ * src/hildon-text-view.c
+ * src/hildon-touch-selector.c
+ * src/hildon-window-stack.c
+ * src/hildon-window.c:
+ Add missing 'Since: 2.2' tags.
+
+ * doc/hildon-sections.txt:
+ Add some missing symbols.
+
+ * doc/hildon-docs.sgml:
+ New 'Other' section for HildonAnimationActor and
+ HildonRemoteTexture
+
+2009-04-06 Alberto Garcia <agarcia@igalia.com>
+
Patch by Iván Gómez (igomez@igalia.com)
* doc/building.sgml
</chapter>
<chapter>
+ <title>Other</title>
+ <xi:include href="xml/hildon-animation-actor.xml"/>
+ <xi:include href="xml/hildon-remote-texture.xml"/>
+ </chapter>
+
+ <chapter>
<title>Deprecated</title>
<xi:include href="xml/hildon-color-button.xml"/>
<xi:include href="xml/hildon-color-chooser.xml"/>
<SECTION>
+<FILE>hildon-animation-actor</FILE>
+<TITLE>HildonAnimationActor</TITLE>
+HildonAnimationActor
+hildon_animation_actor_new
+hildon_animation_actor_send_message
+hildon_animation_actor_set_anchor
+hildon_animation_actor_set_anchor_from_gravity
+hildon_animation_actor_set_depth
+hildon_animation_actor_set_opacity
+hildon_animation_actor_set_parent
+hildon_animation_actor_set_position
+hildon_animation_actor_set_position_full
+hildon_animation_actor_set_rotation
+hildon_animation_actor_set_rotationx
+hildon_animation_actor_set_scale
+hildon_animation_actor_set_scalex
+hildon_animation_actor_set_show
+hildon_animation_actor_set_show_full
+HILDON_AA_CENTER_GRAVITY
+HILDON_AA_E_GRAVITY
+HILDON_AA_NE_GRAVITY
+HILDON_AA_NW_GRAVITY
+HILDON_AA_N_GRAVITY
+HILDON_AA_SE_GRAVITY
+HILDON_AA_SW_GRAVITY
+HILDON_AA_S_GRAVITY
+HILDON_AA_W_GRAVITY
+HILDON_AA_X_AXIS
+HILDON_AA_Y_AXIS
+HILDON_AA_Z_AXIS
+<SUBSECTION Standard>
+HILDON_ANIMATION_ACTOR
+HILDON_ANIMATION_ACTOR_CLASS
+HILDON_ANIMATION_ACTOR_GET_CLASS
+HILDON_ANIMATION_ACTOR_GET_PRIVATE
+HILDON_IS_ANIMATION_ACTOR
+HILDON_IS_ANIMATION_ACTOR_CLASS
+HILDON_TYPE_ANIMATION_ACTOR
+HildonAnimationActorClass
+HildonAnimationActorPrivate
+hildon_animation_actor_get_type
+</SECTION>
+
+<SECTION>
+<FILE>hildon-remote-texture</FILE>
+<TITLE>HildonRemoteTexture</TITLE>
+HildonRemoteTexture
+hildon_remote_texture_new
+hildon_remote_texture_send_message
+hildon_remote_texture_set_image
+hildon_remote_texture_set_offset
+hildon_remote_texture_set_opacity
+hildon_remote_texture_set_parent
+hildon_remote_texture_set_position
+hildon_remote_texture_set_scale
+hildon_remote_texture_set_show
+hildon_remote_texture_set_show_full
+hildon_remote_texture_update_area
+<SUBSECTION Standard>
+HILDON_IS_REMOTE_TEXTURE
+HILDON_IS_REMOTE_TEXTURE_CLASS
+HILDON_REMOTE_TEXTURE
+HILDON_REMOTE_TEXTURE_CLASS
+HILDON_REMOTE_TEXTURE_GET_CLASS
+HILDON_REMOTE_TEXTURE_GET_PRIVATE
+HILDON_TYPE_REMOTE_TEXTURE
+HildonRemoteTextureClass
+HildonRemoteTexturePrivate
+hildon_remote_texture_get_type
+</SECTION>
+
+<SECTION>
<FILE>hildon-date-selector</FILE>
<TITLE>HildonDateSelector</TITLE>
HildonDateSelector
hildon_touch_selector_get_current_text
hildon_touch_selector_set_print_func
hildon_touch_selector_get_print_func
+hildon_touch_selector_set_print_func_full
hildon_touch_selector_has_multiple_selection
<SUBSECTION Standard>
HILDON_TOUCH_SELECTOR
HILDON_HARDKEY_FULLSCREEN
HILDON_HARDKEY_INCREASE
HILDON_HARDKEY_DECREASE
+HILDON_WINDOW_TITLEBAR_HEIGHT
hildon_get_icon_pixel_size
</SECTION>
* Creates a new #HildonAnimationActor.
*
* Return value: A #HildonAnimationActor
+ *
+ * Since: 2.2
**/
GtkWidget*
hildon_animation_actor_new (void)
*
* This is an internal utility function that application will
* not need to call directly.
+ *
+ * Since: 2.2
**/
void
hildon_animation_actor_send_message (HildonAnimationActor *self,
*
* If the animation actor WM-counterpart is not ready, the show message
* will be queued until the WM is ready for it.
+ *
+ * Since: 2.2
**/
void
hildon_animation_actor_set_show_full (HildonAnimationActor *self,
* This function is a shortcut for hildon_animation_actor_set_show_full(),
* setting the overall actor visibility without changing it's opacity
* setting.
+ *
+ * Since: 2.2
**/
void
hildon_animation_actor_set_show (HildonAnimationActor *self,
*
* See hildon_animation_actor_set_show_full() for description of the range
* of values @opacity argument takes.
+ *
+ * Since: 2.2
**/
void
hildon_animation_actor_set_opacity (HildonAnimationActor *self,
*
* If the animation actor WM-counterpart is not ready, the show message
* will be queued until the WM is ready for it.
+ *
+ * Since: 2.2
**/
void
hildon_animation_actor_set_position_full (HildonAnimationActor *self,
*
* A shortcut for hildon_animation_actor_set_position_full(),
* changing the window position, but preserving it's depth setting.
+ *
+ * Since: 2.2
**/
void
hildon_animation_actor_set_position (HildonAnimationActor *self,
*
* A shortcut for hildon_animation_actor_set_position_full(),
* changing the window depth, but preserving it's position.
+ *
+ * Since: 2.2
**/
void
hildon_animation_actor_set_depth (HildonAnimationActor *self,
*
* This function is just like hildon_animation_actor_set_scale(),
* but the scale factors are given as 16-bit fixed-point number.
+ *
+ * Since: 2.2
**/
void
hildon_animation_actor_set_scalex (HildonAnimationActor *self,
*
* If the animation actor WM-counterpart is not ready, the show message
* will be queued until the WM is ready for it.
+ *
+ * Since: 2.2
**/
void
hildon_animation_actor_set_scale (HildonAnimationActor *self,
*
* This function is just like hildon_animation_actor_set_rotation(),
* but the rotation angle is given as 16-bit fixed-point number.
+ *
+ * Since: 2.2
**/
void
hildon_animation_actor_set_rotationx (HildonAnimationActor *self,
*
* If the animation actor WM-counterpart is not ready, the show message
* will be queued until the WM is ready for it.
+ *
+ * Since: 2.2
**/
void
hildon_animation_actor_set_rotation (HildonAnimationActor *self,
*
* If the animation actor WM-counterpart is not ready, the show message
* will be queued until the WM is ready for it.
+ *
+ * Since: 2.2
**/
void
hildon_animation_actor_set_anchor (HildonAnimationActor *self,
*
* If the animation actor WM-counterpart is not ready, the show message
* will be queued until the WM is ready for it.
+ *
+ * Since: 2.2
**/
void
hildon_animation_actor_set_anchor_from_gravity (HildonAnimationActor *self,
*
* If the animation actor WM-counterpart is not ready, the show message
* will be queued until the WM is ready for it.
+ *
+ * Since: 2.2
**/
void
hildon_animation_actor_set_parent (HildonAnimationActor *self,
* @size_group: A #GtkSizeGroup for the button title (main label)
*
* Adds the title label of @button to @size_group.
+ *
+ * Since: 2.2
**/
void
hildon_button_add_title_size_group (HildonButton *button,
* @size_group: A #GtkSizeGroup for the button value (secondary label)
*
* Adds the value label of @button to @size_group.
+ *
+ * Since: 2.2
**/
void
hildon_button_add_value_size_group (HildonButton *button,
*
* Adds the image of @button to @size_group. You must add an image
* using hildon_button_set_image() before calling this function.
+ *
+ * Since: 2.2
**/
void
hildon_button_add_image_size_group (HildonButton *button,
*
* Convenience function to add title, value and image to size
* groups. %NULL size groups will be ignored.
+ *
+ * Since: 2.2
**/
void
hildon_button_add_size_groups (HildonButton *button,
* If @value is set to %NULL, the value label will be hidden and the
* title label will be realigned.
*
- *
* Since: 2.2
**/
void
* Initializes the hildon library. Call this function after calling gtk_init()
* and before using any hildon or GTK+ functions in your program.
*
+ * Since: 2.2
**/
void
hildon_init (void)
* libraries. Use this function to replace a call to gtk_init() and also
* initialize the hildon library. See hildon_init() and gtk_init() for details.
*
+ * Since: 2.2
**/
void
hildon_gtk_init (int *argc, char ***argv)
*
* The horizontal-movement signal is emitted when the pannable area
* starts a horizontal movement.
+ *
+ * Since: 2.2
*/
pannable_area_signals[HORIZONTAL_MOVEMENT] =
g_signal_new ("horizontal_movement",
*
* The vertical-movement signal is emitted when the pannable area
* starts a vertical movement.
+ *
+ * Since: 2.2
*/
pannable_area_signals[VERTICAL_MOVEMENT] =
g_signal_new ("vertical_movement",
* artifacts in the animations.
*
* returns: The horizontal #GtkAdjustment
+ *
+ * Since: 2.2
**/
GtkAdjustment*
hildon_pannable_area_get_hadjustment (HildonPannableArea *area)
* artifacts in the animations.
*
* returns: The vertical #GtkAdjustment
+ *
+ * Since: 2.2
**/
GtkAdjustment*
hildon_pannable_area_get_vadjustment (HildonPannableArea *area)
*
* returns: the policy is currently being used in the widget
* #HildonSizeRequestPolicy.
+ *
+ * Since: 2.2
**/
HildonSizeRequestPolicy
hildon_pannable_area_get_size_request_policy (HildonPannableArea *area)
* parameter will not have any effect with
* #HILDON_SIZE_REQUEST_MINIMUM set.
*
+ * Since: 2.2
**/
void
hildon_pannable_area_set_size_request_policy (HildonPannableArea *area,
*
* Emits a "#HildonPickerButton::value-changed" signal to the given
* #HildonPickerButton
+ *
+ * Since: 2.2
**/
void
hildon_picker_button_value_changed (HildonPickerButton *button)
* Deprecated: Use hildon_window_stack_pop() instead
*
* Returns: A #HildonStackableWindow, or %NULL
+ *
+ * Since: 2.2
*/
HildonStackableWindow *
hildon_program_pop_window_stack (HildonProgram *self)
* Deprecated: Use hildon_window_stack_peek() instead
*
* Returns: A #HildonStackableWindow, or %NULL
+ *
+ * Since: 2.2
*/
HildonStackableWindow *
hildon_program_peek_window_stack (HildonProgram *self)
* Goes to the root window of the stack.
*
* Deprecated: See #HildonWindowStack
+ *
+ * Since: 2.2
*/
void
hildon_program_go_to_root_window (HildonProgram *self)
* Creates a new #HildonRemoteTexture.
*
* Return value: A #HildonRemoteTexture
+ *
+ * Since: 2.2
**/
GtkWidget*
hildon_remote_texture_new (void)
*
* This is an internal utility function that application will
* not need to call directly.
+ *
+ * Since: 2.2
**/
void
hildon_remote_texture_send_message (HildonRemoteTexture *self,
* @width: width of image in pixels
* @height: height of image in pixels
* @bpp: BYTES per pixel - usually 2,3 or 4
+ *
+ * Since: 2.2
*/
void
hildon_remote_texture_set_image (HildonRemoteTexture *self,
* This signals to hildon-desktop that a specific region of the memory area
* has changed. This will trigger a redraw and will update the relevant tiles
* of the texture.
+ *
+ * Since: 2.2
*/
void
hildon_remote_texture_update_area (HildonRemoteTexture *self,
*
* If the remote texture WM-counterpart is not ready, the show message
* will be queued until the WM is ready for it.
+ *
+ * Since: 2.2
**/
void
hildon_remote_texture_set_show_full (HildonRemoteTexture *self,
* This function is a shortcut for hildon_remote_texture_set_show_full(),
* setting the overall actor visibility without changing it's opacity
* setting.
+ *
+ * Since: 2.2
**/
void
hildon_remote_texture_set_show (HildonRemoteTexture *self,
*
* See hildon_remote_texture_set_show_full() for description of the range
* of values @opacity argument takes.
+ *
+ * Since: 2.2
**/
void
hildon_remote_texture_set_opacity (HildonRemoteTexture *self,
*
* If the remote texture WM-counterpart is not ready, the show message
* will be queued until the WM is ready for it.
+ *
+ * Since: 2.2
**/
void
hildon_remote_texture_set_position (HildonRemoteTexture *self,
*
* If the remote texture WM-counterpart is not ready, the show message
* will be queued until the WM is ready for it.
+ *
+ * Since: 2.2
**/
void
hildon_remote_texture_set_offset (HildonRemoteTexture *self,
* @self: A #HildonRemoteTexture
* @x_scale: The scale factor for the memory area to be rendered in the X-axis
* @y_scale: The scale factor for the memory area to be rendered in the X-axis
+ *
+ * Since: 2.2
**/
void
hildon_remote_texture_set_scale (HildonRemoteTexture *self,
*
* If the remote texture WM-counterpart is not ready, the show message
* will be queued until the WM is ready for it.
+ *
+ * Since: 2.2
**/
void
hildon_remote_texture_set_parent (HildonRemoteTexture *self,
*
* Returns: a new #HildonTextView
*
- * Since: 2.2
+ * Since: 2.2
*/
GtkWidget *
hildon_text_view_new (void)
* This can be due to the user selecting a different item from the list, or
* due to a call to hildon_touch_selector_select_iter() on one of the columns.
*
+ * Since: 2.2
*/
hildon_touch_selector_signals[CHANGED] =
g_signal_new ("changed",
* The "columns-changed" signal is emitted when the number
* of columns in the #HildonTouchSelector change.
*
+ * Since: 2.2
*/
hildon_touch_selector_signals[COLUMNS_CHANGED] =
g_signal_new ("columns-changed",
* doesn't need to be created by the application.
*
* Return value: the default #HildonWindowStack
- *
+ *
* Since: 2.2
**/
HildonWindowStack *
* done with the list you must call g_list_free().
*
* Returns: a newly-allocated list of #HildonStackableWindow<!-- -->s
+ *
+ * Since: 2.2
**/
GList *
hildon_window_stack_get_windows (HildonWindowStack *stack)
*
* A window can only have at most one edit toolbar at a time, so the
* previous toolbar (if any) is replaced after calling this function.
+ *
+ * Since: 2.2
**/
void
hildon_window_set_edit_toolbar (HildonWindow *self,
* you should use hildon_window_get_app_menu() instead.
*
* Return value: The #GtkMenu assigned to this application view.
+ *
+ * Since: 2.2
**/
GtkMenu*
hildon_window_get_main_menu (HildonWindow * self)
* Returns: the marked up title of the window, or %NULL if none has
* been set explicitely. The returned string is owned by the widget
* and must not be modified or freed.
+ *
+ * Since: 2.2
**/
const gchar *
hildon_window_get_markup (HildonWindow *window)
* Note that you need support from the window manager for this title
* to be used. See gtk_window_set_title() for the standard way of
* setting the title of a window.
+ *
+ * Since: 2.2
**/
void
hildon_window_set_markup (HildonWindow *window,