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