sd/source/ui/slidesorter/inc/view/SlsInsertAnimator.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 <controller/SlsAnimator.hxx>
  23 #include <memory>
  24
  25 namespace sd::slidesorter::view
  26 {
  27 class InsertPosition;
  28
  29 /** Animate the positions of page objects to make room at the insert
  30     position while a move or copy operation takes place.
  31 */
  32 class InsertAnimator
  33 {
  34 public:
  35     explicit InsertAnimator(SlideSorter& rSlideSorter);
  36     InsertAnimator(const InsertAnimator&) = delete;
  37     InsertAnimator& operator=(const InsertAnimator&) = delete;
  38
  39     /** Set the position at which we have to make room for the display of an
  40         icon.
  41     */
  42     void SetInsertPosition(const InsertPosition& rInsertPosition);
  43
  44     /** Restore the normal position of all page objects.
  45         @param eMode
  46             This flag controls whether to start an animation that ends in the
  47             normal positions of all slides (AM_Animated) or to restore the
  48             normal positions immediately (AM_Immediate).
  49     */
  50     void Reset(const controller::Animator::AnimationMode eMode);
  51
  52 private:
  53     class Implementation;
  54     std::shared_ptr<Implementation> mpImplementation;
  55 };
  56
  57 } // end of namespace ::sd::slidesorter::view
  58
  59 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */