offapi/com/sun/star/drawing/SlideSorter.idl

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