winaccessibility/source/service/AccComponentEventListener.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 <com/sun/star/accessibility/XAccessible.hpp>
  21 #include <com/sun/star/accessibility/AccessibleStateType.hpp>
  22 #include <com/sun/star/accessibility/AccessibleEventId.hpp>
  23 #include <com/sun/star/accessibility/AccessibleRole.hpp>
  24 #include <com/sun/star/accessibility/XAccessibleEventBroadcaster.hpp>
  25
  26 #include <vcl/svapp.hxx>
  27
  28 #include <AccComponentEventListener.hxx>
  29 #include <AccObjectManagerAgent.hxx>
  30 #include <unomsaaevent.hxx>
  31
  32 using namespace com::sun::star::uno;
  33 using namespace com::sun::star::accessibility;
  34
  35 AccComponentEventListener::AccComponentEventListener(css::accessibility::XAccessible* pAcc, AccObjectManagerAgent* Agent)
  36         :AccEventListener(pAcc, Agent)
  37 {
  38 }
  39
  40 AccComponentEventListener::~AccComponentEventListener()
  41 {
  42 }
  43
  44 /**
  45  * Uno's event notifier when event is captured
  46  *
  47  * @param   AccessibleEventObject   the event object which contains information about event
  48  */
  49 void  AccComponentEventListener::notifyEvent( const css::accessibility::AccessibleEventObject& aEvent )
  50 {
  51     SolarMutexGuard g;
  52
  53     switch (aEvent.EventId)
  54     {
  55     case AccessibleEventId::VALUE_CHANGED:
  56         HandleValueChangedEvent(aEvent.OldValue, aEvent.NewValue);
  57         break;
  58     case AccessibleEventId::ACTION_CHANGED:
  59         HandleActionChangedEvent();
  60         break;
  61     case AccessibleEventId::TEXT_CHANGED:
  62         HandleTextChangedEvent(aEvent.OldValue, aEvent.NewValue);
  63         break;
  64     case AccessibleEventId::CARET_CHANGED:
  65         HandleCaretChangedEvent(aEvent.OldValue, aEvent.NewValue);
  66         break;
  67     case AccessibleEventId::VISIBLE_DATA_CHANGED:
  68         HandleVisibleDataChangedEvent();
  69         break;
  70     case AccessibleEventId::BOUNDRECT_CHANGED:
  71         HandleBoundrectChangedEvent();
  72         break;
  73     case AccessibleEventId::SELECTION_CHANGED:
  74         HandleSelectionChangedEventNoArgs();
  75         break;
  76         //to add TEXT_SELECTION_CHANGED event
  77     case AccessibleEventId::TEXT_SELECTION_CHANGED:
  78         HandleTextSelectionChangedEvent();
  79         break;
  80         //End
  81     default:
  82         AccEventListener::notifyEvent(aEvent);
  83         break;
  84     }
  85 }
  86
  87 /**
  88  * handle the VALUE_CHANGED event
  89  *
  90  * @param   oldValue    the old value of the source of event
  91  * @param   newValue    the new value of the source of event
  92  */
  93 void AccComponentEventListener::HandleValueChangedEvent(Any, Any)
  94 {
  95     pAgent->UpdateValue(m_xAccessible.get());
  96     pAgent->NotifyAccEvent(UM_EVENT_OBJECT_VALUECHANGE, m_xAccessible.get());
  97 }
  98
  99 /**
 100  * handle the NAME_CHANGED event
 101  */
 102 void AccComponentEventListener::HandleActionChangedEvent()
 103 {
 104     pAgent->UpdateAction(m_xAccessible.get());
 105     pAgent->NotifyAccEvent(UM_EVENT_OBJECT_DEFACTIONCHANGE, m_xAccessible.get());
 106 }
 107
 108 /**
 109  * handle the TEXT_CHANGED event
 110  *
 111  * @param   oldValue    the old value of the source of event
 112  * @param   newValue    the new value of the source of event
 113  */
 114 void AccComponentEventListener::HandleTextChangedEvent(Any, Any newValue)
 115 {
 116     pAgent->UpdateValue(m_xAccessible.get(), newValue);
 117     pAgent->NotifyAccEvent(UM_EVENT_OBJECT_VALUECHANGE, m_xAccessible.get());
 118 }
 119
 120 /**
 121  * handle the CARET_CHANGED event
 122  *
 123  * @param   oldValue    the old value of the source of event
 124  * @param   newValue    the new value of the source of event
 125  */
 126 void AccComponentEventListener::HandleCaretChangedEvent(Any, Any)
 127 {
 128     pAgent->NotifyAccEvent(UM_EVENT_OBJECT_CARETCHANGE, m_xAccessible.get());
 129 }
 130
 131 /**
 132  * set the new state and fire the MSAA event
 133  *
 134  * @param   state   new state id
 135  * @param   enable  true if state is set, false if state is unset
 136  */
 137 void AccComponentEventListener::SetComponentState(short state, bool enable)
 138 {
 139     // only the following state can be fired state event.
 140     switch (state)
 141     {
 142     case AccessibleStateType::CHECKED:
 143     case AccessibleStateType::PRESSED:
 144     case AccessibleStateType::SELECTED:
 145     case AccessibleStateType::ARMED:
 146     case AccessibleStateType::INDETERMINATE:
 147     case AccessibleStateType::SHOWING:
 148         FireStatePropertyChange(state, enable);
 149         break;
 150     case AccessibleStateType::VISIBLE:
 151         if (GetRole() == AccessibleRole::MENU_ITEM)
 152         {
 153             if(enable)
 154             {
 155                 pAgent->IncreaseState(m_xAccessible.get(), AccessibleStateType::VISIBLE);
 156                 pAgent->IncreaseState(m_xAccessible.get(), AccessibleStateType::FOCUSABLE);
 157             }
 158             else
 159             {
 160                 pAgent->DecreaseState(m_xAccessible.get(), AccessibleStateType::VISIBLE);
 161                 pAgent->DecreaseState(m_xAccessible.get(), AccessibleStateType::FOCUSABLE);
 162             }
 163         }
 164         else
 165         {
 166             FireStatePropertyChange(state, enable);
 167         }
 168         break;
 169     case AccessibleStateType::FOCUSED:
 170         FireStateFocusedChange(enable);
 171         break;
 172     case AccessibleStateType::ENABLED:
 173         if(enable)
 174         {
 175             pAgent->UpdateState(m_xAccessible.get());
 176             pAgent->DecreaseState(m_xAccessible.get(), AccessibleStateType::DEFUNC);
 177             // 8. label should have no FOCUSABLE state, Firefox has READONLY state, we can also have.
 178             if (    GetRole() != AccessibleRole::LABEL
 179                 &&  GetRole() != AccessibleRole::STATIC
 180                 &&  GetRole() != AccessibleRole::SCROLL_BAR)
 181             {
 182                 pAgent->IncreaseState(m_xAccessible.get(), AccessibleStateType::FOCUSABLE);
 183             }
 184         }
 185         else
 186         {
 187             pAgent->UpdateState(m_xAccessible.get());
 188             pAgent->IncreaseState(m_xAccessible.get(), AccessibleStateType::DEFUNC);
 189             pAgent->DecreaseState(m_xAccessible.get(), AccessibleStateType::FOCUSABLE);
 190         }
 191         break;
 192     case AccessibleStateType::ACTIVE:
 193         // Only frames should be active
 194         // no msaa state mapping
 195         break;
 196     default:
 197         break;
 198     }
 199 }
 200
 201 /**
 202  * fire the MSAA state changed event
 203  *
 204  * @param   state   the state id
 205  * @param   set     true if state is set, false if state is unset
 206  */
 207 void AccComponentEventListener::FireStatePropertyChange(short state, bool set)
 208 {
 209     if( set)
 210         {
 211             // new value
 212             switch(state)
 213             {
 214             case AccessibleStateType::CHECKED:
 215             case AccessibleStateType::INDETERMINATE:
 216                 pAgent->IncreaseState(m_xAccessible.get(), state);
 217                 pAgent->UpdateAction(m_xAccessible.get());
 218
 219                 if(!pAgent->IsSpecialToolboItem(m_xAccessible.get()))
 220                 {
 221                     pAgent->NotifyAccEvent(UM_EVENT_STATE_CHECKED, m_xAccessible.get());
 222                 }
 223                 break;
 224             case AccessibleStateType::PRESSED:
 225                 pAgent->IncreaseState(m_xAccessible.get(), state);
 226                 pAgent->NotifyAccEvent(UM_EVENT_STATE_PRESSED, m_xAccessible.get());
 227                 break;
 228             case AccessibleStateType::SELECTED:
 229                 pAgent->IncreaseState(m_xAccessible.get(), state);
 230                 break;
 231             case AccessibleStateType::ARMED:
 232                 pAgent->IncreaseState(m_xAccessible.get(), state);
 233                 pAgent->NotifyAccEvent(UM_EVENT_STATE_ARMED, m_xAccessible.get());
 234                 break;
 235             case AccessibleStateType::SHOWING:
 236                 pAgent->DecreaseState(m_xAccessible.get(), AccessibleStateType::DEFUNC);
 237                 // UNO !SHOWING == MSAA OFFSCREEN
 238                 pAgent->IncreaseState(m_xAccessible.get(), AccessibleStateType::SHOWING );
 239                 break;
 240             case AccessibleStateType::VISIBLE:
 241                 // UNO !VISIBLE == MSAA INVISIBLE
 242                 pAgent->IncreaseState(m_xAccessible.get(), AccessibleStateType::VISIBLE );
 243                 break;
 244             default:
 245                 break;
 246             }
 247         }
 248     else
 249     {
 250         // old value
 251         switch(state)
 252         {
 253         case AccessibleStateType::CHECKED:
 254         case AccessibleStateType::INDETERMINATE:
 255             pAgent->DecreaseState(m_xAccessible.get(), state);
 256             pAgent->UpdateAction(m_xAccessible.get());
 257
 258             if(!pAgent->IsSpecialToolboItem(m_xAccessible.get()))
 259             {
 260                 pAgent->NotifyAccEvent(UM_EVENT_STATE_CHECKED, m_xAccessible.get());
 261             }
 262             break;
 263         case AccessibleStateType::PRESSED:
 264             pAgent->DecreaseState(m_xAccessible.get(), state);
 265             pAgent->NotifyAccEvent(UM_EVENT_STATE_PRESSED, m_xAccessible.get());
 266             break;
 267         case AccessibleStateType::SELECTED:
 268             pAgent->DecreaseState(m_xAccessible.get(), state);
 269             //if the state is unset, no need to send MSAA SELECTION event
 270             //pAgent->NotifyAccEvent(UM_EVENT_STATE_SELECTED, m_xAccessible.get());
 271             break;
 272         case AccessibleStateType::ARMED:
 273             {
 274                 pAgent->DecreaseState(m_xAccessible.get(), state);
 275                 //if the state is unset, no need to send MSAA MENU event
 276                 //pAgent->NotifyAccEvent(UM_EVENT_STATE_ARMED, m_xAccessible.get());
 277             }
 278             break;
 279         case AccessibleStateType::SHOWING:
 280             pAgent->DecreaseState(m_xAccessible.get(), AccessibleStateType::DEFUNC);
 281             // UNO !SHOWING == MSAA OFFSCREEN
 282             pAgent->DecreaseState(m_xAccessible.get(), AccessibleStateType::SHOWING);
 283             break;
 284         case AccessibleStateType::VISIBLE:
 285             // UNO !VISIBLE == MSAA INVISIBLE
 286             pAgent->DecreaseState(m_xAccessible.get(), AccessibleStateType::VISIBLE);
 287             break;
 288
 289         default:
 290             break;
 291         }
 292     }
 293 }
 294
 295 /**
 296  * handle the focused event
 297  *
 298  * @param   enable  true if get focus, false if lose focus
 299  */
 300 void AccComponentEventListener::FireStateFocusedChange(bool enable)
 301 {
 302     if(enable)
 303     {
 304         if (GetParentRole() != AccessibleRole::COMBO_BOX)
 305             pAgent->NotifyAccEvent(UM_EVENT_STATE_FOCUSED, m_xAccessible.get());
 306     }
 307     else
 308     {
 309         //if lose focus, no need to send MSAA FOCUS event
 310         pAgent->DecreaseState(m_xAccessible.get(), AccessibleStateType::FOCUSED);
 311     }
 312 }
 313
 314 void AccComponentEventListener::HandleSelectionChangedEventNoArgs()
 315 {
 316     pAgent->NotifyAccEvent(UM_EVENT_SELECTION_CHANGED, m_xAccessible.get());
 317 }
 318
 319 //add TEXT_SELECTION_CHANGED event
 320 void AccComponentEventListener::HandleTextSelectionChangedEvent()
 321 {
 322     pAgent->NotifyAccEvent(UM_EVENT_TEXT_SELECTION_CHANGED, m_xAccessible.get());
 323 }
 324
 325 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */