slideshow/source/inc/unoview.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: unoview.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_UNOVIEW_HXX
  32 #define INCLUDED_SLIDESHOW_UNOVIEW_HXX
  33
  34 #include "view.hxx"
  35 #include <com/sun/star/uno/Reference.hxx>
  36
  37 #include <vector>
  38
  39 namespace com { namespace sun { namespace star { namespace presentation
  40 {
  41     class XSlideShowView;
  42 } } } }
  43
  44
  45 /* Definition of UnoView interface */
  46
  47 namespace slideshow
  48 {
  49     namespace internal
  50     {
  51         /** Extend View with UNO interface retrieval.
  52
  53             This interface extends View with an UNO interface
  54             retrieval, to be used for Views which are set from
  55             external API.
  56          */
  57         class UnoView : public View
  58         {
  59         public:
  60             /** Retrieve the underlying UNO slide view.
  61              */
  62             virtual ::com::sun::star::uno::Reference< ::com::sun::star::presentation::XSlideShowView > getUnoView() const = 0;
  63
  64             /** Dispose view
  65
  66                 This needs to be different from Disposable interface,
  67                 as the UNO XComponent also provides a dispose() (only
  68                 with a different calling convention under Windows).
  69              */
  70             virtual void _dispose() = 0;
  71
  72             /** Return whether the sound play back is enabled.
  73             */
  74             virtual bool isSoundEnabled (void) const = 0;
  75
  76             /** Tell the view whether it may play sounds.  Disabling this
  77                 can be used to prevent different views to play the same
  78                 sounds at the same time.
  79             */
  80             virtual void setIsSoundEnabled (const bool bValue) = 0;
  81         };
  82
  83         typedef ::boost::shared_ptr< UnoView >          UnoViewSharedPtr;
  84         typedef ::std::vector< UnoViewSharedPtr >       UnoViewVector;
  85     }
  86 }
  87
  88 #endif /* INCLUDED_SLIDESHOW_UNOVIEW_HXX */