chart2/source/controller/inc/AccessibleTextHelper.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  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #pragma once
  20
  21 #include <memory>
  22 #include <comphelper/compbase.hxx>
  23 #include <com/sun/star/accessibility/XAccessibleContext.hpp>
  24 #include <com/sun/star/awt/XWindow.hpp>
  25
  26 // forward declaration of helper class from svx
  27 namespace accessibility
  28 {
  29 class AccessibleTextHelper;
  30 }
  31
  32 namespace chart
  33 {
  34
  35 class DrawViewWrapper;
  36
  37 namespace impl
  38 {
  39 typedef comphelper::WeakComponentImplHelper<
  40         css::accessibility::XAccessibleContext >
  41     AccessibleTextHelper_Base;
  42 }
  43
  44 class AccessibleTextHelper final :
  45         public impl::AccessibleTextHelper_Base
  46 {
  47 public:
  48     explicit AccessibleTextHelper( DrawViewWrapper * pDrawViewWrapper );
  49     virtual ~AccessibleTextHelper() override;
  50
  51     /** Must be called at least once for this helper class to work.
  52
  53         mandatory parameter 0: type string. This is the CID that is used to find
  54             the corresponding drawing object that contains the text that should
  55             be handled by this helper class.
  56 1
  57         mandatory parameter 1: type XAccessible.  Is used as EventSource for the
  58             ::accessibility::AccessibleTextHelper (svx)
  59
  60         mandatory parameter 2: type awt::XWindow.  The Window that shows the
  61             text currently.
  62      */
  63     void initialize(const OUString& aCID,
  64                     const css::uno::Reference< css::accessibility::XAccessible >& xEventSource,
  65                     const css::uno::Reference< css::awt::XWindow >& xWindow );
  66
  67     // ____ XAccessibleContext ____
  68     virtual sal_Int64 SAL_CALL getAccessibleChildCount() override;
  69     virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL getAccessibleChild(
  70         sal_Int64 i ) override;
  71     virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL getAccessibleParent() override;
  72     virtual sal_Int64 SAL_CALL getAccessibleIndexInParent() override;
  73     virtual ::sal_Int16 SAL_CALL getAccessibleRole() override;
  74     virtual OUString SAL_CALL getAccessibleDescription() override;
  75     virtual OUString SAL_CALL getAccessibleName() override;
  76     virtual css::uno::Reference< css::accessibility::XAccessibleRelationSet > SAL_CALL getAccessibleRelationSet() override;
  77     virtual sal_Int64 SAL_CALL getAccessibleStateSet() override;
  78     virtual css::lang::Locale SAL_CALL getLocale() override;
  79
  80 private:
  81     std::unique_ptr<::accessibility::AccessibleTextHelper> m_pTextHelper;
  82     DrawViewWrapper *                                      m_pDrawViewWrapper;
  83 };
  84
  85 } //  namespace chart
  86
  87 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */