summaryrefslogtreecommitdiff
path: root/Source/DirectFB/include/directfb_windows.h
blob: b0135e001123c180a99853420bf09b890ee2d632 (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
/*
   (c) Copyright 2001-2009  The world wide DirectFB Open Source Community (directfb.org)
   (c) Copyright 2000-2004  Convergence (integrated media) GmbH

   All rights reserved.

   Written by Denis Oliver Kropp <dok@directfb.org>,
              Andreas Hundt <andi@fischlustig.de>,
              Sven Neumann <neo@directfb.org>,
              Ville Syrjälä <syrjala@sci.fi> and
              Claudio Ciccani <klan@users.sf.net>.

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Lesser General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.

   This library 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
   Lesser General Public License for more details.

   You should have received a copy of the GNU Lesser General Public
   License along with this library; if not, write to the
   Free Software Foundation, Inc., 59 Temple Place - Suite 330,
   Boston, MA 02111-1307, USA.
*/

#ifndef __DIRECTFB_WINDOWS_H__
#define __DIRECTFB_WINDOWS_H__

#include <directfb.h>

#ifdef __cplusplus
extern "C"
{
#endif

/*
 * The DirectFB Windows interface version.
 */
#define DIRECTFB_WINDOWS_INTERFACE_VERSION  1


/*
 * Window stack extension.
 */
DECLARE_INTERFACE( IDirectFBWindows )


typedef enum {
     DWCONF_NONE                   = 0x00000000,

     DWCONF_POSITION               = 0x00000001,
     DWCONF_SIZE                   = 0x00000002,
     DWCONF_OPACITY                = 0x00000004,
     DWCONF_STACKING               = 0x00000008,

     DWCONF_OPTIONS                = 0x00000010,
     DWCONF_EVENTS                 = 0x00000020,
     DWCONF_ASSOCIATION            = 0x00000040,

     DWCONF_COLOR_KEY              = 0x00000100,
     DWCONF_OPAQUE                 = 0x00000200,
     DWCONF_COLOR                  = 0x00000400,

     DWCONF_KEY_SELECTION          = 0x00001000,
     DWCONF_CURSOR_FLAGS           = 0x00002000,
     DWCONF_CURSOR_RESOLUTION      = 0x00004000,

     DWCONF_SRC_GEOMETRY           = 0x00010000,
     DWCONF_DST_GEOMETRY           = 0x00020000,

     DWCONF_ROTATION               = 0x00040000,

     DWCONF_ALL                    = 0x0007777F
} DFBWindowConfigFlags;

typedef struct {
     DFBRectangle                  bounds;                  /* position and size */
     int                           opacity;                 /* global alpha factor */
     DFBWindowStackingClass        stacking;                /* level boundaries */

     DFBWindowOptions              options;                 /* flags for appearance/behaviour */
     DFBWindowEventType            events;                  /* mask of enabled events */
     DFBWindowID                   association;             /* ID of window which this is associated to */

     u32                           color_key;               /* transparent pixel */
     DFBRegion                     opaque;                  /* region of the window forced to be opaque */
     DFBColor                      color;                   /* constant color (no surface needed) */

//     DFBWindowKeySelection         key_selection;           /* how to filter keys in focus */
//     DFBInputDeviceKeySymbol      *keys;                    /* list of keys for DWKS_LIST */
//     unsigned int                  num_keys;                /* number of entries in key array */

     DFBWindowCursorFlags          cursor_flags;
     DFBDimension                  cursor_resolution;

     DFBWindowGeometry             src_geometry;            /* advanced source geometry */
     DFBWindowGeometry             dst_geometry;            /* advanced destination geometry */

     int                           rotation;
} DFBWindowConfig;


typedef enum {
     DWSTATE_NONE                  = 0x00000000,

     DWSTATE_INSERTED              = 0x00000001,

     DWSTATE_FOCUSED               = 0x00000002,            /* only used for GetWindowInfo */
     DWSTATE_ENTERED               = 0x00000004,            /* only used for GetWindowInfo */

     DWSTATE_UPDATING              = 0x00000010,

     DWSTATE_ALL                   = 0x00000017
} DFBWindowStateFlags;

typedef struct {
     DFBWindowStateFlags           flags;
} DFBWindowState;


typedef struct {
     DFBWindowID                   window_id;
     DFBWindowCapabilities         caps;

     u64                           resource_id;


     DFBWindowConfig               config;

     DFBWindowState                state;
} DFBWindowInfo;


typedef enum {
     DWREL_TOP,
     DWREL_BOTTOM
} DFBWindowRelation;


/*
 * Windows watcher interface
 */
typedef struct {
     /*
      * Add window,
      *
      * called for each window existing at watcher registration and each added afterwards.
      */
     void (*WindowAdd)     ( void                   *context,
                             const DFBWindowInfo    *info );

     /*
      * Remove window,
      *
      * called for each window being removed.
      */
     void (*WindowRemove)  ( void                   *context,
                             DFBWindowID             window_id );

     /*
      * Change window configuration,
      *
      * called for each window changing its configuration.
      *
      * The flags specify which of the items have changed actually.
      */
     void (*WindowConfig)  ( void                   *context,
                             DFBWindowID             window_id,
                             const DFBWindowConfig  *config,
                             DFBWindowConfigFlags    flags );

     /*
      * Update window state,
      *
      * called for each window changing its state.
      *
      * In case of insertion of a window, prior to this, the watcher will receive the WindowRestack call,
      * which contains the z-position at which the window has been inserted.
      */
     void (*WindowState)   ( void                   *context,
                             DFBWindowID             window_id,
                             const DFBWindowState   *state );

     /*
      * Update window z-position,
      *
      * called for each window changing its z-position.
      *
      * In case of insertion of a window, after this call, the watcher will receive the WindowState call,
      * which indicates insertion of the window.
      *
      * Upon reinsertion, only this call will be received.
      */
     void (*WindowRestack) ( void                   *context,
                             DFBWindowID             window_id,
                             unsigned int            index );

     /*
      * Switch window focus,
      *
      * called for each window getting the focus.
      */
     void (*WindowFocus)   ( void                   *context,
                             DFBWindowID             window_id );
} DFBWindowsWatcher;


/********************
 * IDirectFBWindows *
 ********************/

/*
 * <i>No summary yet...</i>
 */
DEFINE_INTERFACE(   IDirectFBWindows,

   /** Watching **/

     /*
      * Registers a new windows watcher.
      *
      * For any window already existing, the WindowAdded callback will be called immediately.
      */
     DFBResult (*RegisterWatcher) (
          IDirectFBWindows         *thiz,
          const DFBWindowsWatcher  *watcher,
          void                     *context
     );
)


#ifdef __cplusplus
}
#endif

#endif