winaccessibility/source/UAccCOM/AccText.h

   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 #ifndef INCLUDED_WINACCESSIBILITY_SOURCE_UACCCOM_ACCTEXT_H
  21 #define INCLUDED_WINACCESSIBILITY_SOURCE_UACCCOM_ACCTEXT_H
  22
  23 #include "Resource.h"       // main symbols
  24
  25 #include "AccTextBase.h"
  26
  27 /**
  28  * CAccText implements IAccessibleText interface.
  29  */
  30 class ATL_NO_VTABLE CAccText :
  31             public CComObjectRoot,
  32             public CComCoClass<CAccText,&CLSID_AccText>,
  33             public IAccessibleText,
  34             public CAccTextBase
  35 {
  36 public:
  37     CAccText()
  38     {
  39             }
  40
  41     BEGIN_COM_MAP(CAccText)
  42     COM_INTERFACE_ENTRY(IAccessibleText)
  43     COM_INTERFACE_ENTRY(IUNOXWrapper)
  44     COM_INTERFACE_ENTRY_FUNC_BLIND(NULL,SmartQI_)
  45 #if defined __clang__
  46 #pragma clang diagnostic push
  47 #pragma clang diagnostic ignored "-Winconsistent-missing-override"
  48 #endif
  49     END_COM_MAP()
  50 #if defined __clang__
  51 #pragma clang diagnostic pop
  52 #endif
  53
  54     static HRESULT WINAPI SmartQI_(void* pv,
  55                                    REFIID iid, void** ppvObject, DWORD_PTR)
  56     {
  57         return static_cast<CAccText*>(pv)->SmartQI(iid,ppvObject);
  58     }
  59
  60     HRESULT SmartQI(REFIID iid, void** ppvObject)
  61     {
  62         if( m_pOuterUnknown )
  63             return OuterQueryInterface(iid,ppvObject);
  64         return E_FAIL;
  65     }
  66
  67     DECLARE_NO_REGISTRY()
  68
  69 public:
  70     // IAccessibleText
  71
  72     // Adds a text selection.
  73     STDMETHOD(addSelection)(long startOffset, long endOffset) override;//, unsigned char * success);
  74
  75     // Gets text attributes.
  76     STDMETHOD(get_attributes)(long offset, long * startOffset, long * endOffset, BSTR * textAttributes) override;
  77
  78     // Gets caret offset.
  79     STDMETHOD(get_caretOffset)(long * offset) override;
  80
  81     // Gets bounding rect containing the glyph(s) representing the character
  82     // at the specified text offset
  83     STDMETHOD(get_characterExtents)(long offset, IA2CoordinateType coordType, long * x, long * y, long * width, long * height) override;
  84
  85     // Gets number of active non-contiguous selections.
  86     STDMETHOD(get_nSelections)(long * nSelections) override;
  87
  88     // Gets bounding rect for the glyph at a certain point.
  89     STDMETHOD(get_offsetAtPoint)(long x, long y, IA2CoordinateType coordType, long * offset) override;
  90
  91     // Gets character offsets of N-th active text selection.
  92     STDMETHOD(get_selection)(long selection, long * startOffset, long * endOffset) override;
  93
  94     // Gets a range of text by offset NOTE: returned string may be longer
  95     // than endOffset-startOffset bytes if text contains multi-byte characters.
  96     STDMETHOD(get_text)(long startOffset, long endOffset, BSTR * text) override;
  97
  98     // Gets a specified amount of text that ends before a specified offset.
  99     STDMETHOD(get_textBeforeOffset)(long offset, IA2TextBoundaryType boundaryType, long * startOffset, long * endOffset, BSTR * text) override;
 100
 101     // Gets a specified amount of text that spans the specified offset.
 102     STDMETHOD(get_textAfterOffset)(long offset, IA2TextBoundaryType boundaryType, long * startOffset, long * endOffset, BSTR * text) override;
 103
 104     // Gets a specified amount of text that starts after a specified offset.
 105     STDMETHOD(get_textAtOffset)(long offset, IA2TextBoundaryType boundaryType, long * startOffset, long * endOffset, BSTR * text) override;
 106
 107     // Unselects a range of text.
 108     STDMETHOD(removeSelection)(long selectionIndex) override;//, unsigned char * success);
 109
 110     // Moves text caret.
 111     STDMETHOD(setCaretOffset)(long offset) override;//, unsigned char * success);
 112
 113     // Changes the bounds of an existing selection.
 114     STDMETHOD(setSelection)(long selectionIndex, long startOffset, long endOffset) override;//, unsigned char * success);
 115
 116     // Gets total number of characters.
 117     // NOTE: this may be different than the total number of bytes required
 118     // to store the text, if the text contains multi-byte characters.
 119     STDMETHOD(get_nCharacters)(long * nCharacters) override;
 120
 121     // Makes specific part of string visible on screen.
 122     STDMETHOD(scrollSubstringTo)(long startIndex, long endIndex,enum IA2ScrollType scrollType) override;
 123     STDMETHOD(scrollSubstringToPoint)(long startIndex, long endIndex,enum IA2CoordinateType coordinateType, long x, long y ) override;
 124
 125     STDMETHOD(get_newText)( IA2TextSegment *newText) override;
 126
 127     STDMETHOD(get_oldText)( IA2TextSegment *oldText) override;
 128 };
 129
 130 #endif // INCLUDED_WINACCESSIBILITY_SOURCE_UACCCOM_ACCTEXT_H
 131
 132 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */