1
=== modified file 'examples/tooltip.c'
2
--- examples/tooltip.c	2015-06-17 05:20:42 +0000
3
+++ examples/tooltip.c	2016-07-20 10:29:25 +0000
4
@@ -102,8 +102,8 @@
5
102
    MirRectangle zone = { 0, 0, 10, 10 };
102
    MirRectangle zone = { 0, 0, 10, 10 };
6
103
    int const width = 50;
103
    int const width = 50;
7
104
    int const height = 20;
104
    int const height = 20;
10
105
    MirSurfaceSpec* const spec = mir_connection_create_spec_for_tooltip(
105
    MirSurfaceSpec* const spec = mir_connection_create_spec_for_tip(
11
106
        connection, width, height, format, parent, &zone);
106
        connection, width, height, format, parent, &zone, mir_edge_attachment_vertical);
12
107
107
13
108
    mir_surface_spec_set_buffer_usage(spec, mir_buffer_usage_software);
108
    mir_surface_spec_set_buffer_usage(spec, mir_buffer_usage_software);
14
109
    mir_surface_spec_set_name(spec, "tooltip");
109
    mir_surface_spec_set_name(spec, "tooltip");
15
110
110
16
=== modified file 'include/client/mir_toolkit/mir_surface.h'
17
--- include/client/mir_toolkit/mir_surface.h	2016-06-09 00:38:26 +0000
18
+++ include/client/mir_toolkit/mir_surface.h	2016-07-20 10:29:25 +0000
19
@@ -103,9 +103,10 @@
20
103
 *                          return a surface of this height.
103
 *                          return a surface of this height.
21
104
 * \param [in] format       Pixel format for the surface.
104
 * \param [in] format       Pixel format for the surface.
22
105
 * \param [in] parent       A valid parent surface for this tooltip.
105
 * \param [in] parent       A valid parent surface for this tooltip.
24
106
 * \param [in] rect         A target zone relative to parent.
106
 * \param [in] zone         A target zone relative to parent.
25
107
 * \return                  A handle that can be passed to mir_surface_create()
107
 * \return                  A handle that can be passed to mir_surface_create()
26
108
 *                          to complete construction.
108
 *                          to complete construction.
27
109
 *\deprecated use mir_connection_create_spec_for_tip() instead
28
109
 */
110
 */
29
110
MirSurfaceSpec*
111
MirSurfaceSpec*
30
111
mir_connection_create_spec_for_tooltip(MirConnection* connection,
112
mir_connection_create_spec_for_tooltip(MirConnection* connection,
31
@@ -113,7 +114,42 @@
32
113
                                       int height,
114
                                       int height,
33
114
                                       MirPixelFormat format,
115
                                       MirPixelFormat format,
34
115
                                       MirSurface* parent,
116
                                       MirSurface* parent,
36
116
                                       MirRectangle* zone);
117
                                       MirRectangle* zone)
37
118
    __attribute__((deprecated));
38
119
39
120
/**
40
121
 * Create a surface specification for a tip surface.
41
122
 *
42
123
 * Positioning of the surface is specified with respect to the parent surface
43
124
 * via an adjacency rectangle. The server will attempt to choose an edge of the
44
125
 * adjacency rectangle on which to place the surface taking in to account
45
126
 * screen-edge proximity or similar constraints. In addition, the server can use
46
127
 * the edge affinity hint to consider only horizontal or only vertical adjacency
47
128
 * edges in the given rectangle.
48
129
 *
49
130
 * \param [in] connection   Connection the surface will be created on
50
131
 * \param [in] width        Requested width. The server is not guaranteed to
51
132
 *                          return a surface of this width.
52
133
 * \param [in] height       Requested height. The server is not guaranteed to
53
134
 *                          return a surface of this height.
54
135
 * \param [in] format       Pixel format for the surface.
55
136
 * \param [in] parent       A valid parent surface for this tip.
56
137
 * \param [in] rect         The adjacency rectangle. The server is not
57
138
 *                          guaranteed to create a surface at the requested
58
139
 *                          location.
59
140
 * \param [in] edge         The preferred edge direction to attach to. Use
60
141
 *                          mir_edge_attachment_any for no preference.
61
142
 * \return                  A handle that can be passed to mir_surface_create()
62
143
 *                          to complete construction.
63
144
 */
