Mir
Functions | Variables
mir_window.h File Reference
#include <mir_toolkit/mir_native_buffer.h>
#include <mir_toolkit/client_types.h>
#include <mir_toolkit/common.h>
#include <mir_toolkit/mir_cursor_configuration.h>
#include <mir_toolkit/deprecations.h>
#include <stdbool.h>
Include dependency graph for mir_window.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

MirWindowSpecmir_create_normal_window_spec (MirConnection *connection, int width, int height)
 Create a window specification for a normal window. More...
 
MirWindowSpecmir_create_menu_window_spec (MirConnection *connection, int width, int height, MirWindow *parent, MirRectangle *rect, MirEdgeAttachment edge)
 Create a window specification for a menu window. More...
 
MirWindowSpecmir_create_tip_window_spec (MirConnection *connection, int width, int height, MirWindow *parent, MirRectangle *rect, MirEdgeAttachment edge)
 Create a window specification for a tip window. More...
 
MirWindowSpecmir_create_modal_dialog_window_spec (MirConnection *connection, int width, int height, MirWindow *parent)
 Create a window specification for a modal dialog window. More...
 
MirWindowSpecmir_create_dialog_window_spec (MirConnection *connection, int width, int height)
 Create a window specification for a parentless dialog window. More...
 
MirWindowSpecmir_create_input_method_window_spec (MirConnection *connection, int width, int height)
 Create a window specification for an input method window. More...
 
MirWindowSpecmir_create_gloss_window_spec (MirConnection *connection, int width, int height)
 Create a window specification for a gloss window. More...
 
MirWindowSpecmir_create_satellite_window_spec (MirConnection *connection, int width, int height, MirWindow *parent)
 Create a window specification for a satellite window. More...
 
MirWindowSpecmir_create_utility_window_spec (MirConnection *connection, int width, int height)
 Create a window specification for a utility window. More...
 
MirWindowSpecmir_create_freestyle_window_spec (MirConnection *connection, int width, int height)
 Create a window specification for a freestyle window. More...
 
MirWindowSpecmir_create_window_spec (MirConnection *connection)
 Create a window specification. More...
 
MirConnectionmir_window_get_connection (MirWindow *window)
 Retrieve the connection. More...
 
void mir_window_spec_set_parent (MirWindowSpec *spec, MirWindow *parent)
 Set the requested parent. More...
 
void mir_window_spec_set_type (MirWindowSpec *spec, MirWindowType type)
 Update a window specification with a window type. More...
 
void mir_window_spec_set_name (MirWindowSpec *spec, char const *name)
 Set the requested name. More...
 
void mir_window_spec_set_width (MirWindowSpec *spec, unsigned width)
 Set the requested width, in pixels. More...
 
void mir_window_spec_set_height (MirWindowSpec *spec, unsigned height)
 Set the requested height, in pixels. More...
 
void mir_window_spec_set_width_increment (MirWindowSpec *spec, unsigned width_inc)
 Set the requested width increment, in pixels. More...
 
void mir_window_spec_set_height_increment (MirWindowSpec *spec, unsigned height_inc)
 Set the requested height increment, in pixels Defines an arithmetic progression of sizes starting with min_height (if set, otherwise 0) into which the window prefers to be resized. More...
 
void mir_window_spec_set_min_width (MirWindowSpec *spec, unsigned min_width)
 Set the minimum width, in pixels. More...
 
void mir_window_spec_set_min_height (MirWindowSpec *spec, unsigned min_height)
 Set the minimum height, in pixels. More...
 
void mir_window_spec_set_max_width (MirWindowSpec *spec, unsigned max_width)
 Set the maximum width, in pixels. More...
 
void mir_window_spec_set_max_height (MirWindowSpec *spec, unsigned max_height)
 Set the maximum height, in pixels. More...
 
void mir_window_spec_set_min_aspect_ratio (MirWindowSpec *spec, unsigned width, unsigned height)
 Set the minimum aspect ratio. More...
 
void mir_window_spec_set_max_aspect_ratio (MirWindowSpec *spec, unsigned width, unsigned height)
 Set the maximum aspect ratio. More...
 
void mir_window_spec_set_fullscreen_on_output (MirWindowSpec *spec, uint32_t output_id)
 
void mir_window_spec_set_preferred_orientation (MirWindowSpec *spec, MirOrientationMode mode)
 Set the requested preferred orientation mode. More...
 
bool mir_window_spec_attach_to_foreign_parent (MirWindowSpec *spec, MirWindowId *parent, MirRectangle *attachment_rect, MirEdgeAttachment edge)
 Request that the created window be attached to a window of a different client. More...
 
void mir_window_spec_set_state (MirWindowSpec *spec, MirWindowState state)
 Set the requested state. More...
 
void mir_window_spec_set_input_shape (MirWindowSpec *spec, MirRectangle const *rectangles, size_t n_rects)
 Set a collection of input rectangles associated with the spec. More...
 
void mir_window_spec_set_event_handler (MirWindowSpec *spec, MirWindowEventCallback callback, void *context)
 Set the event handler to be called when events arrive for a window. More...
 
void mir_window_spec_set_shell_chrome (MirWindowSpec *spec, MirShellChrome style)
 Ask the shell to customize "chrome" for this window. More...
 
void mir_window_spec_set_pointer_confinement (MirWindowSpec *spec, MirPointerConfinementState state)
 Attempts to set the pointer confinement spec for this window. More...
 
void mir_window_spec_set_placement (MirWindowSpec *spec, const MirRectangle *rect, MirPlacementGravity rect_gravity, MirPlacementGravity window_gravity, MirPlacementHints placement_hints, int offset_dx, int offset_dy)
 Set the window placement on the spec. More...
 
void mir_window_spec_set_cursor_name (MirWindowSpec *spec, char const *name)
 Set the name for the cursor from the system cursor theme. More...
 
void mir_window_spec_set_pixel_format (MirWindowSpec *spec, MirPixelFormat format) MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_connection_allocate_buffer/mir_render_surface_get_buffer_stream instead")
 Set the requested pixel format. More...
 
void mir_window_spec_set_buffer_usage (MirWindowSpec *spec, MirBufferUsage usage) MIR_FOR_REMOVAL_IN_VERSION_1("No longer applicable
 
void mir_window_spec_set_streams (MirWindowSpec *spec, MirBufferStreamInfo *streams, unsigned int num_streams) MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_window_spec_add_render_surface instead")
 Set the streams associated with the spec. More...
 
void mir_window_spec_release (MirWindowSpec *spec)
 Release the resources held by a MirWindowSpec. More...
 
void mir_window_apply_spec (MirWindow *window, MirWindowSpec *spec)
 Request changes to the specification of a window. More...
 
void mir_create_window (MirWindowSpec *requested_specification, MirWindowCallback callback, void *context)
 Create a window from a given specification. More...
 
MirWindowmir_create_window_sync (MirWindowSpec *requested_specification)
 Create a window from a given specification and wait for the result. More...
 
void mir_window_release (MirWindow *window, MirWindowCallback callback, void *context)
 Release the supplied window and any associated buffer. More...
 
void mir_window_release_sync (MirWindow *window)
 Release the specified window like in mir_window_release(), but also wait for the operation to complete. More...
 
bool mir_window_is_valid (MirWindow *window)
 Test for a valid window. More...
 
void mir_window_set_event_handler (MirWindow *window, MirWindowEventCallback callback, void *context)
 Set the event handler to be called when events arrive for a window. More...
 
MirBufferStreammir_window_get_buffer_stream (MirWindow *window) MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_window_spec_add_render_surface during window creation/modification instead")
 Retrieve the primary MirBufferStream associated with a window (to advance buffers, obtain EGLNativeWindow, etc...) More...
 
char const * mir_window_get_error_message (MirWindow *window)
 Retrieve a text description of the error. More...
 
void mir_window_get_parameters (MirWindow *window, MirWindowParameters *parameters) MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_window_get_xxx apis or listen to state/attribute change events instead")
 Get a window's parameters. More...
 
MirOrientation mir_window_get_orientation (MirWindow *window)
 Get the orientation of a window. More...
 
void mir_window_raise (MirWindow *window, MirCookie const *cookie)
 Attempts to raise the window to the front. More...
 
void mir_window_request_user_move (MirWindow *window, MirCookie const *cookie)
 Informs the window manager that the user is moving the window. More...
 
void mir_window_request_user_resize (MirWindow *window, MirResizeEdge edge, MirCookie const *cookie)
 Informs the window manager that the user is resizing the window. More...
 
MirWindowType mir_window_get_type (MirWindow *window)
 Get the type (purpose) of a window. More...
 
void mir_window_set_state (MirWindow *window, MirWindowState state)
 Change the state of a window. More...
 
MirWindowState mir_window_get_state (MirWindow *window)
 Get the current state of a window. More...
 
MirWindowFocusState mir_window_get_focus_state (MirWindow *window)
 Query the focus state for a window. More...
 
MirWindowVisibility mir_window_get_visibility (MirWindow *window)
 Query the visibility state for a window. More...
 
int mir_window_get_dpi (MirWindow *window)
 Query the DPI value of the window (dots per inch). More...
 
void mir_window_configure_cursor (MirWindow *window, MirCursorConfiguration const *parameters) MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_window_spec_set_cursor_name/mir_window_spec_set_cursor_render_surface instead")
 Choose the cursor state for a window: whether a cursor is shown, and which cursor if so. More...
 
void mir_window_set_preferred_orientation (MirWindow *window, MirOrientationMode orientation)
 Request to set the preferred orientations of a window. More...
 
MirOrientationMode mir_window_get_preferred_orientation (MirWindow *window)
 Get the preferred orientation modes of a window. More...
 
void mir_window_request_persistent_id (MirWindow *window, MirWindowIdCallback callback, void *context) MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_window_request_window_id() instead")
 Request an ID for the window that can be shared cross-process and across restarts. More...
 
void mir_window_request_window_id (MirWindow *window, MirWindowIdCallback callback, void *context)
 
MirPersistentId * mir_window_request_persistent_id_sync (MirWindow *window) MIR_FOR_REMOVAL_IN_VERSION_1("Use mir_window_request_window_id_sync")
 Request a persistent ID for a window and wait for the result. More...
 
MirWindowIdmir_window_request_window_id_sync (MirWindow *window)
 

Variables

void use mir_render_surface apis
 

Copyright © 2012-2022 Canonical Ltd.
Generated on Mon Jun 20 18:21:25 UTC 2022
This documentation is licensed under the GPL version 2 or 3.