AccTextBase.h

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
 
// AccTextBase.h: interface for the CAccTextBase class.
 
#pragma once
 
#include <com/sun/star/uno/Reference.hxx>
#include <com/sun/star/accessibility/XAccessibleText.hpp>
#include "UNOXWrapper.h"
 
class ATL_NO_VTABLE CAccTextBase : public CUNOXWrapper
{
public:
    CAccTextBase();
    virtual ~CAccTextBase();
 
    // IAccessibleText
public:
    // IAccessibleText
 
    // Adds a text selection.
    STDMETHOD(get_addSelection)(long startOffset, long endOffset);
 
    // Gets text attributes.
    STDMETHOD(get_attributes)
    (long offset, long* startOffset, long* endOffset, BSTR* textAttributes);
 
    // Gets caret offset.
    STDMETHOD(get_caretOffset)(long* offset);
 
    // Gets total number of characters.
    STDMETHOD(get_characterCount)(long* nCharacters);
 
    // Gets bounding rect containing the glyph(s) representing the character
    // at the specified text offset
    STDMETHOD(get_characterExtents)
    (long offset, IA2CoordinateType coordType, long* x, long* y, long* width, long* height);
 
    // Gets number of active non-contiguous selections.
    STDMETHOD(get_nSelections)(long* nSelections);
 
    // Gets bounding rect for the glyph at a certain point.
    STDMETHOD(get_offsetAtPoint)(long x, long y, IA2CoordinateType coordType, long* offset);
 
    // Gets character offsets of N-th active text selection.
    STDMETHOD(get_selection)(long selectionIndex, long* startOffset, long* endOffset);
 
    // Gets a range of text by offset NOTE: returned string may be longer
    // than endOffset-startOffset bytes if text contains multi-byte characters.
    STDMETHOD(get_text)(long startOffset, long endOffset, BSTR* text);
 
    // Gets a specified amount of text that ends before a specified offset.
    STDMETHOD(get_textBeforeOffset)
    (long offset, IA2TextBoundaryType boundaryType, long* startOffset, long* endOffset, BSTR* text);
 
    // Gets a specified amount of text that spans the specified offset.
    STDMETHOD(get_textAfterOffset)
    (long offset, IA2TextBoundaryType boundaryType, long* startOffset, long* endOffset, BSTR* text);
 
    // Gets a specified amount of text that starts after a specified offset.
    STDMETHOD(get_textAtOffset)
    (long offset, IA2TextBoundaryType boundaryType, long* startOffset, long* endOffset, BSTR* text);
 
    // Unselects a range of text.
    STDMETHOD(removeSelection)(long selectionIndex);
 
    // Moves text caret.
    STDMETHOD(setCaretOffset)(long offset);
 
    // Changes the bounds of an existing selection.
    STDMETHOD(setSelection)(long selectionIndex, long startOffset, long endOffset);
 
    // Gets total number of characters.
    // NOTE: this may be different than the total number of bytes required
    // to store the text, if the text contains multi-byte characters.
    STDMETHOD(get_nCharacters)(long* nCharacters);
 
    STDMETHOD(get_newText)(IA2TextSegment* newText);
 
    STDMETHOD(get_oldText)(IA2TextSegment* oldText);
 
    // Makes specific part of string visible on screen.
    STDMETHOD(scrollSubstringTo)(long startIndex, long endIndex, enum IA2ScrollType scrollType);
    STDMETHOD(scrollSubstringToPoint)
    (long startIndex, long endIndex, enum IA2CoordinateType coordinateType, long x, long y);
 
    // Override of IUNOXWrapper.
    STDMETHOD(put_XInterface)(hyper pXInterface) override;
 
private:
    css::uno::Reference<css::accessibility::XAccessibleText> pRXText;
 
    css::accessibility::XAccessibleText* GetXInterface() { return pRXText.get(); }
};
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */