]> icculus.org git repositories - dana/openbox.git/blob - engines/engineinterface.h
add descriptive names and long descriptions to config var def'ns. set these for the...
[dana/openbox.git] / engines / engineinterface.h
1 #ifndef __engineinterface_h
2 #define __engineinterface_h
3
4 #include "../kernel/frame.h"
5 #include <glib.h>
6
7 /* startup */
8 typedef gboolean EngineStartup();
9
10 /* shutdown */
11 typedef void EngineShutdown();
12
13 /* frame_new */
14 typedef Frame *EngineFrameNew();
15
16 /* frame_grab_client */
17 typedef void EngineFrameGrabClient(Frame *self, Client *client);
18 /* frame_release_client */
19 typedef void EngineFrameReleaseClient(Frame *self, Client *client);
20
21 /* frame_adjust_area */
22 /*! Update the frame's size/position to match the client */
23 typedef void EngineFrameAdjustArea(Frame *self);
24 /* frame_adjust_shape */
25 /*! Shape the frame window to the client window */
26 typedef void EngineFrameAdjustShape(Frame *self);
27 /* frame_adjust_state */
28 /*! Update the frame to match the client's new state (for things like toggle
29   buttons, focus, and the title) XXX break this up */
30 typedef void EngineFrameAdjustState(Frame *self);
31 /* frame_adjust_focus */
32 /*! Update the frame to match the client's focused state */
33 typedef void EngineFrameAdjustFocus(Frame *self);
34 /* frame_adjust_title */
35 /*! Update the frame to display the client's current title */
36 typedef void EngineFrameAdjustTitle(Frame *self);
37 /* frame_adjust_icon */
38 /*! Update the frame to display the client's current icon */
39 typedef void EngineFrameAdjustIcon(Frame *self);
40
41 /* frame_show */
42 /*! Shows the frame */
43 typedef void EngineFrameShow(Frame *self);
44 /*! Hides the frame */
45 typedef void EngineFrameHide(Frame *self);
46
47 /* get_context */
48 typedef GQuark EngineGetContext(Client *client, Window win);
49
50 #endif