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