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 #ifndef INCLUDED_CHART2_SOURCE_CONTROLLER_INC_ACCESSIBLETEXTHELPER_HXX
  20 #define INCLUDED_CHART2_SOURCE_CONTROLLER_INC_ACCESSIBLETEXTHELPER_HXX
  21
  22 #include "MutexContainer.hxx"
  23 #include <cppuhelper/compbase2.hxx>
  24 #include <com/sun/star/lang/XInitialization.hpp>
  25 #include <com/sun/star/accessibility/XAccessibleContext.hpp>
  26
  27 // forward declaration of helper class from svx
  28 namespace accessibility
  29 {
  30 class AccessibleTextHelper;
  31 }
  32
  33 namespace chart
  34 {
  35
  36 class DrawViewWrapper;
  37
  38 namespace impl
  39 {
  40 typedef ::cppu::WeakComponentImplHelper2<
  41         ::com::sun::star::lang::XInitialization,
  42         ::com::sun::star::accessibility::XAccessibleContext >
  43     AccessibleTextHelper_Base;
  44 }
  45
  46 class AccessibleTextHelper :
  47         public MutexContainer,
  48         public impl::AccessibleTextHelper_Base
  49 {
  50 public:
  51     explicit AccessibleTextHelper( DrawViewWrapper * pDrawViewWrapper );
  52     virtual ~AccessibleTextHelper();
  53
  54     // ____ XInitialization ____
  55     /** Must be called at least once for this helper class to work.
  56
  57         mandatory parameter 0: type string. This is the CID that is used to find
  58             the corresponding drawing object that contains the text that should
  59             be handled by this helper class.
  60 1
  61         mandatory parameter 1: type XAccessible.  Is used as EventSource for the
  62             ::accessibility::AccessibleTextHelper (svx)
  63
  64         mandatory parameter 2: type awt::XWindow.  The Window that shows the
  65             text currently.
  66      */
  67     virtual void SAL_CALL initialize(
  68         const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any >& aArguments )
  69         throw (::com::sun::star::uno::Exception,
  70                ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
  71
  72     // ____ XAccessibleContext ____
  73     virtual ::sal_Int32 SAL_CALL getAccessibleChildCount()
  74         throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
  75     virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible > SAL_CALL getAccessibleChild(
  76         ::sal_Int32 i )
  77         throw (::com::sun::star::lang::IndexOutOfBoundsException,
  78                ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
  79     virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible > SAL_CALL getAccessibleParent()
  80         throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
  81     virtual ::sal_Int32 SAL_CALL getAccessibleIndexInParent()
  82         throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
  83     virtual ::sal_Int16 SAL_CALL getAccessibleRole()
  84         throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
  85     virtual OUString SAL_CALL getAccessibleDescription()
  86         throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
  87     virtual OUString SAL_CALL getAccessibleName()
  88         throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
  89     virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessibleRelationSet > SAL_CALL getAccessibleRelationSet()
  90         throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
  91     virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessibleStateSet > SAL_CALL getAccessibleStateSet()
  92         throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
  93     virtual ::com::sun::star::lang::Locale SAL_CALL getLocale()
  94         throw (::com::sun::star::accessibility::IllegalAccessibleComponentStateException,
  95                ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
  96
  97 private:
  98     ::accessibility::AccessibleTextHelper * m_pTextHelper;
  99     DrawViewWrapper *                       m_pDrawViewWrapper;
 100 };
 101
 102 } //  namespace chart
 103
 104 // INCLUDED_CHART2_SOURCE_CONTROLLER_INC_ACCESSIBLETEXTHELPER_HXX
 105 #endif
 106
 107 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */