sfx2/inc/SfxRedactionHelper.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; fill-column: 100 -*- */
   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
  10 #ifndef INCLUDED_CUI_SOURCE_INC_SFXREDACTIONHELPER_HXX
  11 #define INCLUDED_CUI_SOURCE_INC_SFXREDACTIONHELPER_HXX
  12
  13 #include <com/sun/star/uno/Reference.hxx>
  14 #include <com/sun/star/lang/XComponent.hpp>
  15 #include <com/sun/star/frame/XModel.hpp>
  16 #include <com/sun/star/beans/XPropertySet.hpp>
  17 #include <com/sun/star/drawing/XDrawPage.hpp>
  18
  19 #include <sal/types.h>
  20 #include <rtl/ustring.hxx>
  21 #include <tools/gen.hxx>
  22
  23 #include <vector>
  24
  25 using namespace ::com::sun::star;
  26 using namespace ::com::sun::star::lang;
  27 using namespace ::com::sun::star::uno;
  28
  29 class SfxRequest;
  30 class SfxStringItem;
  31 class GDIMetaFile;
  32 class DocumentToGraphicRenderer;
  33 class SfxViewFrame;
  34
  35 struct PageMargins
  36 {
  37     // Page margins in mm100th
  38     sal_Int32 nTop;
  39     sal_Int32 nBottom;
  40     sal_Int32 nLeft;
  41     sal_Int32 nRight;
  42 };
  43
  44 /*
  45  * Mostly a bunch of static methods to handle the redaction functionality at
  46  * different points of the process.
  47  **/
  48 class SfxRedactionHelper
  49 {
  50 public:
  51     /// Checks to see if the request has a parameter of IsRedactMode:bool=true
  52     static bool isRedactMode(const SfxRequest& rReq);
  53     /*
  54      * Returns the value of the given string param as an OUString
  55      * Returns empty OUString if no param
  56      * */
  57     static OUString getStringParam(const SfxRequest& rReq, const sal_uInt16& nParamId);
  58     /*
  59      * Creates metafiles from the pages of the given document,
  60      * and pushes into the given vector.
  61      * */
  62     static void getPageMetaFilesFromDoc(std::vector<GDIMetaFile>& aMetaFiles,
  63                                         std::vector<::Size>& aPageSizes, const sal_Int32& nPages,
  64                                         DocumentToGraphicRenderer& aRenderer);
  65     /*
  66      * Creates one shape and one draw page for each gdimetafile,
  67      * and inserts the shapes into the newly created draw pages.
  68      * */
  69     static void addPagesToDraw(uno::Reference<XComponent>& xComponent, const sal_Int32& nPages,
  70                                const std::vector<GDIMetaFile>& aMetaFiles,
  71                                const std::vector<::Size>& aPageSizes,
  72                                const PageMargins& aPageMargins);
  73     /*
  74      * Makes the Redaction toolbar visible to the user.
  75      * Meant to be called after converting a document to a Draw doc
  76      * for redaction purposes.
  77      * */
  78     static void showRedactionToolbar(SfxViewFrame* pViewFrame);
  79
  80     /*
  81      * Used to get the page margins from the original/source Writer document. Then we apply these values to the
  82      * pages inserted into Draw for redaction.
  83      * */
  84     static PageMargins getPageMarginsForWriter(css::uno::Reference<css::frame::XModel>& xModel);
  85
  86     /*
  87      * Used to get the page margins from the original/source Calc document. Then we apply these values to the
  88      * pages inserted into Draw for redaction.
  89      * */
  90     static PageMargins getPageMarginsForCalc(css::uno::Reference<css::frame::XModel>& xModel);
  91
  92     static void searchInMetaFile(const OUString& sSearchTerm, const GDIMetaFile& rMtf,
  93                                  std::vector<tools::Rectangle>& aRedactionRectangles,
  94                                  uno::Reference<XComponent>& xComponent);
  95
  96     /*
  97      * Draws a redaction rectangle on the draw page referenced with its page number (0-based)
  98      * */
  99     static void addRedactionRectToPage(uno::Reference<XComponent>& xComponent,
 100                                        uno::Reference<drawing::XDrawPage>& xPage,
 101                                        const std::vector<tools::Rectangle>& aNewRectangles);
 102
 103     /*
 104      * Search for the given term through the gdimetafile, which has the whole content of a draw page,
 105      * and draw redaction rectangles to the appropriate positions with suitable sizes.
 106      * */
 107     static void autoRedactPage(const OUString& sRedactionTerm, const GDIMetaFile& rGDIMetaFile,
 108                                uno::Reference<drawing::XDrawPage>& xPage,
 109                                uno::Reference<XComponent>& xComponent);
 110 };
 111
 112 #endif // INCLUDED_CUI_SOURCE_INC_SFXREDACTIONHELPER_HXX
 113
 114 /* vim:set shiftwidth=4 softtabstop=4 expandtab cinoptions=b1,g0,N-s cinkeys+=0=break: */