sd/source/ui/slidesorter/inc/controller/SlsVisibleAreaManager.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 <model/SlsSharedPageDescriptor.hxx>
  23 #include <optional>
  24 #include <tools/gen.hxx>
  25 #include <vector>
  26
  27 namespace sd::slidesorter
  28 {
  29 class SlideSorter;
  30 }
  31
  32 namespace sd::slidesorter::controller
  33 {
  34 /** Manage requests for scrolling page objects into view.
  35 */
  36 class VisibleAreaManager
  37 {
  38 public:
  39     explicit VisibleAreaManager(SlideSorter& rSlideSorter);
  40     ~VisibleAreaManager();
  41     VisibleAreaManager(const VisibleAreaManager&) = delete;
  42     VisibleAreaManager& operator=(const VisibleAreaManager&) = delete;
  43
  44     void ActivateCurrentSlideTracking();
  45     void DeactivateCurrentSlideTracking();
  46     bool IsCurrentSlideTrackingActive() const { return mbIsCurrentSlideTrackingActive; }
  47
  48     /** Request the current slide to be moved into the visible area.
  49         This request is only obeyed when the current slide tracking is
  50         active.
  51         @see ActivateCurrentSlideTracking() and DeactivateCurrentSlideTracking()
  52     */
  53     void RequestCurrentSlideVisible();
  54
  55     /** Request to make the specified page object visible.
  56     */
  57     void RequestVisible(const model::SharedPageDescriptor& rpDescriptor, const bool bForce = false);
  58
  59     /** Temporarily disable the update of the visible area.
  60     */
  61     class TemporaryDisabler
  62     {
  63     public:
  64         explicit TemporaryDisabler(SlideSorter const& rSlideSorter);
  65         ~TemporaryDisabler();
  66
  67     private:
  68         VisibleAreaManager& mrVisibleAreaManager;
  69     };
  70
  71 private:
  72     SlideSorter& mrSlideSorter;
  73
  74     /** List of rectangle that someone wants to be moved into the visible
  75         area.
  76         Cleared on every call to ForgetVisibleRequests() and MakeVisible().
  77     */
  78     ::std::vector<::tools::Rectangle> maVisibleRequests;
  79
  80     Point maRequestedVisibleTopLeft;
  81     bool mbIsCurrentSlideTrackingActive;
  82     int mnDisableCount;
  83
  84     void MakeVisible();
  85     ::std::optional<Point> GetRequestedTopLeft() const;
  86 };
  87
  88 } // end of namespace ::sd::slidesorter::view
  89
  90 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */