slideshow/source/inc/view.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: view.hxx,v $
  10  * $Revision: 1.6 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef INCLUDED_SLIDESHOW_VIEW_HXX
  32 #define INCLUDED_SLIDESHOW_VIEW_HXX
  33
  34 #include "viewlayer.hxx"
  35
  36 #include <boost/shared_ptr.hpp>
  37 #include <vector>
  38
  39
  40 namespace basegfx { class B2DRange; class B2DVector; }
  41
  42
  43 /* Definition of View interface */
  44
  45 namespace slideshow
  46 {
  47     namespace internal
  48     {
  49         class View : public ViewLayer
  50         {
  51         public:
  52             /** Create a new view layer for this view
  53
  54                 @param rLayerBounds
  55                 Specifies the bound rect of the layer relative to the
  56                 user view coordinate system.
  57
  58                 This method sets the bounds of the view layer in
  59                 document coordinates (i.e. 'logical' coordinates). The
  60                 resulting transformation is then concatenated with the
  61                 underlying view transformation, returned by the
  62                 getTransformation() method.
  63              */
  64             virtual ViewLayerSharedPtr createViewLayer( const basegfx::B2DRange& rLayerBounds ) const = 0;
  65
  66             /** Update screen representation from backbuffer
  67              */
  68             virtual bool updateScreen() const = 0;
  69
  70             /** Paint screen content unconditionally from backbuffer
  71              */
  72             virtual bool paintScreen() const = 0;
  73
  74             /** Set the size of the user view coordinate system.
  75
  76                 This method sets the width and height of the view in
  77                 document coordinates (i.e. 'logical' coordinates). The
  78                 resulting transformation is then concatenated with the
  79                 underlying view transformation, returned by the
  80                 getTransformation() method.
  81             */
  82             virtual void setViewSize( const ::basegfx::B2DVector& ) = 0;
  83
  84             /** Change the view's mouse cursor.
  85
  86                 @param nPointerShape
  87                 One of the ::com::sun::star::awt::SystemPointer
  88                 constant group members.
  89              */
  90             virtual void setCursorShape( sal_Int16 nPointerShape ) = 0;
  91         };
  92
  93         typedef ::boost::shared_ptr< View >     ViewSharedPtr;
  94         typedef ::std::vector< ViewSharedPtr >  ViewVector;
  95     }
  96 }
  97
  98 #endif /* INCLUDED_SLIDESHOW_VIEW_HXX */