1 /**************************************************************
2  *
3  * Licensed to the Apache Software Foundation (ASF) under one
4  * or more contributor license agreements.  See the NOTICE file
5  * distributed with this work for additional information
6  * regarding copyright ownership.  The ASF licenses this file
7  * to you under the Apache License, Version 2.0 (the
8  * "License"); you may not use this file except in compliance
9  * with the License.  You may obtain a copy of the License at
10  *
11  *   http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing,
14  * software distributed under the License is distributed on an
15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16  * KIND, either express or implied.  See the License for the
17  * specific language governing permissions and limitations
18  * under the License.
19  *
20  *************************************************************/
21 
22 
23 
24 #ifndef SD_SLIDESORTER_HIDE_SLIDE_FUNCTION_HXX
25 #define SD_SLIDESORTER_HIDE_SLIDE_FUNCTION_HXX
26 
27 #include "controller/SlsSlideFunction.hxx"
28 #include "model/SlsPageEnumeration.hxx"
29 
30 
31 namespace sd { namespace slidesorter { namespace controller {
32 
33 /** Toggle the hidden flag of the selected slides.
34     When the selected pages have not all the same state they will all set to
35     hidden.  When all selected pages have the same state this state is
36     toggled for all of them
37 */
38 class HideSlideFunction
39     : public SlideFunction
40 {
41 public:
42 	TYPEINFO();
43 
44     virtual ~HideSlideFunction (void);
45 
46 	static FunctionReference Create( SlideSorter& rSlideSorter, SfxRequest& rRequest );
47 	virtual void DoExecute( SfxRequest& rReq );
48 
49     // The state of a set of slides with respect to being excluded from the
50     // slide show.
51     enum ExclusionState {UNDEFINED, EXCLUDED, INCLUDED, MIXED};
52 
53     /** Return for the given set of slides whether they included are
54         excluded from the slide show.
55     */
56     static ExclusionState GetExclusionState (model::PageEnumeration& rPageSet);
57 
58 protected:
59 	HideSlideFunction (
60         SlideSorter& rSlideSorter,
61         SfxRequest& rRequest);
62 
63 	SlideSorter& mrSlideSorter;
64 };
65 
66 } } } // end of namespace ::sd::slidesorter::controller
67 
68 #endif
69 
70