← Back to branch summary

~vanvugt/mir/log-level

« back to all changes in this revision

Viewing changes to include/client/mir_toolkit/mir_surface.h

  • Committer: Daniel van Vugt
  • Date: 2015-01-23 03:08:41 UTC
  • mfrom: (2201.2.50 development-branch)
  • Revision ID: daniel.van.vugt@canonical.com-20150123030841-zn39cao9um2o9x0p
Merge latest trunk

Show diffs side-by-side

added added

removed removed

Lines of Context:
include/client/mir_toolkit/mir_surface.h
76
76
 *                          to complete construction.
77
77
 */
78
78
MirSurfaceSpec*
79
 
mir_connection_create_spec_for_menu_surface(MirConnection* connection,
 
79
mir_connection_create_spec_for_menu(MirConnection* connection,
 
80
                                    int width,
 
81
                                    int height,
 
82
                                    MirPixelFormat format,
 
83
                                    MirSurface* parent,
 
84
                                    MirRectangle* rect,
 
85
                                    MirEdgeAttachment edge);
 
86
 
 
87
/**
 
88
 * Create a surface specification for a tooltip surface.
 
89
 *
 
90
 * A tooltip surface becomes visible when the pointer hovers the specified
 
91
 * target zone. A tooltip surface has no input focus and will be closed when
 
92
 * the pointer moves out of the target zone or the parent closes, moves or hides
 
93
 *
 
94
 * The tooltip parent cannot be another tooltip surface.
 
95
 *
 
96
 * The tooltip position is decided by the server but typically it will appear
 
97
 * near the pointer.
 
98
 *
 
99
 * \param [in] connection   Connection the surface will be created on
 
100
 * \param [in] width        Requested width. The server is not guaranteed to
 
101
 *                          return a surface of this width.
 
102
 * \param [in] height       Requested height. The server is not guaranteed to
 
103
 *                          return a surface of this height.
 
104
 * \param [in] format       Pixel format for the surface.
 
105
 * \param [in] parent       A valid parent surface for this tooltip.
 
106
 * \param [in] rect         A target zone relative to parent.
 
107
 * \return                  A handle that can be passed to mir_surface_create()
 
108
 *                          to complete construction.
 
109
 */
 
110
MirSurfaceSpec*
 
111
mir_connection_create_spec_for_tooltip(MirConnection* connection,
 
112
                                       int width,
 
113
                                       int height,
 
114
                                       MirPixelFormat format,
 
115
                                       MirSurface* parent,
 
116
                                       MirRectangle* zone);
 
117
 
 
118
/**
 
119
 * Create a surface specification for a modal dialog surface.
 
120
 *
 
121
 * The dialog surface will have input focus; the parent can still be moved,
 
122
 * resized or hidden/minimized but no interaction is possible until the dialog
 
123
 * is dismissed.
 
124
 *
 
125
 * A dialog will typically have no close/maximize button decorations.
 
126
 *
 
127
 * During surface creation, if the specified parent is another dialog surface
 
128
 * the server may choose to close the specified parent in order to show this
 
129
 * new dialog surface.
 
130
 *
 
131
 * \param [in] connection   Connection the surface will be created on
 
132
 * \param [in] width        Requested width. The server is not guaranteed to
 
133
 *                          return a surface of this width.
 
134
 * \param [in] height       Requested height. The server is not guaranteed to
 
135
 *                          return a surface of this height.
 
136
 * \param [in] format       Pixel format for the surface.
 
137
 * \param [in] parent       A valid parent surface.
 
138
 *
 
139
 */
 
140
MirSurfaceSpec*
 
141
mir_connection_create_spec_for_modal_dialog(MirConnection* connection,
80
142
                                            int width,
81
143
                                            int height,
82
144
                                            MirPixelFormat format,
83
 
                                            MirSurface* parent,
84
 
                                            MirRectangle* rect,
85
 
                                            MirEdgeAttachment edge);
 
145
                                            MirSurface* parent);
 
146
 
 
147
/**
 
148
 * Create a surface specification for a parentless dialog surface.
 
149
 *
 
150
 * A parentless dialog surface is similar to a normal surface, but it cannot
 
151
 * be fullscreen and typically won't have any maximize/close button decorations.
 
152
 *
 
153
 * A parentless dialog is not allowed to have other dialog children. The server
 
154
 * may decide to close the parent and show the child dialog only.
 
155
 *
 
156
 * \param [in] connection   Connection the surface will be created on
 
157
 * \param [in] width        Requested width. The server is not guaranteed to
 
158
 *                          return a surface of this width.
 
159
 * \param [in] height       Requested height. The server is not guaranteed to
 
160
 *                          return a surface of this height.
 
161
 * \param [in] format       Pixel format for the surface.
 
162
 *
 
163
 */
 
164
MirSurfaceSpec*
 
165
mir_connection_create_spec_for_dialog(MirConnection* connection,
 
166
                                      int width,
 
167
                                      int height,
 
168
                                      MirPixelFormat format);
86
169
 
87
170
/**
88
171
 * Create a surface from a given specification