Mir
Namespaces | Classes | Typedefs | Functions
miral Namespace Reference

Mir Abstraction Layer. More...

Namespaces

 detail
 

Classes

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  CommandLineOption
 Add a user configuration option to Mir's option handling. By default the callback will be invoked following Mir initialisation but prior to the server starting. The value supplied to the callback will come from the command line, environment variable, config file or the default. More...
 
class  CursorTheme
 Load an X-cursor theme, either the supplied default, or through the –cursor-theme config option. More...
 
class  DebugExtension
 Allow debug extension APIs to be enabled and disabled. More...
 
class  ExternalClientLauncher
 
class  InternalClientLauncher
 
class  Keymap
 Load a keymap. More...
 
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  SetWindowManagementPolicy
 
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 apply_lifecycle_state_to (Application const &application, MirLifecycleState state)
 
void kill (Application const &application, int sig)
 
auto name_of (Application const &application) -> std::string
 
auto pid_of (Application const &application) -> pid_t
 
auto pre_init (CommandLineOption const &clo) -> CommandLineOption
 Update the option to be called back before Mir initialization starts. More...
 
void display_configuration_options (mir::Server &server)
 
template<typename Lambda >
auto lambda_as_function (Lambda &&lambda) -> typename detail::FunctionType< decltype(&Lambda::operator())>::type
 
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_management_policy (Args &... args) -> SetWindowManagementPolicy
 
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!= (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<= (Window const &lhs, Window const &rhs)
 
bool operator>= (Window const &lhs, Window 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

◆ Application

using miral::Application = typedef std::shared_ptr<mir::scene::Session>

◆ BufferStreamId

typedef mir::IntWrapper<detail::SessionsBufferStreamIdTag> miral::BufferStreamId

◆ WindowManagementPolicyBuilder

using miral::WindowManagementPolicyBuilder = typedef std::function<std::unique_ptr<miral::WindowManagementPolicy>(WindowManagerTools const& tools)>

Function Documentation

◆ add_window_manager_policy()

template<typename Policy , typename ... Args>
auto miral::add_window_manager_policy ( std::string const &  name,
Args &...  args 
) -> WindowManagerOption
inline

◆ apply_lifecycle_state_to()

void miral::apply_lifecycle_state_to ( Application const &  application,
MirLifecycleState  state 
)

◆ display_configuration_options()

void miral::display_configuration_options ( mir::Server &  server)

◆ equivalent_display_area()

auto miral::equivalent_display_area ( Output const &  lhs,
Output const &  rhs 
) -> bool

◆ kill()

void miral::kill ( Application const &  application,
int  sig 
)

◆ lambda_as_function()

template<typename Lambda >
auto miral::lambda_as_function ( Lambda &&  lambda) -> typename detail::FunctionType<decltype(&Lambda::operator())>::type

◆ name_of()

auto miral::name_of ( Application const &  application) -> std::string

◆ operator!=() [1/4]

bool miral::operator!= ( Window const &  lhs,
Window const &  rhs 
)
inline

◆ operator!=() [2/4]

bool miral::operator!= ( std::shared_ptr< mir::scene::Surface > const &  lhs,
Window const &  rhs 
)
inline

◆ operator!=() [3/4]

bool miral::operator!= ( Window const &  lhs,
std::shared_ptr< mir::scene::Surface > const &  rhs 
)
inline

◆ operator!=() [4/4]

bool miral::operator!= ( Output::PhysicalSizeMM const &  lhs,
Output::PhysicalSizeMM const &  rhs 
)
inline

◆ operator<()

bool miral::operator< ( Window const &  lhs,
Window const &  rhs 
)

◆ operator<=()

bool miral::operator<= ( Window const &  lhs,
Window const &  rhs 
)
inline

◆ operator==() [1/4]

bool miral::operator== ( Window const &  lhs,
Window const &  rhs 
)

◆ operator==() [2/4]

bool miral::operator== ( std::shared_ptr< mir::scene::Surface > const &  lhs,
Window const &  rhs 
)

◆ operator==() [3/4]

bool miral::operator== ( Window const &  lhs,
std::shared_ptr< mir::scene::Surface > const &  rhs 
)

◆ operator==() [4/4]

bool miral::operator== ( Output::PhysicalSizeMM const &  lhs,
Output::PhysicalSizeMM const &  rhs 
)

◆ operator>()

bool miral::operator> ( Window const &  lhs,
Window const &  rhs 
)
inline

◆ operator>=()

bool miral::operator>= ( Window const &  lhs,
Window const &  rhs 
)
inline

◆ pid_of()

auto miral::pid_of ( Application const &  application) -> pid_t

◆ pre_init()

auto miral::pre_init ( CommandLineOption const &  clo) -> CommandLineOption

Update the option to be called back before Mir initialization starts.

Parameters
clothe option

◆ set_window_management_policy()

template<typename Policy , typename ... Args>
auto miral::set_window_management_policy ( Args &...  args) -> SetWindowManagementPolicy

Copyright © 2012-2018 Canonical Ltd.
Generated on Thu 12 Jul 10:49:10 UTC 2018