sc/source/ui/Accessibility/AccessiblePageHeaderArea.cxx

   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
  20 #include <sal/config.h>
  21
  22 #include <tools/gen.hxx>
  23 #include <AccessiblePageHeaderArea.hxx>
  24 #include <AccessibleText.hxx>
  25 #include <editsrc.hxx>
  26 #include <prevwsh.hxx>
  27 #include <scresid.hxx>
  28 #include <strings.hrc>
  29 #include <strings.hxx>
  30
  31 #include <com/sun/star/accessibility/AccessibleRole.hpp>
  32 #include <com/sun/star/accessibility/AccessibleStateType.hpp>
  33 #include <com/sun/star/accessibility/AccessibleEventId.hpp>
  34 #include <comphelper/sequence.hxx>
  35 #include <editeng/editobj.hxx>
  36 #include <svx/AccessibleTextHelper.hxx>
  37 #include <vcl/svapp.hxx>
  38 #include <vcl/unohelp.hxx>
  39
  40 using namespace ::com::sun::star;
  41 using namespace ::com::sun::star::accessibility;
  42
  43     //=====  internal  ========================================================
  44
  45 ScAccessiblePageHeaderArea::ScAccessiblePageHeaderArea(
  46         const uno::Reference<XAccessible>& rxParent,
  47         ScPreviewShell* pViewShell,
  48         const EditTextObject* pEditObj,
  49         SvxAdjust eAdjust)
  50         : ScAccessibleContextBase(rxParent, AccessibleRole::TEXT),
  51         mpEditObj(pEditObj->Clone()),
  52         mpViewShell(pViewShell),
  53         meAdjust(eAdjust)
  54 {
  55     if (mpViewShell)
  56         mpViewShell->AddAccessibilityObject(*this);
  57 }
  58
  59 ScAccessiblePageHeaderArea::~ScAccessiblePageHeaderArea()
  60 {
  61     if (!ScAccessibleContextBase::IsDefunc() && !rBHelper.bInDispose)
  62     {
  63         // increment refcount to prevent double call off dtor
  64         osl_atomic_increment( &m_refCount );
  65         dispose();
  66     }
  67 }
  68
  69 void SAL_CALL ScAccessiblePageHeaderArea::disposing()
  70 {
  71     SolarMutexGuard aGuard;
  72     if (mpViewShell)
  73     {
  74         mpViewShell->RemoveAccessibilityObject(*this);
  75         mpViewShell = nullptr;
  76     }
  77     mpTextHelper.reset();
  78     mpEditObj.reset();
  79     ScAccessibleContextBase::disposing();
  80 }
  81
  82 //=====  SfxListener  =====================================================
  83
  84 void ScAccessiblePageHeaderArea::Notify( SfxBroadcaster& rBC, const SfxHint& rHint )
  85 {
  86     // only notify if child exist, otherwise it is not necessary
  87     if (rHint.GetId() == SfxHintId::ScAccVisAreaChanged)
  88     {
  89         if (mpTextHelper)
  90             mpTextHelper->UpdateChildren();
  91
  92         AccessibleEventObject aEvent;
  93         aEvent.EventId = AccessibleEventId::VISIBLE_DATA_CHANGED;
  94         aEvent.Source = uno::Reference< XAccessibleContext >(this);
  95         CommitChange(aEvent);
  96     }
  97     ScAccessibleContextBase::Notify(rBC, rHint);
  98 }
  99     //=====  XAccessibleComponent  ============================================
 100
 101 uno::Reference< XAccessible > SAL_CALL ScAccessiblePageHeaderArea::getAccessibleAtPoint(
 102         const awt::Point& rPoint )
 103 {
 104     uno::Reference<XAccessible> xRet;
 105     if (containsPoint(rPoint))
 106     {
 107         SolarMutexGuard aGuard;
 108         IsObjectValid();
 109
 110         if(!mpTextHelper)
 111             CreateTextHelper();
 112
 113         xRet = mpTextHelper->GetAt(rPoint);
 114     }
 115
 116     return xRet;
 117 }
 118
 119     //=====  XAccessibleContext  ==============================================
 120
 121 sal_Int64 SAL_CALL
 122     ScAccessiblePageHeaderArea::getAccessibleChildCount()
 123 {
 124     SolarMutexGuard aGuard;
 125     IsObjectValid();
 126     if (!mpTextHelper)
 127         CreateTextHelper();
 128     return mpTextHelper->GetChildCount();
 129 }
 130
 131 uno::Reference< XAccessible > SAL_CALL
 132     ScAccessiblePageHeaderArea::getAccessibleChild(sal_Int64 nIndex)
 133 {
 134     SolarMutexGuard aGuard;
 135     IsObjectValid();
 136     if (!mpTextHelper)
 137         CreateTextHelper();
 138     return mpTextHelper->GetChild(nIndex);
 139 }
 140
 141 sal_Int64 SAL_CALL ScAccessiblePageHeaderArea::getAccessibleStateSet()
 142 {
 143     SolarMutexGuard aGuard;
 144     sal_Int64 nStateSet = 0;
 145     if (IsDefunc())
 146         nStateSet |= AccessibleStateType::DEFUNC;
 147     else
 148     {
 149         nStateSet |= AccessibleStateType::ENABLED;
 150         nStateSet |= AccessibleStateType::MULTI_LINE;
 151         if (isShowing())
 152             nStateSet |= AccessibleStateType::SHOWING;
 153         if (isVisible())
 154             nStateSet |= AccessibleStateType::VISIBLE;
 155     }
 156     return nStateSet;
 157 }
 158
 159 // XServiceInfo
 160
 161 OUString SAL_CALL
 162        ScAccessiblePageHeaderArea::getImplementationName()
 163 {
 164     return u"ScAccessiblePageHeaderArea"_ustr;
 165 }
 166
 167 uno::Sequence< OUString> SAL_CALL
 168        ScAccessiblePageHeaderArea::getSupportedServiceNames()
 169 {
 170     const css::uno::Sequence<OUString> vals { u"com.sun.star.sheet.AccessiblePageHeaderFooterAreasView"_ustr };
 171     return comphelper::concatSequences(ScAccessibleContextBase::getSupportedServiceNames(), vals);
 172 }
 173
 174 //=====  XTypeProvider  =======================================================
 175
 176 uno::Sequence<sal_Int8> SAL_CALL
 177     ScAccessiblePageHeaderArea::getImplementationId()
 178 {
 179     return css::uno::Sequence<sal_Int8>();
 180 }
 181
 182 //===== internal ==============================================================
 183 OUString ScAccessiblePageHeaderArea::createAccessibleDescription()
 184 {
 185     OUString sDesc;
 186     switch (meAdjust)
 187     {
 188     case SvxAdjust::Left :
 189         sDesc = STR_ACC_LEFTAREA_DESCR;
 190         break;
 191     case SvxAdjust::Right:
 192         sDesc = STR_ACC_RIGHTAREA_DESCR;
 193         break;
 194     case SvxAdjust::Center:
 195         sDesc = STR_ACC_CENTERAREA_DESCR;
 196         break;
 197     default:
 198         OSL_FAIL("wrong adjustment found");
 199     }
 200
 201     return sDesc;
 202 }
 203
 204 OUString ScAccessiblePageHeaderArea::createAccessibleName()
 205 {
 206     OUString sName;
 207     switch (meAdjust)
 208     {
 209     case SvxAdjust::Left :
 210         sName = ScResId(STR_ACC_LEFTAREA_NAME);
 211         break;
 212     case SvxAdjust::Right:
 213         sName = ScResId(STR_ACC_RIGHTAREA_NAME);
 214         break;
 215     case SvxAdjust::Center:
 216         sName = ScResId(STR_ACC_CENTERAREA_NAME);
 217         break;
 218     default:
 219         OSL_FAIL("wrong adjustment found");
 220     }
 221
 222     return sName;
 223 }
 224
 225 AbsoluteScreenPixelRectangle ScAccessiblePageHeaderArea::GetBoundingBoxOnScreen() const
 226 {
 227     AbsoluteScreenPixelRectangle aRect;
 228     if (mxParent.is())
 229     {
 230         uno::Reference<XAccessibleContext> xContext = mxParent->getAccessibleContext();
 231         uno::Reference<XAccessibleComponent> xComp(xContext, uno::UNO_QUERY);
 232         if (xComp.is())
 233         {
 234             // has the same size and position on screen like the parent
 235             aRect = AbsoluteScreenPixelRectangle(
 236                 AbsoluteScreenPixelPoint(
 237                     vcl::unohelper::ConvertToVCLPoint(xComp->getLocationOnScreen())),
 238                 AbsoluteScreenPixelSize(
 239                     vcl::unohelper::ConvertToVCLRect(xComp->getBounds()).GetSize()));
 240         }
 241     }
 242     return aRect;
 243 }
 244
 245 tools::Rectangle ScAccessiblePageHeaderArea::GetBoundingBox() const
 246 {
 247     tools::Rectangle aRect;
 248     if (mxParent.is())
 249     {
 250         uno::Reference<XAccessibleContext> xContext = mxParent->getAccessibleContext();
 251         uno::Reference<XAccessibleComponent> xComp(xContext, uno::UNO_QUERY);
 252         if (xComp.is())
 253         {
 254             // has the same size and position on screen like the parent and so the pos is (0, 0)
 255             tools::Rectangle aNewRect(Point(0, 0),
 256                                       vcl::unohelper::ConvertToVCLRect(xComp->getBounds()).GetSize());
 257             aRect = aNewRect;
 258         }
 259     }
 260
 261     return aRect;
 262 }
 263
 264 void ScAccessiblePageHeaderArea::CreateTextHelper()
 265 {
 266     if (!mpTextHelper)
 267     {
 268         mpTextHelper.reset( new ::accessibility::AccessibleTextHelper(
 269             std::make_unique<ScAccessibilityEditSource>(
 270                 std::make_unique<ScAccessibleHeaderTextData>(
 271                     mpViewShell, mpEditObj.get(), meAdjust))) );
 272         mpTextHelper->SetEventSource(this);
 273     }
 274 }
 275
 276 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */