Mercurial > pidgin

comparison finch/libgnt/gntcombobox.h @ 19116:992afeb1d40f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added some docs
author Eric Polino <aluink@pidgin.im>
date Wed, 27 Jun 2007 02:51:00 +0000
parents 8410511f4dbb
children b25cb0775be3
comparison
equal deleted inserted replaced
19115:4c26b23e7859 19116:992afeb1d40f
63 }; 63 };
64 64
65 G_BEGIN_DECLS 65 G_BEGIN_DECLS
66 66
67 /** 67 /**
68 * 68 *
69 * Get the GType for GntComboBox
69 * 70 *
70 * @return 71 * @return
71 */ 72 */
72 GType gnt_combo_box_get_gtype(void); 73 GType gnt_combo_box_get_gtype(void);
73 74
74 /** 75 /**
75 * 76 *
77 * Create a new GntComboBox
76 * 78 *
77 * @return 79 * @return A new GntComboBox
78 */ 80 */
79 GntWidget * gnt_combo_box_new(void); 81 GntWidget * gnt_combo_box_new(void);
80 82
81 /** 83 /**
82 * 84 *
83 * @param box 85 * Add an entry
84 * @param key 86 *
85 * @param text 87 * @param box The GntComboBox
88 * @param key The data
89 * @param text The text to display
86 */ 90 */
87 void gnt_combo_box_add_data(GntComboBox *box, gpointer key, const char *text); 91 void gnt_combo_box_add_data(GntComboBox *box, gpointer key, const char *text);
88 92
89 /** 93 /**
94 *
95 * Remove an entry
90 * 96 *
91 * @param box 97 * @param box The GntComboBox
92 * @param key 98 * @param key The data to be removed
93 */ 99 */
94 void gnt_combo_box_remove(GntComboBox *box, gpointer key); 100 void gnt_combo_box_remove(GntComboBox *box, gpointer key);
95 101
96 /** 102 /**
97 * 103 *
98 * @param box 104 * Remove all entries
105 *
106 * @param box The GntComboBox
99 */ 107 */
100 void gnt_combo_box_remove_all(GntComboBox *box); 108 void gnt_combo_box_remove_all(GntComboBox *box);
101 109
102 /** 110 /**
103 * 111 *
104 * @param box 112 * Get the data that is currently selected
105 * 113 *
106 * @return 114 * @param box The GntComboBox
115 *
116 * @return The data of the currently selected entry
107 */ 117 */
108 gpointer gnt_combo_box_get_selected_data(GntComboBox *box); 118 gpointer gnt_combo_box_get_selected_data(GntComboBox *box);
109 119
110 /** 120 /**
111 * 121 *
112 * @param box 122 * Set the current selection to a specific entry
113 * @param key 123 *
124 * @param box The GntComboBox
125 * @param key The data to be set to
114 */ 126 */
115 void gnt_combo_box_set_selected(GntComboBox *box, gpointer key); 127 void gnt_combo_box_set_selected(GntComboBox *box, gpointer key);
116 128
117 G_END_DECLS 129 G_END_DECLS
118 130