enum MetaTabList

typedef enum {
  META_TAB_LIST_NORMAL,
  META_TAB_LIST_DOCKS,
  META_TAB_LIST_GROUP,
  META_TAB_LIST_NORMAL_ALL
} MetaTabList;

enum MetaTabShowType

typedef enum {
  META_TAB_SHOW_ICON,      /* Alt-Tab mode */
  META_TAB_SHOW_INSTANTLY  /* Alt-Esc mode */
} MetaTabShowType;

meta_XFree()

#define meta_XFree(p) do { if ((p)) XFree ((p)); } while (0)

enum MetaAtom

typedef enum {
  META_ATOM_FIRST = 0,
#define item(x) META_ATOM_##x,
#include "atomnames.h"
#undef item
} MetaAtom;

enum MetaListWindowsFlags

typedef enum {
  META_LIST_DEFAULT                   = 0,      /* normal windows */
  META_LIST_INCLUDE_OVERRIDE_REDIRECT = 1 << 0, /* normal and O-R */
} MetaListWindowsFlags;

meta_display_get_compositor_version ()

void                meta_display_get_compositor_version (MetaDisplay *display,
                                                         int *major,
                                                         int *minor);

meta_display_get_xdisplay ()

Display *           meta_display_get_xdisplay           (MetaDisplay *display);

meta_display_get_compositor ()

MetaCompositor *    meta_display_get_compositor         (MetaDisplay *display);

meta_display_get_screens ()

GSList *            meta_display_get_screens            (MetaDisplay *display);

meta_display_has_shape ()

gboolean            meta_display_has_shape              (MetaDisplay *display);

meta_display_screen_for_root ()

MetaScreen *        meta_display_screen_for_root        (MetaDisplay *display,
                                                         Window xroot);

Return the MetaScreen corresponding to a specified X root window ID.

meta_display_get_focus_window ()

MetaWindow *        meta_display_get_focus_window       (MetaDisplay *display);

