Line data    Source code

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