AccessibleTextHelper.hxx

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 .
 */

#ifndef INCLUDED_SVX_ACCESSIBLETEXTHELPER_HXX
#define INCLUDED_SVX_ACCESSIBLETEXTHELPER_HXX

#include <memory>
#include <vector>

#include <com/sun/star/uno/Reference.hxx>
#include <sal/types.h>
#include <svx/svxdllapi.h>

namespace com::sun::star
{
namespace accessibility
{
class XAccessible;
}
namespace accessibility
{
class XAccessibleEventListener;
}
namespace awt
{
struct Point;
}
}

class Point;
class SvxEditSource;

namespace accessibility
{
class AccessibleTextHelper_Impl;

class SVX_DLLPUBLIC AccessibleTextHelper final
{
public:
    typedef ::std::vector<sal_Int16> VectorOfStates;

    explicit AccessibleTextHelper(::std::unique_ptr<SvxEditSource>&& pEditSource);

    ~AccessibleTextHelper();

    AccessibleTextHelper(const AccessibleTextHelper&) = delete;
    AccessibleTextHelper& operator=(const AccessibleTextHelper&) = delete;

    const SvxEditSource& GetEditSource() const;

    void SetEditSource(::std::unique_ptr<SvxEditSource>&& pEditSource);

    void SetEventSource(const css::uno::Reference<css::accessibility::XAccessible>& rInterface);

    void SetOffset(const Point& rPoint);

    void SetStartIndex(sal_Int32 nOffset);

    sal_Int32 GetStartIndex() const;

    void SetAdditionalChildStates(const VectorOfStates& rChildStates);

    void UpdateChildren();

    void Dispose();

    void SetFocus(bool bHaveFocus = true);

    bool HaveFocus();

    // XAccessibleContext child handling methods

    sal_Int32 GetChildCount() const;
    css::uno::Reference<css::accessibility::XAccessible> GetChild(sal_Int32 i);

    // XAccessibleEventBroadcaster child related methods

    void AddEventListener(
        const css::uno::Reference<css::accessibility::XAccessibleEventListener>& xListener);
    void RemoveEventListener(
        const css::uno::Reference<css::accessibility::XAccessibleEventListener>& xListener);

    // XAccessibleComponent child related methods

    css::uno::Reference<css::accessibility::XAccessible> GetAt(const css::awt::Point& aPoint);

private:
    const std::unique_ptr<AccessibleTextHelper_Impl> mpImpl;
};

} // end of namespace accessibility

#endif // INCLUDED_SVX_ACCESSIBLETEXTHELPER_HXX

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */