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