comparison finch/libgnt/gntcombobox.h @ 19186:eef82b050c21

merge of 'bbeac90ad01d5059327da9e2504716614a191cab' and 'f30bfc6fc7aee19d096dd838aad5a784a7371d6c'
author Kevin Stange <kevin@simguy.net>
date Sat, 11 Aug 2007 21:08:27 +0000
parents b25cb0775be3
children 44b4e8bd759b
comparison
equal deleted inserted replaced
18842:e20619418edf 19186:eef82b050c21
67 }; 67 };
68 68
69 G_BEGIN_DECLS 69 G_BEGIN_DECLS
70 70
71 /** 71 /**
72 * 72 *
73 * Get the GType for GntComboBox
73 * 74 *
74 * @return 75 * @return
75 */ 76 */
76 GType gnt_combo_box_get_gtype(void); 77 GType gnt_combo_box_get_gtype(void);
77 78
78 /** 79 /**
79 * 80 *
81 * Create a new GntComboBox
80 * 82 *
81 * @return 83 * @return A new GntComboBox
82 */ 84 */
83 GntWidget * gnt_combo_box_new(void); 85 GntWidget * gnt_combo_box_new(void);
84 86
85 /** 87 /**
86 * 88 *
87 * @param box 89 * Add an entry
88 * @param key 90 *
89 * @param text 91 * @param box The GntComboBox
92 * @param key The data
93 * @param text The text to display
90 */ 94 */
91 void gnt_combo_box_add_data(GntComboBox *box, gpointer key, const char *text); 95 void gnt_combo_box_add_data(GntComboBox *box, gpointer key, const char *text);
92 96
93 /** 97 /**
98 *
99 * Remove an entry
94 * 100 *
95 * @param box 101 * @param box The GntComboBox
96 * @param key 102 * @param key The data to be removed
97 */ 103 */
98 void gnt_combo_box_remove(GntComboBox *box, gpointer key); 104 void gnt_combo_box_remove(GntComboBox *box, gpointer key);
99 105
100 /** 106 /**
101 * 107 *
102 * @param box 108 * Remove all entries
109 *
110 * @param box The GntComboBox
103 */ 111 */
104 void gnt_combo_box_remove_all(GntComboBox *box); 112 void gnt_combo_box_remove_all(GntComboBox *box);
105 113
106 /** 114 /**
107 * 115 *
108 * @param box 116 * Get the data that is currently selected
109 * 117 *
110 * @return 118 * @param box The GntComboBox
119 *
120 * @return The data of the currently selected entry
111 */ 121 */
112 gpointer gnt_combo_box_get_selected_data(GntComboBox *box); 122 gpointer gnt_combo_box_get_selected_data(GntComboBox *box);
113 123
114 /** 124 /**
115 * 125 *
116 * @param box 126 * Set the current selection to a specific entry
117 * @param key 127 *
128 * @param box The GntComboBox
129 * @param key The data to be set to
118 */ 130 */
119 void gnt_combo_box_set_selected(GntComboBox *box, gpointer key); 131 void gnt_combo_box_set_selected(GntComboBox *box, gpointer key);
120 132
121 G_END_DECLS 133 G_END_DECLS
122 134