sd/source/ui/inc/tools/GraphicSizeCheck.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  */
  10
  11 #pragma once
  12
  13 #include <memory>
  14 #include <drawdoc.hxx>
  15 #include <svx/GenericCheckDialog.hxx>
  16 #include <svx/svdograf.hxx>
  17
  18 namespace sd
  19 {
  20 /**
  21  * Class responsible to check if a graphic object violates the size
  22  * constraints and store the results.
  23  */
  24 class GraphicSizeViolation final
  25 {
  26 private:
  27     SdrGrafObj* m_pGraphicObject;
  28
  29     sal_Int32 m_nLowDPILimit = 0;
  30     sal_Int32 m_nHighDPILimit = 0;
  31
  32     sal_Int32 m_nDPIX = 0;
  33     sal_Int32 m_nDPIY = 0;
  34
  35 public:
  36     GraphicSizeViolation(sal_Int32 nDPI, SdrGrafObj* pGraphicObject);
  37     bool check();
  38
  39     const OUString& getGraphicName();
  40
  41     SdrGrafObj* getObject() const { return m_pGraphicObject; }
  42
  43     bool isDPITooLow() { return m_nDPIX < m_nLowDPILimit || m_nDPIY < m_nLowDPILimit; }
  44
  45     bool isDPITooHigh() { return m_nDPIX > m_nHighDPILimit || m_nDPIY > m_nHighDPILimit; }
  46
  47     sal_Int32 getDPIX() { return m_nDPIX; }
  48
  49     sal_Int32 getDPIY() { return m_nDPIY; }
  50 };
  51
  52 /**
  53  * Run the graphic size checks for all the graphic objects in the DOM
  54  * and store a list of violations.
  55  */
  56 class GraphicSizeCheck final
  57 {
  58 private:
  59     SdDrawDocument* m_pDocument;
  60     std::vector<std::unique_ptr<GraphicSizeViolation>> m_aGraphicSizeViolationList;
  61
  62 public:
  63     GraphicSizeCheck(SdDrawDocument* pDocument)
  64         : m_pDocument(pDocument)
  65     {
  66     }
  67
  68     void check();
  69
  70     std::vector<std::unique_ptr<GraphicSizeViolation>>& getViolationList()
  71     {
  72         return m_aGraphicSizeViolationList;
  73     }
  74 };
  75
  76 /** The UI part of the GraphicSizeViolation used by GenericCheckDialog */
  77 class GraphicSizeCheckGUIEntry : public svx::CheckData
  78 {
  79 private:
  80     SdDrawDocument* m_pDocument;
  81     std::unique_ptr<GraphicSizeViolation> m_pViolation;
  82
  83 public:
  84     GraphicSizeCheckGUIEntry(SdDrawDocument* pDocument,
  85                              std::unique_ptr<GraphicSizeViolation>&& pViolation)
  86         : m_pDocument(pDocument)
  87         , m_pViolation(std::move(pViolation))
  88     {
  89     }
  90
  91     OUString getText() override;
  92
  93     bool canMarkObject() override { return true; }
  94
  95     void markObject() override;
  96
  97     bool hasProperties() override { return true; }
  98
  99     void runProperties() override;
 100 };
 101
 102 /**
 103  * The UI part presenting the graphic size check results, which is
 104  * used by GenericCheckDialog
 105  */
 106 class GraphicSizeCheckGUIResult : public svx::CheckDataCollection
 107 {
 108 public:
 109     GraphicSizeCheckGUIResult(SdDrawDocument* m_pDocument);
 110
 111     OUString getTitle() override;
 112 };
 113
 114 } // end of namespace sd
 115
 116 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */