xref: /trunk/main/slideshow/source/inc/viewupdate.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_VIEWUPDATE_HXX
29 #define INCLUDED_SLIDESHOW_VIEWUPDATE_HXX
30 
31 #include "disposable.hxx"
32 #include "view.hxx"
33 #include <boost/shared_ptr.hpp>
34 
35 /* Definition of ViewUpdate interface */
36 
37 namespace slideshow
38 {
39     namespace internal
40     {
41         /** Interface for something that can perform view updates.
42 
43             Use this interface for objects that perform view updates
44             from time to time, e.g. slide content. Availability of
45             updates can be queried, and subsequently performed.
46          */
47         class ViewUpdate : public Disposable
48         {
49         public:
50             /** Perform the update action on all views
51 
52                 @return true, if the update was performed
53                 successfully, false otherwise.
54              */
55             virtual bool update() = 0;
56 
57             /** Perform the update action on given view only
58 
59                 @return true, if the update was performed
60                 successfully, false otherwise.
61              */
62             virtual bool update( ViewSharedPtr const& rView ) = 0;
63 
64             /** Query whether updates are pending
65 
66                 @return true, if updates are pending. Calling update()
67                 subsequently will perform the pending update then.
68              */
69             virtual bool needsUpdate() const = 0;
70         };
71 
72         typedef ::boost::shared_ptr< ViewUpdate > ViewUpdateSharedPtr;
73     }
74 }
75 
76 #endif /* INCLUDED_SLIDESHOW_VIEWUPDATE_HXX */
77