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 #pragma once
  21
  22 #include <com/sun/star/uno/Reference.hxx>
  23 #include <tools/link.hxx>
  24 #include <memory>
  25
  26 namespace com::sun::star::rendering
  27 {
  28 class XSpriteCanvas;
  29 }
  30
  31 struct ImplSVEvent;
  32
  33 namespace sd::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 : public std::enable_shared_from_this<CanvasUpdateRequester>
  41 {
  42 public:
  43     CanvasUpdateRequester(const CanvasUpdateRequester&) = delete;
  44     CanvasUpdateRequester& operator=(const CanvasUpdateRequester&) = delete;
  45
  46     /** @return the Canvas UpdateRequester object for the given shared canvas.
  47                 A new object is created when it does not already exist.
  48     */
  49     static std::shared_ptr<CanvasUpdateRequester>
  50     Instance(const css::uno::Reference<css::rendering::XSpriteCanvas>& rxCanvas);
  51
  52     void RequestUpdate(const bool bUpdateAll);
  53
  54 private:
  55     explicit CanvasUpdateRequester(
  56         const css::uno::Reference<css::rendering::XSpriteCanvas>& rxCanvas);
  57     ~CanvasUpdateRequester();
  58     class Deleter;
  59     friend class Deleter;
  60
  61     /// keep instance alive waiting for event dispatch
  62     std::shared_ptr<CanvasUpdateRequester> m_pThis;
  63     css::uno::Reference<css::rendering::XSpriteCanvas> mxCanvas;
  64     ImplSVEvent* m_pUserEventId;
  65     bool mbUpdateFlag;
  66
  67     DECL_LINK(Callback, void*, void);
  68 };
  69
  70 } // end of namespace ::sd::presenter
  71
  72 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */