annotate finch/libgnt/gntbox.h @ 22879:780972e37f0c

merge of '99687ce6fa955d1d32092992b65de140dc944ab0' and 'd26b1eaa92aaac0a6de151a429c6b7a3bf5bd241'
author Kevin Stange <kevin@simguy.net>
date Sat, 10 May 2008 05:20:29 +0000
parents 44b4e8bd759b
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
17928
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
1 /**
18303
5c6f019e48f8 Generate doxy-help files for libgnt. And make it actually work.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 17928
diff changeset
2 * @file gntbox.h Box API
5c6f019e48f8 Generate doxy-help files for libgnt. And make it actually work.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 17928
diff changeset
3 * @ingroup gnt
5c6f019e48f8 Generate doxy-help files for libgnt. And make it actually work.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 17928
diff changeset
4 */
5c6f019e48f8 Generate doxy-help files for libgnt. And make it actually work.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 17928
diff changeset
5 /*
17928
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
6 * GNT - The GLib Ncurses Toolkit
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
7 *
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
8 * GNT is the legal property of its developers, whose names are too numerous
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
9 * to list here. Please refer to the COPYRIGHT file distributed with this
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
10 * source distribution.
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
11 *
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
12 * This library is free software; you can redistribute it and/or modify
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
13 * it under the terms of the GNU General Public License as published by
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
14 * the Free Software Foundation; either version 2 of the License, or
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
15 * (at your option) any later version.
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
16 *
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
17 * This program is distributed in the hope that it will be useful,
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
20 * GNU General Public License for more details.
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
21 *
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
22 * You should have received a copy of the GNU General Public License
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
23 * along with this program; if not, write to the Free Software
19681
44b4e8bd759b The FSF changed its address a while ago; our files were out of date.
John Bailey <rekkanoryo@rekkanoryo.org>
parents: 18304
diff changeset
24 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
17928
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
25 */
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
26
15817
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
27 #ifndef GNT_BOX_H
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
28 #define GNT_BOX_H
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
29
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
30 #include "gnt.h"
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
31 #include "gntwidget.h"
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
32
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
33 #define GNT_TYPE_BOX (gnt_box_get_gtype())
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
34 #define GNT_BOX(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), GNT_TYPE_BOX, GntBox))
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
35 #define GNT_BOX_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), GNT_TYPE_BOX, GntBoxClass))
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
36 #define GNT_IS_BOX(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), GNT_TYPE_BOX))
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
37 #define GNT_IS_BOX_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), GNT_TYPE_BOX))
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
38 #define GNT_BOX_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), GNT_TYPE_BOX, GntBoxClass))
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
39
15928
f00f2e283ffb Some define changes. This helps in generating the python bindings.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 15817
diff changeset
40 typedef struct _GntBox GntBox;
f00f2e283ffb Some define changes. This helps in generating the python bindings.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 15817
diff changeset
41 typedef struct _GntBoxClass GntBoxClass;
15817
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
42
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
43 typedef enum
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
44 {
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
45 /* These for vertical boxes */
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
46 GNT_ALIGN_LEFT,
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
47 GNT_ALIGN_RIGHT,
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
48
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
49 GNT_ALIGN_MID,
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
50
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
51 /* These for horizontal boxes */
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
52 GNT_ALIGN_TOP,
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
53 GNT_ALIGN_BOTTOM
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
54 } GntAlignment;
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
55
15928
f00f2e283ffb Some define changes. This helps in generating the python bindings.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 15817
diff changeset
56 struct _GntBox
15817
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
57 {
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
58 GntWidget parent;
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
59
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
60 gboolean vertical;
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
61 gboolean homogeneous;
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
62 gboolean fill;
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
63 GList *list; /* List of widgets */
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
64
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
65 GntWidget *active;
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
66 int pad; /* Number of spaces to use between widgets */
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
67 GntAlignment alignment; /* How are the widgets going to be aligned? */
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
68
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
69 char *title;
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
70 GList *focus; /* List of widgets to cycle focus (only valid for parent boxes) */
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
71
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
72 void (*gnt_reserved1)(void);
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
73 void (*gnt_reserved2)(void);
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
74 void (*gnt_reserved3)(void);
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
75 void (*gnt_reserved4)(void);
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
76 };
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
77
15928
f00f2e283ffb Some define changes. This helps in generating the python bindings.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 15817
diff changeset
78 struct _GntBoxClass
15817
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
79 {
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
80 GntWidgetClass parent;
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
81
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
82 void (*gnt_reserved1)(void);
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
83 void (*gnt_reserved2)(void);
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
84 void (*gnt_reserved3)(void);
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
85 void (*gnt_reserved4)(void);
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
86 };
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
87
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
88 G_BEGIN_DECLS
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
89
17928
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
90 /**
18304
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
91 * The GType for GntBox.
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
92 * @return The GType.
17928
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
93 */
15817
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
94 GType gnt_box_get_gtype(void);
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
95
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
96 #define gnt_vbox_new(homo) gnt_box_new(homo, TRUE)
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
97 #define gnt_hbox_new(homo) gnt_box_new(homo, FALSE)
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
98
17928
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
99 /**
18304
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
100 * Create a new GntBox.
17928
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
101 *
18304
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
102 * @param homo If @c TRUE, all the widgets in it will have the same width (or height)
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
103 * @param vert Whether the widgets in it should be stacked vertically (if @c TRUE)
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
104 * or horizontally (if @c FALSE).
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
105 *
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
106 * @return The new GntBox.
17928
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
107 */
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
108 GntWidget * gnt_box_new(gboolean homo, gboolean vert);
15817
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
109
17928
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
110 /**
18304
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
111 * Add a widget in the box.
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
112 *
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
113 * @param box The box
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
114 * @param widget The widget to add
17928
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
115 */
15817
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
116 void gnt_box_add_widget(GntBox *box, GntWidget *widget);
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
117
17928
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
118 /**
18304
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
119 * Set a title for the box.
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
120 *
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
121 * @param box The box
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
122 * @param title The title to set
17928
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
123 */
15817
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
124 void gnt_box_set_title(GntBox *box, const char *title);
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
125
17928
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
126 /**
18304
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
127 * Set the padding to use between the widgets in the box.
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
128 *
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
129 * @param box The box
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
130 * @param pad The padding to use
17928
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
131 */
15817
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
132 void gnt_box_set_pad(GntBox *box, int pad);
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
133
17928
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
134 /**
18304
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
135 * Set whether it's a toplevel box (ie, a window) or not. If a box is toplevel,
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
136 * then it will show borders, the title (if set) and shadow (if enabled in
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
137 * @e .gntrc)
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
138 *
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
139 * @param box The box
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
140 * @param set @c TRUE if it's a toplevel box, @c FALSE otherwise.
17928
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
141 */
15817
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
142 void gnt_box_set_toplevel(GntBox *box, gboolean set);
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
143
17928
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
144 /**
18304
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
145 * Reposition and refresh the widgets in the box.
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
146 *
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
147 * @param box The box
17928
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
148 */
15817
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
149 void gnt_box_sync_children(GntBox *box);
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
150
17928
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
151 /**
18304
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
152 * Set the alignment for the widgets in the box.
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
153 *
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
154 * @param box The box
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
155 * @param alignment The alignment to use
17928
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
156 */
15817
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
157 void gnt_box_set_alignment(GntBox *box, GntAlignment alignment);
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
158
17928
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
159 /**
18304
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
160 * Remove a widget from the box. Calling this does NOT destroy the removed widget.
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
161 *
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
162 * @param box The box
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
163 * @param widget The widget to remove
17928
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
164 */
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
165 void gnt_box_remove(GntBox *box, GntWidget *widget);
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
166
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
167 /**
18304
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
168 * Remove all widgets from the box. This DOES destroy all widgets in the box.
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
169 *
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
170 * @param box The box
17928
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
171 */
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
172 void gnt_box_remove_all(GntBox *box);
15817
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
173
17928
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
174 /**
18304
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
175 * Readjust the size of each child widget, reposition the child widgets and
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
176 * recalculate the size of the box.
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
177 *
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
178 * @param box The box
17928
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
179 */
15817
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
180 void gnt_box_readjust(GntBox *box);
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
181
17928
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
182 /**
18304
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
183 * Set whether the widgets in the box should fill the empty spaces.
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
184 *
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
185 * @param box The box
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
186 * @param fill Whether the child widgets should fill the empty space
17928
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
187 */
15817
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
188 void gnt_box_set_fill(GntBox *box, gboolean fill);
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
189
17928
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
190 /**
18304
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
191 * Move the focus from one widget to the other.
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
192 *
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
193 * @param box The box
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
194 * @param dir The direction. If it's 1, then the focus is moved forwards, if it's
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
195 * -1, the focus is moved backwards.
17928
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
196 */
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
197 void gnt_box_move_focus(GntBox *box, int dir);
15817
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
198
17928
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
199 /**
18304
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
200 * Give focus to a specific child widget.
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
201 *
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
202 * @param box The box
38ecbc8a70bd Start filling in the doxygen-help skeleton.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents: 18303
diff changeset
203 * @param widget The child widget to give focus
17928
8410511f4dbb applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents: 15928
diff changeset
204 */
15817
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
205 void gnt_box_give_focus_to_child(GntBox *box, GntWidget *widget);
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
206
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
207 G_END_DECLS
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
208
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
209 #endif /* GNT_BOX_H */
0e3a8505ebbe renamed gaim-text to finch
Sean Egan <seanegan@gmail.com>
parents:
diff changeset
210