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 module com {  module sun {  module star {  module drawing {
  21
  22 /** This interface exists only because services do not directly support
  23     multiple inheritance and attributes.
  24     <p>It provides the interfaces and attributes that every object that
  25     implements the SlideSorter service.</p>
  26 */
  27 interface XSlideSorterBase
  28 {
  29     /** This interface is included to mark a SlideSorter object
  30         as view of the drawing framework and to provide a
  31         ResourceId.
  32     */
  33     interface ::com::sun::star::drawing::framework::XView;
  34
  35     /** The XDrawView interface is included to provide access
  36         to the current slide (especially write access).
  37     */
  38     interface ::com::sun::star::drawing::XDrawView;
  39
  40     /** The set of slides that are displayed by the implementing object.
  41         <p>The default value is the set of all slides of the document for
  42         which a slide sorter is created.</p>
  43     */
  44     [attribute] ::com::sun::star::container::XIndexAccess DocumentSlides;
  45
  46     /** Set this flag to `TRUE` in order to have the current slide
  47         highlighted.
  48         <p>The default value is `FALSE`.</p>
  49     */
  50     [attribute] boolean IsHighlightCurrentSlide;
  51
  52     /** Set this flag to `TRUE` in order to visualize the selection of
  53         slides (typically a bold frame around the selected slides).
  54         <p>The default value is `TRUE`.</p>
  55     */
  56     [attribute] boolean IsShowSelection;
  57
  58     /** Set this flag to `TRUE` to visualize to where the focus is by
  59         showing a dotted rectangle around the focused slide.
  60         <p>The default value is `TRUE`.</p>
  61     */
  62     [attribute] boolean IsShowFocus;
  63
  64     /** When this flag has the value `TRUE` then every time the current
  65         slide is changed the visual area is shifted so that the new current
  66         slide is display in the center of the slide sorter window.
  67         <p>It is not always possible to move the current slide into the
  68         exact center of the window, for example when slides are located near
  69         the start or end of a document.</p>
  70         <p>The default value is `FALSE`.
  71     */
  72     [attribute] boolean IsCenterSelection;
  73
  74     /** This flag controls whether updates of previews are created during
  75         full screen presentations (`FALSE`) or not (`TRUE`).  The
  76         suspension of preview creations is an optimization for not slowing
  77         down a running presentation.
  78         <p>The default value is `TRUE`.</p>
  79     */
  80     [attribute] boolean IsSuspendPreviewUpdatesDuringFullScreenPresentation;
  81
  82     /** The orientation of a slide sorter can be either vertical (`TRUE`)
  83         or horizontal (`FALSE`).
  84     */
  85     [attribute] boolean IsOrientationVertical;
  86
  87     /** This flag is a hint to make scrolling look smooth.
  88     */
  89     [attribute] boolean IsSmoothScrolling;
  90
  91     [attribute] ::com::sun::star::util::Color BackgroundColor;
  92     [attribute] ::com::sun::star::util::Color TextColor;
  93     [attribute] ::com::sun::star::util::Color SelectionColor;
  94     [attribute] ::com::sun::star::util::Color HighlightColor;
  95
  96     /** This flag controls whether the model can be modified by using
  97         keyboard or mouse.
  98         <p>The default value is `TRUE`.</p>
  99     */
 100     [attribute] boolean IsUIReadOnly;
 101 };
 102
 103
 104
 105 }; }; }; };
 106
 107 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */