sd/source/ui/inc/PreviewRenderer.hxx

   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: PreviewRenderer.hxx,v $
  10  * $Revision: 1.6.34.1 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef SD_PREVIEW_RENDERER_HXX
  32 #define SD_PREVIEW_RENDERER_HXX
  33
  34 #include "drawview.hxx"
  35 #include <vcl/image.hxx>
  36 #include <vcl/virdev.hxx>
  37 #include <svtools/listener.hxx>
  38 #include <memory>
  39
  40
  41 class OutputDevice;
  42 class SdPage;
  43 class VirtualDevice;
  44
  45 namespace sd {
  46
  47 class DrawDocShell;
  48 class DrawView;
  49
  50
  51 class PreviewRenderer
  52     : public SfxListener
  53 {
  54 public:
  55     /** Create a new preview renderer that takes some of its inital values
  56         from the given output device.
  57         @param pTemplate
  58             May be NULL.
  59         @param bPaintFrame
  60             When <TRUE/> (the default) then a frame is painted around the
  61             preview.  This makes the actual preview smaller.
  62     */
  63     PreviewRenderer (
  64         OutputDevice* pTemplate = NULL,
  65         const bool bPaintFrame = true);
  66
  67     ~PreviewRenderer (void);
  68
  69     /** Render a page with the given pixel size.
  70         Use this version when only the width of the preview is known to the
  71         caller.  The height is then calculated according to the aspect
  72         ration of the given page.
  73         @param pPage
  74             The page to render.
  75         @param nWidth
  76             The width of the preview in device coordinates.
  77         @param sSubstitutionText
  78             When the actual preview can not be created for some reason, then
  79             this text is painted in an empty rectangle of the requested size
  80             instead.
  81     */
  82     Image RenderPage (
  83         const SdPage* pPage,
  84         const sal_Int32 nWidth,
  85         const String& sSubstitutionText);
  86
  87     /** Render a page with the given pixel size.
  88         @param pPage
  89             The page to render.
  90         @param aPreviewPixelSize
  91             The size in device coordinates of the preview.
  92         @param sSubstitutionText
  93             When the actual preview can not be created for some reason, then
  94             this text is painted in an empty rectangle of the requested size
  95             instead.
  96     */
  97     Image RenderPage (
  98         const SdPage* pPage,
  99         const Size aPreviewPixelSize,
 100         const String& sSubstitutionText);
 101
 102     /** Render an image that contains the given substitution text instead of a
 103         slide preview.
 104         @param aPreviewPixelSize
 105             The size in device coordinates of the image.
 106     */
 107     Image RenderSubstitution (
 108         const Size& rPreviewPixelSize,
 109         const String& sSubstitutionText);
 110
 111     /** Scale the given bitmap by keeping its aspect ratio to the desired
 112         width.  Add a frame to it afterwards.
 113     */
 114     Image ScaleBitmap (
 115         const BitmapEx& rBitmap,
 116         int nWidth);
 117
 118 protected:
 119         virtual void Notify(SfxBroadcaster& rBC, const SfxHint& rHint);
 120
 121 private:
 122     ::std::auto_ptr<VirtualDevice> mpPreviewDevice;
 123     ::std::auto_ptr<DrawView> mpView;
 124     DrawDocShell* mpDocShellOfView;
 125     int mnWidthOfView;
 126     const Color maFrameColor;
 127     const bool mbHasFrame;
 128     static const int snSubstitutionTextSize;
 129     // Width of the frame that is painted arround the preview.
 130     static const int snFrameWidth;
 131
 132     bool Initialize (
 133         const SdPage* pPage,
 134         const Size& rPixelSize);
 135     void Cleanup (void);
 136     void PaintPage (const SdPage* pPage);
 137     void PaintSubstitutionText (const String& rSubstitutionText);
 138     void PaintFrame (void);
 139
 140     /** Set up the map mode so that the given page is renderer into a bitmap
 141         with the specified width.
 142         @param rPage
 143             The page for which the preview is created.
 144         @param rPixelSize
 145             The size of the resulting preview bitmap.  Note that this size
 146             includes the frame.  The actual preview is smaller accordingly.
 147      */
 148     void SetupOutputSize (const SdPage& rPage, const Size& rPixelSize);
 149
 150     /** When mpView is empty then create a new view and initialize it.
 151         Otherwise just initialize it.
 152     */
 153     void ProvideView (DrawDocShell* pDocShell);
 154 };
 155
 156 } // end of namespace ::sd
 157
 158 #endif