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