Mir
Public Member Functions | Public Attributes | List of all members
mir::shell::CanonicalSurfaceInfo Struct Reference

#include <canonical_window_manager.h>

Public Member Functions

 CanonicalSurfaceInfo (std::shared_ptr< scene::Session > const &session, std::shared_ptr< scene::Surface > const &surface, scene::SurfaceCreationParameters const &params)
 
bool can_be_active () const
 
bool can_morph_to (MirSurfaceType new_type) const
 
bool must_have_parent () const
 
bool must_not_have_parent () const
 
bool is_visible () const
 
void constrain_resize (std::shared_ptr< scene::Surface > const &surface, geometry::Point &requested_pos, geometry::Size &requested_size, const bool left_resize, const bool top_resize, geometry::Rectangle const &bounds) const
 

Public Attributes

MirSurfaceType type
 
MirSurfaceState state
 
geometry::Rectangle restore_rect
 
std::weak_ptr< scene::Sessionsession
 
std::weak_ptr< scene::Surfaceparent
 
std::vector< std::weak_ptr< scene::Surface > > children
 
geometry::Width min_width
 
geometry::Height min_height
 
geometry::Width max_width
 
geometry::Height max_height
 
mir::optional_value< geometry::DeltaXwidth_inc
 
mir::optional_value< geometry::DeltaYheight_inc
 
mir::optional_value< SurfaceAspectRatiomin_aspect
 
mir::optional_value< SurfaceAspectRatiomax_aspect
 

Constructor & Destructor Documentation

mir::shell::CanonicalSurfaceInfo::CanonicalSurfaceInfo ( std::shared_ptr< scene::Session > const &  session,
std::shared_ptr< scene::Surface > const &  surface,
scene::SurfaceCreationParameters const &  params 
)

Member Function Documentation

bool mir::shell::CanonicalSurfaceInfo::can_be_active ( ) const

< AKA "regular"

< AKA "floating"

< AKA "toolbox"/"toolbar"

< AKA "OSK" or handwriting etc.

< AKA "tooltip"

bool mir::shell::CanonicalSurfaceInfo::can_morph_to ( MirSurfaceType  new_type) const
void mir::shell::CanonicalSurfaceInfo::constrain_resize ( std::shared_ptr< scene::Surface > const &  surface,
geometry::Point requested_pos,
geometry::Size requested_size,
const bool  left_resize,
const bool  top_resize,
geometry::Rectangle const &  bounds 
) const
bool mir::shell::CanonicalSurfaceInfo::is_visible ( ) const
bool mir::shell::CanonicalSurfaceInfo::must_have_parent ( ) const
bool mir::shell::CanonicalSurfaceInfo::must_not_have_parent ( ) const

Member Data Documentation

std::vector<std::weak_ptr<scene::Surface> > mir::shell::CanonicalSurfaceInfo::children
mir::optional_value<geometry::DeltaY> mir::shell::CanonicalSurfaceInfo::height_inc
mir::optional_value<SurfaceAspectRatio> mir::shell::CanonicalSurfaceInfo::max_aspect
geometry::Height mir::shell::CanonicalSurfaceInfo::max_height
geometry::Width mir::shell::CanonicalSurfaceInfo::max_width
mir::optional_value<SurfaceAspectRatio> mir::shell::CanonicalSurfaceInfo::min_aspect
geometry::Height mir::shell::CanonicalSurfaceInfo::min_height
geometry::Width mir::shell::CanonicalSurfaceInfo::min_width
std::weak_ptr<scene::Surface> mir::shell::CanonicalSurfaceInfo::parent
geometry::Rectangle mir::shell::CanonicalSurfaceInfo::restore_rect
std::weak_ptr<scene::Session> mir::shell::CanonicalSurfaceInfo::session
MirSurfaceState mir::shell::CanonicalSurfaceInfo::state
MirSurfaceType mir::shell::CanonicalSurfaceInfo::type
mir::optional_value<geometry::DeltaX> mir::shell::CanonicalSurfaceInfo::width_inc

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

Copyright © 2012-2015 Canonical Ltd.
Generated on Thu Oct 8 16:20:16 UTC 2015