1*cdf0e10cSrcweir /*************************************************************************
2*cdf0e10cSrcweir  *
3*cdf0e10cSrcweir  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir  *
5*cdf0e10cSrcweir  * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir  *
7*cdf0e10cSrcweir  * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir  *
9*cdf0e10cSrcweir  * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir  *
11*cdf0e10cSrcweir  * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir  * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir  * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir  *
15*cdf0e10cSrcweir  * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir  * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir  * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir  *
21*cdf0e10cSrcweir  * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir  * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir  * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir  * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir  *
26*cdf0e10cSrcweir  ************************************************************************/
27*cdf0e10cSrcweir 
28*cdf0e10cSrcweir #ifndef INCLUDED_SLIDESHOW_VIEWUPDATE_HXX
29*cdf0e10cSrcweir #define INCLUDED_SLIDESHOW_VIEWUPDATE_HXX
30*cdf0e10cSrcweir 
31*cdf0e10cSrcweir #include "disposable.hxx"
32*cdf0e10cSrcweir #include "view.hxx"
33*cdf0e10cSrcweir #include <boost/shared_ptr.hpp>
34*cdf0e10cSrcweir 
35*cdf0e10cSrcweir /* Definition of ViewUpdate interface */
36*cdf0e10cSrcweir 
37*cdf0e10cSrcweir namespace slideshow
38*cdf0e10cSrcweir {
39*cdf0e10cSrcweir     namespace internal
40*cdf0e10cSrcweir     {
41*cdf0e10cSrcweir         /** Interface for something that can perform view updates.
42*cdf0e10cSrcweir 
43*cdf0e10cSrcweir             Use this interface for objects that perform view updates
44*cdf0e10cSrcweir             from time to time, e.g. slide content. Availability of
45*cdf0e10cSrcweir             updates can be queried, and subsequently performed.
46*cdf0e10cSrcweir          */
47*cdf0e10cSrcweir         class ViewUpdate : public Disposable
48*cdf0e10cSrcweir         {
49*cdf0e10cSrcweir         public:
50*cdf0e10cSrcweir             /** Perform the update action on all views
51*cdf0e10cSrcweir 
52*cdf0e10cSrcweir                 @return true, if the update was performed
53*cdf0e10cSrcweir                 successfully, false otherwise.
54*cdf0e10cSrcweir              */
55*cdf0e10cSrcweir             virtual bool update() = 0;
56*cdf0e10cSrcweir 
57*cdf0e10cSrcweir             /** Perform the update action on given view only
58*cdf0e10cSrcweir 
59*cdf0e10cSrcweir                 @return true, if the update was performed
60*cdf0e10cSrcweir                 successfully, false otherwise.
61*cdf0e10cSrcweir              */
62*cdf0e10cSrcweir             virtual bool update( ViewSharedPtr const& rView ) = 0;
63*cdf0e10cSrcweir 
64*cdf0e10cSrcweir             /** Query whether updates are pending
65*cdf0e10cSrcweir 
66*cdf0e10cSrcweir                 @return true, if updates are pending. Calling update()
67*cdf0e10cSrcweir                 subsequently will perform the pending update then.
68*cdf0e10cSrcweir              */
69*cdf0e10cSrcweir             virtual bool needsUpdate() const = 0;
70*cdf0e10cSrcweir         };
71*cdf0e10cSrcweir 
72*cdf0e10cSrcweir         typedef ::boost::shared_ptr< ViewUpdate > ViewUpdateSharedPtr;
73*cdf0e10cSrcweir     }
74*cdf0e10cSrcweir }
75*cdf0e10cSrcweir 
76*cdf0e10cSrcweir #endif /* INCLUDED_SLIDESHOW_VIEWUPDATE_HXX */
77