diff -r 125a7f267af8 -r f1ba94fd20f1 finch/libgnt/gntwidget.h --- a/finch/libgnt/gntwidget.h Sun Feb 02 01:22:13 2014 +0530 +++ b/finch/libgnt/gntwidget.h Sun Feb 02 03:49:31 2014 +0530 @@ -140,173 +140,209 @@ G_BEGIN_DECLS /** + * gnt_widget_get_gtype: + * * Returns: GType for GntWidget. */ GType gnt_widget_get_gtype(void); /** + * gnt_widget_destroy: + * @widget: The widget to destroy. + * * Destroy a widget. - * @widget: The widget to destroy. */ void gnt_widget_destroy(GntWidget *widget); /** + * gnt_widget_show: + * @widget: The widget to show. + * * Show a widget. This should only be used for toplevel widgets. For the rest * of the widgets, use #gnt_widget_draw instead. - * - * @widget: The widget to show. */ void gnt_widget_show(GntWidget *widget); /** + * gnt_widget_draw: + * @widget: The widget to draw. + * * Draw a widget. - * @widget: The widget to draw. */ void gnt_widget_draw(GntWidget *widget); /** + * gnt_widget_expose: + * * @internal * Expose part of a widget. */ void gnt_widget_expose(GntWidget *widget, int x, int y, int width, int height); /** + * gnt_widget_hide: + * @widget: The widget to hide. + * * Hide a widget. - * @widget: The widget to hide. */ void gnt_widget_hide(GntWidget *widget); /** - * Get the position of a widget. - * + * gnt_widget_get_position: * @widget: The widget. * @x: Location to store the x-coordinate of the widget. * @y: Location to store the y-coordinate of the widget. + * + * Get the position of a widget. */ void gnt_widget_get_position(GntWidget *widget, int *x, int *y); /** - * Set the position of a widget. + * gnt_widget_set_position: * @widget: The widget to reposition. * @x: The x-coordinate of the widget. * @y: The x-coordinate of the widget. + * + * Set the position of a widget. */ void gnt_widget_set_position(GntWidget *widget, int x, int y); /** + * gnt_widget_size_request: + * @widget: The widget. + * * Request a widget to calculate its desired size. - * @widget: The widget. */ void gnt_widget_size_request(GntWidget *widget); /** - * Get the size of a widget. + * gnt_widget_get_size: * @widget: The widget. * @width: Location to store the width of the widget. * @height: Location to store the height of the widget. + * + * Get the size of a widget. */ void gnt_widget_get_size(GntWidget *widget, int *width, int *height); /** - * Set the size of a widget. - * + * gnt_widget_set_size: * @widget: The widget to resize. * @width: The width of the widget. * @height: The height of the widget. * + * Set the size of a widget. + * * Returns: If the widget was resized to the new size. */ gboolean gnt_widget_set_size(GntWidget *widget, int width, int height); /** - * Confirm a requested a size for a widget. - * + * gnt_widget_confirm_size: * @widget: The widget. * @width: The requested width. * @height: The requested height. * + * Confirm a requested a size for a widget. + * * Returns: %TRUE if the new size was confirmed, %FALSE otherwise. */ gboolean gnt_widget_confirm_size(GntWidget *widget, int width, int height); /** - * Trigger the key-press callbacks for a widget. - * + * gnt_widget_key_pressed: * @widget: The widget. * @keys: The keypress on the widget. * + * Trigger the key-press callbacks for a widget. + * * Returns: %TRUE if the key-press was handled, %FALSE otherwise. */ gboolean gnt_widget_key_pressed(GntWidget *widget, const char *keys); /** - * Trigger the 'click' callback of a widget. - * + * gnt_widget_clicked: * @widget: The widget. * @event: The mouseevent. * @x: The x-coordinate of the mouse. * @y: The y-coordinate of the mouse. * + * Trigger the 'click' callback of a widget. + * * Returns: %TRUE if the event was handled, %FALSE otherwise. */ gboolean gnt_widget_clicked(GntWidget *widget, GntMouseEvent event, int x, int y); /** - * Give or remove focus to a widget. + * gnt_widget_set_focus: * @widget: The widget. * @set: %TRUE of focus should be given to the widget, %FALSE if * focus should be removed. * + * Give or remove focus to a widget. + * * Returns: %TRUE if the focus has been changed, %FALSE otherwise. */ gboolean gnt_widget_set_focus(GntWidget *widget, gboolean set); /** + * gnt_widget_activate: + * @widget: The widget to activate. + * * Activate a widget. This only applies to widgets that can be activated (eg. GntButton) - * @widget: The widget to activate. */ void gnt_widget_activate(GntWidget *widget); /** - * Set the name of a widget. + * gnt_widget_set_name: * @widget: The widget. * @name: A new name for the widget. + * + * Set the name of a widget. */ void gnt_widget_set_name(GntWidget *widget, const char *name); /** + * gnt_widget_get_name: + * @widget: The widget. + * * Get the name of a widget. - * @widget: The widget. + * * Returns: The name of the widget. */ const char *gnt_widget_get_name(GntWidget *widget); /** + * gnt_widget_queue_update: + * * @internal * Use #gnt_widget_draw instead. */ void gnt_widget_queue_update(GntWidget *widget); /** - * Set whether a widget can take focus or not. - * + * gnt_widget_set_take_focus: * @widget: The widget. * @set: %TRUE if the widget can take focus. + * + * Set whether a widget can take focus or not. */ void gnt_widget_set_take_focus(GntWidget *widget, gboolean set); /** - * Set the visibility of a widget. - * + * gnt_widget_set_visible: * @widget: The widget. * @set: Whether the widget is visible or not. + * + * Set the visibility of a widget. */ void gnt_widget_set_visible(GntWidget *widget, gboolean set); /** - * Check whether the widget has shadows. + * gnt_widget_has_shadow: + * @widget: The widget. * - * @widget: The widget. + * Check whether the widget has shadows. * * Returns: %TRUE if the widget has shadows. This checks both the user-setting * and whether the widget can have shadows at all.