Home · API Reference · Modules
Public Types | Public Member Functions | List of all members
Maliit::Plugins::AbstractSurface Class Referenceabstract
Inheritance diagram for Maliit::Plugins::AbstractSurface:
Inheritance graph
[legend]

Public Types

enum  Option
 

Public Member Functions

virtual ~AbstractSurface ()
 
virtual void show ()=0
 
virtual void hide ()=0
 
virtual QSize size () const =0
 
virtual void setSize (const QSize &size)=0
 
virtual QPoint relativePosition () const =0
 
virtual void setRelativePosition (const QPoint &position)=0
 
virtual QSharedPointer< AbstractSurfaceparent () const =0
 
virtual QPoint translateEventPosition (const QPoint &eventPosition, const QSharedPointer< AbstractSurface > &eventSurface=QSharedPointer< AbstractSurface >()) const =0
 

Detailed Description

The AbstractSurface class provides a window abstraction for rendering the plugin.

Member Enumeration Documentation

§ Option

The Option enum describes the postioning and type of a surface.

Enumerator
None 
PositionOverlay 
PositionCenterBottom 
PositionLeftBottom 
PositionRightBottom 
TypeWidget 
TypeWindow 
TypeQuick1 
TypeQuick2 

Constructor & Destructor Documentation

§ ~AbstractSurface()

Maliit::Plugins::AbstractSurface::~AbstractSurface ( )
virtual

~AbstractSurface

Member Function Documentation

§ hide()

virtual void Maliit::Plugins::AbstractSurface::hide ( )
pure virtual

hides the surface and its children.

§ parent()

virtual QSharedPointer<AbstractSurface> Maliit::Plugins::AbstractSurface::parent ( ) const
pure virtual

returns the parent of a surface

Returns
the surface's parent

§ relativePosition()

virtual QPoint Maliit::Plugins::AbstractSurface::relativePosition ( ) const
pure virtual

returns the position of the surface relative to its parent

Returns
the surface's position relative to its parent

§ setRelativePosition()

virtual void Maliit::Plugins::AbstractSurface::setRelativePosition ( const QPoint &  position)
pure virtual

sets the surface's position relative to its parent (for a PositionOverlay surface)

Parameters
positionthe requested relative position

§ setSize()

virtual void Maliit::Plugins::AbstractSurface::setSize ( const QSize &  size)
pure virtual

sets the size of the surface

Parameters
sizethe requested surface size

Implemented in Maliit::Server::WindowedGraphicsViewSurface.

§ show()

virtual void Maliit::Plugins::AbstractSurface::show ( )
pure virtual

shows the surface.

Implemented in Maliit::Server::WindowedGraphicsViewSurface.

§ size()

virtual QSize Maliit::Plugins::AbstractSurface::size ( ) const
pure virtual

returns the real size of the surface

Returns
the surface's real size

§ translateEventPosition()

virtual QPoint Maliit::Plugins::AbstractSurface::translateEventPosition ( const QPoint &  eventPosition,
const QSharedPointer< AbstractSurface > &  eventSurface = QSharedPointer< AbstractSurface >() 
) const
pure virtual

translates the coordinates of an event into the surfaces coordinate system

Parameters
eventPositionthe coordinates of the event
eventSurfacethe surface where the event occured (by default this)
Returns
the event coordinates translated to the surface coordinate system

Copyright © 2011 Nokia Corporation
Maliit