xref: /aoo41x/main/slideshow/source/inc/unoview.hxx (revision cdf0e10c)
1 /*************************************************************************
2  *
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * Copyright 2000, 2010 Oracle and/or its affiliates.
6  *
7  * OpenOffice.org - a multi-platform office productivity suite
8  *
9  * This file is part of OpenOffice.org.
10  *
11  * OpenOffice.org is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser General Public License version 3
13  * only, as published by the Free Software Foundation.
14  *
15  * OpenOffice.org is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU Lesser General Public License version 3 for more details
19  * (a copy is included in the LICENSE file that accompanied this code).
20  *
21  * You should have received a copy of the GNU Lesser General Public License
22  * version 3 along with OpenOffice.org.  If not, see
23  * <http://www.openoffice.org/license.html>
24  * for a copy of the LGPLv3 License.
25  *
26  ************************************************************************/
27 
28 #ifndef INCLUDED_SLIDESHOW_UNOVIEW_HXX
29 #define INCLUDED_SLIDESHOW_UNOVIEW_HXX
30 
31 #include "view.hxx"
32 #include <com/sun/star/uno/Reference.hxx>
33 
34 #include <vector>
35 
36 namespace com { namespace sun { namespace star { namespace presentation
37 {
38     class XSlideShowView;
39 } } } }
40 
41 
42 /* Definition of UnoView interface */
43 
44 namespace slideshow
45 {
46     namespace internal
47     {
48         /** Extend View with UNO interface retrieval.
49 
50         	This interface extends View with an UNO interface
51         	retrieval, to be used for Views which are set from
52         	external API.
53          */
54         class UnoView : public View
55         {
56         public:
57             /** Retrieve the underlying UNO slide view.
58              */
59             virtual ::com::sun::star::uno::Reference< ::com::sun::star::presentation::XSlideShowView > getUnoView() const = 0;
60 
61             /** Dispose view
62 
63                 This needs to be different from Disposable interface,
64                 as the UNO XComponent also provides a dispose() (only
65                 with a different calling convention under Windows).
66              */
67             virtual void _dispose() = 0;
68 
69             /** Return whether the sound play back is enabled.
70             */
71             virtual bool isSoundEnabled (void) const = 0;
72 
73             /** Tell the view whether it may play sounds.  Disabling this
74                 can be used to prevent different views to play the same
75                 sounds at the same time.
76             */
77             virtual void setIsSoundEnabled (const bool bValue) = 0;
78         };
79 
80         typedef ::boost::shared_ptr< UnoView > 		UnoViewSharedPtr;
81         typedef ::std::vector< UnoViewSharedPtr >	UnoViewVector;
82     }
83 }
84 
85 #endif /* INCLUDED_SLIDESHOW_UNOVIEW_HXX */
86