winaccessibility/source/UAccCOM/AccHypertext.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 "stdafx.h"
  21 #include "AccHypertext.h"
  22 #include "AccHyperLink.h"
  23 #include "acccommon.h"
  24
  25 #if defined __clang__
  26 #pragma clang diagnostic push
  27 #pragma clang diagnostic ignored "-Wnon-virtual-dtor"
  28 #endif
  29 #include  <UAccCOM.h>
  30 #if defined __clang__
  31 #pragma clang diagnostic pop
  32 #endif
  33
  34 #include <vcl/svapp.hxx>
  35
  36
  37 using namespace com::sun::star::accessibility;
  38 using namespace com::sun::star::uno;
  39
  40
  41 /**
  42    * Get special selection.
  43    * @param startOffset Start selection offset.
  44    * @param endOffset   End selection offset.
  45    * @param success     Variant to accept the result of if the method call is successful.
  46    * @return Result.
  47 */
  48 COM_DECLSPEC_NOTHROW STDMETHODIMP CAccHypertext::addSelection(long startOffset, long endOffset)
  49 {
  50
  51     return CAccTextBase::get_addSelection(startOffset, endOffset);
  52 }
  53
  54
  55 /**
  56    * Get special attributes.
  57    * @param offset Offset.
  58    * @param startOffset Variant to accept start offset.
  59    * @param endOffset   Variant to accept end offset.
  60    * @param textAttributes     Variant to accept attributes.
  61    * @return Result.
  62 */
  63 COM_DECLSPEC_NOTHROW STDMETHODIMP CAccHypertext::get_attributes(long offset, long * startOffset, long * endOffset, BSTR * textAttributes)
  64 {
  65
  66     return CAccTextBase::get_attributes(offset, startOffset, endOffset, textAttributes);
  67 }
  68
  69 /**
  70    * Get caret position.
  71    * @param offset     Variant to accept caret offset.
  72    * @return Result.
  73 */
  74 COM_DECLSPEC_NOTHROW STDMETHODIMP CAccHypertext::get_caretOffset(long * offset)
  75 {
  76
  77     return CAccTextBase::get_caretOffset(offset);
  78 }
  79
  80 /**
  81    * Get character extents.
  82    * @param offset  Offset.
  83    * @param x Variant to accept x position.
  84    * @param y Variant to accept y position.
  85    * @param width Variant to accept width.
  86    * @param Height Variant to accept height.
  87    * @return Result.
  88 */
  89 COM_DECLSPEC_NOTHROW STDMETHODIMP CAccHypertext::get_characterExtents(long offset, IA2CoordinateType coordType, long * x, long * y, long * width, long * height)
  90 {
  91
  92     return CAccTextBase::get_characterExtents(offset, coordType, x, y, width, height);
  93 }
  94
  95 /**
  96    * Get selections count.
  97    * @param nSelections Variant to accept selections count.
  98    * @return Result.
  99 */
 100 COM_DECLSPEC_NOTHROW STDMETHODIMP CAccHypertext::get_nSelections(long * nSelections)
 101 {
 102
 103     return CAccTextBase::get_nSelections(nSelections);
 104 }
 105
 106 /**
 107    * Get offset of some special point.
 108    * @param x X position of one point.
 109    * @param x Y position of one point.
 110    * @param coordType Type.
 111    * @param offset Variant to accept offset.
 112    * @return Result.
 113 */
 114 COM_DECLSPEC_NOTHROW STDMETHODIMP CAccHypertext::get_offsetAtPoint(long x, long y, IA2CoordinateType coordType, long * offset)
 115 {
 116     return CAccTextBase::get_offsetAtPoint(x, y, coordType, offset);
 117 }
 118
 119 /**
 120    * Get selection range.
 121    * @param selection selection count.
 122    * @param startOffset Variant to accept the start offset of special selection.
 123    * @param endOffset Variant to accept the end offset of special selection.
 124    * @return Result.
 125 */
 126 COM_DECLSPEC_NOTHROW STDMETHODIMP CAccHypertext::get_selection(long selection, long * startOffset, long * endOffset)
 127 {
 128
 129     return CAccTextBase::get_selection(selection, startOffset, endOffset);
 130 }
 131
 132 /**
 133    * Get special text.
 134    * @param startOffset Start position of special range.
 135    * @param endOffset   End position of special range.
 136    * @param text        Variant to accept the text of special range.
 137    * @return Result.
 138 */
 139 COM_DECLSPEC_NOTHROW STDMETHODIMP CAccHypertext::get_text(long startOffset, long endOffset, BSTR * text)
 140 {
 141
 142     return CAccTextBase::get_text(startOffset, endOffset, text);
 143 }
 144
 145 /**
 146    * Get special text before some position.
 147    * @param offset Special position.
 148    * @param boundaryType Boundary type.
 149    * @param startOffset Variant to accept the start offset.
 150    * @param endOffset   Variant to accept the end offset.
 151    * @param text        Variant to accept the special text.
 152    * @return Result.
 153 */
 154 COM_DECLSPEC_NOTHROW STDMETHODIMP CAccHypertext::get_textBeforeOffset(long offset, IA2TextBoundaryType boundaryType, long * startOffset, long * endOffset, BSTR * text)
 155 {
 156
 157     return CAccTextBase::get_textBeforeOffset(offset, boundaryType,
 158             startOffset, endOffset, text);
 159 }
 160
 161 /**
 162    * Get special text after some position.
 163    * @param offset Special position.
 164    * @param boundaryType Boundary type.
 165    * @param startOffset Variant to accept the start offset.
 166    * @param endOffset   Variant to accept the end offset.
 167    * @param text        Variant to accept the special text.
 168    * @return Result.
 169 */
 170 COM_DECLSPEC_NOTHROW STDMETHODIMP CAccHypertext::get_textAfterOffset(long offset, IA2TextBoundaryType boundaryType, long * startOffset, long * endOffset, BSTR * text)
 171 {
 172
 173     return CAccTextBase::get_textAfterOffset(offset, boundaryType,
 174             startOffset, endOffset, text);
 175 }
 176
 177 /**
 178    * Get special text at some position.
 179    * @param offset Special position.
 180    * @param boundaryType Boundary type.
 181    * @param startOffset Variant to accept the start offset.
 182    * @param endOffset   Variant to accept the end offset.
 183    * @param text        Variant to accept the special text.
 184    * @return Result.
 185 */
 186 COM_DECLSPEC_NOTHROW STDMETHODIMP CAccHypertext::get_textAtOffset(long offset, IA2TextBoundaryType boundaryType, long * startOffset, long * endOffset, BSTR * text)
 187 {
 188
 189     return CAccTextBase::get_textAtOffset(offset, boundaryType,
 190                                           startOffset, endOffset, text);
 191 }
 192
 193 /**
 194    * Remove selection.
 195    * @param selectionIndex Special selection index
 196    * @param success Variant to accept the memthod called result.
 197    * @return Result.
 198 */
 199 COM_DECLSPEC_NOTHROW STDMETHODIMP CAccHypertext::removeSelection(long selectionIndex)
 200 {
 201
 202     return CAccTextBase::removeSelection(selectionIndex);
 203 }
 204
 205 /**
 206    * Set caret position.
 207    * @param offset Special position.
 208    * @param success Variant to accept the memthod called result.
 209    * @return Result.
 210 */
 211 COM_DECLSPEC_NOTHROW STDMETHODIMP CAccHypertext::setCaretOffset(long offset)
 212 {
 213
 214     return CAccTextBase::setCaretOffset(offset);
 215 }
 216
 217 /**
 218    * Set special selection.
 219    * @param selectionIndex Special selection index.
 220    * @param startOffset start position.
 221    * @param endOffset end position.
 222    * @param success Variant to accept the memthod called result.
 223    * @return Result.
 224 */
 225 COM_DECLSPEC_NOTHROW STDMETHODIMP CAccHypertext::setSelection(long selectionIndex, long startOffset, long endOffset)
 226 {
 227
 228     return CAccTextBase::setSelection(selectionIndex, startOffset,
 229                                       endOffset);
 230 }
 231
 232 /**
 233    * Get characters count.
 234    * @param nCharacters Variant to accept the characters count.
 235    * @return Result.
 236 */
 237 COM_DECLSPEC_NOTHROW STDMETHODIMP CAccHypertext::get_nCharacters(long * nCharacters)
 238 {
 239
 240     return CAccTextBase::get_nCharacters(nCharacters);
 241 }
 242
 243 COM_DECLSPEC_NOTHROW STDMETHODIMP CAccHypertext::get_newText( IA2TextSegment *newText)
 244 {
 245     return CAccTextBase::get_newText(newText);
 246 }
 247
 248 COM_DECLSPEC_NOTHROW STDMETHODIMP CAccHypertext::get_oldText( IA2TextSegment *oldText)
 249 {
 250     return CAccTextBase::get_oldText(oldText);
 251 }
 252
 253 /**
 254    * Scroll to special sub-string .
 255    * @param startIndex Start index of sub string.
 256    * @param endIndex   End index of sub string.
 257    * @return Result.
 258 */
 259 COM_DECLSPEC_NOTHROW STDMETHODIMP CAccHypertext::scrollSubstringToPoint(long startIndex, long endIndex,enum IA2CoordinateType coordinateType, long x, long y )
 260 {
 261
 262     return CAccTextBase::scrollSubstringToPoint(startIndex, endIndex, coordinateType, x, y);
 263 }
 264 COM_DECLSPEC_NOTHROW STDMETHODIMP CAccHypertext::scrollSubstringTo(long startIndex, long endIndex,enum IA2ScrollType scrollType)
 265 {
 266
 267     return CAccTextBase::scrollSubstringTo(startIndex, endIndex,scrollType);
 268 }
 269
 270 /**
 271    * Get hyperlink count.
 272    * @param hyperlinkCount Variant to accept hyperlink count.
 273    * @return Result.
 274 */
 275 COM_DECLSPEC_NOTHROW STDMETHODIMP CAccHypertext::get_nHyperlinks(long *hyperlinkCount)
 276 {
 277     SolarMutexGuard g;
 278
 279     ENTER_PROTECTED_BLOCK
 280
 281     // #CHECK#
 282     if(hyperlinkCount == nullptr)
 283         return E_INVALIDARG;
 284     // #CHECK XInterface#
 285     if(!pHyperText.is())
 286     {
 287         return E_FAIL;
 288     }
 289
 290     *hyperlinkCount = pHyperText->getHyperLinkCount();
 291     return S_OK;
 292
 293     LEAVE_PROTECTED_BLOCK
 294 }
 295
 296 /**
 297    * Get special hyperlink.
 298    * @param index Special hyperlink index.
 299    * @param hyperlink Variant to accept special hyperlink via index.
 300    * @return Result.
 301 */
 302 COM_DECLSPEC_NOTHROW STDMETHODIMP CAccHypertext::get_hyperlink(long index,IAccessibleHyperlink **hyperlink)
 303 {
 304     SolarMutexGuard g;
 305
 306     ENTER_PROTECTED_BLOCK
 307
 308     // #CHECK#
 309     if(hyperlink == nullptr)
 310         return E_INVALIDARG;
 311     // #CHECK XInterface#
 312     if(!pHyperText.is())
 313     {
 314         return E_FAIL;
 315     }
 316
 317     Reference<XAccessibleHyperlink> pRLink = pHyperText->getHyperLink(index);
 318     if(!pRLink.is())
 319     {
 320         *hyperlink = nullptr;
 321         return E_FAIL;
 322     }
 323
 324     IAccessibleHyperlink* plink = nullptr;
 325     HRESULT hr = createInstance<CAccHyperLink>(IID_IAccessibleHyperlink, &plink);
 326     if( SUCCEEDED(hr) )
 327     {
 328         IUNOXWrapper* wrapper = nullptr;
 329         plink->QueryInterface(IID_IUNOXWrapper, reinterpret_cast<void**>(&wrapper));
 330         if(wrapper)
 331         {
 332             wrapper->put_XSubInterface(reinterpret_cast<hyper>(pRLink.get()));
 333             wrapper->Release();
 334         }
 335         *hyperlink = plink;
 336         return S_OK;
 337     }
 338
 339     return E_FAIL;
 340
 341     LEAVE_PROTECTED_BLOCK
 342 }
 343
 344 /**
 345    * Returns the index of the hyperlink that is associated with this character index.
 346    * @param charIndex Special char index.
 347    * @param hyperlinkIndex Variant to accept special hyperlink index.
 348    * @return Result.
 349 */
 350 COM_DECLSPEC_NOTHROW STDMETHODIMP CAccHypertext::get_hyperlinkIndex(long charIndex, long *hyperlinkIndex)
 351 {
 352     SolarMutexGuard g;
 353
 354     ENTER_PROTECTED_BLOCK
 355
 356     // #CHECK#
 357     if(hyperlinkIndex == nullptr)
 358         return E_INVALIDARG;
 359     // #CHECK XInterface#
 360     if(!pHyperText.is())
 361     {
 362         return E_FAIL;
 363     }
 364
 365     *hyperlinkIndex = pHyperText->getHyperLinkIndex(charIndex);
 366     return S_OK;
 367
 368     LEAVE_PROTECTED_BLOCK
 369 }
 370
 371 /**
 372    * Put UNO interface.
 373    * @param pXInterface UNO interface.
 374    * @return Result.
 375 */
 376 COM_DECLSPEC_NOTHROW STDMETHODIMP CAccHypertext::put_XInterface(hyper pXInterface)
 377 {
 378     // internal IUNOXWrapper - no mutex meeded
 379
 380     ENTER_PROTECTED_BLOCK
 381
 382     CAccTextBase::put_XInterface(pXInterface);
 383     //special query.
 384     if(pUNOInterface == nullptr)
 385         return E_FAIL;
 386     Reference<XAccessibleContext> pRContext = pUNOInterface->getAccessibleContext();
 387     if( !pRContext.is() )
 388     {
 389         return E_FAIL;
 390     }
 391     Reference<XAccessibleHypertext> pRXI(pRContext,UNO_QUERY);
 392     if( !pRXI.is() )
 393         pHyperText = nullptr;
 394     else
 395         pHyperText = pRXI.get();
 396     return S_OK;
 397
 398     LEAVE_PROTECTED_BLOCK
 399 }
 400
 401 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */