winaccessibility/source/service/AccEventListener.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 <cppuhelper/bootstrap.hxx>
  21 #include <com/sun/star/bridge/XUnoUrlResolver.hpp>
  22 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  23
  24 #include <vcl/svapp.hxx>
  25
  26 #include <AccEventListener.hxx>
  27 #include <AccObjectManagerAgent.hxx>
  28 #include <unomsaaevent.hxx>
  29
  30 #include <com/sun/star/accessibility/XAccessible.hpp>
  31 #include <com/sun/star/accessibility/AccessibleStateType.hpp>
  32 #include <com/sun/star/accessibility/AccessibleEventId.hpp>
  33 #include <com/sun/star/accessibility/AccessibleRole.hpp>
  34 #include <com/sun/star/accessibility/XAccessibleEventBroadcaster.hpp>
  35 #include <com/sun/star/accessibility/XAccessibleComponent.hpp>
  36
  37 #include <stdio.h>
  38
  39 using namespace com::sun::star::uno;
  40 using namespace com::sun::star::accessibility;
  41 using namespace cppu;
  42
  43 AccEventListener::AccEventListener(css::accessibility::XAccessible* pAcc,
  44                                    AccObjectManagerAgent* Agent)
  45     : m_xAccessible(pAcc)
  46     , pAgent(Agent)
  47 {
  48 }
  49
  50 AccEventListener::~AccEventListener() {}
  51
  52 /**
  53  *  Uno's event notifier when event is captured
  54  *  @param AccessibleEventObject    the event object which contains information about event
  55  */
  56 void AccEventListener::notifyEvent(const css::accessibility::AccessibleEventObject& aEvent)
  57 {
  58     SolarMutexGuard g;
  59
  60     switch (aEvent.EventId)
  61     {
  62         case AccessibleEventId::NAME_CHANGED:
  63             HandleNameChangedEvent(aEvent.NewValue);
  64             break;
  65         case AccessibleEventId::DESCRIPTION_CHANGED:
  66             HandleDescriptionChangedEvent();
  67             break;
  68         case AccessibleEventId::STATE_CHANGED:
  69             HandleStateChangedEvent(aEvent.OldValue, aEvent.NewValue);
  70             break;
  71         default:
  72             break;
  73     }
  74 }
  75
  76 /**
  77  *  handle the NAME_CHANGED event
  78  *  @param  name        the new name with changed.
  79  */
  80 void AccEventListener::HandleNameChangedEvent(Any name)
  81 {
  82     if (pAgent->IsTopWinAcc(m_xAccessible.get()))
  83     {
  84         XAccessible* pAccDoc = pAgent->GetAccDocByAccTopWin(m_xAccessible.get());
  85         if (pAccDoc)
  86         {
  87             pAgent->UpdateAccName(pAccDoc);
  88             pAgent->NotifyAccEvent(UnoMSAAEvent::OBJECT_NAMECHANGE, pAccDoc);
  89         }
  90     }
  91
  92     pAgent->UpdateAccName(m_xAccessible.get(), name);
  93     pAgent->NotifyAccEvent(UnoMSAAEvent::OBJECT_NAMECHANGE, m_xAccessible.get());
  94 }
  95
  96 /**
  97  *  handle the DESCRIPTION_CHANGED event
  98  */
  99 void AccEventListener::HandleDescriptionChangedEvent()
 100 {
 101     pAgent->NotifyAccEvent(UnoMSAAEvent::OBJECT_DESCRIPTIONCHANGE, m_xAccessible.get());
 102 }
 103
 104 /**
 105  *  handle the BOUNDRECT_CHANGED event
 106  */
 107 void AccEventListener::HandleBoundrectChangedEvent()
 108 {
 109     pAgent->NotifyAccEvent(UnoMSAAEvent::BOUNDRECT_CHANGED, m_xAccessible.get());
 110 }
 111
 112 /**
 113  *  handle the VISIBLE_DATA_CHANGED event
 114  */
 115 void AccEventListener::HandleVisibleDataChangedEvent()
 116 {
 117     pAgent->UpdateValue(m_xAccessible.get());
 118     pAgent->NotifyAccEvent(UnoMSAAEvent::VISIBLE_DATA_CHANGED, m_xAccessible.get());
 119 }
 120
 121 /**
 122  *  handle the STATE_CHANGED event
 123  *  @param  oldValue    the old state of the source of event
 124  *  @param  newValue    the new state of the source of event
 125  */
 126 void AccEventListener::HandleStateChangedEvent(Any oldValue, Any newValue)
 127 {
 128     sal_Int64 newV, oldV;
 129     if (newValue >>= newV)
 130     {
 131         SetComponentState(newV, true);
 132     }
 133     else if (oldValue >>= oldV)
 134     {
 135         SetComponentState(oldV, false);
 136     }
 137 }
 138
 139 /**
 140  *  set the new state and fire the MSAA event
 141  *  @param  state       new state id
 142  *  @param  enable      true if state is set, false if state is unset
 143  */
 144 void AccEventListener::SetComponentState(sal_Int64 state, bool enable)
 145 {
 146     switch (state)
 147     {
 148         case AccessibleStateType::FOCUSED:
 149             FireStateFocusedChange(enable);
 150             break;
 151         default:
 152             FireStatePropertyChange(state, enable);
 153             break;
 154     }
 155 }
 156
 157 /**
 158  *  handle the focused event
 159  *  @param enable   true if get focus, false if lose focus
 160  */
 161 void AccEventListener::FireStateFocusedChange(bool enable)
 162 {
 163     if (enable)
 164     {
 165         pAgent->IncreaseState(m_xAccessible.get(), AccessibleStateType::FOCUSED);
 166         pAgent->NotifyAccEvent(UnoMSAAEvent::STATE_FOCUSED, m_xAccessible.get());
 167     }
 168     else
 169     {
 170         // no focus lost event in MSAA
 171     }
 172 }
 173
 174 /**
 175  *  fire the MSAA state changed event
 176  *  @param state    the state id
 177  *  @param set      true if state is set, false if state is unset
 178  */
 179 void AccEventListener::FireStatePropertyChange(sal_Int64 /*state*/, bool set)
 180 {
 181     if (set)
 182     {
 183         //get new state
 184     }
 185     else
 186     {
 187         //lose old state
 188     }
 189 }
 190
 191 /**
 192  *  get the role of accessible object which is observed
 193  */
 194 short AccEventListener::GetRole()
 195 {
 196     css::uno::Reference<css::accessibility::XAccessibleContext> const xContext(
 197         m_xAccessible->getAccessibleContext());
 198     if (xContext.is())
 199     {
 200         return xContext->getAccessibleRole();
 201     }
 202     return -1;
 203 }
 204
 205 /**
 206  *  get the role of accessible parent object which is observed
 207  */
 208 short AccEventListener::GetParentRole()
 209 {
 210     if (m_xAccessible.is())
 211     {
 212         return pAgent->GetParentRole(m_xAccessible.get());
 213     }
 214     return -1;
 215 }
 216 /**
 217  *  remove the listener from accessible object
 218  */
 219 void AccEventListener::RemoveMeFromBroadcaster(bool const isNotifyDestroy)
 220 {
 221     try
 222     {
 223         if (!m_xAccessible.is())
 224         {
 225             return;
 226         }
 227         try
 228         {
 229             css::uno::Reference<XAccessibleEventBroadcaster> const xBroadcaster(
 230                 m_xAccessible->getAccessibleContext(), UNO_QUERY);
 231             if (xBroadcaster.is())
 232             {
 233                 //remove the lister from accessible object
 234                 xBroadcaster->removeAccessibleEventListener(this);
 235             }
 236         }
 237         catch (Exception const&)
 238         { // may throw if it's already disposed - ignore that
 239         }
 240         if (isNotifyDestroy)
 241         {
 242             pAgent->NotifyDestroy(m_xAccessible.get());
 243         }
 244         m_xAccessible.clear(); // release cyclic reference
 245     }
 246     catch (...)
 247     {
 248         return;
 249     }
 250 }
 251
 252 /**
 253  *  this method is invoked before listener is disposed
 254  */
 255 void AccEventListener::disposing(const css::lang::EventObject& /*Source*/)
 256 {
 257     SolarMutexGuard g;
 258
 259     RemoveMeFromBroadcaster(true);
 260 }
 261
 262 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */