sd/source/ui/slidesorter/inc/view/SlsPageObjectLayouter.hxx

   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 INCLUDED_SD_SOURCE_UI_SLIDESORTER_INC_VIEW_SLSPAGEOBJECTLAYOUTER_HXX
  21 #define INCLUDED_SD_SOURCE_UI_SLIDESORTER_INC_VIEW_SLSPAGEOBJECTLAYOUTER_HXX
  22
  23 #include <model/SlsSharedPageDescriptor.hxx>
  24 #include <tools/gen.hxx>
  25 #include <vcl/image.hxx>
  26
  27 namespace vcl { class Font; }
  28 namespace sd { class Window; }
  29
  30 namespace sd { namespace slidesorter { namespace view {
  31
  32 /** In contrast to the Layouter that places page objects in the view, the
  33     PageObjectLayouter places the parts of individual page objects like page
  34     number area, borders, preview.
  35 */
  36 class PageObjectLayouter
  37 {
  38 public:
  39     /** Create a new PageObjectLayouter object.
  40         @param rPageObjectSize
  41             In general either the width or the height will be 0 in order to
  42             signal that this size component has to be calculated from the other.
  43             This calculation will make the preview as large as possible.
  44         @param nPageCount
  45             The page count is used to determine how wide the page number
  46             area has to be, how many digits to except for the largest page number.
  47     */
  48     PageObjectLayouter(
  49         const Size& rPageObjectWindowSize,
  50         const Size& rPreviewModelSize,
  51         sd::Window *pWindow,
  52         const sal_Int32 nPageCount);
  53     ~PageObjectLayouter();
  54
  55     enum class Part {
  56         // The focus indicator is painted outside the actual page object.
  57         FocusIndicator,
  58         // This is the outer bounding box that includes the preview, page
  59         // number, title.
  60         PageObject,
  61         // Bounding box of the actual preview.
  62         Preview,
  63         // Bounding box of the page number.
  64         PageNumber,
  65         // Indicator whether or not there is a slide transition associated
  66         // with this slide.
  67         TransitionEffectIndicator,
  68         // Indicator whether or not there is a custom animation associated
  69         // with this slide.
  70         CustomAnimationEffectIndicator
  71     };
  72     /** Two coordinate systems are supported.  They differ only in
  73         translation not in scale.  Both relate to pixel values in the window.
  74         A position in the model coordinate system does not change when the window content is
  75         scrolled up or down.  In the window coordinate system (relative
  76         to the top left point of the window)scrolling leads to different values.
  77     */
  78     enum CoordinateSystem {
  79         WindowCoordinateSystem,
  80         ModelCoordinateSystem
  81     };
  82
  83     /** Return the bounding box of the page object or one of its graphical
  84         parts.
  85         @param rWindow
  86             This device is used to translate between model and window
  87             coordinates.
  88         @param rpPageDescriptor
  89             The page for which to calculate the bounding box.  This may be
  90             NULL.  When it is NULL then a generic bounding box is calculated
  91             for the location (0,0).
  92         @param ePart
  93             The part of the page object for which to return the bounding
  94             box.
  95         @param eCoodinateSystem
  96             The bounding box can be returned in model and in pixel
  97             (window) coordinates.
  98         @param bIgnoreLocation
  99             Return a position ignoring the slides' location, ie. as if
 100             we were the first slide.
 101     */
 102     ::tools::Rectangle GetBoundingBox (
 103         const model::SharedPageDescriptor& rpPageDescriptor,
 104         const Part ePart,
 105         const CoordinateSystem eCoordinateSystem,
 106         bool bIgnoreLocation = false);
 107
 108     /// the size of the embedded preview: position independent, in window coordinate system
 109     Size GetPreviewSize();
 110
 111     /// the maximum size of each tile, also position independent, in window coordinate system
 112     Size GetGridMaxSize();
 113
 114     const Image& GetTransitionEffectIcon() const { return maTransitionEffectIcon;}
 115     const Image& GetCustomAnimationEffectIcon() const { return maCustomAnimationEffectIcon;}
 116
 117 private:
 118     ::tools::Rectangle GetBoundingBox (
 119         const Point& rPageObjectLocation,
 120         const Part ePart,
 121         const CoordinateSystem eCoordinateSystem);
 122
 123 private:
 124     VclPtr<sd::Window> mpWindow;
 125     ::tools::Rectangle maFocusIndicatorBoundingBox;
 126     ::tools::Rectangle maPageObjectBoundingBox;
 127     ::tools::Rectangle maPageNumberAreaBoundingBox;
 128     ::tools::Rectangle maPreviewBoundingBox;
 129     ::tools::Rectangle maTransitionEffectBoundingBox;
 130     ::tools::Rectangle maCustomAnimationEffectBoundingBox;
 131     const Image maTransitionEffectIcon;
 132     const Image maCustomAnimationEffectIcon;
 133     const std::shared_ptr<vcl::Font> mpPageNumberFont;
 134
 135     Size GetPageNumberAreaSize (const int nPageCount);
 136     ::tools::Rectangle CalculatePreviewBoundingBox (
 137         Size& rPageObjectSize,
 138         const Size& rPreviewModelSize,
 139         const sal_Int32 nPageNumberAreaWidth,
 140         const sal_Int32 nFocusIndicatorWidth);
 141 };
 142
 143 } } } // end of namespace ::sd::slidesorter::view
 144
 145 #endif
 146
 147 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */