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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_drawing_XSlideSorterBase_idl__
  21 #define __com_sun_star_drawing_XSlideSorterBase_idl__
  22
  23 #include <com/sun/star/drawing/framework/XView.idl>
  24 #include <com/sun/star/drawing/XDrawView.idl>
  25 #include <com/sun/star/awt/XWindow.idl>
  26 #include <com/sun/star/container/XIndexAccess.idl>
  27 #include <com/sun/star/frame/XController.idl>
  28 #include <com/sun/star/util/Color.idl>
  29
  30 module com {  module sun {  module star {  module drawing {
  31
  32 /** This interface exists only because services do not directly support
  33     multiple inheritance and attributes.
  34     <p>It provides the interfaces and attributes that every object that
  35     implements the SlideSorter service.</p>
  36 */
  37 interface XSlideSorterBase
  38 {
  39     /** This interface is included to mark a SlideSorter object
  40         as view of the drawing framework and to provide a
  41         ResourceId.
  42     */
  43     interface ::com::sun::star::drawing::framework::XView;
  44
  45     /** The XDrawView interface is included to provide access
  46         to the current slide (especially write access).
  47     */
  48     interface ::com::sun::star::drawing::XDrawView;
  49
  50     /** The set of slides that are displayed by the implementing object.
  51         <p>The default value is the set of all slides of the document for
  52         which a slide sorter is created.</p>
  53     */
  54     [attribute] ::com::sun::star::container::XIndexAccess DocumentSlides;
  55
  56     /** Set this flag to `TRUE` in order to have the current slide
  57         highlighted.
  58         <p>The default value is `FALSE`.</p>
  59     */
  60     [attribute] boolean IsHighlightCurrentSlide;
  61
  62     /** Set this flag to `TRUE` in order to visualize the selection of
  63         slides (typically a bold frame around the selected slides).
  64         <p>The default value is `TRUE`.</p>
  65     */
  66     [attribute] boolean IsShowSelection;
  67
  68     /** Set this flag to `TRUE` to visualize to where the focus is by
  69         showing a dotted rectangle around the focused slide.
  70         <p>The default value is `TRUE`.</p>
  71     */
  72     [attribute] boolean IsShowFocus;
  73
  74     /** When this flag has the value `TRUE` then every time the current
  75         slide is changed the visual area is shifted so that the new current
  76         slide is display in the center of the slide sorter window.
  77         <p>It is not always possible to move the current slide into the
  78         exact center of the window, for example when slides are located near
  79         the start or end of a document.</p>
  80         <p>The default value is `FALSE`.
  81     */
  82     [attribute] boolean IsCenterSelection;
  83
  84     /** This flag controls whether updates of previews are created during
  85         full screen presentations (`FALSE`) or not (`TRUE`).  The
  86         suspension of preview creations is an optimization for not slowing
  87         down a running presentation.
  88         <p>The default value is `TRUE`.</p>
  89     */
  90     [attribute] boolean IsSuspendPreviewUpdatesDuringFullScreenPresentation;
  91
  92     /** The orientation of a slide sorter can be either vertical (`TRUE`)
  93         or horizontal (`FALSE`).
  94     */
  95     [attribute] boolean IsOrientationVertical;
  96
  97     /** This flag is a hint to make scrolling look smooth.
  98     */
  99     [attribute] boolean IsSmoothScrolling;
 100
 101     [attribute] ::com::sun::star::util::Color BackgroundColor;
 102     [attribute] ::com::sun::star::util::Color TextColor;
 103     [attribute] ::com::sun::star::util::Color SelectionColor;
 104     [attribute] ::com::sun::star::util::Color HighlightColor;
 105
 106     /** This flag controls whether the model can be modified by using
 107         keyboard or mouse.
 108         <p>The default value is `TRUE`.</p>
 109     */
 110     [attribute] boolean IsUIReadOnly;
 111 };
 112
 113
 114
 115 }; }; }; };
 116
 117 #endif
 118
 119 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */