Mir
Public Member Functions | Protected Member Functions | List of all members
mir::shell::DisplayLayout Class Referenceabstract

Interface to the layout of the display outputs. More...

#include <display_layout.h>

Public Member Functions

virtual ~DisplayLayout ()=default
 
virtual void clip_to_output (geometry::Rectangle &rect)=0
 Clips a rectangle to the output it is in. More...
 
virtual void size_to_output (geometry::Rectangle &rect)=0
 Makes a rectangle take up the whole area of the output it is in. More...
 
virtual bool place_in_output (graphics::DisplayConfigurationOutputId id, geometry::Rectangle &rect)=0
 Places a rectangle in an particular output if the display is known, otherwise does nothing. More...
 

Protected Member Functions

 DisplayLayout ()=default
 
 DisplayLayout (DisplayLayout const &)=delete
 
DisplayLayoutoperator= (DisplayLayout const &)=delete
 

Detailed Description

Interface to the layout of the display outputs.

Constructor & Destructor Documentation

virtual mir::shell::DisplayLayout::~DisplayLayout ( )
virtualdefault
mir::shell::DisplayLayout::DisplayLayout ( )
protecteddefault
mir::shell::DisplayLayout::DisplayLayout ( DisplayLayout const &  )
protecteddelete

Member Function Documentation

virtual void mir::shell::DisplayLayout::clip_to_output ( geometry::Rectangle rect)
pure virtual

Clips a rectangle to the output it is in.

Parameters
[in,out]rectthe rectangle to clip
DisplayLayout& mir::shell::DisplayLayout::operator= ( DisplayLayout const &  )
protecteddelete
virtual bool mir::shell::DisplayLayout::place_in_output ( graphics::DisplayConfigurationOutputId  id,
geometry::Rectangle rect 
)
pure virtual

Places a rectangle in an particular output if the display is known, otherwise does nothing.

Parameters
[in]idthe id of the output to place the rectangle in
[in,out]rectthe rectangle to place
Returns
true iff the display id is recognised
virtual void mir::shell::DisplayLayout::size_to_output ( geometry::Rectangle rect)
pure virtual

Makes a rectangle take up the whole area of the output it is in.

Parameters
[in,out]rectthe rectangle to make fullscreen

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

Copyright © 2012-2016 Canonical Ltd.
Generated on Mon Jun 5 13:49:26 UTC 2017