MirAL
Namespaces | Classes | Typedefs | Functions
miral Namespace Reference

Mir Abstraction Layer. More...

Namespaces

 toolkit
 Convinent C++ wrappers around the Mir toolkit API.
 

Classes

class  ActiveOutputsListener
 
class  ActiveOutputsMonitor
 
class  AddInitCallback
 Add a callback to be invoked when the server has been initialized, but before it starts. If multiple callbacks are added they will be invoked in the sequence added. More...
 
class  AppendEventFilter
 
class  ApplicationAuthorizer
 
class  ApplicationCredentials
 
struct  ApplicationInfo
 
class  BasicSetApplicationAuthorizer
 
class  CanonicalWindowManagerPolicy
 Widely accepted defaults for window management. More...
 
class  CursorTheme
 Load a cursor theme. More...
 
class  InternalClientLauncher
 
class  MirRunner
 Runner for applying initialization options to Mir. More...
 
class  Output
 
class  SetApplicationAuthorizer
 
class  SetCommandLineHandler
 Set a handler for any command line options Mir/MirAL does not recognise. This will be invoked if any unrecognised options are found during initialisation. Any unrecognised arguments are passed to this function. The pointers remain valid for the duration of the call only. If set_command_line_handler is not called the default action is to exit by throwing mir::AbnormalExit (which will be handled by the exception handler prior to exiting run(). More...
 
class  SetTerminator
 Set handler for termination requests. terminator will be called following receipt of SIGTERM or SIGINT. The default terminator stop()s the server, replacements should probably do the same in addition to any additional shutdown logic. More...
 
class  SetWindowManagmentPolicy
 
class  StartupInternalClient
 Wrapper for running an internal Mir client at startup. More...
 
class  Window
 Handle class to manage a Mir surface. It may be null (e.g. default initialized) More...
 
struct  WindowInfo
 
class  WindowManagementPolicy
 The interface through which the window management policy is determined. More...
 
struct  WindowManagerOption
 
class  WindowManagerOptions
 
class  WindowManagerTools
 Window management functions for querying and updating MirAL's model. More...
 
class  WindowSpecification
 

Typedefs

using Application = std::shared_ptr< mir::scene::Session >
 
using WindowManagementPolicyBuilder = std::function< std::unique_ptr< miral::WindowManagementPolicy >(WindowManagerTools const &tools)>
 
typedef mir::IntWrapper< detail::SessionsBufferStreamIdTag > BufferStreamId
 

Functions

void kill (Application const &application, int sig)
 
void display_configuration_options (mir::Server &server)
 
bool operator== (Output::PhysicalSizeMM const &lhs, Output::PhysicalSizeMM const &rhs)
 
bool operator!= (Output::PhysicalSizeMM const &lhs, Output::PhysicalSizeMM const &rhs)
 
auto equivalent_display_area (Output const &lhs, Output const &rhs) -> bool
 
template<typename Policy , typename... Args>
auto set_window_managment_policy (Args &...args) -> SetWindowManagmentPolicy
 
bool operator== (Window const &lhs, Window const &rhs)
 
bool operator== (std::shared_ptr< mir::scene::Surface > const &lhs, Window const &rhs)
 
bool operator== (Window const &lhs, std::shared_ptr< mir::scene::Surface > const &rhs)
 
bool operator!= (Window const &lhs, Window const &rhs)
 
bool operator!= (std::shared_ptr< mir::scene::Surface > const &lhs, Window const &rhs)
 
bool operator!= (Window const &lhs, std::shared_ptr< mir::scene::Surface > const &rhs)
 
template<typename Policy , typename... Args>
auto add_window_manager_policy (std::string const &name, Args &...args) -> WindowManagerOption
 

Detailed Description

Mir Abstraction Layer.

A thin, hopefully ABI stable, layer over the Mir libraries exposing only those abstractions needed to write a shell. One day this may inspire a core Mir library.

Typedef Documentation

using miral::Application = typedef std::shared_ptr<mir::scene::Session>
typedef mir::IntWrapper<detail::SessionsBufferStreamIdTag> miral::BufferStreamId
using miral::WindowManagementPolicyBuilder = typedef std::function<std::unique_ptr<miral::WindowManagementPolicy>(WindowManagerTools const& tools)>

Function Documentation

template<typename Policy , typename... Args>
auto miral::add_window_manager_policy ( std::string const &  name,
Args &...  args 
) -> WindowManagerOption
inline
void miral::display_configuration_options ( mir::Server &  server)
auto miral::equivalent_display_area ( Output const &  lhs,
Output const &  rhs 
) -> bool
void miral::kill ( Application const &  application,
int  sig 
)
bool miral::operator!= ( Window const &  lhs,
Window const &  rhs 
)
inline
bool miral::operator!= ( std::shared_ptr< mir::scene::Surface > const &  lhs,
Window const &  rhs 
)
inline
bool miral::operator!= ( Window const &  lhs,
std::shared_ptr< mir::scene::Surface > const &  rhs 
)
inline
bool miral::operator!= ( Output::PhysicalSizeMM const &  lhs,
Output::PhysicalSizeMM const &  rhs 
)
inline
bool miral::operator== ( Window const &  lhs,
Window const &  rhs 
)
bool miral::operator== ( std::shared_ptr< mir::scene::Surface > const &  lhs,
Window const &  rhs 
)
bool miral::operator== ( Window const &  lhs,
std::shared_ptr< mir::scene::Surface > const &  rhs 
)
bool miral::operator== ( Output::PhysicalSizeMM const &  lhs,
Output::PhysicalSizeMM const &  rhs 
)
template<typename Policy , typename... Args>
auto miral::set_window_managment_policy ( Args &...  args) -> SetWindowManagmentPolicy

Copyright © 2016 Canonical Ltd.
Generated on Fri Sep 30 13:21:55 UTC 2016