slideshow/source/engine/shapes/backgroundshape.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: backgroundshape.hxx,v $
  10  * $Revision: 1.3 $
  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_BACKGROUNDSHAPE_HXX
  32 #define INCLUDED_SLIDESHOW_BACKGROUNDSHAPE_HXX
  33
  34 #include <com/sun/star/uno/Reference.hxx>
  35 #include <boost/shared_ptr.hpp>
  36
  37 namespace com { namespace sun { namespace star { namespace drawing
  38 {
  39     class XDrawPage;
  40 } } } }
  41
  42 namespace slideshow
  43 {
  44     namespace internal
  45     {
  46         class  Shape;
  47         struct SlideShowContext;
  48
  49         /** Representation of a draw document's background shape.
  50
  51             This function generates the Shape for the background
  52             shape. Since the background shape is neither animatable
  53             nor attributable, those more specialized derivations of
  54             the Shape interface are not implemented here.
  55          */
  56         boost::shared_ptr<Shape> createBackgroundShape(
  57             const ::com::sun::star::uno::Reference<
  58                   ::com::sun::star::drawing::XDrawPage >& xDrawPage,
  59             const ::com::sun::star::uno::Reference<
  60                   ::com::sun::star::drawing::XDrawPage >& xMasterPage,
  61             const SlideShowContext&                       rContext ); // throw ShapeLoadFailedException;
  62     }
  63 }
  64
  65 #endif /* INCLUDED_SLIDESHOW_BACKGROUNDSHAPE_HXX */