aboutsummaryrefslogtreecommitdiffstats
path: root/matchbox2/mb-wm-client.h
blob: 4e01dd995af870f6f20f3f6f1096ca4483489bda (plain)
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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
/*
 *  Matchbox Window Manager II - A lightweight window manager not for the
 *                               desktop.
 *
 *  Authored By Matthew Allum <mallum@o-hand.com>
 *
 *  Copyright (c) 2005 OpenedHand Ltd - http://o-hand.com
 *
 *  This program 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, 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.
 *
 */

#ifndef _HAVE_MB_CLIENT_H
#define _HAVE_MB_CLIENT_H

#include <matchbox2/mb-wm-client-window.h>
#include <matchbox2/mb-wm-config.h>
#if ENABLE_COMPOSITE
#include <matchbox2/mb-wm-comp-mgr.h>
#endif

/* XXX: We have a circular dependency between mb-wm-comp-mgr.h
 * and mb-wm-client.h */
#ifndef MB_WM_COMP_MGR_TYPEDEF_DEFINED
typedef struct MBWMCompMgr                 MBWMCompMgr;
#define MB_WM_COMP_MGR_TYPEDEF_DEFINED
#endif

#define MB_WM_CLIENT(c) ((MBWindowManagerClient*)(c))
#define MB_WM_CLIENT_CLASS(c) ((MBWindowManagerClientClass*)(c))
#define MB_WM_TYPE_CLIENT (mb_wm_client_class_type ())
#define MB_WM_CLIENT_XWIN(w) (w)->window->xwindow
#define MB_WM_CLIENT_CLIENT_TYPE(c) \
    (MB_WM_CLIENT_CLASS(MB_WM_OBJECT_GET_CLASS(c))->client_type)

/* XXX: We have a circular dependency between mb-wm-comp-mgr.h
 * and mb-wm-client.h */
#ifndef MB_WM_CLIENT_TYPEDEF_DEFINED
typedef struct MBWindowManagerClient MBWindowManagerClient;
#define MB_WM_CLIENT_TYPEDEF_DEFINED
#endif
typedef struct MBWindowManagerClientClass  MBWindowManagerClientClass;
typedef struct MBWindowManagerClientPriv   MBWindowManagerClientPriv;

typedef void (*MBWindowManagerClientInitMethod) (MBWindowManagerClient *client);

/* Clients hint to what stacking layer they exist in. By default all
 * transients to that client will also be stacked there.
 */
typedef enum MBWMStackLayerType
{
  MBWMStackLayerUnknown     = 0, /* Transients */
  MBWMStackLayerBottom       , 	 /* Desktop window */
  MBWMStackLayerBottomMid    ,	 /* Panels */
  MBWMStackLayerMid          ,	 /* Apps */
  MBWMStackLayerTopMid       ,	 /* Trans for root dialogs */
  MBWMStackLayerTop          ,	 /* Something else ? */
  N_MBWMStackLayerTypes
}
MBWMStackLayerType;

/* Clients can also hint to as how they would like to be managed by the
 * layout manager.
 */
typedef enum MBWMClientLayoutHints
  {
    LayoutPrefReserveEdgeNorth = (1<< 0), /* panels */
    LayoutPrefReserveEdgeSouth = (1<< 1),
    LayoutPrefReserveEdgeEast  = (1<< 2),
    LayoutPrefReserveEdgeWest  = (1<< 3),
    LayoutPrefReserveNorth     = (1<< 4), /* Input wins */
    LayoutPrefReserveSouth     = (1<< 5),
    LayoutPrefReserveEast      = (1<< 6),
    LayoutPrefReserveWest      = (1<< 7),
    LayoutPrefGrowToFreeSpace  = (1<< 8), /* Free space left by above   */
    LayoutPrefFullscreen       = (1<< 9), /* Fullscreen and desktop wins */
    LayoutPrefPositionFree     = (1<<10), /* Dialog */
    LayoutPrefVisible          = (1<<11), /* Flag is toggled by stacking */
    LayoutPrefFixedX           = (1<<12), /* X and width are fixed*/
    LayoutPrefFixedY           = (1<<13),
    LayoutPrefOverlaps         = (1<<14), /* stacked over other windows */
    LayoutPrefMovable          = (1<<15),
    LayoutPrefResizable        = (1<<16),
  }
MBWMClientLayoutHints;

typedef enum MBWMClientReqGeomType
  {
    MBWMClientReqGeomDontCommit         = (1 << 1),
    MBWMClientReqGeomIsViaConfigureReq  = (1 << 2),
    MBWMClientReqGeomIsViaUserAction    = (1 << 3),
    MBWMClientReqGeomIsViaLayoutManager = (1 << 4),
    MBWMClientReqGeomForced             = (1 << 5)
  }
MBWMClientReqGeomType;

/* Methods */

typedef  void (*MBWMClientNewMethod) (MBWindowManager       *wm,
				      MBWMClientWindow      *win);

typedef  void (*MBWMClientInitMethod) (MBWindowManager       *wm,
				       MBWindowManagerClient *client,
				       MBWMClientWindow      *win);

typedef  void (*MBWMClientRealizeMethod) (MBWindowManagerClient *client);

typedef  void (*MBWMClientDestroyMethod) (MBWindowManagerClient *client);

typedef  Bool (*MBWMClientGeometryMethod) (MBWindowManagerClient *client,
					   MBGeometry            *new_geometry,
					   MBWMClientReqGeomType  flags);

typedef  void (*MBWMClientStackMethod) (MBWindowManagerClient *client,
					int                    flags);

typedef  void (*MBWMClientShowMethod) (MBWindowManagerClient *client);

typedef  void (*MBWMClientHideMethod) (MBWindowManagerClient *client);

typedef  void (*MBWMClientSyncMethod) (MBWindowManagerClient *client);

typedef  Bool (*MBWMClientFocusMethod)(MBWindowManagerClient *client);

typedef  void (*MBWMClientThemeChangeMethod) (MBWindowManagerClient *client);

typedef  void (*MBWMClientDetransitise) (MBWindowManagerClient *client);

typedef  MBWMStackLayerType (*MBWMClientStackingLayer)(MBWindowManagerClient*);

struct MBWindowManagerClientClass
{
  MBWMObjectClass              parent;

  MBWMClientType               client_type;

  MBWMClientRealizeMethod      realize;	 /* create dpy resources / reparent */
  MBWMClientGeometryMethod     geometry; /* requests a gemetry change */
  MBWMClientStackMethod        stack;    /* positions win in stack */
  MBWMClientShowMethod         show;
  MBWMClientHideMethod         hide;
  MBWMClientSyncMethod         sync;     /* sync internal changes to display */
  MBWMClientFocusMethod        focus;
  MBWMClientThemeChangeMethod  theme_change;
  MBWMClientDetransitise       detransitise;
  MBWMClientStackingLayer      stacking_layer;
};

struct MBWindowManagerClient
{
  MBWMObject                   parent;
  /* ### public ### */

  MBWindowManager             *wmref;
  char                        *name;
  MBWMClientWindow            *window;
  Window                       xwin_frame;
  Window                       xwin_modal_blocker;
  MBWMStackLayerType           stacking_layer;
  unsigned long                stacking_hints;

  MBWMClientLayoutHints        layout_hints;

  MBWindowManagerClient       *stacked_above, *stacked_below;
  MBWindowManagerClient       *next_focused_client;

  MBGeometry frame_geometry;  /* FIXME: in ->priv ? */
  MBWMList                    *decor;
  MBWMList                    *transients;
  MBWindowManagerClient       *transient_for;
  MBWindowManagerClient       *last_focused_transient;

  int                          skip_unmaps;

  /* ### Private ### */

  MBWindowManagerClientPriv   *priv;
  unsigned long                sig_prop_change_id;
  unsigned long                ping_cb_id;
  unsigned long                sig_theme_change_id;
  int                          ping_timeout;

  Bool                         is_argb32;

  int                          desktop;

#if ENABLE_COMPOSITE
  MBWMCompMgrClient           *cm_client;
#endif
};

#define mb_wm_client_frame_west_width(c) \
         ((c)->window->geometry.x - (c)->frame_geometry.x)
#define mb_wm_client_frame_east_width(c) \
         (((c)->frame_geometry.x + (c)->frame_geometry.width) \
          - ((c)->window->geometry.x + (c)->window->geometry.width))
#define mb_wm_client_frame_east_x(c) \
          ((c)->window->geometry.x + (c)->window->geometry.width)
#define mb_wm_client_frame_north_height(c) \
         ((c)->window->geometry.y - (c)->frame_geometry.y)
#define mb_wm_client_frame_south_y(c) \
         ((c)->window->geometry.y + (c)->window->geometry.height)
#define mb_wm_client_frame_south_height(c) \
         ( ((c)->frame_geometry.y + (c)->frame_geometry.height) \
          - ((c)->window->geometry.y + (c)->window->geometry.height) )

int
mb_wm_client_class_type ();

MBWMClientWindow*
mb_wm_client_window_new (MBWindowManager *wm, Window window);

MBWindowManagerClient*
mb_wm_client_new (MBWindowManager *wm, MBWMClientWindow *win);

void
mb_wm_client_realize (MBWindowManagerClient *client);

void
mb_wm_client_stack (MBWindowManagerClient *client,
		    int                    flags);
void
mb_wm_client_show (MBWindowManagerClient *client);

void
mb_wm_client_hide (MBWindowManagerClient *client);

Bool
mb_wm_client_focus (MBWindowManagerClient *client);

Bool
mb_wm_client_want_focus (MBWindowManagerClient *client);

void
mb_wm_client_display_sync (MBWindowManagerClient *client);


Bool
mb_wm_client_is_realized (MBWindowManagerClient *client);

Bool
mb_wm_client_request_geometry (MBWindowManagerClient *client,
                               MBGeometry            *new_geometry,
                               MBWMClientReqGeomType  flags);

Bool
mb_wm_client_needs_geometry_sync (MBWindowManagerClient *client);

Bool
mb_wm_client_needs_visibility_sync (MBWindowManagerClient *client);

Bool
mb_wm_client_needs_fullscreen_sync (MBWindowManagerClient *client);

Bool
mb_wm_client_needs_decor_sync (MBWindowManagerClient *client);

Bool
mb_wm_client_needs_configure_request_ack (MBWindowManagerClient *client);

void
mb_wm_client_configure_request_ack_queue (MBWindowManagerClient *client);

Bool
mb_wm_client_needs_sync (MBWindowManagerClient *client);

Bool
mb_wm_client_is_mapped (MBWindowManagerClient *client);

void
mb_wm_client_get_coverage (MBWindowManagerClient *client,
                           MBGeometry            *coverage);

MBWMClientLayoutHints
mb_wm_client_get_layout_hints (MBWindowManagerClient *client);

void
mb_wm_client_set_layout_hints (MBWindowManagerClient *client,
                               MBWMClientLayoutHints  hints);

void
mb_wm_client_set_layout_hint (MBWindowManagerClient *client,
			      MBWMClientLayoutHints  hint,
                              Bool                   state);

void
mb_wm_client_stacking_mark_dirty (MBWindowManagerClient *client);

void
mb_wm_client_fullscreen_mark_dirty (MBWindowManagerClient *client);

void
mb_wm_client_geometry_mark_dirty (MBWindowManagerClient *client);

void
mb_wm_client_visibility_mark_dirty (MBWindowManagerClient *client);

void
mb_wm_client_decor_mark_dirty (MBWindowManagerClient *client);

void
mb_wm_client_add_transient (MBWindowManagerClient *client,
			    MBWindowManagerClient *transient);

void
mb_wm_client_remove_transient (MBWindowManagerClient *client,
			       MBWindowManagerClient *transient);

MBWMList*
mb_wm_client_get_transients (MBWindowManagerClient *client);

MBWindowManagerClient*
mb_wm_client_get_transient_for (MBWindowManagerClient *client);

const char*
mb_wm_client_get_name (MBWindowManagerClient *client);

void
mb_wm_client_deliver_delete (MBWindowManagerClient *client);

void
mb_wm_client_deliver_message (MBWindowManagerClient   *client,
			      Atom          delivery_atom,
			      unsigned long data0,
			      unsigned long data1,
			      unsigned long data2,
			      unsigned long data3,
			      unsigned long data4);

void
mb_wm_client_deliver_wm_protocol (MBWindowManagerClient *client,
				  Atom protocol);

void
mb_wm_client_shutdown (MBWindowManagerClient *client);

void
mb_wm_client_set_state (MBWindowManagerClient *client,
			MBWMAtom state,
			MBWMClientWindowStateChange state_op);

Bool
mb_wm_client_ping_in_progress (MBWindowManagerClient * client);

void
mb_wm_client_ping_stop (MBWindowManagerClient *client);

void
mb_wm_client_theme_change (MBWindowManagerClient *client);

void
mb_wm_client_detransitise (MBWindowManagerClient *client);

Bool
mb_wm_client_is_iconizing (MBWindowManagerClient *client);

void
mb_wm_client_reset_iconizing (MBWindowManagerClient *client);

void
mb_wm_client_iconize (MBWindowManagerClient *client);

int
mb_wm_client_title_height (MBWindowManagerClient *client);

Bool
mb_wm_client_is_modal (MBWindowManagerClient *client);

Bool
mb_wm_client_owns_xwindow (MBWindowManagerClient *client, Window xwin);

MBWMStackLayerType
mb_wm_client_get_stacking_layer (MBWindowManagerClient *client);

void
mb_wm_client_ping_start (MBWindowManagerClient *client);

Bool
mb_wm_client_is_argb32 (MBWindowManagerClient *client);

void
mb_wm_client_set_desktop (MBWindowManagerClient * client, int desktop);

int
mb_wm_client_get_desktop (MBWindowManagerClient * client);

void
mb_wm_client_desktop_change (MBWindowManagerClient * client, int desktop);

Bool
mb_wm_client_is_hiding_from_desktop (MBWindowManagerClient * client);

void
mb_wm_client_reset_hiding_from_desktop (MBWindowManagerClient * client);

#endif