Mir
surface_event.h
Go to the documentation of this file.
1 /*
2  * Copyright © 2014 Canonical Ltd.
3  *
4  * This program is free software: you can redistribute it and/or modify it
5  * under the terms of the GNU Lesser General Public License version 2 or 3,
6  * as published by the Free Software Foundation.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU Lesser General Public License for more details.
12  *
13  * You should have received a copy of the GNU Lesser General Public License
14  * along with this program. If not, see <http://www.gnu.org/licenses/>.
15  *
16  * Authored by: Robert Carr <robert.carr@canonical.com>
17  */
18 
19 #ifndef MIR_TOOLKIT_EVENTS_SURFACE_EVENT_H_
20 #define MIR_TOOLKIT_EVENTS_SURFACE_EVENT_H_
21 
24 
25 #ifdef __cplusplus
26 
30 extern "C" {
31 #endif
32 
33 // Ignore use of deprecate MirSurfaceEvent typedef in deprecated functions (for now)
34 #pragma GCC diagnostic push
35 #pragma GCC diagnostic ignored "-Wdeprecated-declarations"
36 
42 MirSurfaceAttrib mir_surface_event_get_attribute(MirSurfaceEvent const* event)
43 MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_event_get_attribute instead");
44 
51 int mir_surface_event_get_attribute_value(MirSurfaceEvent const* event)
52 MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_event_get_attribute_value with MirWindowEvent instead");
53 #pragma GCC diagnostic pop
54 
55 #ifdef __cplusplus
56 }
58 #endif
59 
60 #endif /* MIR_TOOLKIT_SURFACE_EVENT_H_ */
mir_surface_event_get_attribute_value
int mir_surface_event_get_attribute_value(MirSurfaceEvent const *event) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_event_get_attribute_value with MirWindowEvent instead")
Retrieve the new value of the associated attribute for a given MirSurfaceEvent.
event.h
MIR_FOR_REMOVAL_IN_VERSION_1
#define MIR_FOR_REMOVAL_IN_VERSION_1(message)
Definition: deprecations.h:30
deprecations.h
MirSurfaceAttrib
MirSurfaceAttrib
Attributes of a surface that the client and server/shell may wish to get or set over the wire.
Definition: common.h:55
mir_surface_event_get_attribute
MirSurfaceAttrib mir_surface_event_get_attribute(MirSurfaceEvent const *event) MIR_FOR_REMOVAL_IN_VERSION_1("use mir_window_event_get_attribute instead")
Retrieve the attribute index configured with a given MirSurfaceEvent.

Copyright © 2012-2024 Canonical Ltd.
Generated on Tue May 7 06:11:54 UTC 2024
This documentation is licensed under the GPL version 2 or 3.