Quelle  AccessibilityIssue.hxx

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 */

#pragma once

#include <sfx2/dllapi.h>

#include <vcl/weld.hxx>
#include <rtl/ustring.hxx>

#include <vector>
#include <memory>

namespace sfx
{
enum class AccessibilityIssueID
{
    DOCUMENT_TITLE,
    DOCUMENT_LANGUAGE,
    DOCUMENT_BACKGROUND,
    STYLE_LANGUAGE,
    LINKED_GRAPHIC,
    NO_ALT_OLE,
    NO_ALT_GRAPHIC,
    NO_ALT_SHAPE,
    TABLE_MERGE_SPLIT,
    TEXT_NEW_LINES,
    TEXT_SPACES,
    TEXT_TABS,
    TEXT_EMPTY_NUM_PARA,
    DIRECT_FORMATTING,
    TABLE_FORMATTING,
    HYPERLINK_IS_TEXT,
    HYPERLINK_SHORT,
    HYPERLINK_NO_NAME,
    LINK_IN_HEADER_FOOTER,
    FAKE_FOOTNOTE,
    FAKE_CAPTION,
    MANUAL_NUMBERING,
    TEXT_CONTRAST,
    TEXT_BLINKING,
    HEADINGS_NOT_IN_ORDER,
    NON_INTERACTIVE_FORMS,
    FLOATING_TEXT,
    HEADING_IN_TABLE,
    HEADING_START,
    HEADING_ORDER,
    CONTENT_CONTROL,
    AVOID_FOOTNOTES,
    AVOID_ENDNOTES,
    FONTWORKS,
};

enum class AccessibilityIssueLevel : size_t
{
    ERRORLEV = 0,
    WARNLEV = 1,
    LAST = WARNLEV
};

class SFX2_DLLPUBLIC AccessibilityIssue
{
public:
    AccessibilityIssue(AccessibilityIssueID eIssueID, AccessibilityIssueLevel eIssueLvl);
    AccessibilityIssue(AccessibilityIssue const&) = default;
    virtual ~AccessibilityIssue();

    virtual bool canGotoIssue() const = 0;
    virtual void gotoIssue() const = 0;

    virtual bool canQuickFixIssue() const = 0;
    virtual void quickFixIssue() const = 0;

    void setParent(weld::Window* pParent) { m_pParent = pParent; }

    void setHidden(bool bHidden) { m_bHidden = bHidden; }
    bool getHidden() const { return m_bHidden; }

    AccessibilityIssue& operator=(const AccessibilityIssue&) = default;

    AccessibilityIssueID m_eIssueID;
    AccessibilityIssueLevel m_eIssueLvl;
    OUString m_aIssueText;
    bool m_bHidden;

    weld::Window* m_pParent;
};

class SFX2_DLLPUBLIC AccessibilityIssueCollection
{
private:
    std::vector<std::shared_ptr<AccessibilityIssue>> m_aIssues;

public:
    AccessibilityIssueCollection() = default;

    std::vector<std::shared_ptr<AccessibilityIssue>>& getIssues();

    void clear();
};

} // end sfx namespace

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */