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