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