sd/source/ui/slidesorter/inc/controller/SlsCurrentSlideManager.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: SlsCurrentSlideManager.hxx,v $
  10  *
  11  * $Revision: 1.3 $
  12  *
  13  * This file is part of OpenOffice.org.
  14  *
  15  * OpenOffice.org is free software: you can redistribute it and/or modify
  16  * it under the terms of the GNU Lesser General Public License version 3
  17  * only, as published by the Free Software Foundation.
  18  *
  19  * OpenOffice.org is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU Lesser General Public License version 3 for more details
  23  * (a copy is included in the LICENSE file that accompanied this code).
  24  *
  25  * You should have received a copy of the GNU Lesser General Public License
  26  * version 3 along with OpenOffice.org.  If not, see
  27  * <http://www.openoffice.org/license.html>
  28  * for a copy of the LGPLv3 License.
  29  *
  30  ************************************************************************/
  31
  32 #ifndef SD_SLIDESORTER_CURRENT_SLIDE_MANAGER_HXX
  33 #define SD_SLIDESORTER_CURRENT_SLIDE_MANAGER_HXX
  34
  35 #include "model/SlsSharedPageDescriptor.hxx"
  36 #include <com/sun/star/drawing/XDrawPage.hpp>
  37
  38 class SdPage;
  39
  40 namespace sd { namespace slidesorter {
  41 class SlideSorter;
  42 } }
  43
  44
  45 namespace sd { namespace slidesorter { namespace controller {
  46
  47 /** Manage the current slide.  This includes setting the according flags at
  48     the PageDescriptor objects and setting the current slide at the main
  49     view shell.
  50 */
  51 class CurrentSlideManager
  52 {
  53 public:
  54     /** Create a new CurrentSlideManager object that manages the current
  55         slide for the given SlideSorter.
  56     */
  57     CurrentSlideManager (SlideSorter& rSlideSorter);
  58
  59     ~CurrentSlideManager (void);
  60
  61     /** Call this when the current page of the main view shell has been
  62         switched.  Use SwitchCurrentSlide() to initiate such a switch.
  63     */
  64     void CurrentSlideHasChanged (const sal_Int32 nSlideIndex);
  65
  66     /** Call this method to switch the current page of the main view shell
  67         to the given slide.  Use CurrentSlideHasChanged() when the current
  68         slide change has been initiated by someone else.
  69     */
  70     void SwitchCurrentSlide (const sal_Int32 nSlideIndex);
  71     void SwitchCurrentSlide (const model::SharedPageDescriptor& rpSlide);
  72
  73     /** Return the page descriptor for the current slide.  Note, that when
  74         there is no current slide then the returned pointer is empty.
  75     */
  76     model::SharedPageDescriptor GetCurrentSlide (void);
  77
  78     /** Release all references to model data.
  79     */
  80     void PrepareModelChange (void);
  81
  82     /** Modify inner state in reaction to a change of the SlideSorterModel.
  83     */
  84     void HandleModelChange (void);
  85
  86 private:
  87     SlideSorter& mrSlideSorter;
  88     sal_Int32 mnCurrentSlideIndex;
  89     model::SharedPageDescriptor mpCurrentSlide;
  90
  91     bool IsCurrentSlideIsValid (void);
  92     void SetCurrentSlideAtViewShellBase (const model::SharedPageDescriptor& rpSlide);
  93     void SetCurrentSlideAtXController (const model::SharedPageDescriptor& rpSlide);
  94
  95     /** When switching from one slide to a new current slide then this
  96         method releases all ties to the old slide.
  97     */
  98     void ReleaseCurrentSlide (void);
  99
 100     /** When switching from one slide to a new current slide then this
 101         method connects to the new current slide.
 102     */
 103     void AcquireCurrentSlide (const sal_Int32 nSlideIndex);
 104 };
 105
 106
 107 } } } // end of namespace ::sd::slidesorter::controller
 108
 109 #endif