Get the window that, according to events received from X server, currently has the input focus. We may have already sent a request to the X server to move the focus window elsewhere. (The expected_focus_window records where we've last set the input focus.)

meta_display_list_windows ()

GSList *            meta_display_list_windows           (MetaDisplay *display,
                                                         MetaListWindowsFlags flags);

Lists windows for the display, the flags parameter for now determines whether override-redirect windows will be included.

meta_display_xwindow_is_a_no_focus_window ()

gboolean            meta_display_xwindow_is_a_no_focus_window
                                                        (MetaDisplay *display,
                                                         Window xwindow);

meta_display_get_damage_event_base ()

int                 meta_display_get_damage_event_base  (MetaDisplay *display);

meta_display_get_shape_event_base ()

int                 meta_display_get_shape_event_base   (MetaDisplay *display);

meta_display_get_atom ()

Atom                meta_display_get_atom               (MetaDisplay *display,
                                                         MetaAtom meta_atom);

Gets up an X atom that Muffin prefetched at startup.

meta_display_xserver_time_is_before ()

gboolean            meta_display_xserver_time_is_before (MetaDisplay *display,
                                                         guint32 time1,
                                                         guint32 time2);

Xserver time can wraparound, thus comparing two timestamps needs to take this into account. If no wraparound has occurred, this is equivalent to time1 < time2 Otherwise, we need to account for the fact that wraparound can occur and the fact that a timestamp of 0 must be special-cased since it means "older than anything else".

Note that this is NOT an equivalent for time1 <= time2; if that's what you need then you'll need to swap the order of the arguments and negate the result.

meta_display_get_last_user_time ()

guint32             meta_display_get_last_user_time     (MetaDisplay *display);

meta_display_get_current_time ()

guint32             meta_display_get_current_time       (MetaDisplay *display);

meta_display_get_current_time_roundtrip ()

guint32             meta_display_get_current_time_roundtrip
                                                        (MetaDisplay *display);

meta_display_get_ignored_modifier_mask ()

unsigned int        meta_display_get_ignored_modifier_mask
                                                        (MetaDisplay *display);

meta_display_get_tab_list ()

GList *             meta_display_get_tab_list           (MetaDisplay *display,
                                                         MetaTabList type,
                                                         MetaScreen *screen,
                                                         MetaWorkspace *workspace);

Determine the list of windows that should be displayed for Alt-TAB functionality. The windows are returned in most recently used order.

meta_display_get_tab_next ()

MetaWindow *        meta_display_get_tab_next           (MetaDisplay *display,
                                                         MetaTabList type,
                                                         MetaScreen *screen,
                                                         MetaWorkspace *workspace,
                                                         MetaWindow *window,
                                                         gboolean backward);

Determine the next window that should be displayed for Alt-TAB functionality.

meta_display_get_tab_current ()

MetaWindow *        meta_display_get_tab_current        (MetaDisplay *display,
                                                         MetaTabList type,
                                                         MetaScreen *screen,
                                                         MetaWorkspace *workspace);

Determine the active window that should be displayed for Alt-TAB.

meta_display_begin_grab_op ()

gboolean            meta_display_begin_grab_op          (MetaDisplay *display,
                                                         MetaScreen *screen,
                                                         MetaWindow *window,
                                                         MetaGrabOp op,
                                                         gboolean pointer_already_grabbed,
                                                         gboolean frame_action,
                                                         int button,
                                                         gulong modmask,
                                                         guint32 timestamp,
                                                         int root_x,
                                                         int root_y);

meta_display_end_grab_op ()

void                meta_display_end_grab_op            (MetaDisplay *display,
                                                         guint32 timestamp);

meta_display_get_grab_op ()

MetaGrabOp          meta_display_get_grab_op            (MetaDisplay *display);

meta_display_add_keybinding ()

gboolean            meta_display_add_keybinding         (MetaDisplay *display,
                                                         const char *name,
                                                         const char *schema,
                                                         MetaKeyBindingFlags flags,
                                                         MetaKeyHandlerFunc handler,
                                                         gpointer user_data,
                                                         GDestroyNotify free_data);

Add a keybinding at runtime. The key name in schema needs to be of type G_VARIANT_TYPE_STRING_ARRAY, with each string describing a keybinding in the form of "<Control>a" or "<Shift><Alt>F1". The parser is fairly liberal and allows lower or upper case, and also abbreviations such as "<Ctl>" and "<Ctrl>". If the key is set to the empty list or a list with a single element of either "" or "disabled", the keybinding is disabled. If META_KEY_BINDING_REVERSES is specified in flags, the binding may be reversed by holding down the "shift" key; therefore, "<Shift>" cannot be one of the keys used. handler is expected to check for the "shift" modifier in this case and reverse its action.

Use meta_display_remove_keybinding() to remove the binding.

meta_display_remove_keybinding ()

gboolean            meta_display_remove_keybinding      (MetaDisplay *display,
                                                         const char *name);

Remove keybinding name; the function will fail if name is not a known keybinding or has not been added with meta_display_add_keybinding().

meta_display_rebuild_keybindings ()

void                meta_display_rebuild_keybindings    (MetaDisplay *display);

Rebuild all keybindings (typically done after adding, removing, or changing one or more keybindings)

meta_display_add_custom_keybinding ()

gboolean            meta_display_add_custom_keybinding  (MetaDisplay *display,
                                                         const char *name,
                                                         const char **bindings,
                                                         MetaKeyHandlerFunc callback,
                                                         gpointer user_data,
                                                         GDestroyNotify free_data);

Use meta_display_remove_custom_keybinding() to remove the binding.

meta_display_remove_custom_keybinding ()

gboolean            meta_display_remove_custom_keybinding
                                                        (MetaDisplay *display,
                                                         const char *name);

Remove keybinding name; the function will fail if name is not a known keybinding or has not been added with meta_display_add_custom_keybinding().

meta_display_get_keybinding_action ()

MetaKeyBindingAction meta_display_get_keybinding_action (MetaDisplay *display,
                                                         unsigned int keycode,
                                                         unsigned long  mask);

Get the MetaKeyBindingAction bound to keycode. Only builtin keybindings have an associated MetaKeyBindingAction, for bindings added dynamically with meta_display_add_keybinding() the function will always return META_KEYBINDING_ACTION_NONE.

meta_display_set_input_focus_window ()

void                meta_display_set_input_focus_window (MetaDisplay *display,
                                                         MetaWindow *window,
                                                         gboolean focus_frame,
                                                         guint32 timestamp);

meta_display_focus_the_no_focus_window ()

void                meta_display_focus_the_no_focus_window
                                                        (MetaDisplay *display,
                                                         MetaScreen *screen,
                                                         guint32 timestamp);

meta_display_sort_windows_by_stacking ()

GSList *            meta_display_sort_windows_by_stacking
                                                        (MetaDisplay *display,
                                                         GSList *windows);

Sorts a set of windows according to their current stacking order. If windows from multiple screens are present in the set of input windows, then all the windows on screen 0 are sorted below all the windows on screen 1, and so forth. Since the stacking order of override-redirect windows isn't controlled by Metacity, if override-redirect windows are in the input, the result may not correspond to the actual stacking order in the X server.

An example of using this would be to sort the list of transient dialogs for a window into their current stacking order.

meta_display_get_leader_window ()

Window              meta_display_get_leader_window      (MetaDisplay *display);

Returns the window manager's leader window (as defined by the _NET_SUPPORTING_WM_CHECK mechanism of EWMH). For use by plugins that wish to attach additional custom properties to this window.

meta_display_add_ignored_crossing_serial ()

void                meta_display_add_ignored_crossing_serial
                                                        (MetaDisplay *display,
                                                         unsigned long  serial);

Save the specified serial and ignore crossing events with that serial for the purpose of focus-follows-mouse. This can be used for certain changes to the window hierarchy that we don't want to change the focus window, even if they cause the pointer to end up in a new window.

meta_display_unmanage_screen ()

void                meta_display_unmanage_screen        (MetaDisplay *display,
                                                         MetaScreen *screen,
                                                         guint32 timestamp);

meta_display_keybinding_action_invoke_by_code ()

void                meta_display_keybinding_action_invoke_by_code
                                                        (MetaDisplay *display,
                                                         unsigned int keycode,
                                                         unsigned long  mask);

MetaDisplayClass

typedef struct _MetaDisplayClass MetaDisplayClass;