sd/source/ui/slidesorter/inc/controller/SlsSelectionObserver.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 <sal/types.h>
  23 #include <memory>
  24 #include <vector>
  25
  26 namespace sd::slidesorter
  27 {
  28 class SlideSorter;
  29 }
  30
  31 class SdrPage;
  32 class SdPage;
  33
  34 namespace sd::slidesorter::controller
  35 {
  36 /** Observe insertions and deletions of pages between calls to
  37     StartObservation() and EndObservation().  When the later is called
  38     the selection is set to just the newly inserted pages.
  39 */
  40 class SelectionObserver final
  41 {
  42 public:
  43     SelectionObserver(SlideSorter& rSlideSorter);
  44     ~SelectionObserver();
  45
  46     void NotifyPageEvent(const SdrPage* pPage);
  47     void StartObservation();
  48     void AbortObservation();
  49     void EndObservation();
  50
  51     /** Use this little class instead of calling StartObservation and
  52         EndObservation directly so that EndObservation is not forgotten or
  53         omitted due to an exception or some break or return in the middle of
  54         code.
  55     */
  56     class Context
  57     {
  58     public:
  59         Context(SlideSorter const& rSlideSorter);
  60         ~Context() COVERITY_NOEXCEPT_FALSE;
  61         void Abort();
  62
  63     private:
  64         std::shared_ptr<SelectionObserver> mpSelectionObserver;
  65     };
  66
  67 private:
  68     SlideSorter& mrSlideSorter;
  69     bool mbIsObservationActive;
  70     bool mbPageEventOccurred;
  71
  72     ::std::vector<const SdPage*> maInsertedPages;
  73 };
  74
  75 } // end of namespace ::sd::slidesorter::controller
  76
  77 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */