slideshow/source/inc/view.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_SLIDESHOW_SOURCE_INC_VIEW_HXX
  21 #define INCLUDED_SLIDESHOW_SOURCE_INC_VIEW_HXX
  22
  23 #include "viewlayer.hxx"
  24
  25 #include <boost/shared_ptr.hpp>
  26 #include <vector>
  27
  28
  29 namespace basegfx { class B2DRange; class B2DVector; }
  30
  31
  32 /* Definition of View interface */
  33
  34 namespace slideshow
  35 {
  36     namespace internal
  37     {
  38         class View : public ViewLayer
  39         {
  40         public:
  41             /** Create a new view layer for this view
  42
  43                 @param rLayerBounds
  44                 Specifies the bound rect of the layer relative to the
  45                 user view coordinate system.
  46
  47                 This method sets the bounds of the view layer in
  48                 document coordinates (i.e. 'logical' coordinates). The
  49                 resulting transformation is then concatenated with the
  50                 underlying view transformation, returned by the
  51                 getTransformation() method.
  52              */
  53             virtual ViewLayerSharedPtr createViewLayer( const basegfx::B2DRange& rLayerBounds ) const = 0;
  54
  55             /** Update screen representation from backbuffer
  56              */
  57             virtual bool updateScreen() const = 0;
  58
  59             /** Paint screen content unconditionally from backbuffer
  60              */
  61             virtual bool paintScreen() const = 0;
  62
  63             /** Set the size of the user view coordinate system.
  64
  65                 This method sets the width and height of the view in
  66                 document coordinates (i.e. 'logical' coordinates). The
  67                 resulting transformation is then concatenated with the
  68                 underlying view transformation, returned by the
  69                 getTransformation() method.
  70             */
  71             virtual void setViewSize( const ::basegfx::B2DVector& ) = 0;
  72
  73             /** Change the view's mouse cursor.
  74
  75                 @param nPointerShape
  76                 One of the ::com::sun::star::awt::SystemPointer
  77                 constant group members.
  78              */
  79             virtual void setCursorShape( sal_Int16 nPointerShape ) = 0;
  80         };
  81
  82         typedef ::boost::shared_ptr< View >     ViewSharedPtr;
  83         typedef ::std::vector< ViewSharedPtr >  ViewVector;
  84     }
  85 }
  86
  87 #endif // INCLUDED_SLIDESHOW_SOURCE_INC_VIEW_HXX
  88
  89 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */