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