2006-10-01 18:30:10 -04:00
|
|
|
/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
|
|
|
|
|
|
2008-05-18 20:00:09 -04:00
|
|
|
/*
|
|
|
|
|
* Copyright (C) 2008 Iain Holmes
|
|
|
|
|
*
|
2003-11-15 23:35:16 -05:00
|
|
|
* 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 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.
|
2008-05-18 20:00:09 -04:00
|
|
|
*
|
2003-11-15 23:35:16 -05:00
|
|
|
* You should have received a copy of the GNU General Public License
|
2014-01-11 20:42:06 -05:00
|
|
|
* along with this program; if not, see <http://www.gnu.org/licenses/>.
|
2003-11-15 23:35:16 -05:00
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
#ifndef META_COMPOSITOR_H
|
|
|
|
|
#define META_COMPOSITOR_H
|
|
|
|
|
|
2008-05-18 20:00:09 -04:00
|
|
|
#include <glib.h>
|
|
|
|
|
|
2011-03-05 19:29:12 -05:00
|
|
|
#include <meta/types.h>
|
|
|
|
|
#include <meta/boxes.h>
|
|
|
|
|
#include <meta/window.h>
|
|
|
|
|
#include <meta/workspace.h>
|
2008-09-18 11:09:11 -04:00
|
|
|
|
2019-01-11 11:18:27 -05:00
|
|
|
#define META_TYPE_COMPOSITOR (meta_compositor_get_type ())
|
|
|
|
|
META_EXPORT
|
2019-08-14 13:04:41 -04:00
|
|
|
G_DECLARE_DERIVABLE_TYPE (MetaCompositor, meta_compositor,
|
|
|
|
|
META, COMPOSITOR, GObject)
|
2019-01-11 11:18:27 -05:00
|
|
|
|
Simplify relationship between mapping and visibility
Previously, changes to the visibility of a window could be indicated
by meta_compositor_map_window(), meta_compositor_unminimize_window(),
meta_compositor_set_window_hidden(), etc, with the exact behavior
depending on the 'live_hidden_windows' preference.
Simplify this so that visibility is controlled by:
meta_compositor_show_window()
meta_compositor_hide_window()
With an 'effect' parameter provided to indicate the appropriate
effect (CREATE/UNMINIMIZE/MINIMIZE/DESTROY/NONE.)
The map state of the window is signalled separately by:
meta_compositor_map_window()
meta_compositor_unmap_window()
And is used only to control resource handling.
Other changes:
* The desired effect on show/hide is explicitly stored in
MetaWindow, avoiding the need for the was_minimized flag.
At idle, once we calculate the window state, we pass the
effect to the compositor if it matches the new window
state, and then clear the effect to start over for future
map state changes.
* meta_compositor_switch_workspace() is called before any windows
are hidden or shown, allowing the compositor to avoid hiding
or showing an effect for windows involved in the switch.
http://bugzilla.gnome.org/show_bug.cgi?id=582341
* Handling of post-effect cleanups for MutterWindow are
simplified - instead of trying to do different things based
on the individual needs of different effects, we just wait until
all effects complete and sync the window state to what it
should be.
* On unmap, once we destroy the pixmap, we tell ClutterX11Pixmap
that we've done so, so it can clean up and unbind. (The
unbinding doesn't seem to be working properly because of
ClutterGLXPixmap or video driver issues.)
http://bugzilla.gnome.org/show_bug.cgi?id=587251
2009-06-28 17:10:40 -04:00
|
|
|
/**
|
|
|
|
|
* MetaCompEffect:
|
|
|
|
|
* @META_COMP_EFFECT_CREATE: The window is newly created
|
|
|
|
|
* (also used for a window that was previously on a different
|
|
|
|
|
* workspace and is changed to become visible on the active
|
|
|
|
|
* workspace.)
|
|
|
|
|
* @META_COMP_EFFECT_UNMINIMIZE: The window should be shown
|
|
|
|
|
* as unminimizing from its icon geometry.
|
|
|
|
|
* @META_COMP_EFFECT_DESTROY: The window is being destroyed
|
|
|
|
|
* @META_COMP_EFFECT_MINIMIZE: The window should be shown
|
|
|
|
|
* as minimizing to its icon geometry.
|
|
|
|
|
* @META_COMP_EFFECT_NONE: No effect, the window should be
|
|
|
|
|
* shown or hidden immediately.
|
|
|
|
|
*
|
|
|
|
|
* Indicates the appropriate effect to show the user for
|
|
|
|
|
* meta_compositor_show_window() and meta_compositor_hide_window()
|
|
|
|
|
*/
|
|
|
|
|
typedef enum
|
|
|
|
|
{
|
|
|
|
|
META_COMP_EFFECT_CREATE,
|
|
|
|
|
META_COMP_EFFECT_UNMINIMIZE,
|
|
|
|
|
META_COMP_EFFECT_DESTROY,
|
|
|
|
|
META_COMP_EFFECT_MINIMIZE,
|
|
|
|
|
META_COMP_EFFECT_NONE
|
|
|
|
|
} MetaCompEffect;
|
|
|
|
|
|
2018-12-19 03:04:25 -05:00
|
|
|
typedef enum
|
|
|
|
|
{
|
2015-07-06 00:08:08 -04:00
|
|
|
META_SIZE_CHANGE_MAXIMIZE,
|
|
|
|
|
META_SIZE_CHANGE_UNMAXIMIZE,
|
2013-09-01 16:04:19 -04:00
|
|
|
META_SIZE_CHANGE_FULLSCREEN,
|
|
|
|
|
META_SIZE_CHANGE_UNFULLSCREEN,
|
2015-07-06 00:08:08 -04:00
|
|
|
} MetaSizeChange;
|
|
|
|
|
|
2019-01-22 21:25:35 -05:00
|
|
|
META_EXPORT
|
2009-06-27 11:01:58 -04:00
|
|
|
void meta_compositor_destroy (MetaCompositor *compositor);
|
2008-05-18 20:00:09 -04:00
|
|
|
|
2019-01-22 21:25:35 -05:00
|
|
|
META_EXPORT
|
2014-03-18 17:31:22 -04:00
|
|
|
void meta_compositor_manage (MetaCompositor *compositor);
|
2019-01-22 21:25:35 -05:00
|
|
|
|
|
|
|
|
META_EXPORT
|
2014-03-18 17:31:22 -04:00
|
|
|
void meta_compositor_unmanage (MetaCompositor *compositor);
|
2003-11-15 23:35:16 -05:00
|
|
|
|
2019-01-22 21:25:35 -05:00
|
|
|
META_EXPORT
|
2014-02-26 20:45:38 -05:00
|
|
|
void meta_compositor_window_shape_changed (MetaCompositor *compositor,
|
2013-08-23 22:20:49 -04:00
|
|
|
MetaWindow *window);
|
2019-01-22 21:25:35 -05:00
|
|
|
|
|
|
|
|
META_EXPORT
|
2013-12-06 13:44:31 -05:00
|
|
|
void meta_compositor_window_opacity_changed (MetaCompositor *compositor,
|
|
|
|
|
MetaWindow *window);
|
2019-01-22 21:25:35 -05:00
|
|
|
|
|
|
|
|
META_EXPORT
|
2012-08-09 20:27:18 -04:00
|
|
|
gboolean meta_compositor_filter_keybinding (MetaCompositor *compositor,
|
|
|
|
|
MetaKeyBinding *binding);
|
|
|
|
|
|
2019-01-22 21:25:35 -05:00
|
|
|
META_EXPORT
|
Always map the client and frame windows
Traditionally, WMs unmap windows when minimizing them, and map them
when restoring them or wanting to show them for other reasons, like
upon creation.
However, as metacity morphed into mutter, we optionally chose to keep
windows mapped for the lifetime of the window under the user option
"live-window-previews", which makes the code keep windows mapped so it
can show window preview for minimized windows in other places, like
Alt-Tab and Expose.
I removed this preference two years ago mechanically, by removing all
the if statements, but never went through and cleaned up the code so
that windows are simply mapped for the lifetime of the window -- the
"architecture" of the old code that maps and unmaps on show/hide was
still there.
Remove this now.
The one case we still need to be careful of is shaded windows, in which
we do still unmap the client window. In the future, we might want to
show previews of shaded windows in the overview and Alt-Tab. In that
we'd also keep shaded windows mapped, and could remove all unmap logic,
but we'd need a more complex method of showing the shaded titlebar, such
as using a different actor.
At the same time, simplify the compositor interface by removing
meta_compositor_window_[un]mapped API, and instead adding/removing the
window on-demand.
https://bugzilla.gnome.org/show_bug.cgi?id=720631
2014-02-01 19:06:51 -05:00
|
|
|
void meta_compositor_add_window (MetaCompositor *compositor,
|
|
|
|
|
MetaWindow *window);
|
2019-01-22 21:25:35 -05:00
|
|
|
|
|
|
|
|
META_EXPORT
|
Always map the client and frame windows
Traditionally, WMs unmap windows when minimizing them, and map them
when restoring them or wanting to show them for other reasons, like
upon creation.
However, as metacity morphed into mutter, we optionally chose to keep
windows mapped for the lifetime of the window under the user option
"live-window-previews", which makes the code keep windows mapped so it
can show window preview for minimized windows in other places, like
Alt-Tab and Expose.
I removed this preference two years ago mechanically, by removing all
the if statements, but never went through and cleaned up the code so
that windows are simply mapped for the lifetime of the window -- the
"architecture" of the old code that maps and unmaps on show/hide was
still there.
Remove this now.
The one case we still need to be careful of is shaded windows, in which
we do still unmap the client window. In the future, we might want to
show previews of shaded windows in the overview and Alt-Tab. In that
we'd also keep shaded windows mapped, and could remove all unmap logic,
but we'd need a more complex method of showing the shaded titlebar, such
as using a different actor.
At the same time, simplify the compositor interface by removing
meta_compositor_window_[un]mapped API, and instead adding/removing the
window on-demand.
https://bugzilla.gnome.org/show_bug.cgi?id=720631
2014-02-01 19:06:51 -05:00
|
|
|
void meta_compositor_remove_window (MetaCompositor *compositor,
|
|
|
|
|
MetaWindow *window);
|
2019-01-22 21:25:35 -05:00
|
|
|
|
|
|
|
|
META_EXPORT
|
Simplify relationship between mapping and visibility
Previously, changes to the visibility of a window could be indicated
by meta_compositor_map_window(), meta_compositor_unminimize_window(),
meta_compositor_set_window_hidden(), etc, with the exact behavior
depending on the 'live_hidden_windows' preference.
Simplify this so that visibility is controlled by:
meta_compositor_show_window()
meta_compositor_hide_window()
With an 'effect' parameter provided to indicate the appropriate
effect (CREATE/UNMINIMIZE/MINIMIZE/DESTROY/NONE.)
The map state of the window is signalled separately by:
meta_compositor_map_window()
meta_compositor_unmap_window()
And is used only to control resource handling.
Other changes:
* The desired effect on show/hide is explicitly stored in
MetaWindow, avoiding the need for the was_minimized flag.
At idle, once we calculate the window state, we pass the
effect to the compositor if it matches the new window
state, and then clear the effect to start over for future
map state changes.
* meta_compositor_switch_workspace() is called before any windows
are hidden or shown, allowing the compositor to avoid hiding
or showing an effect for windows involved in the switch.
http://bugzilla.gnome.org/show_bug.cgi?id=582341
* Handling of post-effect cleanups for MutterWindow are
simplified - instead of trying to do different things based
on the individual needs of different effects, we just wait until
all effects complete and sync the window state to what it
should be.
* On unmap, once we destroy the pixmap, we tell ClutterX11Pixmap
that we've done so, so it can clean up and unbind. (The
unbinding doesn't seem to be working properly because of
ClutterGLXPixmap or video driver issues.)
http://bugzilla.gnome.org/show_bug.cgi?id=587251
2009-06-28 17:10:40 -04:00
|
|
|
void meta_compositor_show_window (MetaCompositor *compositor,
|
2009-06-27 11:01:58 -04:00
|
|
|
MetaWindow *window,
|
Simplify relationship between mapping and visibility
Previously, changes to the visibility of a window could be indicated
by meta_compositor_map_window(), meta_compositor_unminimize_window(),
meta_compositor_set_window_hidden(), etc, with the exact behavior
depending on the 'live_hidden_windows' preference.
Simplify this so that visibility is controlled by:
meta_compositor_show_window()
meta_compositor_hide_window()
With an 'effect' parameter provided to indicate the appropriate
effect (CREATE/UNMINIMIZE/MINIMIZE/DESTROY/NONE.)
The map state of the window is signalled separately by:
meta_compositor_map_window()
meta_compositor_unmap_window()
And is used only to control resource handling.
Other changes:
* The desired effect on show/hide is explicitly stored in
MetaWindow, avoiding the need for the was_minimized flag.
At idle, once we calculate the window state, we pass the
effect to the compositor if it matches the new window
state, and then clear the effect to start over for future
map state changes.
* meta_compositor_switch_workspace() is called before any windows
are hidden or shown, allowing the compositor to avoid hiding
or showing an effect for windows involved in the switch.
http://bugzilla.gnome.org/show_bug.cgi?id=582341
* Handling of post-effect cleanups for MutterWindow are
simplified - instead of trying to do different things based
on the individual needs of different effects, we just wait until
all effects complete and sync the window state to what it
should be.
* On unmap, once we destroy the pixmap, we tell ClutterX11Pixmap
that we've done so, so it can clean up and unbind. (The
unbinding doesn't seem to be working properly because of
ClutterGLXPixmap or video driver issues.)
http://bugzilla.gnome.org/show_bug.cgi?id=587251
2009-06-28 17:10:40 -04:00
|
|
|
MetaCompEffect effect);
|
2019-01-22 21:25:35 -05:00
|
|
|
|
|
|
|
|
META_EXPORT
|
Simplify relationship between mapping and visibility
Previously, changes to the visibility of a window could be indicated
by meta_compositor_map_window(), meta_compositor_unminimize_window(),
meta_compositor_set_window_hidden(), etc, with the exact behavior
depending on the 'live_hidden_windows' preference.
Simplify this so that visibility is controlled by:
meta_compositor_show_window()
meta_compositor_hide_window()
With an 'effect' parameter provided to indicate the appropriate
effect (CREATE/UNMINIMIZE/MINIMIZE/DESTROY/NONE.)
The map state of the window is signalled separately by:
meta_compositor_map_window()
meta_compositor_unmap_window()
And is used only to control resource handling.
Other changes:
* The desired effect on show/hide is explicitly stored in
MetaWindow, avoiding the need for the was_minimized flag.
At idle, once we calculate the window state, we pass the
effect to the compositor if it matches the new window
state, and then clear the effect to start over for future
map state changes.
* meta_compositor_switch_workspace() is called before any windows
are hidden or shown, allowing the compositor to avoid hiding
or showing an effect for windows involved in the switch.
http://bugzilla.gnome.org/show_bug.cgi?id=582341
* Handling of post-effect cleanups for MutterWindow are
simplified - instead of trying to do different things based
on the individual needs of different effects, we just wait until
all effects complete and sync the window state to what it
should be.
* On unmap, once we destroy the pixmap, we tell ClutterX11Pixmap
that we've done so, so it can clean up and unbind. (The
unbinding doesn't seem to be working properly because of
ClutterGLXPixmap or video driver issues.)
http://bugzilla.gnome.org/show_bug.cgi?id=587251
2009-06-28 17:10:40 -04:00
|
|
|
void meta_compositor_hide_window (MetaCompositor *compositor,
|
2009-06-27 11:01:58 -04:00
|
|
|
MetaWindow *window,
|
Simplify relationship between mapping and visibility
Previously, changes to the visibility of a window could be indicated
by meta_compositor_map_window(), meta_compositor_unminimize_window(),
meta_compositor_set_window_hidden(), etc, with the exact behavior
depending on the 'live_hidden_windows' preference.
Simplify this so that visibility is controlled by:
meta_compositor_show_window()
meta_compositor_hide_window()
With an 'effect' parameter provided to indicate the appropriate
effect (CREATE/UNMINIMIZE/MINIMIZE/DESTROY/NONE.)
The map state of the window is signalled separately by:
meta_compositor_map_window()
meta_compositor_unmap_window()
And is used only to control resource handling.
Other changes:
* The desired effect on show/hide is explicitly stored in
MetaWindow, avoiding the need for the was_minimized flag.
At idle, once we calculate the window state, we pass the
effect to the compositor if it matches the new window
state, and then clear the effect to start over for future
map state changes.
* meta_compositor_switch_workspace() is called before any windows
are hidden or shown, allowing the compositor to avoid hiding
or showing an effect for windows involved in the switch.
http://bugzilla.gnome.org/show_bug.cgi?id=582341
* Handling of post-effect cleanups for MutterWindow are
simplified - instead of trying to do different things based
on the individual needs of different effects, we just wait until
all effects complete and sync the window state to what it
should be.
* On unmap, once we destroy the pixmap, we tell ClutterX11Pixmap
that we've done so, so it can clean up and unbind. (The
unbinding doesn't seem to be working properly because of
ClutterGLXPixmap or video driver issues.)
http://bugzilla.gnome.org/show_bug.cgi?id=587251
2009-06-28 17:10:40 -04:00
|
|
|
MetaCompEffect effect);
|
2019-01-22 21:25:35 -05:00
|
|
|
|
|
|
|
|
META_EXPORT
|
Simplify relationship between mapping and visibility
Previously, changes to the visibility of a window could be indicated
by meta_compositor_map_window(), meta_compositor_unminimize_window(),
meta_compositor_set_window_hidden(), etc, with the exact behavior
depending on the 'live_hidden_windows' preference.
Simplify this so that visibility is controlled by:
meta_compositor_show_window()
meta_compositor_hide_window()
With an 'effect' parameter provided to indicate the appropriate
effect (CREATE/UNMINIMIZE/MINIMIZE/DESTROY/NONE.)
The map state of the window is signalled separately by:
meta_compositor_map_window()
meta_compositor_unmap_window()
And is used only to control resource handling.
Other changes:
* The desired effect on show/hide is explicitly stored in
MetaWindow, avoiding the need for the was_minimized flag.
At idle, once we calculate the window state, we pass the
effect to the compositor if it matches the new window
state, and then clear the effect to start over for future
map state changes.
* meta_compositor_switch_workspace() is called before any windows
are hidden or shown, allowing the compositor to avoid hiding
or showing an effect for windows involved in the switch.
http://bugzilla.gnome.org/show_bug.cgi?id=582341
* Handling of post-effect cleanups for MutterWindow are
simplified - instead of trying to do different things based
on the individual needs of different effects, we just wait until
all effects complete and sync the window state to what it
should be.
* On unmap, once we destroy the pixmap, we tell ClutterX11Pixmap
that we've done so, so it can clean up and unbind. (The
unbinding doesn't seem to be working properly because of
ClutterGLXPixmap or video driver issues.)
http://bugzilla.gnome.org/show_bug.cgi?id=587251
2009-06-28 17:10:40 -04:00
|
|
|
void meta_compositor_switch_workspace (MetaCompositor *compositor,
|
|
|
|
|
MetaWorkspace *from,
|
|
|
|
|
MetaWorkspace *to,
|
|
|
|
|
MetaMotionDirection direction);
|
|
|
|
|
|
2019-01-22 21:25:35 -05:00
|
|
|
META_EXPORT
|
2015-07-06 00:08:08 -04:00
|
|
|
void meta_compositor_size_change_window (MetaCompositor *compositor,
|
|
|
|
|
MetaWindow *window,
|
|
|
|
|
MetaSizeChange which_change,
|
|
|
|
|
MetaRectangle *old_frame_rect,
|
|
|
|
|
MetaRectangle *old_buffer_rect);
|
2009-06-27 11:01:58 -04:00
|
|
|
|
2019-01-22 21:25:35 -05:00
|
|
|
META_EXPORT
|
2009-06-27 11:01:58 -04:00
|
|
|
void meta_compositor_sync_window_geometry (MetaCompositor *compositor,
|
2013-02-15 21:27:00 -05:00
|
|
|
MetaWindow *window,
|
|
|
|
|
gboolean did_placement);
|
2019-01-22 21:25:35 -05:00
|
|
|
|
|
|
|
|
META_EXPORT
|
2014-06-17 13:06:10 -04:00
|
|
|
void meta_compositor_sync_updates_frozen (MetaCompositor *compositor,
|
|
|
|
|
MetaWindow *window);
|
2019-01-22 21:25:35 -05:00
|
|
|
|
|
|
|
|
META_EXPORT
|
2013-02-14 13:40:55 -05:00
|
|
|
void meta_compositor_queue_frame_drawn (MetaCompositor *compositor,
|
|
|
|
|
MetaWindow *window,
|
|
|
|
|
gboolean no_delay_frame);
|
2009-06-27 11:01:58 -04:00
|
|
|
|
2019-01-22 21:25:35 -05:00
|
|
|
META_EXPORT
|
2009-06-27 11:01:58 -04:00
|
|
|
void meta_compositor_sync_stack (MetaCompositor *compositor,
|
|
|
|
|
GList *stack);
|
|
|
|
|
|
2019-01-22 21:25:35 -05:00
|
|
|
META_EXPORT
|
2017-08-26 15:43:17 -04:00
|
|
|
void meta_compositor_flash_display (MetaCompositor *compositor,
|
|
|
|
|
MetaDisplay *display);
|
2011-03-18 09:36:28 -04:00
|
|
|
|
2019-01-22 21:25:35 -05:00
|
|
|
META_EXPORT
|
2012-03-24 06:29:39 -04:00
|
|
|
void meta_compositor_show_tile_preview (MetaCompositor *compositor,
|
|
|
|
|
MetaWindow *window,
|
|
|
|
|
MetaRectangle *tile_rect,
|
|
|
|
|
int tile_monitor_number);
|
2019-01-22 21:25:35 -05:00
|
|
|
|
|
|
|
|
META_EXPORT
|
2014-03-18 17:31:22 -04:00
|
|
|
void meta_compositor_hide_tile_preview (MetaCompositor *compositor);
|
2019-01-22 21:25:35 -05:00
|
|
|
|
|
|
|
|
META_EXPORT
|
2014-05-23 17:14:51 -04:00
|
|
|
void meta_compositor_show_window_menu (MetaCompositor *compositor,
|
|
|
|
|
MetaWindow *window,
|
|
|
|
|
MetaWindowMenuType menu,
|
|
|
|
|
int x,
|
|
|
|
|
int y);
|
2019-01-22 21:25:35 -05:00
|
|
|
|
|
|
|
|
META_EXPORT
|
2014-05-30 18:52:06 -04:00
|
|
|
void meta_compositor_show_window_menu_for_rect (MetaCompositor *compositor,
|
|
|
|
|
MetaWindow *window,
|
|
|
|
|
MetaWindowMenuType menu,
|
|
|
|
|
MetaRectangle *rect);
|
2012-03-24 06:29:39 -04:00
|
|
|
|
2009-06-27 11:01:58 -04:00
|
|
|
#endif /* META_COMPOSITOR_H */
|