MirSurface Struct Reference

#include <mir_surface.h>

Public Member Functions
	MirSurface (MirSurface const &)=delete
MirSurface &	operator= (MirSurface const &)=delete
	MirSurface (std::string const &error, MirConnection *allocating_connection, mir::frontend::SurfaceId surface_id, std::shared_ptr< MirWaitHandle > const &handle)
	MirSurface (MirConnection *allocating_connection, mir::client::rpc::DisplayServer &server, mir::client::rpc::DisplayServerDebug *debug, std::shared_ptr< mir::client::ClientBufferStream > const &buffer_stream, std::shared_ptr< mir::input::receiver::InputPlatform > const &input_platform, MirSurfaceSpec const &spec, mir::protobuf::Surface const &surface_proto, std::shared_ptr< MirWaitHandle > const &handle)
	~MirSurface ()
MirSurfaceParameters	get_parameters () const
char const *	get_error_message ()
int	id () const
MirWaitHandle *	configure (MirSurfaceAttrib a, int value)
bool	translate_to_screen_coordinates (int x, int y, int *screen_x, int *screen_y)
int	attrib (MirSurfaceAttrib a) const
MirOrientation	get_orientation () const
MirWaitHandle *	set_preferred_orientation (MirOrientationMode mode)
void	raise_surface (MirCookie const *cookie)
MirWaitHandle *	configure_cursor (MirCursorConfiguration const *cursor)
void	set_event_handler (mir_surface_event_callback callback, void *context)
void	handle_event (MirEvent const &e)
void	request_and_wait_for_configure (MirSurfaceAttrib a, int value)
mir::client::ClientBufferStream *	get_buffer_stream ()
MirWaitHandle *	modify (MirSurfaceSpec const &changes)
MirWaitHandle *	request_persistent_id (mir_surface_id_callback callback, void *context)
MirConnection *	connection () const

Static Public Member Functions
static bool	is_valid (MirSurface *query)

Detailed Description

Examples:

basic.c, prompt_session.c, and tooltip.c.

Constructor & Destructor Documentation

MirSurface::MirSurface ( MirSurface const &  )

delete

MirSurface::MirSurface	(	std::string const &	error,
		MirConnection *	allocating_connection,
		mir::frontend::SurfaceId	surface_id,
		std::shared_ptr< MirWaitHandle > const &	handle
	)

MirSurface::MirSurface	(	MirConnection *	allocating_connection,
		mir::client::rpc::DisplayServer &	server,
		mir::client::rpc::DisplayServerDebug *	debug,
		std::shared_ptr< mir::client::ClientBufferStream > const &	buffer_stream,
		std::shared_ptr< mir::input::receiver::InputPlatform > const &	input_platform,
		MirSurfaceSpec const &	spec,
		mir::protobuf::Surface const &	surface_proto,
		std::shared_ptr< MirWaitHandle > const &	handle
	)

MirSurface::~MirSurface

(

)

Member Function Documentation

int MirSurface::attrib

(

MirSurfaceAttrib

a

)

const

MirWaitHandle * MirSurface::configure	(	MirSurfaceAttrib	a,
		int	value
	)

MirWaitHandle * MirSurface::configure_cursor

(

MirCursorConfiguration const *

cursor

)

MirConnection * MirSurface::connection

(

)

const

mir::client::ClientBufferStream * MirSurface::get_buffer_stream

(

)

char const * MirSurface::get_error_message

(

)

MirOrientation MirSurface::get_orientation

(

)

const

MirSurfaceParameters MirSurface::get_parameters

(

)

const

void MirSurface::handle_event

(

MirEvent const &

e

)

int MirSurface::id

(

)

const

bool MirSurface::is_valid ( MirSurface *  query )

static

MirWaitHandle * MirSurface::modify

(

MirSurfaceSpec const &

changes

)

MirSurface& MirSurface::operator= ( MirSurface const &  )

delete

void MirSurface::raise_surface

(

MirCookie const *

cookie

)

void MirSurface::request_and_wait_for_configure	(	MirSurfaceAttrib	a,
		int	value
	)

MirWaitHandle * MirSurface::request_persistent_id	(	mir_surface_id_callback	callback,
		void *	context
	)

void MirSurface::set_event_handler	(	mir_surface_event_callback	callback,
		void *	context
	)

MirWaitHandle * MirSurface::set_preferred_orientation

(

MirOrientationMode

mode

)

bool MirSurface::translate_to_screen_coordinates	(	int	x,
		int	y,
		int *	screen_x,
		int *	screen_y
	)

---

The documentation for this struct was generated from the following files:

• src/client/mir_surface.h
• src/client/mir_surface.cpp