diff options
author | Sadrul Habib Chowdhury <sadrul@pidgin.im> | 2007-10-10 03:54:14 +0000 |
---|---|---|
committer | Sadrul Habib Chowdhury <sadrul@pidgin.im> | 2007-10-10 03:54:14 +0000 |
commit | 90a09184ddc85f58657b01c3078c5a1638214911 (patch) | |
tree | d51e99c51ddd90acbc34c96462460e8d57ecd342 | |
parent | ebd3c4b692cd9456ece8e1980209b9ce6919cdec (diff) | |
download | pidgin-90a09184ddc85f58657b01c3078c5a1638214911.tar.gz |
Add @since doxygen tags for finch/libgnt.
-rw-r--r-- | finch/gntaccount.h | 2 | ||||
-rw-r--r-- | finch/gntblist.h | 2 | ||||
-rw-r--r-- | finch/gntsound.h | 12 | ||||
-rw-r--r-- | finch/libgnt/gnt.h | 8 | ||||
-rw-r--r-- | finch/libgnt/gntslider.h | 20 | ||||
-rw-r--r-- | finch/libgnt/gntstyle.h | 4 | ||||
-rw-r--r-- | finch/libgnt/gnttextview.h | 2 | ||||
-rw-r--r-- | finch/libgnt/gnttree.h | 14 | ||||
-rw-r--r-- | finch/libgnt/gntutils.h | 4 | ||||
-rw-r--r-- | finch/libgnt/gntws.h | 94 | ||||
-rw-r--r-- | finch/libgnt/test/Makefile | 2 |
11 files changed, 163 insertions, 1 deletions
diff --git a/finch/gntaccount.h b/finch/gntaccount.h index e1fd0378d6..2cf7d8f9e7 100644 --- a/finch/gntaccount.h +++ b/finch/gntaccount.h @@ -59,6 +59,8 @@ void finch_accounts_show_all(void); * Show the edit dialog for an account. * * @param account The account to edit, or @c NULL to create a new account. + * + * @since 2.2.0 */ void finch_account_dialog_show(PurpleAccount *account); diff --git a/finch/gntblist.h b/finch/gntblist.h index 23968d357e..0a9770a643 100644 --- a/finch/gntblist.h +++ b/finch/gntblist.h @@ -98,6 +98,8 @@ void finch_blist_set_size(int width, int height); * @param name The user to get information about. * * @return Returns the ui-handle for the userinfo notification. + * + * @since 2.1.0 */ gpointer finch_retrieve_user_info(PurpleConnection *conn, const char *name); diff --git a/finch/gntsound.h b/finch/gntsound.h index bb816ff47f..7ffb2d744d 100644 --- a/finch/gntsound.h +++ b/finch/gntsound.h @@ -37,6 +37,8 @@ * Get the name of the active sound profile. * * @return The name of the profile + * + * @since 2.1.0 */ const char *finch_sound_get_active_profile(void); @@ -44,6 +46,8 @@ const char *finch_sound_get_active_profile(void); * Set the active profile. If the profile doesn't exist, nothing is changed. * * @param name The name of the profile + * + * @since 2.1.0 */ void finch_sound_set_active_profile(const char *name); @@ -52,6 +56,8 @@ void finch_sound_set_active_profile(const char *name); * * @return A list of strings denoting sound profile names. * Caller must free the list (but not the data). + * + * @since 2.1.0 */ GList *finch_sound_get_profiles(void); @@ -60,6 +66,8 @@ GList *finch_sound_get_profiles(void); * * @return Returns FALSE if preference is set to 'No sound', or if volume is * set to zero. + * + * @since 2.2.0 */ gboolean finch_sound_is_enabled(void); @@ -67,11 +75,15 @@ gboolean finch_sound_is_enabled(void); * Gets GNT sound UI ops. * * @return The UI operations structure. + * + * @since 2.1.0 */ PurpleSoundUiOps *finch_sound_get_ui_ops(void); /** * Show the sound settings dialog. + * + * @since 2.1.0 */ void finch_sounds_show_all(void); diff --git a/finch/libgnt/gnt.h b/finch/libgnt/gnt.h index 510547d0cb..6e13679086 100644 --- a/finch/libgnt/gnt.h +++ b/finch/libgnt/gnt.h @@ -62,6 +62,14 @@ void gnt_main(void); */ gboolean gnt_ascii_only(void); +/** + * Present a window. If the event was triggered because of user interaction, + * the window is moved to the foreground. Otherwise, the Urgent hint is set. + * + * @param window The window the present. + * + * @since 2.0.0 (gnt), 2.1.0 (pidgin) + */ void gnt_window_present(GntWidget *window); /** * diff --git a/finch/libgnt/gntslider.h b/finch/libgnt/gntslider.h index 459e00e1e7..7cd6584342 100644 --- a/finch/libgnt/gntslider.h +++ b/finch/libgnt/gntslider.h @@ -75,6 +75,8 @@ G_BEGIN_DECLS /** * @return The GType for GntSlider + * + * @since 2.0.0 (gnt), 2.1.0 (pidgin) */ GType gnt_slider_get_gtype(void); @@ -89,6 +91,8 @@ GType gnt_slider_get_gtype(void); * @param min The minimum value for the slider * * @return The newly created slider + * + * @since 2.0.0 (gnt), 2.1.0 (pidgin) */ GntWidget * gnt_slider_new(gboolean orient, int max, int min); @@ -98,6 +102,8 @@ GntWidget * gnt_slider_new(gboolean orient, int max, int min); * @param slider The slider * @param max The maximum value * @param min The minimum value + * + * @since 2.0.0 (gnt), 2.1.0 (pidgin) */ void gnt_slider_set_range(GntSlider *slider, int max, int min); @@ -106,6 +112,8 @@ void gnt_slider_set_range(GntSlider *slider, int max, int min); * * @param slider The slider * @param step The amount for each step + * + * @since 2.0.0 (gnt), 2.1.0 (pidgin) */ void gnt_slider_set_step(GntSlider *slider, int step); @@ -114,6 +122,8 @@ void gnt_slider_set_step(GntSlider *slider, int step); * * @param slider The slider * @param step The amount for a small step (for the slider) + * + * @since 2.2.0 */ void gnt_slider_set_small_step(GntSlider *slider, int step); @@ -122,6 +132,8 @@ void gnt_slider_set_small_step(GntSlider *slider, int step); * * @param slider The slider * @param step The amount for a large step (for the slider) + * + * @since 2.2.0 */ void gnt_slider_set_large_step(GntSlider *slider, int step); @@ -133,6 +145,8 @@ void gnt_slider_set_large_step(GntSlider *slider, int step); * forward, negative to change backward * * @return The value of the slider after the change + * + * @since 2.0.0 (gnt), 2.1.0 (pidgin) */ int gnt_slider_advance_step(GntSlider *slider, int steps); @@ -141,6 +155,8 @@ int gnt_slider_advance_step(GntSlider *slider, int steps); * * @param slider The slider * @param value The current value + * + * @since 2.0.0 (gnt), 2.1.0 (pidgin) */ void gnt_slider_set_value(GntSlider *slider, int value); @@ -149,6 +165,8 @@ void gnt_slider_set_value(GntSlider *slider, int value); * * @param slider The slider * + * + * @since 2.0.0 (gnt), 2.1.0 (pidgin) */ int gnt_slider_get_value(GntSlider *slider); @@ -157,6 +175,8 @@ int gnt_slider_get_value(GntSlider *slider); * * @param slider The slider * @param label The label to update + * + * @since 2.0.0 (gnt), 2.1.0 (pidgin) */ void gnt_slider_reflect_label(GntSlider *slider, GntLabel *label); diff --git a/finch/libgnt/gntstyle.h b/finch/libgnt/gntstyle.h index 745d1517ac..22cde9781a 100644 --- a/finch/libgnt/gntstyle.h +++ b/finch/libgnt/gntstyle.h @@ -53,6 +53,8 @@ const char *gnt_style_get(GntStyle style); * @param key The key * * @return The value of the setting as a string, or @c NULL + * + * @since 2.0.0 (gnt), 2.1.0 (pidgin) */ char *gnt_style_get_from_name(const char *group, const char *key); @@ -62,6 +64,8 @@ char *gnt_style_get_from_name(const char *group, const char *key); * * @param value The value of the boolean setting as a string * @return The boolean value + * + * @since 2.0.0 (gnt), 2.1.0 (pidgin) */ gboolean gnt_style_parse_bool(const char *value); diff --git a/finch/libgnt/gnttextview.h b/finch/libgnt/gnttextview.h index a4ba38d1f4..67b2cf86ed 100644 --- a/finch/libgnt/gnttextview.h +++ b/finch/libgnt/gnttextview.h @@ -204,6 +204,8 @@ void gnt_text_view_attach_editor_widget(GntTextView *view, GntWidget *pager); * * @param view The textview widget * @param flag The flag to set + * + * @since 2.0.0 (gnt), 2.1.0 (pidgin) */ void gnt_text_view_set_flag(GntTextView *view, GntTextViewFlag flag); diff --git a/finch/libgnt/gnttree.h b/finch/libgnt/gnttree.h index e8bd55057c..9be004d052 100644 --- a/finch/libgnt/gnttree.h +++ b/finch/libgnt/gnttree.h @@ -383,6 +383,8 @@ void gnt_tree_set_col_width(GntTree *tree, int col, int width); * * @see gnt_tree_set_column_titles * @see gnt_tree_set_show_title + * + * @since 2.0.0 (gnt), 2.1.0 (pidgin) */ void gnt_tree_set_column_title(GntTree *tree, int index, const char *title); @@ -486,6 +488,8 @@ void gnt_tree_set_column_visible(GntTree *tree, int col, gboolean vis); * * @see gnt_tree_set_col_width * @see gnt_tree_set_column_width_ratio + * + * @since 2.0.0 (gnt), 2.1.0 (pidgin) */ void gnt_tree_set_column_resizable(GntTree *tree, int col, gboolean res); @@ -505,6 +509,8 @@ void gnt_tree_set_column_is_binary(GntTree *tree, int col, gboolean bin); * @param tree The tree * @param col The index of the column * @param right @c TRUE if the text in the column should be right aligned + * + * @since 2.0.0 (gnt), 2.1.0 (pidgin) */ void gnt_tree_set_column_is_right_aligned(GntTree *tree, int col, gboolean right); @@ -519,6 +525,8 @@ void gnt_tree_set_column_is_right_aligned(GntTree *tree, int col, gboolean right * * @see gnt_tree_set_col_width * @see gnt_tree_set_column_resizable + * + * @since 2.0.0 (gnt), 2.1.0 (pidgin) */ void gnt_tree_set_column_width_ratio(GntTree *tree, int cols[]); @@ -527,6 +535,8 @@ void gnt_tree_set_column_width_ratio(GntTree *tree, int cols[]); * * @param tree The tree * @param col The index of the column + * + * @since 2.0.0 (gnt), 2.1.0 (pidgin) */ void gnt_tree_set_search_column(GntTree *tree, int col); @@ -535,6 +545,8 @@ void gnt_tree_set_search_column(GntTree *tree, int col); * * @param tree The tree * @return @c TRUE if the user is searching, @c FALSE otherwise. + * + * @since 2.0.0 (gnt), 2.1.0 (pidgin) */ gboolean gnt_tree_is_searching(GntTree *tree); @@ -547,6 +559,8 @@ gboolean gnt_tree_is_searching(GntTree *tree); * string and the content of row in the search column. * If the function returns @c TRUE, the row is dislayed, * otherwise it's not. + * + * @since 2.0.0 (gnt), 2.1.0 (pidgin) */ void gnt_tree_set_search_function(GntTree *tree, gboolean (*func)(GntTree *tree, gpointer key, const char *search, const char *current)); diff --git a/finch/libgnt/gntutils.h b/finch/libgnt/gntutils.h index f976d4ba08..4f00a960d7 100644 --- a/finch/libgnt/gntutils.h +++ b/finch/libgnt/gntutils.h @@ -139,6 +139,8 @@ void gnt_util_parse_widgets(const char *string, int num, ...); * @param string The XHTML string * @param tv The GntTextView * @return @c TRUE if the string was added to the textview properly, @c FALSE otherwise. + * + * @since 2.2.0 */ gboolean gnt_util_parse_xhtml_to_textview(const char *string, GntTextView *tv); @@ -148,6 +150,8 @@ gboolean gnt_util_parse_xhtml_to_textview(const char *string, GntTextView *tv); * @param widget The widget * @param key The key to trigger the button * @param button The button to trigger + * + * @since 2.0.0 (gnt), 2.1.0 (pidgin) */ void gnt_util_set_trigger_widget(GntWidget *wid, const char *text, GntWidget *button); diff --git a/finch/libgnt/gntws.h b/finch/libgnt/gntws.h index 82ffca6a7b..e4e68c6338 100644 --- a/finch/libgnt/gntws.h +++ b/finch/libgnt/gntws.h @@ -69,18 +69,112 @@ struct _GntWSClass G_BEGIN_DECLS +/** + * @return The GType for GntWS. + * + * @since 2.0.0 (gnt), 2.1.0 (pidgin) + */ GType gnt_ws_get_gtype(void); +/** + * Create a new workspace with the specified name. + * + * @param name The desired name of the workspace, or @c NULL. + * + * @return The newly created workspace. + * + * @since 2.0.0 (gnt), 2.1.0 (pidgin) + */ GntWS *gnt_ws_new(const char *name); + +/** + * Set the name of a workspace. + * + * @param ws The workspace to rename. + * @param name The new name of the workspace. + * + * @since 2.0.0 (gnt), 2.1.0 (pidgin) + */ void gnt_ws_set_name(GntWS *ws, const gchar *name); + +/** + * Add a widget to a workspace. + * + * @param ws The workspace. + * @param widget The widget to add. + * + * @since 2.0.0 (gnt), 2.1.0 (pidgin) + */ void gnt_ws_add_widget(GntWS *ws, GntWidget *widget); + +/** + * Remove a widget from a workspace. + * + * @param ws The workspace + * @param widget The widget to remove from the workspace. + * + * @since 2.0.0 (gnt), 2.1.0 (pidgin) + */ void gnt_ws_remove_widget(GntWS *ws, GntWidget *widget); + +/** + * Hide a widget in a workspace. + * + * @param widget The widget to hide. + * @param nodes A hashtable containing information about the widgets. + * + * @since 2.0.0 (gnt), 2.1.0 (pidgin) + */ void gnt_ws_widget_hide(GntWidget *widget, GHashTable *nodes); + +/** + * Show a widget in a workspace. + * + * @param widget The widget to show. + * @param nodes A hashtable containing information about the widgets. + * + * @since 2.0.0 (gnt), 2.1.0 (pidgin) + */ void gnt_ws_widget_show(GntWidget *widget, GHashTable *nodes); + +/** + * Draw the taskbar in a workspace. + * + * @param ws The workspace. + * @param reposition Whether the workspace should reposition the taskbar. + * + * @since 2.0.0 (gnt), 2.1.0 (pidgin) + */ void gnt_ws_draw_taskbar(GntWS *ws, gboolean reposition); + +/** + * Hide a workspace. + * + * @param ws The workspace to hide. + * @param table A hashtable containing information about the widgets. + * + * @since 2.0.0 (gnt), 2.1.0 (pidgin) + */ void gnt_ws_hide(GntWS *ws, GHashTable *table); + +/** + * Show a workspace. + * + * @param ws The workspace to hide. + * @param table A hashtable containing information about the widgets. + * + * @since 2.0.0 (gnt), 2.1.0 (pidgin) + */ void gnt_ws_show(GntWS *ws, GHashTable *table); +/** + * Get the name of a workspace. + * + * @param ws The workspace. + * @return The name of the workspace (can be @c NULL). + * + * @since 2.0.0 (gnt), 2.1.0 (pidgin) + */ const char * gnt_ws_get_name(GntWS *ws); #endif diff --git a/finch/libgnt/test/Makefile b/finch/libgnt/test/Makefile index 89296db7f6..e40ea7ffa3 100644 --- a/finch/libgnt/test/Makefile +++ b/finch/libgnt/test/Makefile @@ -1,5 +1,5 @@ CC=gcc -CFLAGS=`pkg-config --cflags gobject-2.0 gmodule-2.0` -g -I../ -DSTANDALONE +CFLAGS=`pkg-config --cflags gobject-2.0 gmodule-2.0` -g -I../ -DSTANDALONE -I/usr/inclue/ncursesw/ LDFLAGS=`pkg-config --libs gobject-2.0 gmodule-2.0 gnt` -pg EXAMPLES=combo focus tv multiwin keys menu parse |