Mercurial > pidgin3 / file comparison

comparison: finch/libgnt/gntbox.h

finch/libgnt/gntbox.h

changeset 18359
1e637ecf18a0
parent 18358
2122fd567315
child 19859
71d37b57eff2
equal deleted inserted replaced
18358:2122fd567315 18359:1e637ecf18a0
86 }; 86 };
87 87
88 G_BEGIN_DECLS 88 G_BEGIN_DECLS
89 89
90 /** 90 /**
91 * 91 * The GType for GntBox.
92 * 92 * @return The GType.
93 * @return
94 */ 93 */
95 GType gnt_box_get_gtype(void); 94 GType gnt_box_get_gtype(void);
96 95
97 #define gnt_vbox_new(homo) gnt_box_new(homo, TRUE) 96 #define gnt_vbox_new(homo) gnt_box_new(homo, TRUE)
98 #define gnt_hbox_new(homo) gnt_box_new(homo, FALSE) 97 #define gnt_hbox_new(homo) gnt_box_new(homo, FALSE)
99 98
100 /** 99 /**
101 * 100 * Create a new GntBox.
102 * @param homo 101 *
103 * @param vert 102 * @param homo If @c TRUE, all the widgets in it will have the same width (or height)
104 * 103 * @param vert Whether the widgets in it should be stacked vertically (if @c TRUE)
105 * @return 104 * or horizontally (if @c FALSE).
105 *
106 * @return The new GntBox.
106 */ 107 */
107 GntWidget * gnt_box_new(gboolean homo, gboolean vert); 108 GntWidget * gnt_box_new(gboolean homo, gboolean vert);
108 109
109 /** 110 /**
110 * 111 * Add a widget in the box.
111 * @param box 112 *
112 * @param widget 113 * @param box The box
114 * @param widget The widget to add
113 */ 115 */
114 void gnt_box_add_widget(GntBox *box, GntWidget *widget); 116 void gnt_box_add_widget(GntBox *box, GntWidget *widget);
115 117
116 /** 118 /**
117 * 119 * Set a title for the box.
118 * @param box 120 *
119 * @param title 121 * @param box The box
122 * @param title The title to set
120 */ 123 */
121 void gnt_box_set_title(GntBox *box, const char *title); 124 void gnt_box_set_title(GntBox *box, const char *title);
122 125
123 /** 126 /**
124 * 127 * Set the padding to use between the widgets in the box.
125 * @param box 128 *
126 * @param pad 129 * @param box The box
130 * @param pad The padding to use
127 */ 131 */
128 void gnt_box_set_pad(GntBox *box, int pad); 132 void gnt_box_set_pad(GntBox *box, int pad);
129 133
130 /** 134 /**
131 * 135 * Set whether it's a toplevel box (ie, a window) or not. If a box is toplevel,
132 * @param box 136 * then it will show borders, the title (if set) and shadow (if enabled in
133 * @param set 137 * @e .gntrc)
138 *
139 * @param box The box
140 * @param set @c TRUE if it's a toplevel box, @c FALSE otherwise.
134 */ 141 */
135 void gnt_box_set_toplevel(GntBox *box, gboolean set); 142 void gnt_box_set_toplevel(GntBox *box, gboolean set);
136 143
137 /** 144 /**
138 * 145 * Reposition and refresh the widgets in the box.
139 * @param box 146 *
147 * @param box The box
140 */ 148 */
141 void gnt_box_sync_children(GntBox *box); 149 void gnt_box_sync_children(GntBox *box);
142 150
143 /** 151 /**
144 * 152 * Set the alignment for the widgets in the box.
145 * @param box 153 *
146 * @param alignment 154 * @param box The box
155 * @param alignment The alignment to use
147 */ 156 */
148 void gnt_box_set_alignment(GntBox *box, GntAlignment alignment); 157 void gnt_box_set_alignment(GntBox *box, GntAlignment alignment);
149 158
150 /** 159 /**
151 * 160 * Remove a widget from the box. Calling this does NOT destroy the removed widget.
152 * @param box 161 *
153 * @param widget 162 * @param box The box
163 * @param widget The widget to remove
154 */ 164 */
155 void gnt_box_remove(GntBox *box, GntWidget *widget); 165 void gnt_box_remove(GntBox *box, GntWidget *widget);
156 166
157 /* XXX: does NOT destroy widget */ 167 /**
158 168 * Remove all widgets from the box. This DOES destroy all widgets in the box.
159 /** 169 *
160 * 170 * @param box The box
161 * @param box
162 */ 171 */
163 void gnt_box_remove_all(GntBox *box); 172 void gnt_box_remove_all(GntBox *box);
164 173
165 /* Removes AND destroys all the widgets in it */ 174 /**
166 175 * Readjust the size of each child widget, reposition the child widgets and
167 /** 176 * recalculate the size of the box.
168 * 177 *
169 * @param box 178 * @param box The box
170 */ 179 */
171 void gnt_box_readjust(GntBox *box); 180 void gnt_box_readjust(GntBox *box);
172 181
173 /** 182 /**
174 * 183 * Set whether the widgets in the box should fill the empty spaces.
175 * @param box 184 *
176 * @param fill 185 * @param box The box
186 * @param fill Whether the child widgets should fill the empty space
177 */ 187 */
178 void gnt_box_set_fill(GntBox *box, gboolean fill); 188 void gnt_box_set_fill(GntBox *box, gboolean fill);
179 189
180 /** 190 /**
181 * 191 * Move the focus from one widget to the other.
182 * @param box 192 *
183 * @param dir 193 * @param box The box
194 * @param dir The direction. If it's 1, then the focus is moved forwards, if it's
195 * -1, the focus is moved backwards.
184 */ 196 */
185 void gnt_box_move_focus(GntBox *box, int dir); 197 void gnt_box_move_focus(GntBox *box, int dir);
186 198
187 /* +1 to move forward, -1 for backward */ 199 /**
188 200 * Give focus to a specific child widget.
189 /** 201 *
190 * 202 * @param box The box
191 * @param box 203 * @param widget The child widget to give focus
192 * @param widget
193 */ 204 */
194 void gnt_box_give_focus_to_child(GntBox *box, GntWidget *widget); 205 void gnt_box_give_focus_to_child(GntBox *box, GntWidget *widget);
195 206
196 G_END_DECLS 207 G_END_DECLS
197 208

Mercurial Repository: pidgin3

mercurial