1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
|
/*
* GNT - The GLib Ncurses Toolkit
*
* GNT is the legal property of its developers, whose names are too numerous
* to list here. Please refer to the COPYRIGHT file distributed with this
* source distribution.
*
* This library is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*/
#ifndef GNT_WINDOW_H
#define GNT_WINDOW_H
/**
* SECTION:gntwindow
* @section_id: libgnt-gntwindow
* @title: GntWindow
* @short_description: A toplevel window
*/
#include "gnt.h"
#include "gntbox.h"
#include "gntcolors.h"
#include "gntkeys.h"
#include "gntmenu.h"
#define GNT_TYPE_WINDOW (gnt_window_get_gtype())
#define GNT_WINDOW(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), GNT_TYPE_WINDOW, GntWindow))
#define GNT_WINDOW_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), GNT_TYPE_WINDOW, GntWindowClass))
#define GNT_IS_WINDOW(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), GNT_TYPE_WINDOW))
#define GNT_IS_WINDOW_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), GNT_TYPE_WINDOW))
#define GNT_WINDOW_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), GNT_TYPE_WINDOW, GntWindowClass))
#ifndef GNT_DISABLE_DEPRECATED
/**
* GNT_WINDOW_FLAGS:
*
* Deprecated: 2.14.0: This is an internal implementation detail.
*/
#define GNT_WINDOW_FLAGS(obj) (GNT_WINDOW(obj)->priv.flags)
/**
* GNT_WINDOW_SET_FLAGS:
*
* Deprecated: 2.14.0: This is an internal implementation detail.
*/
#define GNT_WINDOW_SET_FLAGS(obj, flags) (GNT_WINDOW_FLAGS(obj) |= flags)
/**
* GNT_WINDOW_UNSET_FLAGS:
*
* Deprecated: 2.14.0: This is an internal implementation detail.
*/
#define GNT_WINDOW_UNSET_FLAGS(obj, flags) (GNT_WINDOW_FLAGS(obj) &= ~(flags))
#endif
typedef struct _GntWindow GntWindow;
typedef struct _GntWindowClass GntWindowClass;
#ifndef GNT_DISABLE_DEPRECATED
/**
* GntWindowPriv:
*
* Deprecated: 2.14.0: This is an internal implementation detail.
*/
typedef struct _GntWindowPriv GntWindowPriv;
#endif
typedef enum
{
GNT_WINDOW_MAXIMIZE_X = 1 << 0,
GNT_WINDOW_MAXIMIZE_Y = 1 << 1,
} GntWindowFlags;
/**
* GntWindow:
*
* Access to any fields is deprecated. See inline comments for replacements.
*/
struct _GntWindow
{
GntBox parent;
GntMenu *GNTSEAL(menu);
struct _GntWindowPriv *GNTSEAL(priv);
};
struct _GntWindowClass
{
GntBoxClass parent;
/*< private >*/
void (*gnt_reserved1)(void);
void (*gnt_reserved2)(void);
void (*gnt_reserved3)(void);
void (*gnt_reserved4)(void);
};
G_BEGIN_DECLS
/**
* gnt_window_get_gtype:
*
* Returns: GType for GntWindow.
*/
GType gnt_window_get_gtype(void);
#define gnt_vwindow_new(homo) gnt_window_box_new(homo, TRUE)
#define gnt_hwindow_new(homo) gnt_window_box_new(homo, FALSE)
/**
* gnt_window_new:
*
* Create a new window.
*
* Returns: The newly created window.
*/
GntWidget * gnt_window_new(void);
/**
* gnt_window_box_new:
* @homo: %TRUE if the widgets inside the window should have the same dimensions.
* @vert: %TRUE if the widgets inside the window should be stacked vertically.
*
* Create a new window.
*
* Returns: The newly created window.
*/
GntWidget * gnt_window_box_new(gboolean homo, gboolean vert);
/**
* gnt_window_set_menu:
* @window: The window.
* @menu: The menu for the window.
*
* Set the menu for a window.
*/
void gnt_window_set_menu(GntWindow *window, GntMenu *menu);
/**
* gnt_window_get_menu:
* @window: The window.
*
* Get the menu for a window.
*
* Returns: (transfer none) (nullable): The menu for the window.
*
* Since: 2.14.0
*/
GntMenu *gnt_window_get_menu(GntWindow *window);
/**
* gnt_window_get_accel_item:
* @window: The window.
* @key: The keystroke.
*
* Return the id of a menuitem specified to a keystroke.
*
* Returns: The id of the menuitem bound to the keystroke, or %NULL.
*
* Since: 2.3.0
*/
const char * gnt_window_get_accel_item(GntWindow *window, const char *key);
/**
* gnt_window_set_maximize:
* @window: The window to maximize.
* @maximize: The maximization state of the window.
*
* Maximize a window, either horizontally or vertically, or both.
*
* Since: 2.3.0
*/
void gnt_window_set_maximize(GntWindow *window, GntWindowFlags maximize);
/**
* gnt_window_get_maximize:
* @window: The window.
*
* Get the maximization state of a window.
*
* Returns: The maximization state of the window.
*
* Since: 2.3.0
*/
GntWindowFlags gnt_window_get_maximize(GntWindow *window);
void gnt_window_workspace_hiding(GntWindow *);
void gnt_window_workspace_showing(GntWindow *);
G_END_DECLS
#endif /* GNT_WINDOW_H */
|