64
145
MirSurfaceSpec*
65
146
mir_connection_create_spec_for_tip(MirConnection* connection,
66
147
                                   int width,
67
148
                                   int height,
68
149
                                   MirPixelFormat format,
69
150
                                   MirSurface* parent,
70
151
                                   MirRectangle* rect,
71
152
                                   MirEdgeAttachment edge);
72
117
153
73
118
/**
154
/**
74
119
 * Create a surface specification for a modal dialog surface.
155
 * Create a surface specification for a modal dialog surface.
75
120
156
76
=== modified file 'src/client/mir_surface_api.cpp'
77
--- src/client/mir_surface_api.cpp	2016-06-08 13:49:11 +0000
78
+++ src/client/mir_surface_api.cpp	2016-07-20 10:29:25 +0000
79
@@ -88,7 +88,25 @@
80
88
    auto spec = new MirSurfaceSpec{connection, width, height, format};
88
    auto spec = new MirSurfaceSpec{connection, width, height, format};
81
89
    spec->type = mir_surface_type_tip;
89
    spec->type = mir_surface_type_tip;
82
90
    spec->parent = parent;
90
    spec->parent = parent;
83
91
    return spec;
84
92
}
85
93
86
94
MirSurfaceSpec* mir_connection_create_spec_for_tip(MirConnection* connection,
87
95
                                                   int width,
88
96
                                                   int height,
89
97
                                                   MirPixelFormat format,
90
98
                                                   MirSurface* parent,
91
99
                                                   MirRectangle* rect,
92
100
                                                   MirEdgeAttachment edge)
93
101
{
94
102
    mir::require(mir_surface_is_valid(parent));
95
103
    mir::require(rect != nullptr);
96
104
97
105
    auto spec = new MirSurfaceSpec{connection, width, height, format};
98
106
    spec->type = mir_surface_type_tip;
99
107
    spec->parent = parent;
100
91
    spec->aux_rect = *rect;
108
    spec->aux_rect = *rect;
101
109
    spec->edge_attachment = edge;
102
92
    return spec;
110
    return spec;
103
93
}
111
}
104
94
112
105
95
113
106
=== modified file 'src/client/symbols.map'
107
--- src/client/symbols.map	2016-07-07 09:54:02 +0000
108
+++ src/client/symbols.map	2016-07-20 10:29:25 +0000
109
@@ -415,3 +415,9 @@
110
415
    mir_input_device_state_event_device_pointer_buttons;
415
    mir_input_device_state_event_device_pointer_buttons;
111
416
    mir_surface_spec_set_pointer_confinement;
416
    mir_surface_spec_set_pointer_confinement;
112
417
} MIR_CLIENT_0.22;
417
} MIR_CLIENT_0.22;
113
418
114
419
MIR_CLIENT_0.25 {  # New functions in Mir 0.25
115
420
  global:
116
421
    mir_connection_create_spec_for_tip;
117
422
} MIR_CLIENT_0.24;
118
423
119
418
424
120
=== modified file 'tests/acceptance-tests/test_client_surfaces.cpp'
121
--- tests/acceptance-tests/test_client_surfaces.cpp	2016-05-03 06:55:25 +0000
122
+++ tests/acceptance-tests/test_client_surfaces.cpp	2016-07-20 10:29:25 +0000
123
@@ -244,6 +244,8 @@
124
244
    mir_surface_release_sync(menu);
244
    mir_surface_release_sync(menu);
125
245
}
245
}
126
246
246
127
247
#pragma GCC diagnostic push
128
248
#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
129
247
TEST_F(ClientSurfaces, can_be_tooltips)
249
TEST_F(ClientSurfaces, can_be_tooltips)
130
248
{
250
{
131
249
    auto parent = mtf::make_any_surface(connection);
251
    auto parent = mtf::make_any_surface(connection);
132
@@ -262,6 +264,26 @@
133
262
    mir_surface_release_sync(parent);
264
    mir_surface_release_sync(parent);
134
263
    mir_surface_release_sync(tooltip);
265
    mir_surface_release_sync(tooltip);
135
264
}
266
}
136
267
#pragma GCC diagnostic pop
137
268
138
269
TEST_F(ClientSurfaces, can_be_tips)
139
270
{
140
271
    auto parent = mtf::make_any_surface(connection);
141
272
    MirRectangle rect{100, 200, 100, 100};
142
273
143
274
    auto spec = mir_connection_create_spec_for_tip(connection, 640, 480,
144
275
        mir_pixel_format_abgr_8888, parent, &rect, mir_edge_attachment_any);
145
276
    ASSERT_THAT(spec, NotNull());
146
277
147
278
    auto tooltip = mir_surface_create_sync(spec);
148
279
    mir_surface_spec_release(spec);
149
280
150
281
    ASSERT_THAT(tooltip, IsValid());
151
282
    EXPECT_EQ(mir_surface_get_type(tooltip), mir_surface_type_tip);
152
283
153
284
    mir_surface_release_sync(parent);
154
285
    mir_surface_release_sync(tooltip);
155
286
}
156
265
287
157
266
TEST_F(ClientSurfaces, can_be_dialogs)
288
TEST_F(ClientSurfaces, can_be_dialogs)
158
267
{
289
{
159
268
290
160
=== modified file 'tests/integration-tests/client/test_mirsurface.cpp'
161
--- tests/integration-tests/client/test_mirsurface.cpp	2016-01-29 08:18:22 +0000
162
+++ tests/integration-tests/client/test_mirsurface.cpp	2016-07-20 10:29:25 +0000
163
@@ -196,25 +196,25 @@
164
196
    create_surface(menu_spec.get());
196
    create_surface(menu_spec.get());
165
197
}
197
}
166
198
198
168
199
TEST_F(ClientMirSurface, as_tooltip_sends_correct_params)
199
TEST_F(ClientMirSurface, as_tip_sends_correct_params)
169
200
{
200
{
170
201
    EXPECT_CALL(*mock_shell, create_surface(_,_,_));
201
    EXPECT_CALL(*mock_shell, create_surface(_,_,_));
171
202
    auto parent = create_surface(&spec);
202
    auto parent = create_surface(&spec);
172
203
    ASSERT_THAT(parent.get(), IsValid());
203
    ASSERT_THAT(parent.get(), IsValid());
173
204
204
175
205
    MirRectangle target_zone_rect{100, 200, 300, 400};
205
    MirRectangle placement_hint{100, 200, 300, 400};
176
206
206
177
207
    auto spec_deleter = [](MirSurfaceSpec* spec) {mir_surface_spec_release(spec);};
207
    auto spec_deleter = [](MirSurfaceSpec* spec) {mir_surface_spec_release(spec);};
178
208
    std::unique_ptr<MirSurfaceSpec, decltype(spec_deleter)> tooltip_spec{
208
    std::unique_ptr<MirSurfaceSpec, decltype(spec_deleter)> tooltip_spec{
181
209
        mir_connection_create_spec_for_tooltip(connection, 640, 480,
209
        mir_connection_create_spec_for_tip(connection, 640, 480,
182
210
            mir_pixel_format_abgr_8888, parent.get(), &target_zone_rect),
210
            mir_pixel_format_abgr_8888, parent.get(), &placement_hint, mir_edge_attachment_vertical),
183
211
        spec_deleter
211
        spec_deleter
184
212
    };
212
    };
185
213
213
186
214
    ASSERT_THAT(tooltip_spec, NotNull());
214
    ASSERT_THAT(tooltip_spec, NotNull());
187
215
215
188
216
    EXPECT_CALL(*mock_shell, create_surface(_, AllOf(IsATooltip(),
216
    EXPECT_CALL(*mock_shell, create_surface(_, AllOf(IsATooltip(),
190
217
        HasParent(parent.get()), MatchesAuxRect(target_zone_rect)),_));
217
        HasParent(parent.get()), MatchesAuxRect(placement_hint)),_));
191
218
    create_surface(tooltip_spec.get());
218
    create_surface(tooltip_spec.get());
192
219
}
219
}
193
220
220
Reviewer	Review Type	Date Requested	Status
Mir CI Bot	continuous-integration		Approve on 2016-07-21
Alan Griffiths			Abstain on 2016-07-20
Kevin DuBois (community)			Approve on 2016-07-20
Daniel van Vugt		2016-07-18	Abstain on 2016-07-20
Cemil Azizoglu (community)			Approve on 2016-07-19
Review via email: mp+300304@code.launchpad.net