Mercurial > pidgin.yaz
annotate finch/libgnt/gntwindow.h @ 23268:9f34726fe141
Whoops, I should have inverted this logic.
author | Mark Doliner <mark@kingant.net> |
---|---|
date | Mon, 02 Jun 2008 09:00:11 +0000 |
parents | d78e440584e0 |
children |
rev | line source |
---|---|
17718
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
1 /** |
18303
5c6f019e48f8
Generate doxy-help files for libgnt. And make it actually work.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18069
diff
changeset
|
2 * @file gntwindow.h Window API |
5c6f019e48f8
Generate doxy-help files for libgnt. And make it actually work.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18069
diff
changeset
|
3 * @ingroup gnt |
5c6f019e48f8
Generate doxy-help files for libgnt. And make it actually work.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18069
diff
changeset
|
4 */ |
5c6f019e48f8
Generate doxy-help files for libgnt. And make it actually work.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
18069
diff
changeset
|
5 /* |
17718
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
6 * GNT - The GLib Ncurses Toolkit |
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
7 * |
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
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:
15931
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:
15931
diff
changeset
|
10 * source distribution. |
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
11 * |
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
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:
15931
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:
15931
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:
15931
diff
changeset
|
15 * (at your option) any later version. |
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
16 * |
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
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:
15931
diff
changeset
|
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of |
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
20 * GNU General Public License for more details. |
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
21 * |
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
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:
15931
diff
changeset
|
23 * along with this program; if not, write to the Free Software |
19680
44b4e8bd759b
The FSF changed its address a while ago; our files were out of date.
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
18303
diff
changeset
|
24 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA |
17718
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
25 */ |
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
26 |
15818 | 27 #ifndef GNT_WINDOW_H |
28 #define GNT_WINDOW_H | |
29 | |
30 #include "gnt.h" | |
31 #include "gntbox.h" | |
32 #include "gntcolors.h" | |
33 #include "gntkeys.h" | |
34 #include "gntmenu.h" | |
35 | |
36 #define GNT_TYPE_WINDOW (gnt_window_get_gtype()) | |
37 #define GNT_WINDOW(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), GNT_TYPE_WINDOW, GntWindow)) | |
38 #define GNT_WINDOW_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), GNT_TYPE_WINDOW, GntWindowClass)) | |
39 #define GNT_IS_WINDOW(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), GNT_TYPE_WINDOW)) | |
40 #define GNT_IS_WINDOW_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), GNT_TYPE_WINDOW)) | |
41 #define GNT_WINDOW_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), GNT_TYPE_WINDOW, GntWindowClass)) | |
42 | |
43 #define GNT_WINDOW_FLAGS(obj) (GNT_WINDOW(obj)->priv.flags) | |
44 #define GNT_WINDOW_SET_FLAGS(obj, flags) (GNT_WINDOW_FLAGS(obj) |= flags) | |
45 #define GNT_WINDOW_UNSET_FLAGS(obj, flags) (GNT_WINDOW_FLAGS(obj) &= ~(flags)) | |
46 | |
15931
f00f2e283ffb
Some define changes. This helps in generating the python bindings.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15818
diff
changeset
|
47 typedef struct _GntWindow GntWindow; |
f00f2e283ffb
Some define changes. This helps in generating the python bindings.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15818
diff
changeset
|
48 typedef struct _GntWindowPriv GntWindowPriv; |
f00f2e283ffb
Some define changes. This helps in generating the python bindings.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15818
diff
changeset
|
49 typedef struct _GntWindowClass GntWindowClass; |
15818 | 50 |
21454
d78e440584e0
Add maximize flags for windows.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21284
diff
changeset
|
51 typedef enum |
d78e440584e0
Add maximize flags for windows.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21284
diff
changeset
|
52 { |
d78e440584e0
Add maximize flags for windows.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21284
diff
changeset
|
53 GNT_WINDOW_MAXIMIZE_X = 1 << 0, |
d78e440584e0
Add maximize flags for windows.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21284
diff
changeset
|
54 GNT_WINDOW_MAXIMIZE_Y = 1 << 1, |
d78e440584e0
Add maximize flags for windows.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21284
diff
changeset
|
55 } GntWindowFlags; |
d78e440584e0
Add maximize flags for windows.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21284
diff
changeset
|
56 |
15931
f00f2e283ffb
Some define changes. This helps in generating the python bindings.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15818
diff
changeset
|
57 struct _GntWindow |
15818 | 58 { |
59 GntBox parent; | |
60 GntMenu *menu; | |
21212
b65f1bff6412
Allow binding key-shortcuts to menuitems.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
61 GntWindowPriv *priv; |
15818 | 62 }; |
63 | |
15931
f00f2e283ffb
Some define changes. This helps in generating the python bindings.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15818
diff
changeset
|
64 struct _GntWindowClass |
15818 | 65 { |
66 GntBoxClass parent; | |
67 | |
68 void (*gnt_reserved1)(void); | |
69 void (*gnt_reserved2)(void); | |
70 void (*gnt_reserved3)(void); | |
71 void (*gnt_reserved4)(void); | |
72 }; | |
73 | |
74 G_BEGIN_DECLS | |
75 | |
17718
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
76 /** |
21252
d275275a011c
Missing changelog entries and @since tags from 3f567df17490f68b4feb8cf26ad004a34eb7cc9a.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21212
diff
changeset
|
77 * @return GType for GntWindow. |
17718
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
78 */ |
15818 | 79 GType gnt_window_get_gtype(void); |
80 | |
81 #define gnt_vwindow_new(homo) gnt_window_box_new(homo, TRUE) | |
82 #define gnt_hwindow_new(homo) gnt_window_box_new(homo, FALSE) | |
83 | |
17718
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
84 /** |
21161
e119edfc0fb0
applied changes from 172a59b41412c4630834d66f2e7ec3be970cc36b
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21158
diff
changeset
|
85 * Create a new window. |
17718
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
86 * |
21161
e119edfc0fb0
applied changes from 172a59b41412c4630834d66f2e7ec3be970cc36b
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21158
diff
changeset
|
87 * @return The newly created window. |
17718
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
88 */ |
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
89 GntWidget * gnt_window_new(void); |
15818 | 90 |
17718
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
91 /** |
21161
e119edfc0fb0
applied changes from 172a59b41412c4630834d66f2e7ec3be970cc36b
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21158
diff
changeset
|
92 * Create a new window. |
17718
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
93 * |
21161
e119edfc0fb0
applied changes from 172a59b41412c4630834d66f2e7ec3be970cc36b
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21158
diff
changeset
|
94 * @param homo @c TRUE if the widgets inside the window should have the same dimensions. |
e119edfc0fb0
applied changes from 172a59b41412c4630834d66f2e7ec3be970cc36b
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21158
diff
changeset
|
95 * @param vert @c TRUE if the widgets inside the window should be stacked vertically. |
e119edfc0fb0
applied changes from 172a59b41412c4630834d66f2e7ec3be970cc36b
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21158
diff
changeset
|
96 * |
e119edfc0fb0
applied changes from 172a59b41412c4630834d66f2e7ec3be970cc36b
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21158
diff
changeset
|
97 * @return The newly created window. |
17718
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
98 */ |
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
99 GntWidget * gnt_window_box_new(gboolean homo, gboolean vert); |
15818 | 100 |
17718
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
101 /** |
21161
e119edfc0fb0
applied changes from 172a59b41412c4630834d66f2e7ec3be970cc36b
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21158
diff
changeset
|
102 * Set the menu for a window. |
e119edfc0fb0
applied changes from 172a59b41412c4630834d66f2e7ec3be970cc36b
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21158
diff
changeset
|
103 * |
e119edfc0fb0
applied changes from 172a59b41412c4630834d66f2e7ec3be970cc36b
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21158
diff
changeset
|
104 * @param window The window. |
e119edfc0fb0
applied changes from 172a59b41412c4630834d66f2e7ec3be970cc36b
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21158
diff
changeset
|
105 * @param menu The menu for the window. |
17718
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
106 */ |
15818 | 107 void gnt_window_set_menu(GntWindow *window, GntMenu *menu); |
108 | |
21252
d275275a011c
Missing changelog entries and @since tags from 3f567df17490f68b4feb8cf26ad004a34eb7cc9a.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21212
diff
changeset
|
109 /** |
d275275a011c
Missing changelog entries and @since tags from 3f567df17490f68b4feb8cf26ad004a34eb7cc9a.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21212
diff
changeset
|
110 * Return the id of a menuitem specified to a keystroke. |
d275275a011c
Missing changelog entries and @since tags from 3f567df17490f68b4feb8cf26ad004a34eb7cc9a.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21212
diff
changeset
|
111 * |
d275275a011c
Missing changelog entries and @since tags from 3f567df17490f68b4feb8cf26ad004a34eb7cc9a.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21212
diff
changeset
|
112 * @param window The window. |
d275275a011c
Missing changelog entries and @since tags from 3f567df17490f68b4feb8cf26ad004a34eb7cc9a.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21212
diff
changeset
|
113 * @param key The keystroke. |
d275275a011c
Missing changelog entries and @since tags from 3f567df17490f68b4feb8cf26ad004a34eb7cc9a.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21212
diff
changeset
|
114 * |
d275275a011c
Missing changelog entries and @since tags from 3f567df17490f68b4feb8cf26ad004a34eb7cc9a.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21212
diff
changeset
|
115 * @return The id of the menuitem bound to the keystroke, or @c NULL. |
d275275a011c
Missing changelog entries and @since tags from 3f567df17490f68b4feb8cf26ad004a34eb7cc9a.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21212
diff
changeset
|
116 * |
d275275a011c
Missing changelog entries and @since tags from 3f567df17490f68b4feb8cf26ad004a34eb7cc9a.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21212
diff
changeset
|
117 * @since 2.3.0 |
d275275a011c
Missing changelog entries and @since tags from 3f567df17490f68b4feb8cf26ad004a34eb7cc9a.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21212
diff
changeset
|
118 */ |
21212
b65f1bff6412
Allow binding key-shortcuts to menuitems.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
119 const char * gnt_window_get_accel_item(GntWindow *window, const char *key); |
b65f1bff6412
Allow binding key-shortcuts to menuitems.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
120 |
21454
d78e440584e0
Add maximize flags for windows.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21284
diff
changeset
|
121 /** |
d78e440584e0
Add maximize flags for windows.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21284
diff
changeset
|
122 * Maximize a window, either horizontally or vertically, or both. |
d78e440584e0
Add maximize flags for windows.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21284
diff
changeset
|
123 * |
d78e440584e0
Add maximize flags for windows.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21284
diff
changeset
|
124 * @param window The window to maximize. |
d78e440584e0
Add maximize flags for windows.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21284
diff
changeset
|
125 * @param maximize The maximization state of the window. |
d78e440584e0
Add maximize flags for windows.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21284
diff
changeset
|
126 * |
d78e440584e0
Add maximize flags for windows.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21284
diff
changeset
|
127 * @since 2.3.0 |
d78e440584e0
Add maximize flags for windows.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21284
diff
changeset
|
128 */ |
d78e440584e0
Add maximize flags for windows.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21284
diff
changeset
|
129 void gnt_window_set_maximize(GntWindow *window, GntWindowFlags maximize); |
d78e440584e0
Add maximize flags for windows.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21284
diff
changeset
|
130 |
d78e440584e0
Add maximize flags for windows.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21284
diff
changeset
|
131 /** |
d78e440584e0
Add maximize flags for windows.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21284
diff
changeset
|
132 * Get the maximization state of a window. |
d78e440584e0
Add maximize flags for windows.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21284
diff
changeset
|
133 * |
d78e440584e0
Add maximize flags for windows.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21284
diff
changeset
|
134 * @param window The window. |
d78e440584e0
Add maximize flags for windows.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21284
diff
changeset
|
135 * |
d78e440584e0
Add maximize flags for windows.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21284
diff
changeset
|
136 * @return The maximization state of the window. |
d78e440584e0
Add maximize flags for windows.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21284
diff
changeset
|
137 * |
d78e440584e0
Add maximize flags for windows.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21284
diff
changeset
|
138 * @since 2.3.0 |
d78e440584e0
Add maximize flags for windows.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21284
diff
changeset
|
139 */ |
d78e440584e0
Add maximize flags for windows.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21284
diff
changeset
|
140 GntWindowFlags gnt_window_get_maximize(GntWindow *window); |
d78e440584e0
Add maximize flags for windows.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
21284
diff
changeset
|
141 |
16731
3c3fc1432a01
Let windows know when the workspace they are in is being hidden/shown
Richard Nelson <wabz@pidgin.im>
parents:
15931
diff
changeset
|
142 void gnt_window_workspace_hiding(GntWindow *); |
3c3fc1432a01
Let windows know when the workspace they are in is being hidden/shown
Richard Nelson <wabz@pidgin.im>
parents:
15931
diff
changeset
|
143 void gnt_window_workspace_showing(GntWindow *); |
3c3fc1432a01
Let windows know when the workspace they are in is being hidden/shown
Richard Nelson <wabz@pidgin.im>
parents:
15931
diff
changeset
|
144 |
15818 | 145 G_END_DECLS |
146 | |
147 #endif /* GNT_WINDOW_H */ |