include/sfx2/AccessibilityIssue.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 <sfx2/dllapi.h>
  14
  15 #include <vcl/weld.hxx>
  16 #include <rtl/ustring.hxx>
  17
  18 #include <vector>
  19 #include <memory>
  20
  21 namespace sfx
  22 {
  23 enum class AccessibilityIssueID
  24 {
  25     DOCUMENT_TITLE,
  26     DOCUMENT_LANGUAGE,
  27     DOCUMENT_BACKGROUND,
  28     STYLE_LANGUAGE,
  29     LINKED_GRAPHIC,
  30     NO_ALT_OLE,
  31     NO_ALT_GRAPHIC,
  32     NO_ALT_SHAPE,
  33     TABLE_MERGE_SPLIT,
  34     TEXT_FORMATTING,
  35     DIRECT_FORMATTING,
  36     TABLE_FORMATTING,
  37     HYPERLINK_IS_TEXT,
  38     HYPERLINK_SHORT,
  39     HYPERLINK_NO_NAME,
  40     FAKE_FOOTNOTE,
  41     FAKE_CAPTION,
  42     MANUAL_NUMBERING,
  43     TEXT_CONTRAST,
  44     TEXT_BLINKING,
  45     HEADINGS_NOT_IN_ORDER,
  46     NON_INTERACTIVE_FORMS,
  47     FLOATING_TEXT,
  48     HEADING_IN_TABLE,
  49     HEADING_START,
  50     HEADING_ORDER,
  51     CONTENT_CONTROL,
  52     AVOID_FOOTNOTES,
  53     AVOID_ENDNOTES,
  54     FONTWORKS,
  55 };
  56
  57 class SFX2_DLLPUBLIC AccessibilityIssue
  58 {
  59 public:
  60     AccessibilityIssue(AccessibilityIssueID eIssueID);
  61     AccessibilityIssue(AccessibilityIssue const&) = default;
  62     virtual ~AccessibilityIssue();
  63
  64     virtual bool canGotoIssue() const = 0;
  65     virtual void gotoIssue() const = 0;
  66
  67     virtual bool canQuickFixIssue() const = 0;
  68     virtual void quickFixIssue() const = 0;
  69
  70     void setParent(weld::Window* pParent) { m_pParent = pParent; }
  71
  72     void setHidden(bool bHidden) { m_bHidden = bHidden; }
  73     bool getHidden() const { return m_bHidden; }
  74
  75     AccessibilityIssue& operator=(const AccessibilityIssue&) = default;
  76
  77     AccessibilityIssueID m_eIssueID;
  78     OUString m_aIssueText;
  79     bool m_bHidden;
  80
  81     weld::Window* m_pParent;
  82 };
  83
  84 class SFX2_DLLPUBLIC AccessibilityIssueCollection
  85 {
  86 private:
  87     std::vector<std::shared_ptr<AccessibilityIssue>> m_aIssues;
  88
  89 public:
  90     AccessibilityIssueCollection() = default;
  91
  92     std::vector<std::shared_ptr<AccessibilityIssue>>& getIssues();
  93
  94     void clear();
  95 };
  96
  97 } // end sfx namespace
  98
  99 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */