svx/source/accessibility/charmapacc.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 <vcl/settings.hxx>
  21 #include <vcl/svapp.hxx>
  22 #include <stdio.h>
  23 #include <svx/charmap.hxx>
  24 #include <charmapacc.hxx>
  25 #include <com/sun/star/accessibility/AccessibleRole.hpp>
  26 #include <com/sun/star/accessibility/AccessibleStateType.hpp>
  27 #include <com/sun/star/lang/IndexOutOfBoundsException.hpp>
  28 #include <o3tl/temporary.hxx>
  29 #include <osl/interlck.h>
  30 #include <svx/dialmgr.hxx>
  31 #include <svx/strings.hrc>
  32 #include <comphelper/accessiblecontexthelper.hxx>
  33 #include <comphelper/types.hxx>
  34
  35 namespace svx
  36 {
  37     using namespace comphelper;
  38     using namespace ::com::sun::star;
  39     using namespace ::com::sun::star::uno;
  40     using namespace ::com::sun::star::lang;
  41     using namespace ::com::sun::star::accessibility;
  42
  43 SvxShowCharSetItem::SvxShowCharSetItem( SvxShowCharSet& rParent,SvxShowCharSetAcc*  _pParent,sal_uInt16 _nPos ) :
  44     mrParent( rParent )
  45     ,mnId( _nPos )
  46     ,m_pParent(_pParent)
  47 {
  48 }
  49
  50 SvxShowCharSetItem::~SvxShowCharSetItem()
  51 {
  52     if ( m_xItem.is() )
  53     {
  54         m_xItem->ParentDestroyed();
  55         m_xItem.clear();
  56     }
  57 }
  58
  59 uno::Reference< css::accessibility::XAccessible > SvxShowCharSetItem::GetAccessible()
  60 {
  61     if( !m_xItem.is() )
  62     {
  63         m_xItem = new SvxShowCharSetItemAcc( this );
  64     }
  65
  66     return m_xItem;
  67 }
  68
  69 SvxShowCharSetAcc::SvxShowCharSetAcc(SvxShowCharSet* pParent)
  70     : m_pParent(pParent)
  71 {
  72     osl_atomic_increment(&m_refCount);
  73     {
  74         lateInit(this);
  75     }
  76     osl_atomic_decrement(&m_refCount);
  77 }
  78
  79 SvxShowCharSetAcc::~SvxShowCharSetAcc()
  80 {
  81     ensureDisposed();
  82 }
  83
  84 void SAL_CALL SvxShowCharSetAcc::disposing()
  85 {
  86     OAccessibleSelectionHelper::disposing();
  87     for (auto& rChild : m_aChildren)
  88         ::comphelper::disposeComponent(rChild);
  89
  90     m_aChildren.clear();
  91     m_pParent = nullptr;
  92 }
  93
  94 bool SvxShowCharSetAcc::implIsSelected( sal_Int64 nAccessibleChildIndex )
  95 {
  96     if (!m_pParent)
  97         return false;
  98
  99     if (nAccessibleChildIndex < 0 || nAccessibleChildIndex >= getAccessibleChildCount())
 100         throw IndexOutOfBoundsException();
 101
 102     return m_pParent->IsSelected(sal::static_int_cast<sal_uInt16>(nAccessibleChildIndex));
 103 }
 104
 105 // select the specified child => watch for special ChildIndexes (ACCESSIBLE_SELECTION_CHILD_xxx)
 106 void SvxShowCharSetAcc::implSelect(sal_Int64 nAccessibleChildIndex, bool bSelect)
 107 {
 108     if (!m_pParent)
 109         return;
 110
 111     if (nAccessibleChildIndex < 0 || nAccessibleChildIndex >= getAccessibleChildCount())
 112         throw IndexOutOfBoundsException();
 113
 114     if (bSelect)
 115         m_pParent->SelectIndex(nAccessibleChildIndex, true);
 116     else
 117         m_pParent->DeSelect();
 118 }
 119
 120 css::awt::Rectangle SvxShowCharSetAcc::implGetBounds()
 121 {
 122     awt::Rectangle aRet;
 123
 124     if (m_pParent)
 125     {
 126         const Point   aOutPos;//( m_pParent->GetPosPixel() );
 127         Size          aOutSize( m_pParent->GetOutputSizePixel());
 128
 129         aRet.X = aOutPos.X();
 130         aRet.Y = aOutPos.Y();
 131         aRet.Width = aOutSize.Width();
 132         aRet.Height = aOutSize.Height();
 133     }
 134
 135     return aRet;
 136 }
 137
 138 sal_Int64 SAL_CALL SvxShowCharSetAcc::getAccessibleChildCount()
 139 {
 140     OExternalLockGuard aGuard( this );
 141
 142     return m_pParent->getMaxCharCount();
 143 }
 144
 145 uno::Reference< css::accessibility::XAccessible > SAL_CALL SvxShowCharSetAcc::getAccessibleChild( sal_Int64 i )
 146 {
 147     OExternalLockGuard aGuard( this );
 148
 149     uno::Reference< css::accessibility::XAccessible >    xRet;
 150     SvxShowCharSetItem* pItem = m_pParent->ImplGetItem( static_cast< sal_uInt16 >( i ) );
 151
 152     if( !pItem )
 153         throw lang::IndexOutOfBoundsException();
 154
 155     pItem->m_pParent = this;
 156     xRet = pItem->GetAccessible();
 157     m_aChildren.push_back(xRet);
 158
 159     return xRet;
 160 }
 161
 162 uno::Reference< css::accessibility::XAccessible > SAL_CALL SvxShowCharSetAcc::getAccessibleParent()
 163 {
 164     OExternalLockGuard aGuard( this );
 165
 166     if (m_pParent)
 167         return m_pParent->getAccessibleParent();
 168     return uno::Reference<css::accessibility::XAccessible>();
 169 }
 170
 171 sal_Int16 SAL_CALL SvxShowCharSetAcc::getAccessibleRole()
 172 {
 173     return css::accessibility::AccessibleRole::TABLE;
 174 }
 175
 176 OUString SAL_CALL SvxShowCharSetAcc::getAccessibleDescription()
 177 {
 178     OExternalLockGuard aGuard( this );
 179     return SvxResId( RID_SVXSTR_CHARACTER_SELECTION );
 180 }
 181
 182
 183 OUString SAL_CALL SvxShowCharSetAcc::getAccessibleName()
 184 {
 185     OExternalLockGuard aGuard( this );
 186
 187     return SvxResId( RID_SVXSTR_CHAR_SEL_DESC );
 188 }
 189
 190
 191 uno::Reference< css::accessibility::XAccessibleRelationSet > SAL_CALL SvxShowCharSetAcc::getAccessibleRelationSet()
 192 {
 193     return uno::Reference< css::accessibility::XAccessibleRelationSet >();
 194 }
 195
 196
 197 sal_Int64 SAL_CALL SvxShowCharSetAcc::getAccessibleStateSet()
 198 {
 199     OExternalLockGuard aGuard( this );
 200
 201     sal_Int64 nStateSet = 0;
 202
 203     if (m_pParent)
 204     {
 205         // SELECTABLE
 206         nStateSet |= AccessibleStateType::FOCUSABLE;
 207         if (m_pParent->HasFocus())
 208         {
 209             nStateSet |= AccessibleStateType::FOCUSED;
 210             nStateSet |= AccessibleStateType::ACTIVE;
 211         }
 212         if (m_pParent->IsEnabled())
 213         {
 214             nStateSet |= AccessibleStateType::ENABLED;
 215             nStateSet |= AccessibleStateType::SENSITIVE;
 216         }
 217         if (m_pParent->IsVisible())
 218             nStateSet |= AccessibleStateType::VISIBLE;
 219
 220         nStateSet |= AccessibleStateType::MANAGES_DESCENDANTS;
 221     }
 222
 223     return nStateSet;
 224 }
 225
 226
 227 uno::Reference< css::accessibility::XAccessible > SAL_CALL SvxShowCharSetAcc::getAccessibleAtPoint( const awt::Point& aPoint )
 228 {
 229     OExternalLockGuard aGuard( this );
 230
 231     uno::Reference< css::accessibility::XAccessible >    xRet;
 232     const sal_uInt16 nItemId = sal::static_int_cast<sal_uInt16>(
 233         m_pParent->PixelToMapIndex( Point( aPoint.X, aPoint.Y ) ));
 234
 235     if( sal_uInt16(-1) != nItemId )
 236     {
 237         SvxShowCharSetItem* pItem = m_pParent->ImplGetItem( nItemId );
 238         xRet = pItem->GetAccessible();
 239     }
 240     return xRet;
 241 }
 242
 243 void SAL_CALL SvxShowCharSetAcc::grabFocus()
 244 {
 245     OExternalLockGuard aGuard( this );
 246
 247     m_pParent->GrabFocus();
 248 }
 249
 250 sal_Int32 SAL_CALL SvxShowCharSetAcc::getAccessibleRowCount(  )
 251 {
 252     return ((getAccessibleChildCount()-1) / COLUMN_COUNT) + 1;
 253 }
 254
 255 sal_Int32 SAL_CALL SvxShowCharSetAcc::getAccessibleColumnCount(  )
 256 {
 257     return COLUMN_COUNT;
 258 }
 259
 260 OUString SAL_CALL SvxShowCharSetAcc::getAccessibleRowDescription( sal_Int32 /*nRow*/ )
 261 {
 262     return OUString();
 263 }
 264
 265 OUString SAL_CALL SvxShowCharSetAcc::getAccessibleColumnDescription( sal_Int32 /*nColumn*/ )
 266 {
 267     return OUString();
 268 }
 269
 270 sal_Int32 SAL_CALL SvxShowCharSetAcc::getAccessibleRowExtentAt( sal_Int32 /*nRow*/, sal_Int32 /*nColumn*/ )
 271 {
 272     return 1;
 273 }
 274
 275 sal_Int32 SAL_CALL SvxShowCharSetAcc::getAccessibleColumnExtentAt( sal_Int32 /*nRow*/, sal_Int32 /*nColumn*/ )
 276 {
 277     return 1;
 278 }
 279
 280 Reference< XAccessibleTable > SAL_CALL SvxShowCharSetAcc::getAccessibleRowHeaders(  )
 281 {
 282     return Reference< XAccessibleTable >();
 283 }
 284
 285 Reference< XAccessibleTable > SAL_CALL SvxShowCharSetAcc::getAccessibleColumnHeaders(  )
 286 {
 287     return Reference< XAccessibleTable >();
 288 }
 289
 290 Sequence< sal_Int32 > SAL_CALL SvxShowCharSetAcc::getSelectedAccessibleRows(  )
 291 {
 292     OExternalLockGuard aGuard( this );
 293
 294     return { SvxShowCharSet::GetRowPos(m_pParent->GetSelectIndexId()) };
 295 }
 296
 297 Sequence< sal_Int32 > SAL_CALL SvxShowCharSetAcc::getSelectedAccessibleColumns(  )
 298 {
 299     OExternalLockGuard aGuard( this );
 300
 301     return { SvxShowCharSet::GetColumnPos(m_pParent->GetSelectIndexId()) };
 302 }
 303
 304 sal_Bool SAL_CALL SvxShowCharSetAcc::isAccessibleRowSelected( sal_Int32 nRow )
 305 {
 306     OExternalLockGuard aGuard( this );
 307
 308     return SvxShowCharSet::GetRowPos(m_pParent->GetSelectIndexId()) == nRow;
 309 }
 310
 311 sal_Bool SAL_CALL SvxShowCharSetAcc::isAccessibleColumnSelected( sal_Int32 nColumn )
 312 {
 313     OExternalLockGuard aGuard( this );
 314     ensureAlive();
 315     return SvxShowCharSet::GetColumnPos(m_pParent->GetSelectIndexId()) == nColumn;
 316 }
 317
 318 Reference< XAccessible > SAL_CALL SvxShowCharSetAcc::getAccessibleCellAt( sal_Int32 nRow, sal_Int32 nColumn )
 319 {
 320     OExternalLockGuard aGuard( this );
 321
 322     svx::SvxShowCharSetItem* pItem = m_pParent->ImplGetItem(
 323         sal::static_int_cast<sal_uInt16>(getAccessibleIndex(nRow,nColumn) ));
 324     if ( !pItem  )
 325         throw IndexOutOfBoundsException();
 326     return pItem->GetAccessible();
 327 }
 328
 329 Reference< XAccessible > SAL_CALL SvxShowCharSetAcc::getAccessibleCaption(  )
 330 {
 331     return Reference< XAccessible >();
 332 }
 333
 334 Reference< XAccessible > SAL_CALL SvxShowCharSetAcc::getAccessibleSummary(  )
 335 {
 336     return Reference< XAccessible >();
 337 }
 338
 339 sal_Bool SAL_CALL SvxShowCharSetAcc::isAccessibleSelected( sal_Int32 nRow, sal_Int32 nColumn )
 340 {
 341     OExternalLockGuard aGuard( this );
 342
 343     return m_pParent->GetSelectIndexId() == getAccessibleIndex(nRow,nColumn);
 344 }
 345
 346 sal_Int64 SAL_CALL SvxShowCharSetAcc::getAccessibleIndex( sal_Int32 nRow, sal_Int32 nColumn )
 347 {
 348     return (static_cast<sal_Int64>(nRow) * COLUMN_COUNT) + nColumn;
 349 }
 350
 351 sal_Int32 SAL_CALL SvxShowCharSetAcc::getAccessibleRow( sal_Int64 nChildIndex )
 352 {
 353     OExternalLockGuard aGuard( this );
 354
 355     return SvxShowCharSet::GetRowPos(sal::static_int_cast<sal_uInt16>(nChildIndex));
 356 }
 357
 358 sal_Int32 SAL_CALL SvxShowCharSetAcc::getAccessibleColumn( sal_Int64 nChildIndex )
 359 {
 360     OExternalLockGuard aGuard( this );
 361
 362     return SvxShowCharSet::GetColumnPos(sal::static_int_cast<sal_uInt16>(nChildIndex));
 363 }
 364
 365
 366 SvxShowCharSetItemAcc::SvxShowCharSetItemAcc( SvxShowCharSetItem* pParent ) : mpParent( pParent )
 367 {
 368     OSL_ENSURE(pParent,"NO parent supplied!");
 369     osl_atomic_increment(&m_refCount);
 370     { // #b6211265 #
 371         lateInit(this);
 372     }
 373     osl_atomic_decrement(&m_refCount);
 374 }
 375
 376
 377 SvxShowCharSetItemAcc::~SvxShowCharSetItemAcc()
 378 {
 379     ensureDisposed();
 380 }
 381
 382 void SvxShowCharSetItemAcc::ParentDestroyed()
 383 {
 384     const ::osl::MutexGuard aGuard( GetMutex() );
 385     mpParent = nullptr;
 386 }
 387
 388 sal_Int64 SAL_CALL SvxShowCharSetItemAcc::getAccessibleChildCount()
 389 {
 390     return 0;
 391 }
 392
 393
 394 uno::Reference< css::accessibility::XAccessible > SAL_CALL SvxShowCharSetItemAcc::getAccessibleChild( sal_Int64 /*i*/ )
 395 {
 396     throw lang::IndexOutOfBoundsException();
 397 }
 398
 399
 400 uno::Reference< css::accessibility::XAccessible > SAL_CALL SvxShowCharSetItemAcc::getAccessibleParent()
 401 {
 402     OExternalLockGuard aGuard( this );
 403
 404     return mpParent->m_pParent;
 405 }
 406
 407
 408 sal_Int16 SAL_CALL SvxShowCharSetItemAcc::getAccessibleRole()
 409 {
 410     return css::accessibility::AccessibleRole::TABLE_CELL;
 411 }
 412
 413
 414 OUString SAL_CALL SvxShowCharSetItemAcc::getAccessibleDescription()
 415 {
 416     OExternalLockGuard aGuard( this );
 417
 418     OUString sDescription;
 419
 420     const OUString aCharStr( mpParent->maText);
 421     const sal_UCS4 c = aCharStr.iterateCodePoints( &o3tl::temporary(sal_Int32(0)) );
 422     const int tmp_len = (c < 0x10000) ? 4 : 6;
 423     char buf[16] = "0x0000";
 424     sal_UCS4 c_Shifted = c;
 425     for( int i = 0; i < tmp_len; ++i )
 426     {
 427         char h = static_cast<char>(c_Shifted & 0x0F);
 428         buf[tmp_len+1-i] = (h > 9) ? (h - 10 + 'A') : (h + '0');
 429         c_Shifted >>= 4;
 430     }
 431     if( c < 256 )
 432         snprintf( buf+6, 10, " (%" SAL_PRIuUINT32 ")", c );
 433
 434     sDescription = SvxResId( RID_SVXSTR_CHARACTER_CODE )
 435                  + " "
 436                  + OUString(buf, strlen(buf), RTL_TEXTENCODING_ASCII_US);
 437
 438     return sDescription;
 439 }
 440
 441
 442 OUString SAL_CALL SvxShowCharSetItemAcc::getAccessibleName()
 443 {
 444     OExternalLockGuard aGuard( this );
 445
 446     OUString aRet;
 447
 448     if( mpParent )
 449     {
 450         aRet = mpParent->maText;
 451
 452         if (aRet.isEmpty())
 453             aRet = getAccessibleDescription();
 454     }
 455
 456     return aRet;
 457 }
 458
 459
 460 uno::Reference< css::accessibility::XAccessibleRelationSet > SAL_CALL SvxShowCharSetItemAcc::getAccessibleRelationSet()
 461 {
 462     return uno::Reference< css::accessibility::XAccessibleRelationSet >();
 463 }
 464
 465
 466 sal_Int64 SAL_CALL SvxShowCharSetItemAcc::getAccessibleStateSet()
 467 {
 468     OExternalLockGuard aGuard( this );
 469
 470     sal_Int64 nStateSet = 0;
 471
 472     if( mpParent )
 473     {
 474         if (mpParent->mrParent.IsEnabled())
 475         {
 476             nStateSet |= css::accessibility::AccessibleStateType::ENABLED;
 477             // SELECTABLE
 478             nStateSet |= css::accessibility::AccessibleStateType::SELECTABLE;
 479             nStateSet |= css::accessibility::AccessibleStateType::FOCUSABLE;
 480         }
 481
 482         // SELECTED
 483         if( mpParent->mrParent.GetSelectIndexId() == mpParent->mnId )
 484         {
 485             nStateSet |= css::accessibility::AccessibleStateType::SELECTED;
 486             if (mpParent->mrParent.HasChildFocus())
 487                 nStateSet |= css::accessibility::AccessibleStateType::FOCUSED;
 488         }
 489         if ( mpParent->mnId >= mpParent->mrParent.FirstInView() && mpParent->mnId <= mpParent->mrParent.LastInView() )
 490         {
 491             nStateSet |= AccessibleStateType::VISIBLE;
 492             nStateSet |= AccessibleStateType::SHOWING;
 493         }
 494         nStateSet |= AccessibleStateType::TRANSIENT;
 495     }
 496
 497     return nStateSet;
 498 }
 499
 500
 501 sal_Int32 SvxShowCharSetItemAcc::getAccessibleActionCount()
 502 {
 503     return 1;
 504 }
 505
 506
 507 sal_Bool SvxShowCharSetItemAcc::doAccessibleAction ( sal_Int32 nIndex )
 508 {
 509     OExternalLockGuard aGuard( this );
 510
 511     if( nIndex == 0 )
 512     {
 513         mpParent->mrParent.OutputIndex( mpParent->mnId );
 514         return true;
 515     }
 516     throw IndexOutOfBoundsException();
 517 }
 518
 519
 520 OUString SvxShowCharSetItemAcc::getAccessibleActionDescription ( sal_Int32 nIndex )
 521 {
 522     if( nIndex == 0 )
 523         return "press";
 524     throw IndexOutOfBoundsException();
 525 }
 526
 527
 528 Reference< css::accessibility::XAccessibleKeyBinding > SvxShowCharSetItemAcc::getAccessibleActionKeyBinding( sal_Int32 nIndex )
 529 {
 530     if( nIndex == 0 )
 531         return Reference< css::accessibility::XAccessibleKeyBinding >();
 532     throw IndexOutOfBoundsException();
 533 }
 534
 535
 536 void SAL_CALL SvxShowCharSetItemAcc::grabFocus()
 537 {
 538     // nothing to do
 539 }
 540
 541 awt::Rectangle SvxShowCharSetItemAcc::implGetBounds(  )
 542 {
 543     awt::Rectangle      aRet;
 544
 545     if( mpParent )
 546     {
 547         tools::Rectangle   aRect( mpParent->maRect );
 548         tools::Rectangle   aParentRect(Point(), mpParent->mrParent.GetOutputSizePixel());
 549
 550         aRect.Intersection( aParentRect );
 551
 552         aRet.X = aRect.Left();
 553         aRet.Y = aRect.Top();
 554         aRet.Width = aRect.GetWidth();
 555         aRet.Height = aRect.GetHeight();
 556     }
 557
 558     return aRet;
 559 }
 560
 561 uno::Reference< css::accessibility::XAccessible > SAL_CALL SvxShowCharSetItemAcc::getAccessibleAtPoint( const awt::Point& /*aPoint*/ )
 562 {
 563     return uno::Reference< css::accessibility::XAccessible >();
 564 }
 565
 566 sal_Int32 SAL_CALL SvxShowCharSetAcc::getForeground(  )
 567 {
 568     OExternalLockGuard aGuard( this );
 569
 570     //see SvxShowCharSet::InitSettings
 571     const StyleSettings& rStyleSettings = Application::GetSettings().GetStyleSettings();
 572     return static_cast<sal_Int32>(rStyleSettings.GetDialogTextColor());
 573 }
 574
 575 sal_Int32 SAL_CALL SvxShowCharSetAcc::getBackground(  )
 576 {
 577     OExternalLockGuard aGuard( this  );
 578
 579     //see SvxShowCharSet::InitSettings
 580     const StyleSettings& rStyleSettings = Application::GetSettings().GetStyleSettings();
 581     return static_cast<sal_Int32>(rStyleSettings.GetWindowColor());
 582 }
 583
 584 }
 585
 586 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */