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 __com_sun_star_drawing_SlideSorter_idl__
25#define __com_sun_star_drawing_SlideSorter_idl__
26
27#ifndef __com_sun_star_drawing_framework_XView_idl__
28#include <com/sun/star/drawing/framework/XView.idl>
29#endif
30#ifndef __com_sun_star_drawing_XDrawView_idl__
31#include <com/sun/star/drawing/XDrawView.idl>
32#endif
33#ifndef __com_sun_star_awt_XWindow_idl__
34#include <com/sun/star/awt/XWindow.idl>
35#endif
36#ifndef __com_sun_star_container_XIndexAccess_idl__
37#include <com/sun/star/container/XIndexAccess.idl>
38#endif
39#ifndef __com_sun_star_frame_XController_idl__
40#include <com/sun/star/frame/XController.idl>
41#endif
42#ifndef __com_sun_star_util_Color_idl__
43#include <com/sun/star/util/Color.idl>
44#endif
45
46module com {  module sun {  module star {  module drawing {
47
48/** This interface exists only because services do not directly support
49    multiple inheritance and attributes.
50    <p>It provides the interfaces and attributes that every object that
51    implements the <type>SlideSorter</type> service.</p>
52*/
53interface XSlideSorterBase
54{
55    /** This interface is included to mark a <type>SlideSorter</type> object
56        as view of the drawing framework and to provide a
57        <type>ResourceId</type>.
58    */
59    interface ::com::sun::star::drawing::framework::XView;
60
61    /** The <type>XDrawView</type> interface is included to provide access
62        to the current slide (especially write access).
63    */
64    interface ::com::sun::star::drawing::XDrawView;
65
66    /** The set of slides that are displayed by the implementing object.
67        <p>The default value is the set of all slides of the document for
68        which a slide sorter is created.</p>
69    */
70    [attribute] ::com::sun::star::container::XIndexAccess DocumentSlides;
71
72    /** Set this flag to <TRUE/> in order to have the current slide
73        highlighted.
74        <p>The default value is <FALSE/>.</p>
75    */
76    [attribute] boolean IsHighlightCurrentSlide;
77
78    /** Set this flag to <TRUE/> in order to visualize the selection of
79        slides (typically a bold frame around the selected slides).
80        <p>The default value is <TRUE/>.</p>
81    */
82    [attribute] boolean IsShowSelection;
83
84    /** Set this flag to <TRUE/> to visualize to where the focus is by
85        showing a dotted rectangle around the focused slide.
86        <p>The default value is <TRUE/>.</p>
87    */
88    [attribute] boolean IsShowFocus;
89
90    /** When this flag has the value <TRUE/> then every time the current
91        slide is changed the visual area is shifted so that the new current
92        slide is display in the center of the slide sorter window.
93        <p>It is not always possible to move the current slide into the
94        exact center of the window, for example when slides are located near
95        the start or end of a document.</p>
96        <p>The default value is <FALSE/>.
97    */
98    [attribute] boolean IsCenterSelection;
99
100    /** This flag controls whether updates of previews are created during
101        full screen presentations (<FALSE/>) or not (<TRUE/>).  The
102        suspension of preview creations is an optimization for not slowing
103        down a running presentation.
104        <p>The default value is <TRUE/>.</p>
105    */
106    [attribute] boolean IsSuspendPreviewUpdatesDuringFullScreenPresentation;
107
108    /** The orientation of a slide sorter can be either vertical (<TRUE/>)
109        or horizontal (<FALSE/>).
110    */
111    [attribute] boolean IsOrientationVertical;
112
113    /** This flag is a hint to make scrolling look smooth.
114    */
115    [attribute] boolean IsSmoothScrolling;
116
117    [attribute] ::com::sun::star::util::Color BackgroundColor;
118    [attribute] ::com::sun::star::util::Color TextColor;
119    [attribute] ::com::sun::star::util::Color SelectionColor;
120    [attribute] ::com::sun::star::util::Color HighlightColor;
121
122    /** This flag controls whether the model can be modified by using
123        keyboard or mouse.
124        <p>The default value is <TRUE/>.</p>
125    */
126    [attribute] boolean IsUIReadOnly;
127};
128
129
130
131
132/** A slide sorter shows previews for a set of slides, typically all slides
133    in a document, and allows the selection, reordering, creation, and
134    deletion of slides.
135    <p>In the drawing framework a slide sorter is regarded as a view.</p>
136*/
137service SlideSorter : XSlideSorterBase
138{
139    /** Create a new slide sorter object.
140        @param xViewId
141            The resource id of the new slide sorter.
142        @param xController
143            The access point to an impress document.
144        @param xParentWindow
145            The parent window which will be completely covered by the new
146            slide sorter.
147    */
148    create (
149        [in] framework::XResourceId xViewId,
150        [in] ::com::sun::star::frame::XController xController,
151        [in] ::com::sun::star::awt::XWindow xParentWindow);
152};
153
154}; }; }; };
155
156#endif
157