MirAL
Public Member Functions | Static Public Member Functions | List of all members
miral::toolkit::SurfaceSpec Class Reference

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

#include <miral/toolkit/surface_spec.h>

Public Member Functions

 SurfaceSpec (MirSurfaceSpec *spec)
 
auto set_buffer_usage (MirBufferUsage usage) -> SurfaceSpec &
 
auto set_type (MirSurfaceType type) -> SurfaceSpec &
 
auto set_min_size (int min_width, int min_height) -> SurfaceSpec &
 
auto set_max_size (int max_width, int max_height) -> SurfaceSpec &
 
auto set_size_inc (int width_inc, int height_inc) -> SurfaceSpec &
 
auto set_size (int width, int height) -> SurfaceSpec &
 
auto set_name (char const *name) -> SurfaceSpec &
 
auto set_event_handler (mir_surface_event_callback callback, void *context) -> SurfaceSpec &
 
auto set_placement (const MirRectangle *rect, MirPlacementGravity rect_gravity, MirPlacementGravity surface_gravity, MirPlacementHints placement_hints, int offset_dx, int offset_dy) -> SurfaceSpec &
 
auto set_parent (MirSurface *parent) -> SurfaceSpec &
 
template<typename Context >
void create_surface (void(*callback)(MirSurface *, Context *), Context *context) const
 
auto create_surface () const -> Surface
 
void apply_to (MirSurface *surface) const
 
 operator MirSurfaceSpec * () const
 

Static Public Member Functions

static auto for_normal_surface (MirConnection *connection, int width, int height, MirPixelFormat format) -> SurfaceSpec
 
static auto for_menu (MirConnection *connection, int width, int height, MirPixelFormat format, MirSurface *parent, MirRectangle *rect, MirEdgeAttachment edge) -> SurfaceSpec
 
static auto for_tip (MirConnection *connection, int width, int height, MirPixelFormat format, MirSurface *parent, MirRectangle *rect, MirEdgeAttachment edge) -> SurfaceSpec
 
static auto for_dialog (MirConnection *connection, int width, int height, MirPixelFormat format) -> SurfaceSpec
 
static auto for_dialog (MirConnection *connection, int width, int height, MirPixelFormat format, MirSurface *parent) -> SurfaceSpec
 
static auto for_changes (MirConnection *connection) -> SurfaceSpec
 

Detailed Description

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

Constructor & Destructor Documentation

§ SurfaceSpec()

miral::toolkit::SurfaceSpec::SurfaceSpec ( MirSurfaceSpec *  spec)
inlineexplicit

Member Function Documentation

§ apply_to()

void miral::toolkit::SurfaceSpec::apply_to ( MirSurface *  surface) const
inline

§ create_surface() [1/2]

template<typename Context >
void miral::toolkit::SurfaceSpec::create_surface ( void(*)(MirSurface *, Context *)  callback,
Context *  context 
) const
inline

§ create_surface() [2/2]

auto miral::toolkit::SurfaceSpec::create_surface ( ) const -> Surface
inline

§ for_changes()

static auto miral::toolkit::SurfaceSpec::for_changes ( MirConnection *  connection) -> SurfaceSpec
inlinestatic

§ for_dialog() [1/2]

static auto miral::toolkit::SurfaceSpec::for_dialog ( MirConnection *  connection,
int  width,
int  height,
MirPixelFormat  format 
) -> SurfaceSpec
inlinestatic

§ for_dialog() [2/2]

static auto miral::toolkit::SurfaceSpec::for_dialog ( MirConnection *  connection,
int  width,
int  height,
MirPixelFormat  format,
MirSurface *  parent 
) -> SurfaceSpec
inlinestatic

§ for_menu()

static auto miral::toolkit::SurfaceSpec::for_menu ( MirConnection *  connection,
int  width,
int  height,
MirPixelFormat  format,
MirSurface *  parent,
MirRectangle *  rect,
MirEdgeAttachment  edge 
) -> SurfaceSpec
inlinestatic

§ for_normal_surface()

static auto miral::toolkit::SurfaceSpec::for_normal_surface ( MirConnection *  connection,
int  width,
int  height,
MirPixelFormat  format 
) -> SurfaceSpec
inlinestatic

§ for_tip()

static auto miral::toolkit::SurfaceSpec::for_tip ( MirConnection *  connection,
int  width,
int  height,
MirPixelFormat  format,
MirSurface *  parent,
MirRectangle *  rect,
MirEdgeAttachment  edge 
) -> SurfaceSpec
inlinestatic

§ operator MirSurfaceSpec *()

miral::toolkit::SurfaceSpec::operator MirSurfaceSpec * ( ) const
inline

§ set_buffer_usage()

auto miral::toolkit::SurfaceSpec::set_buffer_usage ( MirBufferUsage  usage) -> SurfaceSpec&
inline

§ set_event_handler()

auto miral::toolkit::SurfaceSpec::set_event_handler ( mir_surface_event_callback  callback,
void *  context 
) -> SurfaceSpec&
inline

§ set_max_size()

auto miral::toolkit::SurfaceSpec::set_max_size ( int  max_width,
int  max_height 
) -> SurfaceSpec&
inline

§ set_min_size()

auto miral::toolkit::SurfaceSpec::set_min_size ( int  min_width,
int  min_height 
) -> SurfaceSpec&
inline

§ set_name()

auto miral::toolkit::SurfaceSpec::set_name ( char const *  name) -> SurfaceSpec&
inline

§ set_parent()

auto miral::toolkit::SurfaceSpec::set_parent ( MirSurface *  parent) -> SurfaceSpec&
inline

§ set_placement()

auto miral::toolkit::SurfaceSpec::set_placement ( const MirRectangle *  rect,
MirPlacementGravity  rect_gravity,
MirPlacementGravity  surface_gravity,
MirPlacementHints  placement_hints,
int  offset_dx,
int  offset_dy 
) -> SurfaceSpec&
inline

§ set_size()

auto miral::toolkit::SurfaceSpec::set_size ( int  width,
int  height 
) -> SurfaceSpec&
inline

§ set_size_inc()

auto miral::toolkit::SurfaceSpec::set_size_inc ( int  width_inc,
int  height_inc 
) -> SurfaceSpec&
inline

§ set_type()

auto miral::toolkit::SurfaceSpec::set_type ( MirSurfaceType  type) -> SurfaceSpec&
inline

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

Copyright © 2016 Canonical Ltd.
Generated on Tue Dec 20 16:03:55 UTC 2016