Mir
Public Member Functions | Static Public Member Functions | List of all members
mir::client::WindowSpec Class Reference

Handle class for MirWindowSpec - provides automatic reference counting, method chaining. More...

#include <window_spec.h>

Public Member Functions

 WindowSpec (MirWindowSpec *spec)
 
auto set_type (MirWindowType type) -> WindowSpec &
 
auto set_shell_chrome (MirShellChrome chrome) -> WindowSpec &
 
auto set_min_size (int min_width, int min_height) -> WindowSpec &
 
auto set_max_size (int max_width, int max_height) -> WindowSpec &
 
auto set_size_inc (int width_inc, int height_inc) -> WindowSpec &
 
auto set_size (int width, int height) -> WindowSpec &
 
auto set_name (char const *name) -> WindowSpec &
 
auto set_event_handler (MirWindowEventCallback callback, void *context) -> WindowSpec &
 
auto set_fullscreen_on_output (uint32_t output_id) -> WindowSpec &
 
auto set_placement (const MirRectangle *rect, MirPlacementGravity rect_gravity, MirPlacementGravity surface_gravity, MirPlacementHints placement_hints, int offset_dx, int offset_dy) -> WindowSpec &
 
auto set_parent (MirWindow *parent) -> WindowSpec &
 
auto set_state (MirWindowState state) -> WindowSpec &
 
auto add_surface (MirRenderSurface *surface, int width, int height, int displacement_x, int displacement_y) -> WindowSpec &
 
template<typename Context >
void create_window (void(*callback)(MirWindow *, Context *), Context *context) const
 
auto create_window () const -> Window
 
void apply_to (MirWindow *window) const
 
 operator MirWindowSpec * () const
 

Static Public Member Functions

static auto for_normal_window (MirConnection *connection, int width, int height) -> WindowSpec
 
static auto for_menu (MirConnection *connection, int width, int height, MirWindow *parent, MirRectangle *rect, MirEdgeAttachment edge) -> WindowSpec
 
static auto for_tip (MirConnection *connection, int width, int height, MirWindow *parent, MirRectangle *rect, MirEdgeAttachment edge) -> WindowSpec
 
static auto for_dialog (MirConnection *connection, int width, int height) -> WindowSpec
 
static auto for_dialog (MirConnection *connection, int width, int height, MirWindow *parent) -> WindowSpec
 
static auto for_input_method (MirConnection *connection, int width, int height, MirWindow *parent)
 
static auto for_satellite (MirConnection *connection, int width, int height, MirWindow *parent)
 
static auto for_gloss (MirConnection *connection, int width, int height)
 
static auto for_changes (MirConnection *connection) -> WindowSpec
 

Detailed Description

Handle class for MirWindowSpec - provides automatic reference counting, method chaining.

Constructor & Destructor Documentation

◆ WindowSpec()

mir::client::WindowSpec::WindowSpec ( MirWindowSpec spec)
inlineexplicit

Member Function Documentation

◆ add_surface()

auto mir::client::WindowSpec::add_surface ( MirRenderSurface surface,
int  width,
int  height,
int  displacement_x,
int  displacement_y 
) -> WindowSpec&
inline

◆ apply_to()

void mir::client::WindowSpec::apply_to ( MirWindow window) const
inline

◆ create_window() [1/2]

auto mir::client::WindowSpec::create_window ( ) const -> Window
inline

◆ create_window() [2/2]

template<typename Context >
void mir::client::WindowSpec::create_window ( void(*)(MirWindow *, Context *)  callback,
Context *  context 
) const
inline

◆ for_changes()

static auto mir::client::WindowSpec::for_changes ( MirConnection connection) -> WindowSpec
inlinestatic

◆ for_dialog() [1/2]

static auto mir::client::WindowSpec::for_dialog ( MirConnection connection,
int  width,
int  height 
) -> WindowSpec
inlinestatic

◆ for_dialog() [2/2]

static auto mir::client::WindowSpec::for_dialog ( MirConnection connection,
int  width,
int  height,
MirWindow parent 
) -> WindowSpec
inlinestatic

◆ for_gloss()

static auto mir::client::WindowSpec::for_gloss ( MirConnection connection,
int  width,
int  height 
)
inlinestatic

◆ for_input_method()

static auto mir::client::WindowSpec::for_input_method ( MirConnection connection,
int  width,
int  height,
MirWindow parent 
)
inlinestatic

◆ for_menu()

static auto mir::client::WindowSpec::for_menu ( MirConnection connection,
int  width,
int  height,
MirWindow parent,
MirRectangle rect,
MirEdgeAttachment  edge 
) -> WindowSpec
inlinestatic

◆ for_normal_window()

static auto mir::client::WindowSpec::for_normal_window ( MirConnection connection,
int  width,
int  height 
) -> WindowSpec
inlinestatic

◆ for_satellite()

static auto mir::client::WindowSpec::for_satellite ( MirConnection connection,
int  width,
int  height,
MirWindow parent 
)
inlinestatic

◆ for_tip()

static auto mir::client::WindowSpec::for_tip ( MirConnection connection,
int  width,
int  height,
MirWindow parent,
MirRectangle rect,
MirEdgeAttachment  edge 
) -> WindowSpec
inlinestatic

◆ operator MirWindowSpec *()

mir::client::WindowSpec::operator MirWindowSpec * ( ) const
inline

◆ set_event_handler()

auto mir::client::WindowSpec::set_event_handler ( MirWindowEventCallback  callback,
void *  context 
) -> WindowSpec&
inline

◆ set_fullscreen_on_output()

auto mir::client::WindowSpec::set_fullscreen_on_output ( uint32_t  output_id) -> WindowSpec&
inline

◆ set_max_size()

auto mir::client::WindowSpec::set_max_size ( int  max_width,
int  max_height 
) -> WindowSpec&
inline

◆ set_min_size()

auto mir::client::WindowSpec::set_min_size ( int  min_width,
int  min_height 
) -> WindowSpec&
inline

◆ set_name()

auto mir::client::WindowSpec::set_name ( char const *  name) -> WindowSpec&
inline

◆ set_parent()

auto mir::client::WindowSpec::set_parent ( MirWindow parent) -> WindowSpec&
inline

◆ set_placement()

auto mir::client::WindowSpec::set_placement ( const MirRectangle rect,
MirPlacementGravity  rect_gravity,
MirPlacementGravity  surface_gravity,
MirPlacementHints  placement_hints,
int  offset_dx,
int  offset_dy 
) -> WindowSpec&
inline

◆ set_shell_chrome()

auto mir::client::WindowSpec::set_shell_chrome ( MirShellChrome  chrome) -> WindowSpec&
inline

◆ set_size()

auto mir::client::WindowSpec::set_size ( int  width,
int  height 
) -> WindowSpec&
inline

◆ set_size_inc()

auto mir::client::WindowSpec::set_size_inc ( int  width_inc,
int  height_inc 
) -> WindowSpec&
inline

◆ set_state()

auto mir::client::WindowSpec::set_state ( MirWindowState  state) -> WindowSpec&
inline

◆ set_type()

auto mir::client::WindowSpec::set_type ( MirWindowType  type) -> WindowSpec&
inline

The documentation for this class was generated from the following file:

Copyright © 2012-2022 Canonical Ltd.
Generated on Fri Nov 11 11:01:41 UTC 2022
This documentation is licensed under the GPL version 2 or 3.