Mir
Main Page
Related Pages
Modules
Namespaces
Classes
Files
Examples
File List
File Members
include
common
mir_toolkit
common.h
Go to the documentation of this file.
1
/*
2
* Simple definitions common to client and server.
3
*
4
* Copyright © 2013-2014 Canonical Ltd.
5
*
6
* This program is free software: you can redistribute it and/or modify
7
* it under the terms of the GNU Lesser General Public License version 3 as
8
* published by the Free Software Foundation.
9
*
10
* This program is distributed in the hope that it will be useful,
11
* but WITHOUT ANY WARRANTY; without even the implied warranty of
12
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
* GNU Lesser General Public License for more details.
14
*
15
* You should have received a copy of the GNU Lesser General Public License
16
* along with this program. If not, see <http://www.gnu.org/licenses/>.
17
*
18
* Author: Daniel van Vugt <daniel.van.vugt@canonical.com>
19
*/
20
21
#ifndef MIR_COMMON_H_
22
#define MIR_COMMON_H_
23
24
#include <
mir_toolkit/cursors.h
>
25
30
/* This is C code. Not C++. */
31
36
typedef
enum
MirSurfaceAttrib
37
{
38
/* Do not specify values...code relies on 0...N ordering. */
39
mir_surface_attrib_type
,
40
mir_surface_attrib_state
,
41
mir_surface_attrib_swapinterval
,
42
mir_surface_attrib_focus
,
43
mir_surface_attrib_dpi
,
44
mir_surface_attrib_visibility
,
45
mir_surface_attrib_preferred_orientation
,
46
/* Must be last */
47
mir_surface_attribs
48
}
MirSurfaceAttrib
;
49
50
typedef
enum
MirSurfaceType
51
{
52
mir_surface_type_normal
,
53
mir_surface_type_utility
,
54
mir_surface_type_dialog
,
55
mir_surface_type_overlay
,
56
mir_surface_type_gloss
=
mir_surface_type_overlay
,
57
mir_surface_type_freestyle
,
58
mir_surface_type_popover
,
59
mir_surface_type_menu
=
mir_surface_type_popover
,
60
mir_surface_type_inputmethod
,
61
mir_surface_type_satellite
,
62
mir_surface_type_tip
,
63
mir_surface_types
64
}
MirSurfaceType
;
65
66
typedef
enum
MirSurfaceState
67
{
68
mir_surface_state_unknown
,
69
mir_surface_state_restored
,
70
mir_surface_state_minimized
,
71
mir_surface_state_maximized
,
72
mir_surface_state_vertmaximized
,
73
/* mir_surface_state_semimaximized,
74
Omitted for now, since it's functionally a subset of vertmaximized and
75
differs only in the X coordinate. */
76
mir_surface_state_fullscreen
,
77
mir_surface_state_horizmaximized
,
78
mir_surface_state_hidden
,
79
mir_surface_states
80
}
MirSurfaceState
;
81
82
/* TODO: MirSurfaceFocusState MirSurfaceVisibility and MirLifecycleState use an inconsistent
83
naming convention. */
84
typedef
enum
MirSurfaceFocusState
85
{
86
mir_surface_unfocused
= 0,
87
mir_surface_focused
88
}
MirSurfaceFocusState
;
89
90
typedef
enum
MirSurfaceVisibility
91
{
92
mir_surface_visibility_occluded
= 0,
93
mir_surface_visibility_exposed
94
}
MirSurfaceVisibility
;
95
96
typedef
enum
MirLifecycleState
97
{
98
mir_lifecycle_state_will_suspend
,
99
mir_lifecycle_state_resumed
,
100
mir_lifecycle_connection_lost
101
}
MirLifecycleState
;
102
103
typedef
enum
MirPowerMode
104
{
105
mir_power_mode_on
,
/* Display in use. */
106
mir_power_mode_standby
,
/* Blanked, low power. */
107
mir_power_mode_suspend
,
/* Blanked, lowest power. */
108
mir_power_mode_off
/* Powered down. */
109
}
MirPowerMode
;
110
111
typedef
enum
MirPromptSessionState
112
{
113
mir_prompt_session_state_stopped
= 0,
114
mir_prompt_session_state_started
,
115
mir_prompt_session_state_suspended
116
}
MirPromptSessionState
;
117
127
typedef
enum
MirPixelFormat
128
{
129
mir_pixel_format_invalid
,
130
mir_pixel_format_abgr_8888
,
131
mir_pixel_format_xbgr_8888
,
132
mir_pixel_format_argb_8888
,
133
mir_pixel_format_xrgb_8888
,
134
mir_pixel_format_bgr_888
,
135
mir_pixel_formats
136
}
MirPixelFormat
;
137
138
/* This could be improved... https://bugs.launchpad.net/mir/+bug/1236254 */
139
#define MIR_BYTES_PER_PIXEL(f) (((f) == mir_pixel_format_bgr_888) ? 3 : 4)
140
142
typedef
enum
MirOrientation
143
{
144
mir_orientation_normal
= 0,
145
mir_orientation_left
= 90,
146
mir_orientation_inverted
= 180,
147
mir_orientation_right
= 270
148
}
MirOrientation
;
149
150
typedef
enum
MirOrientationMode
151
{
152
mir_orientation_mode_portrait
= 1 << 0,
153
mir_orientation_mode_landscape
= 1 << 1,
154
mir_orientation_mode_portrait_inverted
= 1 << 2,
155
mir_orientation_mode_landscape_inverted
= 1 << 3,
156
mir_orientation_mode_portrait_any
=
mir_orientation_mode_portrait
|
157
mir_orientation_mode_portrait_inverted
,
158
mir_orientation_mode_landscape_any
=
mir_orientation_mode_landscape
|
159
mir_orientation_mode_landscape_inverted
,
160
mir_orientation_mode_any
=
mir_orientation_mode_portrait_any
|
161
mir_orientation_mode_landscape_any
162
}
MirOrientationMode
;
163
164
typedef
enum
MirEdgeAttachment
165
{
166
mir_edge_attachment_vertical
= 1 << 0,
167
mir_edge_attachment_horizontal
= 1 << 1,
168
mir_edge_attachment_any
=
mir_edge_attachment_vertical
|
169
mir_edge_attachment_horizontal
170
}
MirEdgeAttachment
;
173
#endif
cursors.h
mir_surface_type_inputmethod
AKA "OSK" or handwriting etc.
Definition:
common.h:60
mir_surface_attrib_state
Definition:
common.h:40
mir_surface_type_freestyle
Definition:
common.h:57
mir_surface_visibility_occluded
Definition:
common.h:92
mir_orientation_mode_portrait_inverted
Definition:
common.h:154
mir_surface_state_maximized
Definition:
common.h:71
mir_surface_attribs
Definition:
common.h:47
mir_surface_attrib_visibility
Definition:
common.h:44
MirPromptSessionState
MirPromptSessionState
Definition:
common.h:111
mir_prompt_session_state_suspended
Definition:
common.h:115
mir_surface_attrib_focus
Definition:
common.h:42
mir_lifecycle_connection_lost
Definition:
common.h:100
mir_surface_type_dialog
Definition:
common.h:54
mir_surface_attrib_type
Definition:
common.h:39
mir_lifecycle_state_resumed
Definition:
common.h:99
mir_surface_state_fullscreen
Definition:
common.h:76
mir_lifecycle_state_will_suspend
Definition:
common.h:98
mir_surface_attrib_preferred_orientation
Definition:
common.h:45
mir_surface_visibility_exposed
Definition:
common.h:93
mir_power_mode_off
Definition:
common.h:108
mir_prompt_session_state_stopped
Definition:
common.h:113
mir_surface_unfocused
Definition:
common.h:86
mir_pixel_format_invalid
Definition:
common.h:129
mir_edge_attachment_vertical
Definition:
common.h:166
mir_orientation_normal
Definition:
common.h:144
mir_pixel_format_xrgb_8888
Definition:
common.h:133
mir_orientation_mode_landscape
Definition:
common.h:153
MirOrientation
MirOrientation
Direction relative to the "natural" orientation of the display.
Definition:
common.h:142
mir_orientation_mode_portrait_any
Definition:
common.h:156
mir_pixel_format_xbgr_8888
Definition:
common.h:131
mir_orientation_inverted
Definition:
common.h:146
mir_surface_type_menu
Definition:
common.h:59
mir_surface_state_vertmaximized
Definition:
common.h:72
mir_surface_state_horizmaximized
Definition:
common.h:77
mir_orientation_mode_portrait
Definition:
common.h:152
mir_prompt_session_state_started
Definition:
common.h:114
mir_orientation_right
Definition:
common.h:147
mir_power_mode_suspend
Definition:
common.h:107
MirSurfaceState
MirSurfaceState
Definition:
common.h:66
mir_orientation_left
Definition:
common.h:145
mir_surface_type_tip
AKA "tooltip".
Definition:
common.h:62
mir_pixel_format_bgr_888
Definition:
common.h:134
mir_orientation_mode_landscape_inverted
Definition:
common.h:155
mir_surface_type_gloss
Definition:
common.h:56
mir_pixel_formats
Definition:
common.h:135
mir_surface_type_utility
AKA "floating".
Definition:
common.h:53
MirPowerMode
MirPowerMode
Definition:
common.h:103
MirSurfaceAttrib
MirSurfaceAttrib
Attributes of a surface that the client and server/shell may wish to get or set over the wire...
Definition:
common.h:36
mir_surface_types
Definition:
common.h:63
MirSurfaceType
MirSurfaceType
Definition:
common.h:50
mir_surface_type_overlay
Definition:
common.h:55
mir_pixel_format_argb_8888
Definition:
common.h:132
mir_power_mode_standby
Definition:
common.h:106
MirPixelFormat
MirPixelFormat
The order of components in a format enum matches the order of the components as they would be written...
Definition:
common.h:127
mir_surface_states
Definition:
common.h:79
MirLifecycleState
MirLifecycleState
Definition:
common.h:96
mir_surface_state_unknown
Definition:
common.h:68
MirSurfaceFocusState
MirSurfaceFocusState
Definition:
common.h:84
MirSurfaceVisibility
MirSurfaceVisibility
Definition:
common.h:90
mir_surface_type_popover
Definition:
common.h:58
mir_pixel_format_abgr_8888
Definition:
common.h:130
mir_orientation_mode_landscape_any
Definition:
common.h:158
mir_surface_state_restored
Definition:
common.h:69
mir_edge_attachment_horizontal
Definition:
common.h:167
mir_surface_state_hidden
Definition:
common.h:78
mir_surface_attrib_swapinterval
Definition:
common.h:41
mir_orientation_mode_any
Definition:
common.h:160
MirOrientationMode
MirOrientationMode
Definition:
common.h:150
mir_power_mode_on
Definition:
common.h:105
mir_surface_focused
Definition:
common.h:87
mir_surface_attrib_dpi
Definition:
common.h:43
mir_surface_type_normal
AKA "regular".
Definition:
common.h:52
mir_surface_type_satellite
AKA "toolbox"/"toolbar".
Definition:
common.h:61
mir_edge_attachment_any
Definition:
common.h:168
MirEdgeAttachment
MirEdgeAttachment
Definition:
common.h:164
mir_surface_state_minimized
Definition:
common.h:70
Copyright © 2012,2013 Canonical Ltd.
Generated on Tue Mar 24 16:15:19 UTC 2015