sd/source/ui/presenter/CanvasUpdateRequester.hxx

   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_SD_SOURCE_UI_PRESENTER_CANVASUPDATEREQUESTER_HXX
  21 #define INCLUDED_SD_SOURCE_UI_PRESENTER_CANVASUPDATEREQUESTER_HXX
  22
  23 #include <com/sun/star/rendering/XSpriteCanvas.hpp>
  24 #include <boost/noncopyable.hpp>
  25 #include <boost/shared_ptr.hpp>
  26 #include <sal/types.h>
  27 #include <tools/solar.h>
  28 #include <tools/link.hxx>
  29 #include <vector>
  30
  31 struct ImplSVEvent;
  32
  33 namespace sd { namespace presenter {
  34
  35 /** Each UpdateRequester handles update requests (calls to
  36     XCanvas::updateScreen()) for one shared canvas (a canvas that has one or
  37     more PresenterCanvas wrappers).  Multiple calls are collected and lead
  38     to a single call to updateScreen.
  39 */
  40 class CanvasUpdateRequester : private ::boost::noncopyable
  41 {
  42 public:
  43     /** @return the Canvas UpdateRequester object for the given shared canvas.
  44                 A new object is created when it does not already exist.
  45     */
  46     static ::boost::shared_ptr<CanvasUpdateRequester> Instance (
  47         const css::uno::Reference<css::rendering::XSpriteCanvas>& rxCanvas);
  48
  49     void RequestUpdate (const bool bUpdateAll);
  50
  51 private:
  52     CanvasUpdateRequester (const css::uno::Reference<css::rendering::XSpriteCanvas>& rxCanvas);
  53     ~CanvasUpdateRequester();
  54     class Deleter; friend class Deleter;
  55
  56     typedef ::std::vector<
  57         ::std::pair<
  58             css::uno::Reference<css::rendering::XSpriteCanvas>,
  59            ::boost::shared_ptr<CanvasUpdateRequester> > > RequesterMap;
  60     static RequesterMap maRequesterMap;
  61
  62     css::uno::Reference<css::rendering::XSpriteCanvas> mxCanvas;
  63     ImplSVEvent * mnUserEventId;
  64     bool mbUpdateFlag;
  65     DECL_LINK(Callback, void*);
  66 };
  67
  68 } } // end of namespace ::sd::presenter
  69
  70 #endif
  71
  72 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */