accessibility/source/standard/vclxaccessiblebox.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 <standard/vclxaccessiblebox.hxx>
  21 #include <standard/vclxaccessibletextfield.hxx>
  22 #include <standard/vclxaccessibleedit.hxx>
  23 #include <standard/vclxaccessiblelist.hxx>
  24
  25 #include <com/sun/star/accessibility/AccessibleStateType.hpp>
  26 #include <com/sun/star/accessibility/AccessibleEventId.hpp>
  27 #include <com/sun/star/accessibility/AccessibleRole.hpp>
  28 #include <com/sun/star/lang/IndexOutOfBoundsException.hpp>
  29
  30 #include <vcl/accessibility/strings.hxx>
  31 #include <vcl/svapp.hxx>
  32 #include <vcl/toolkit/combobox.hxx>
  33
  34 using namespace ::com::sun::star;
  35 using namespace ::com::sun::star::uno;
  36 using namespace ::com::sun::star::lang;
  37 using namespace ::com::sun::star::beans;
  38 using namespace ::com::sun::star::accessibility;
  39
  40 VCLXAccessibleBox::VCLXAccessibleBox(vcl::Window* pBox, BoxType aType, bool bIsDropDownBox)
  41     : ImplInheritanceHelper(pBox),
  42       m_aBoxType (aType),
  43       m_bIsDropDownBox (bIsDropDownBox)
  44 {
  45     // Set up the flags that indicate which children this object has.
  46     m_bHasListChild = true;
  47
  48     // A text field is not present for non drop down list boxes.
  49     if ((m_aBoxType==LISTBOX) && ! m_bIsDropDownBox)
  50         m_bHasTextChild = false;
  51     else
  52         m_bHasTextChild = true;
  53 }
  54
  55 VCLXAccessibleBox::~VCLXAccessibleBox() {}
  56
  57 bool VCLXAccessibleBox::IsValid() const
  58 {
  59     return GetWindow();
  60 }
  61
  62 void VCLXAccessibleBox::ProcessWindowChildEvent( const VclWindowEvent& rVclWindowEvent )
  63 {
  64     uno::Any aOldValue, aNewValue;
  65
  66     switch ( rVclWindowEvent.GetId() )
  67     {
  68         case VclEventId::WindowShow:
  69         case VclEventId::WindowHide:
  70         {
  71             vcl::Window* pChildWindow = static_cast<vcl::Window *>(rVclWindowEvent.GetData());
  72             // Just compare to the combo box text field.  All other children
  73             // are identical to this object in which case this object will
  74             // be removed in a short time.
  75             if (m_aBoxType==COMBOBOX)
  76             {
  77                 VclPtr< ComboBox > pComboBox = GetAs< ComboBox >();
  78                 if (pComboBox && pChildWindow && pChildWindow == pComboBox->GetSubEdit()
  79                     && m_xText.is())
  80                 {
  81                     if (rVclWindowEvent.GetId() == VclEventId::WindowShow)
  82                     {
  83                         // Instantiate text field.
  84                         getAccessibleChild (0);
  85                         aNewValue <<= m_xText;
  86                     }
  87                     else
  88                     {
  89                         // Release text field.
  90                         aOldValue <<= m_xText;
  91                         m_xText = nullptr;
  92                     }
  93                     // Tell the listeners about the new/removed child.
  94                     NotifyAccessibleEvent (
  95                         AccessibleEventId::CHILD,
  96                         aOldValue, aNewValue);
  97                 }
  98
  99             }
 100         }
 101         break;
 102
 103         default:
 104             VCLXAccessibleComponent::ProcessWindowChildEvent (rVclWindowEvent);
 105     }
 106 }
 107
 108 void VCLXAccessibleBox::ProcessWindowEvent (const VclWindowEvent& rVclWindowEvent)
 109 {
 110     switch ( rVclWindowEvent.GetId() )
 111     {
 112         case VclEventId::DropdownSelect:
 113         case VclEventId::ListboxSelect:
 114         {
 115             // Forward the call to the list child.
 116             if (!m_xList.is())
 117             {
 118                 getAccessibleChild ( m_bHasTextChild ? 1 : 0 );
 119             }
 120             if (m_xList.is())
 121             {
 122                 m_xList->ProcessWindowEvent(rVclWindowEvent, m_bIsDropDownBox);
 123 #if defined(_WIN32)
 124                 if (m_bIsDropDownBox)
 125                 {
 126                     NotifyAccessibleEvent(AccessibleEventId::VALUE_CHANGED, Any(), Any());
 127                 }
 128 #endif
 129             }
 130             break;
 131         }
 132         case VclEventId::DropdownOpen:
 133         {
 134             if (!m_xList.is())
 135             {
 136                 getAccessibleChild ( m_bHasTextChild ? 1 : 0 );
 137             }
 138             if (m_xList.is())
 139             {
 140                 m_xList->ProcessWindowEvent(rVclWindowEvent);
 141                 m_xList->HandleDropOpen();
 142             }
 143             break;
 144         }
 145         case VclEventId::DropdownClose:
 146         {
 147             if (!m_xList.is())
 148             {
 149                 getAccessibleChild ( m_bHasTextChild ? 1 : 0 );
 150             }
 151             if (m_xList.is())
 152             {
 153                 m_xList->ProcessWindowEvent(rVclWindowEvent);
 154             }
 155             VclPtr<vcl::Window> pWindow = GetWindow();
 156             if( pWindow && (pWindow->HasFocus() || pWindow->HasChildPathFocus()) )
 157             {
 158                 Any aOldValue, aNewValue;
 159                 aNewValue <<= AccessibleStateType::FOCUSED;
 160                 NotifyAccessibleEvent( AccessibleEventId::STATE_CHANGED, aOldValue, aNewValue );
 161             }
 162             break;
 163         }
 164         case VclEventId::ComboboxSelect:
 165         {
 166             if (m_xList.is() && m_xText.is())
 167             {
 168                 Reference<XAccessibleText> xText (m_xText->getAccessibleContext(), UNO_QUERY);
 169                 if ( xText.is() )
 170                 {
 171                     OUString sText = xText->getSelectedText();
 172                     if ( sText.isEmpty() )
 173                         sText = xText->getText();
 174                     m_xList->UpdateSelection_Acc(sText, m_bIsDropDownBox);
 175 #if defined(_WIN32)
 176                     if (m_bIsDropDownBox || m_aBoxType==COMBOBOX)
 177                         NotifyAccessibleEvent(AccessibleEventId::VALUE_CHANGED, Any(), Any());
 178 #endif
 179                 }
 180             }
 181             break;
 182         }
 183         //case VclEventId::DropdownOpen:
 184         //case VclEventId::DropdownClose:
 185         case VclEventId::ListboxDoubleClick:
 186         case VclEventId::ListboxScrolled:
 187         //case VclEventId::ListboxSelect:
 188         case VclEventId::ListboxItemAdded:
 189         case VclEventId::ListboxItemRemoved:
 190         case VclEventId::ComboboxItemAdded:
 191         case VclEventId::ComboboxItemRemoved:
 192         {
 193             // Forward the call to the list child.
 194             if (!m_xList.is())
 195             {
 196                 getAccessibleChild ( m_bHasTextChild ? 1 : 0 );
 197             }
 198             if (m_xList.is())
 199                 m_xList->ProcessWindowEvent(rVclWindowEvent);
 200             break;
 201         }
 202
 203         //case VclEventId::ComboboxSelect:
 204         case VclEventId::ComboboxDeselect:
 205         {
 206             // Selection is handled by VCLXAccessibleList which operates on
 207             // the same VCL object as this box does.  In case of the
 208             // combobox, however, we have to help by providing the list with
 209             // the text of the currently selected item.
 210             if (m_xList.is() && m_xText.is())
 211             {
 212                 Reference<XAccessibleText> xText (m_xText->getAccessibleContext(), UNO_QUERY);
 213                 if ( xText.is() )
 214                 {
 215                     OUString sText = xText->getSelectedText();
 216                     if ( sText.isEmpty() )
 217                         sText = xText->getText();
 218                     m_xList->UpdateSelection(sText);
 219                 }
 220             }
 221             break;
 222         }
 223
 224         case VclEventId::EditModify:
 225         case VclEventId::EditSelectionChanged:
 226         case VclEventId::EditCaretChanged:
 227             // Modify/Selection events are handled by the combo box instead of
 228             // directly by the edit field (Why?).  Therefore, delegate this
 229             // call to the edit field.
 230             if (m_aBoxType==COMBOBOX)
 231             {
 232                 if (m_xText.is())
 233                 {
 234                     Reference<XAccessibleContext> xContext = m_xText->getAccessibleContext();
 235                     VCLXAccessibleEdit* pEdit = static_cast<VCLXAccessibleEdit*>(xContext.get());
 236                     if (pEdit != nullptr)
 237                         pEdit->ProcessWindowEvent (rVclWindowEvent);
 238                 }
 239             }
 240             break;
 241         default:
 242             VCLXAccessibleComponent::ProcessWindowEvent( rVclWindowEvent );
 243     }
 244 }
 245
 246 //=====  XAccessible  =========================================================
 247
 248 Reference< XAccessibleContext > SAL_CALL VCLXAccessibleBox::getAccessibleContext(  )
 249 {
 250     ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
 251
 252     return this;
 253 }
 254
 255 //=====  XAccessibleContext  ==================================================
 256
 257 sal_Int64 VCLXAccessibleBox::getAccessibleChildCount()
 258 {
 259     SolarMutexGuard aSolarGuard;
 260     ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
 261
 262     return implGetAccessibleChildCount();
 263 }
 264
 265 sal_Int64 VCLXAccessibleBox::implGetAccessibleChildCount()
 266 {
 267     // Usually a box has a text field and a list of items as its children.
 268     // Non drop down list boxes have no text field.  Additionally check
 269     // whether the object is valid.
 270     sal_Int64 nCount = 0;
 271     if (IsValid())
 272         nCount += (m_bHasTextChild?1:0) + (m_bHasListChild?1:0);
 273     else
 274     {
 275         // Object not valid anymore.  Release references to children.
 276         m_bHasTextChild = false;
 277         m_xText = nullptr;
 278         m_bHasListChild = false;
 279         m_xList = nullptr;
 280     }
 281
 282     return nCount;
 283 }
 284
 285 Reference<XAccessible> SAL_CALL VCLXAccessibleBox::getAccessibleChild (sal_Int64 i)
 286 {
 287     SolarMutexGuard aSolarGuard;
 288     ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
 289
 290     if (i<0 || i>=implGetAccessibleChildCount())
 291         throw IndexOutOfBoundsException();
 292
 293     Reference< XAccessible > xChild;
 294     if (IsValid())
 295     {
 296         if (i==1 || ! m_bHasTextChild)
 297         {
 298             // List.
 299             if ( ! m_xList.is())
 300             {
 301                 m_xList = new VCLXAccessibleList(GetWindow(),
 302                     (m_aBoxType == LISTBOX ? VCLXAccessibleList::LISTBOX : VCLXAccessibleList::COMBOBOX),
 303                                                                     this);
 304                 m_xList->SetIndexInParent(i);
 305             }
 306             xChild = m_xList;
 307         }
 308         else
 309         {
 310             // Text Field.
 311             if ( ! m_xText.is())
 312             {
 313                 if (m_aBoxType==COMBOBOX)
 314                 {
 315                     VclPtr< ComboBox > pComboBox = GetAs< ComboBox >();
 316                     if (pComboBox && pComboBox->GetSubEdit())
 317                         m_xText = pComboBox->GetSubEdit()->GetAccessible();
 318                 }
 319                 else if (m_bIsDropDownBox)
 320                     m_xText = new VCLXAccessibleTextField(GetWindow(), this);
 321             }
 322             xChild = m_xText;
 323         }
 324     }
 325
 326     return xChild;
 327 }
 328
 329 sal_Int16 SAL_CALL VCLXAccessibleBox::getAccessibleRole()
 330 {
 331     ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
 332
 333     // Return the role <const>COMBO_BOX</const> for both VCL combo boxes and
 334     // VCL list boxes in DropDown-Mode else <const>PANEL</const>.
 335     // This way the Java bridge has not to handle both independently.
 336     //return m_bIsDropDownBox ? AccessibleRole::COMBO_BOX : AccessibleRole::PANEL;
 337     if (m_bIsDropDownBox || (m_aBoxType == COMBOBOX))
 338         return AccessibleRole::COMBO_BOX;
 339     else
 340         return AccessibleRole::PANEL;
 341 }
 342
 343 //=====  XAccessibleAction  ===================================================
 344
 345 sal_Int32 SAL_CALL VCLXAccessibleBox::getAccessibleActionCount()
 346 {
 347     ::osl::Guard< ::osl::Mutex> aGuard (GetMutex());
 348
 349     // There is one action for drop down boxes (toggle popup) and none for
 350     // the other boxes.
 351     return m_bIsDropDownBox ? 1 : 0;
 352 }
 353
 354 sal_Bool SAL_CALL VCLXAccessibleBox::doAccessibleAction (sal_Int32 nIndex)
 355 {
 356     bool bNotify = false;
 357
 358     {
 359         SolarMutexGuard aSolarGuard;
 360         ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
 361
 362         if (nIndex!=0 || !m_bIsDropDownBox)
 363             throw css::lang::IndexOutOfBoundsException(
 364                 ("VCLXAccessibleBox::doAccessibleAction: index "
 365                  + OUString::number(nIndex) + " not among 0.."
 366                  + OUString::number(getAccessibleActionCount())),
 367                 getXWeak());
 368
 369         if (m_aBoxType == COMBOBOX)
 370         {
 371             VclPtr< ComboBox > pComboBox = GetAs< ComboBox >();
 372             if (pComboBox != nullptr)
 373             {
 374                 pComboBox->ToggleDropDown();
 375                 bNotify = true;
 376             }
 377         }
 378         else if (m_aBoxType == LISTBOX)
 379         {
 380             VclPtr< ListBox > pListBox = GetAs< ListBox >();
 381             if (pListBox != nullptr)
 382             {
 383                 pListBox->ToggleDropDown();
 384                 bNotify = true;
 385             }
 386         }
 387     }
 388
 389     if (bNotify)
 390         NotifyAccessibleEvent (AccessibleEventId::ACTION_CHANGED, Any(), Any());
 391
 392     return bNotify;
 393 }
 394
 395 OUString SAL_CALL VCLXAccessibleBox::getAccessibleActionDescription (sal_Int32 nIndex)
 396 {
 397     ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
 398     if (nIndex!=0 || !m_bIsDropDownBox)
 399         throw css::lang::IndexOutOfBoundsException();
 400
 401     return RID_STR_ACC_ACTION_TOGGLEPOPUP;
 402 }
 403
 404 Reference< XAccessibleKeyBinding > VCLXAccessibleBox::getAccessibleActionKeyBinding( sal_Int32 nIndex )
 405 {
 406     ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
 407
 408     Reference< XAccessibleKeyBinding > xRet;
 409
 410     if (nIndex<0 || nIndex>=getAccessibleActionCount())
 411         throw css::lang::IndexOutOfBoundsException();
 412
 413     // ... which key?
 414     return xRet;
 415 }
 416
 417 // =====  XAccessibleValue  ===============================================
 418 Any VCLXAccessibleBox::getCurrentValue( )
 419 {
 420     SolarMutexGuard aSolarGuard;
 421     ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
 422
 423     Any aAny;
 424     if( m_xList.is() && m_xText.is())
 425     {
 426         // VCLXAccessibleList* pList = static_cast<VCLXAccessibleList*>(m_xList.get());
 427         Reference<XAccessibleText> xText (m_xText->getAccessibleContext(), UNO_QUERY);
 428         if ( xText.is() )
 429         {
 430             OUString sText = xText->getText();
 431             aAny <<= sText;
 432         }
 433     }
 434     if (m_aBoxType == LISTBOX && m_bIsDropDownBox  && m_xList.is() )
 435     {
 436         if (m_xList->IsInDropDown())
 437         {
 438             if (m_xList->getSelectedAccessibleChildCount() > 0)
 439             {
 440                 Reference<XAccessibleContext> xName (m_xList->getSelectedAccessibleChild(sal_Int64(0)), UNO_QUERY);
 441                 if(xName.is())
 442                 {
 443                     aAny <<= xName->getAccessibleName();
 444                 }
 445             }
 446         }
 447     }
 448
 449     return aAny;
 450 }
 451
 452 sal_Bool VCLXAccessibleBox::setCurrentValue( const Any& aNumber )
 453 {
 454     SolarMutexGuard aSolarGuard;
 455     ::osl::Guard< ::osl::Mutex > aGuard( GetMutex() );
 456
 457     OUString  fValue;
 458     bool bValid = (aNumber >>= fValue);
 459     return bValid;
 460
 461 }
 462
 463 Any VCLXAccessibleBox::getMaximumValue( )
 464 {
 465     Any aAny;
 466     return aAny;
 467 }
 468
 469 Any VCLXAccessibleBox::getMinimumValue(  )
 470 {
 471     Any aAny;
 472     return aAny;
 473 }
 474
 475 Any VCLXAccessibleBox::getMinimumIncrement(  )
 476 {
 477     return Any();
 478 }
 479
 480 // Set the INDETERMINATE state when there is no selected item for combobox
 481 void VCLXAccessibleBox::FillAccessibleStateSet( sal_Int64& rStateSet )
 482 {
 483     VCLXAccessibleComponent::FillAccessibleStateSet(rStateSet);
 484     if (m_aBoxType == COMBOBOX )
 485     {
 486         OUString sText;
 487         sal_Int32 nEntryCount = 0;
 488         VclPtr< ComboBox > pComboBox = GetAs< ComboBox >();
 489         if (pComboBox != nullptr)
 490         {
 491             Edit* pSubEdit = pComboBox->GetSubEdit();
 492             if ( pSubEdit)
 493                 sText = pSubEdit->GetText();
 494             nEntryCount = pComboBox->GetEntryCount();
 495         }
 496         if ( sText.isEmpty() && nEntryCount > 0 )
 497             rStateSet |= AccessibleStateType::INDETERMINATE;
 498     }
 499     else if (m_aBoxType == LISTBOX && m_bIsDropDownBox)
 500     {
 501         VclPtr< ListBox > pListBox = GetAs< ListBox >();
 502         if (pListBox != nullptr && pListBox->GetEntryCount() > 0)
 503         {
 504             sal_Int32 nSelectedEntryCount = pListBox->GetSelectedEntryCount();
 505             if ( nSelectedEntryCount == 0)
 506                 rStateSet |= AccessibleStateType::INDETERMINATE;
 507         }
 508     }
 509 }
 510
 511 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */