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