winaccessibility/source/service/AccContainerEventListener.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 <AccContainerEventListener.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 AccContainerEventListener::AccContainerEventListener(css::accessibility::XAccessible* pAcc, AccObjectManagerAgent* Agent)
  36         :AccEventListener(pAcc, Agent)
  37 {
  38 }
  39
  40 AccContainerEventListener::~AccContainerEventListener()
  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  AccContainerEventListener::notifyEvent( const css::accessibility::AccessibleEventObject& aEvent )
  50 {
  51     SolarMutexGuard g;
  52
  53     switch (aEvent.EventId)
  54     {
  55     case AccessibleEventId::CHILD:
  56         HandleChildChangedEvent(aEvent.OldValue, aEvent.NewValue);
  57         break;
  58     case AccessibleEventId::SELECTION_CHANGED:
  59         HandleSelectionChangedEvent(aEvent.OldValue, aEvent.NewValue);
  60         break;
  61     case AccessibleEventId::INVALIDATE_ALL_CHILDREN:
  62         HandleAllChildrenChangedEvent();
  63         break;
  64     case AccessibleEventId::TEXT_CHANGED:
  65         HandleTextChangedEvent(aEvent.OldValue, aEvent.NewValue);
  66         [[fallthrough]]; //TODO ???
  67     case AccessibleEventId::VISIBLE_DATA_CHANGED:
  68         HandleVisibleDataChangedEvent();
  69         break;
  70     case AccessibleEventId::BOUNDRECT_CHANGED:
  71         HandleBoundrectChangedEvent();
  72         break;
  73     case AccessibleEventId::STATE_CHANGED:
  74         HandleStateChangedEvent(aEvent.OldValue, aEvent.NewValue);
  75         break;
  76     case AccessibleEventId::VALUE_CHANGED:
  77         HandleValueChangedEvent(aEvent.OldValue, aEvent.NewValue);
  78         break;
  79     case AccessibleEventId::SELECTION_CHANGED_ADD:
  80         HandleSelectionChangedAddEvent(aEvent.OldValue, aEvent.NewValue);
  81         break;
  82     case AccessibleEventId::SELECTION_CHANGED_REMOVE:
  83         HandleSelectionChangedRemoveEvent(aEvent.OldValue, aEvent.NewValue);
  84         break;
  85     case AccessibleEventId::SELECTION_CHANGED_WITHIN:
  86         HandleSelectionChangedWithinEvent(aEvent.OldValue, aEvent.NewValue);
  87         break;
  88     case AccessibleEventId::PAGE_CHANGED:
  89         HandlePageChangedEvent(aEvent.OldValue, aEvent.NewValue);
  90         break;
  91     case AccessibleEventId::SECTION_CHANGED:
  92         HandleSectionChangedEvent(aEvent.OldValue, aEvent.NewValue);
  93         break;
  94     case AccessibleEventId::COLUMN_CHANGED:
  95         HandleColumnChangedEvent(aEvent.OldValue, aEvent.NewValue);
  96         break;
  97     default:
  98         AccEventListener::notifyEvent(aEvent);
  99         break;
 100     }
 101 }
 102
 103 void AccContainerEventListener::HandleStateChangedEvent(Any oldValue, Any newValue)
 104 {
 105     short State;
 106     if( newValue >>= State)
 107     {
 108         SetComponentState(State, true);
 109     }
 110     else if (oldValue >>= State)
 111     {
 112         SetComponentState(State, false);
 113     }
 114
 115 }
 116
 117 /**
 118  * handle the CHILD event
 119  * @param   oldValue    the child to be deleted
 120  * @param   newValue    the child to be added
 121  */
 122 void AccContainerEventListener::HandleChildChangedEvent(Any oldValue, Any newValue)
 123 {
 124     Reference< XAccessible > xChild;
 125     if( newValue >>= xChild)
 126     {
 127         //create a new child
 128         if(xChild.is())
 129         {
 130             XAccessible* pAcc = xChild.get();
 131             //add this child
 132
 133             if (pAgent->InsertAccObj(pAcc, m_xAccessible.get()))
 134             {
 135                 //add all oldValue's existing children
 136                 pAgent->InsertChildrenAccObj(pAcc);
 137                 pAgent->NotifyAccEvent(UM_EVENT_CHILD_ADDED, pAcc);
 138             }
 139         }
 140     }
 141     else if (oldValue >>= xChild)
 142     {
 143         //delete an existing child
 144         if(xChild.is())
 145         {
 146             XAccessible* pAcc = xChild.get();
 147             pAgent->NotifyAccEvent(UM_EVENT_CHILD_REMOVED, pAcc);
 148             //delete all oldValue's existing children
 149             pAgent->DeleteChildrenAccObj( pAcc );
 150             //delete this child
 151             pAgent->DeleteAccObj( pAcc );
 152
 153         }
 154     }
 155
 156 }
 157
 158 /**
 159  * handle the SELECTION_CHANGED event
 160  * @param   oldValue    the old value of the source of event
 161  * @param   newValue    the new value of the source of event
 162  */
 163 void AccContainerEventListener::HandleSelectionChangedEvent(const Any& /*oldValue*/, const Any& newValue)
 164 {
 165     if(NotifyChildEvent(UM_EVENT_SELECTION_CHANGED,newValue))
 166     {
 167         return ;
 168     }
 169
 170     //menu bar does not process selection change event,just same as word behavior
 171     if (GetRole()!=AccessibleRole::MENU_BAR)
 172         pAgent->NotifyAccEvent(UM_EVENT_SELECTION_CHANGED, m_xAccessible.get());
 173 }
 174
 175 /**
 176  *  handle the INVALIDATE_ALL_CHILDREN event
 177  */
 178 void AccContainerEventListener::HandleAllChildrenChangedEvent()
 179 {
 180     //TODO: update all the children
 181     if (m_xAccessible.is())
 182     {
 183         //delete all oldValue's existing children
 184         pAgent->DeleteChildrenAccObj(m_xAccessible.get());
 185         //add all oldValue's existing children
 186         pAgent->InsertChildrenAccObj(m_xAccessible.get());
 187         pAgent->NotifyAccEvent(UM_EVENT_OBJECT_REORDER , m_xAccessible.get());
 188     }
 189 }
 190
 191 /**
 192  *  handle the TEXT_CHANGED event
 193  */
 194 void AccContainerEventListener::HandleTextChangedEvent(Any, Any newValue)
 195 {
 196     pAgent->UpdateValue(m_xAccessible.get(), newValue);
 197     pAgent->NotifyAccEvent(UM_EVENT_OBJECT_TEXTCHANGE, m_xAccessible.get());
 198 }
 199
 200 /**
 201  * set the new state and fire the MSAA event
 202  * @param   state   new state id
 203  * @param   enable  true if state is set, false if state is unset
 204  */
 205 void AccContainerEventListener::SetComponentState(short state, bool enable )
 206 {
 207     // only the following state can be fired state event.
 208
 209     switch (state)
 210     {
 211     case AccessibleStateType::SELECTED:
 212     case AccessibleStateType::BUSY:
 213     case AccessibleStateType::INDETERMINATE:
 214     case AccessibleStateType::OFFSCREEN:
 215     case AccessibleStateType::FOCUSABLE:
 216     case AccessibleStateType::SHOWING:
 217     case AccessibleStateType::VISIBLE:
 218         FireStatePropertyChange(state, enable);
 219         break;
 220     case AccessibleStateType::FOCUSED:
 221         FireStateFocusedChange(enable);
 222         break;
 223     case AccessibleStateType::ENABLED:
 224         if(enable)
 225         {
 226             pAgent->DecreaseState(m_xAccessible.get(), AccessibleStateType::DEFUNC);
 227             pAgent->IncreaseState(m_xAccessible.get(), AccessibleStateType::FOCUSABLE);
 228             pAgent->UpdateState(m_xAccessible.get());
 229
 230             UpdateAllChildrenState(m_xAccessible.get());
 231         }
 232         else
 233         {
 234             pAgent->IncreaseState(m_xAccessible.get(), AccessibleStateType::DEFUNC);
 235             pAgent->DecreaseState(m_xAccessible.get(), AccessibleStateType::FOCUSABLE);
 236             pAgent->UpdateState(m_xAccessible.get());
 237
 238             UpdateAllChildrenState(m_xAccessible.get());
 239         }
 240         break;
 241     case AccessibleStateType::ACTIVE:
 242         // Only frames should be active
 243         // no msaa state mapping
 244         //for PAGE_TAB_LIST, there will be ACTIVE state, then it should be converted to FOCUSED event.
 245         if (GetRole() == AccessibleRole::PAGE_TAB_LIST)
 246         {
 247             if (!enable) /* get the active state */
 248             {
 249                 pAgent->IncreaseState(m_xAccessible.get(), AccessibleStateType::FOCUSED);
 250             }
 251
 252             else    /* lose the active state */
 253             {
 254                 pAgent->DecreaseState(m_xAccessible.get(), AccessibleStateType::FOCUSED);
 255             }
 256         }
 257         break;
 258
 259     case AccessibleStateType::EXPANDED:
 260     case AccessibleStateType::COLLAPSE:
 261     case AccessibleStateType::CHECKED:
 262         {
 263             pAgent->UpdateState(m_xAccessible.get());
 264             pAgent->NotifyAccEvent(UM_EVENT_STATE_BUSY, m_xAccessible.get());
 265             break;
 266         }
 267
 268     default:
 269         break;
 270     }
 271 }
 272
 273 /**
 274  * fire the MSAA state changed event
 275  * @param   state   the state id
 276  * @param   set     true if state is set, false if state is unset
 277  */
 278 void AccContainerEventListener::FireStatePropertyChange(short state, bool set)
 279 {
 280     if( set )
 281     {
 282         // new value
 283         switch(state)
 284         {
 285         case AccessibleStateType::SELECTED:
 286             pAgent->IncreaseState(m_xAccessible.get(), state);
 287             break;
 288         case AccessibleStateType::INDETERMINATE:
 289         case AccessibleStateType::BUSY:
 290         case AccessibleStateType::FOCUSABLE:
 291         case AccessibleStateType::OFFSCREEN:
 292             pAgent->IncreaseState(m_xAccessible.get(), state);
 293             pAgent->NotifyAccEvent(UM_EVENT_STATE_BUSY, m_xAccessible.get());
 294             break;
 295         case AccessibleStateType::SHOWING:
 296             // UNO !SHOWING == MSAA OFFSCREEN
 297             pAgent->IncreaseState(m_xAccessible.get(), AccessibleStateType::SHOWING);
 298             break;
 299         case AccessibleStateType::VISIBLE:
 300             // UNO !VISIBLE == MSAA INVISIBLE
 301             pAgent->IncreaseState(m_xAccessible.get(), AccessibleStateType::VISIBLE);
 302             break;
 303         default:
 304             break;
 305         }
 306     }
 307     else
 308     {
 309         // old value
 310         switch(state)
 311         {
 312         case AccessibleStateType::SELECTED:
 313             pAgent->DecreaseState(m_xAccessible.get(), state);
 314             break;
 315         case AccessibleStateType::BUSY:
 316         case AccessibleStateType::INDETERMINATE:
 317         case AccessibleStateType::FOCUSABLE:
 318         case AccessibleStateType::OFFSCREEN:
 319             pAgent->DecreaseState(m_xAccessible.get(), state);
 320             pAgent->NotifyAccEvent(UM_EVENT_STATE_BUSY, m_xAccessible.get());
 321             break;
 322         case AccessibleStateType::SHOWING:
 323             // UNO !SHOWING == MSAA OFFSCREEN
 324             pAgent->DecreaseState(m_xAccessible.get(), AccessibleStateType::SHOWING);
 325             break;
 326         case AccessibleStateType::VISIBLE:
 327             // UNO !VISIBLE == MSAA INVISIBLE
 328             pAgent->DecreaseState(m_xAccessible.get(), AccessibleStateType::VISIBLE);
 329             break;
 330         default:
 331             break;
 332         }
 333     }
 334 }
 335
 336 /**
 337  * handle the focused event
 338  * @param   enable  true if get focus, false if lose focus
 339  */
 340 void AccContainerEventListener::FireStateFocusedChange(bool enable)
 341 {
 342     if(enable)
 343     {
 344         pAgent->IncreaseState(m_xAccessible.get(), AccessibleStateType::FOCUSED);
 345         //if the acc role is MENU_BAR, MSAA UM_EVENT_MENU_START event should be sent
 346         //if the acc role is POPUP_MENU, MSAA UM_EVENT_MENUPOPUPSTART event should be sent
 347         short role = GetRole();
 348         if(role == AccessibleRole::MENU_BAR)
 349         {
 350             pAgent->NotifyAccEvent(UM_EVENT_MENU_START, m_xAccessible.get());
 351         }
 352         else if (role == AccessibleRole::POPUP_MENU)
 353             pAgent->NotifyAccEvent(UM_EVENT_MENUPOPUPSTART, m_xAccessible.get());
 354         //Disable the focused event on option_pane and Panel.
 355         //only disable option_pane for toolbar has panel to get focus
 356         else if (role == AccessibleRole::PANEL || role == AccessibleRole::OPTION_PANE )
 357         {
 358             //don't send focused event on PANEL & OPTION_PANE if the parent is not toolbar
 359             short parentRole = GetParentRole();
 360             if (parentRole == AccessibleRole::TOOL_BAR
 361                 || parentRole == AccessibleRole::SCROLL_PANE // sidebar
 362                 || parentRole == AccessibleRole::PANEL) // sidebar
 363                 pAgent->NotifyAccEvent(UM_EVENT_STATE_FOCUSED, m_xAccessible.get());
 364         }
 365         //to update ComboBox's description
 366         else if (role == AccessibleRole::COMBO_BOX )
 367         {
 368             pAgent->UpdateDescription(m_xAccessible.get());
 369             //for editable combobox, send focus event on only edit control,
 370             bool bSendFocusOnCombobox = true;
 371             //send focused event to the first text child
 372             Reference<XAccessibleContext> mxContext = m_xAccessible.get()->getAccessibleContext();
 373             if(mxContext.is())
 374             {
 375                 Reference<XAccessible> mxChild = mxContext->getAccessibleChild(0);
 376                 if(mxChild.is())
 377                 {
 378                     Reference<XAccessibleContext> mxChildContext = mxChild->getAccessibleContext();
 379                     short childrole = mxChildContext->getAccessibleRole();
 380                     if (childrole == AccessibleRole::TEXT)
 381                     {
 382                         if (IsEditable(mxChildContext))
 383                         {
 384                             pAgent->DecreaseState(m_xAccessible.get(), AccessibleStateType::FOCUSED);
 385                             pAgent->IncreaseState( mxChild.get(), AccessibleStateType::FOCUSED);
 386                             pAgent->NotifyAccEvent(UM_EVENT_STATE_FOCUSED, mxChild.get());
 387                             bSendFocusOnCombobox = false;
 388                         }
 389                     }
 390                 }
 391             }
 392             if (bSendFocusOnCombobox)
 393                 pAgent->NotifyAccEvent(UM_EVENT_STATE_FOCUSED, m_xAccessible.get());
 394         }
 395         else
 396             pAgent->NotifyAccEvent(UM_EVENT_STATE_FOCUSED, m_xAccessible.get());
 397     }
 398     else
 399     {
 400         pAgent->DecreaseState(m_xAccessible.get(), AccessibleStateType::FOCUSED);
 401         //if the acc role is MENU_BAR, MSAA UM_EVENT_MENU_END event should be sent
 402         //if the acc role is POPUP_MENU, MSAA UM_EVENT_MENUPOPUPEND event should be sent
 403         if (GetRole() == AccessibleRole::MENU_BAR)
 404         {
 405             pAgent->NotifyAccEvent(UM_EVENT_MENU_END, m_xAccessible.get());
 406         }
 407         else if (GetRole() == AccessibleRole::POPUP_MENU)
 408         {
 409             pAgent->NotifyAccEvent(UM_EVENT_MENUPOPUPEND, m_xAccessible.get());
 410         }
 411     }
 412 }
 413
 414 /**
 415  * handle the VALUE_CHANGED event
 416  *
 417  * @param   oldValue    the old value of the source of event
 418  * @param   newValue    the new value of the source of event
 419  */
 420 void AccContainerEventListener::HandleValueChangedEvent(Any, Any)
 421 {
 422     pAgent->UpdateValue(m_xAccessible.get());
 423     pAgent->NotifyAccEvent(UM_EVENT_OBJECT_VALUECHANGE, m_xAccessible.get());
 424 }
 425
 426 bool AccContainerEventListener::IsEditable(Reference<XAccessibleContext> const & xContext)
 427 {
 428     Reference< XAccessibleStateSet > pRState = xContext->getAccessibleStateSet();
 429     if( !pRState.is() )
 430         return false;
 431
 432     Sequence<short> pStates = pRState->getStates();
 433     int count = pStates.getLength();
 434     for( int iIndex = 0;iIndex < count;iIndex++ )
 435     {
 436         if(pStates[iIndex] == AccessibleStateType::EDITABLE)
 437             return true;
 438     }
 439     return false;
 440 }
 441
 442 bool AccContainerEventListener::NotifyChildEvent(short nWinEvent,const Any &Value)
 443 {
 444     Reference< XAccessible > xChild;
 445     if(Value >>= xChild )
 446     {
 447         if(xChild.is())
 448         {
 449             XAccessible* pAcc = xChild.get();
 450             pAgent->NotifyAccEvent(nWinEvent, pAcc);
 451             return true;
 452         }
 453     }
 454     return false;
 455 }
 456
 457 void AccContainerEventListener::HandleSelectionChangedAddEvent(const Any& /*oldValue*/, const Any& newValue)
 458 {
 459     if(NotifyChildEvent(UM_EVENT_SELECTION_CHANGED_ADD,newValue))
 460     {
 461         return ;
 462     }
 463     pAgent->NotifyAccEvent(UM_EVENT_SELECTION_CHANGED_ADD, m_xAccessible.get());
 464 }
 465
 466 void AccContainerEventListener::HandleSelectionChangedRemoveEvent(const Any& /*oldValue*/, const Any& newValue)
 467 {
 468     if(NotifyChildEvent(UM_EVENT_SELECTION_CHANGED_REMOVE,newValue))
 469     {
 470         return ;
 471     }
 472     pAgent->NotifyAccEvent(UM_EVENT_SELECTION_CHANGED_REMOVE, m_xAccessible.get());
 473 }
 474
 475 void AccContainerEventListener::HandleSelectionChangedWithinEvent(const Any& /*oldValue*/, const Any& newValue)
 476 {
 477     if(NotifyChildEvent(UM_EVENT_SELECTION_CHANGED_WITHIN,newValue))
 478     {
 479         return ;
 480     }
 481     pAgent->NotifyAccEvent(UM_EVENT_SELECTION_CHANGED_WITHIN, m_xAccessible.get());
 482 }
 483
 484 void AccContainerEventListener::UpdateAllChildrenState(XAccessible* pXAccessible)
 485 {
 486     Reference<css::accessibility::XAccessibleContext> xContext = pXAccessible->getAccessibleContext();
 487     if(!xContext.is())
 488     {
 489         return;
 490     }
 491     css::accessibility::XAccessibleContext* pAccessibleContext = xContext.get();
 492     if(pAccessibleContext == nullptr)
 493     {
 494         return;
 495     }
 496
 497     if (pAgent && pAgent->IsStateManageDescendant(pXAccessible))
 498     {
 499         return;
 500     }
 501
 502     int count = pAccessibleContext->getAccessibleChildCount();
 503     for (int i=0;i<count;i++)
 504     {
 505         Reference<css::accessibility::XAccessible> mxAccessible
 506         = pAccessibleContext->getAccessibleChild(i);
 507
 508         css::accessibility::XAccessible* mpAccessible = mxAccessible.get();
 509         if(mpAccessible != nullptr)
 510         {
 511             pAgent->UpdateState(mpAccessible);
 512             UpdateAllChildrenState(mpAccessible);
 513         }
 514     }
 515 }
 516
 517 void AccContainerEventListener::HandlePageChangedEvent(const Any& /*oldValue*/, const Any& /*newValue*/)
 518 {
 519     pAgent->NotifyAccEvent(UM_EVENT_OBJECT_PAGECHANGED, m_xAccessible.get());
 520 }
 521
 522 void AccContainerEventListener::HandleSectionChangedEvent(const Any& /*oldValue*/, const Any& /*newValue*/ )
 523 {
 524     pAgent->NotifyAccEvent(UM_EVENT_SECTION_CHANGED, m_xAccessible.get());
 525 }
 526
 527 void AccContainerEventListener::HandleColumnChangedEvent(const Any& /*oldValue*/, const Any& /*newValue*/)
 528 {
 529     pAgent->NotifyAccEvent(UM_EVENT_COLUMN_CHANGED, m_xAccessible.get());
 530 }
 531
 532 void  AccContainerEventListener::HandleNameChangedEvent( Any name )
 533 {
 534     if (GetRole() == AccessibleRole::COMBO_BOX)
 535     {
 536         Reference<XAccessibleContext> mxContext(m_xAccessible->getAccessibleContext());
 537         if(mxContext.is())
 538         {
 539             Reference<XAccessible> mxChild = mxContext->getAccessibleChild(0);
 540             if(mxChild.is())
 541             {
 542                 Reference<XAccessibleContext> mxChildContext = mxChild->getAccessibleContext();
 543                 short childrole = mxChildContext->getAccessibleRole();
 544                 if (childrole == AccessibleRole::TEXT)
 545                 {
 546                     pAgent->UpdateAccName(mxChild.get(), name);
 547                 }
 548             }
 549         }
 550     }
 551     AccEventListener::HandleNameChangedEvent(name);
 552 }
 553
 554 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */