sd/source/ui/slidesorter/controller/SlsHideSlideFunction.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: SlsHideSlideFunction.hxx,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef SD_SLIDESORTER_HIDE_SLIDE_FUNCTION_HXX
  32 #define SD_SLIDESORTER_HIDE_SLIDE_FUNCTION_HXX
  33
  34 #include "controller/SlsSlideFunction.hxx"
  35 #include "model/SlsPageEnumeration.hxx"
  36
  37
  38 namespace sd { namespace slidesorter { namespace controller {
  39
  40 /** Toggle the hidden flag of the selected slides.
  41     When the selected pages have not all the same state they will all set to
  42     hidden.  When all selected pages have the same state this state is
  43     toggled for all of them
  44 */
  45 class HideSlideFunction
  46     : public SlideFunction
  47 {
  48 public:
  49     TYPEINFO();
  50
  51     virtual ~HideSlideFunction (void);
  52
  53     static FunctionReference Create( SlideSorter& rSlideSorter, SfxRequest& rRequest );
  54     virtual void DoExecute( SfxRequest& rReq );
  55
  56     // The state of a set of slides with respect to being excluded from the
  57     // slide show.
  58     enum ExclusionState {UNDEFINED, EXCLUDED, INCLUDED, MIXED};
  59
  60     /** Return for the given set of slides whether they included are
  61         excluded from the slide show.
  62     */
  63     static ExclusionState GetExclusionState (model::PageEnumeration& rPageSet);
  64
  65 protected:
  66     HideSlideFunction (
  67         SlideSorter& rSlideSorter,
  68         SfxRequest& rRequest);
  69
  70     SlideSorter& mrSlideSorter;
  71 };
  72
  73 } } } // end of namespace ::sd::slidesorter::controller
  74
  75 #endif
  76