AccessibleEditObject.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 .
 */
 
#pragma once
 
#include "AccessibleContextBase.hxx"
 
#include <com/sun/star/accessibility/XAccessibleSelection.hpp>
#include <address.hxx>
#include <vcl/vclptr.hxx>
#include <vcl/customweld.hxx>
 
#include <memory>
 
namespace accessibility
{
    class AccessibleTextHelper;
}
class EditView;
class ScTextWnd;
namespace vcl { class Window; }
 
class ScAccessibleEditObject
    :   public  ScAccessibleContextBase,
        public css::accessibility::XAccessibleSelection
{
public:
    enum EditObjectType
    {
        CellInEditMode,
        EditLine,
        EditControl
    };
 
    ScAccessibleEditObject(
        const css::uno::Reference<css::accessibility::XAccessible>& rxParent,
        EditView* pEditView, vcl::Window* pWin, const OUString& rName,
        const OUString& rDescription, EditObjectType eObjectType);
 
    void InitAcc(
        const css::uno::Reference<css::accessibility::XAccessible>& rxParent,
        EditView* pEditView, const OUString& rName, const OUString& rDescription);
 
protected:
    virtual ~ScAccessibleEditObject() override;
 
    ScAccessibleEditObject(EditObjectType eObjectType);
 
    using ScAccessibleContextBase::IsDefunc;
 
public:
    using ScAccessibleContextBase::disposing;
 
    virtual void SAL_CALL disposing() override;
 
    void LostFocus();
 
    void GotFocus();
 
    virtual css::uno::Any SAL_CALL queryInterface(
        css::uno::Type const & rType ) override;
 
    virtual void SAL_CALL acquire() noexcept override;
 
    virtual void SAL_CALL release() noexcept override;
 
    virtual css::uno::Reference< css::accessibility::XAccessible >
        SAL_CALL getAccessibleAtPoint(
        const css::awt::Point& rPoint ) override;
 
    virtual OutputDevice* GetOutputDeviceForView();
 
protected:
    virtual tools::Rectangle GetBoundingBoxOnScreen() const override;
 
    virtual tools::Rectangle GetBoundingBox() const override;
 
public:
 
    virtual sal_Int64 SAL_CALL
        getAccessibleChildCount() override;
 
    virtual css::uno::Reference< css::accessibility::XAccessible> SAL_CALL
        getAccessibleChild(sal_Int64 nIndex) override;
 
    virtual sal_Int64 SAL_CALL getAccessibleStateSet() override;
 
    //=====  XAccessibleSelection  ============================================
 
        virtual void SAL_CALL selectAccessibleChild(
            sal_Int64 nChildIndex ) override;
        virtual sal_Bool SAL_CALL isAccessibleChildSelected(
            sal_Int64 nChildIndex ) override;
        virtual void SAL_CALL clearAccessibleSelection(  ) override;
        virtual void SAL_CALL selectAllAccessibleChildren(  ) override;
        virtual sal_Int64 SAL_CALL getSelectedAccessibleChildCount(  ) override;
        virtual css::uno::Reference< css::accessibility::XAccessible > SAL_CALL getSelectedAccessibleChild(
            sal_Int64 nSelectedChildIndex ) override;
        virtual void SAL_CALL deselectAccessibleChild(
            sal_Int64 nSelectedChildIndex ) override;
    virtual css::uno::Reference< css::accessibility::XAccessibleRelationSet > SAL_CALL getAccessibleRelationSet(  ) override;
protected:
    virtual OUString
        createAccessibleDescription() override;
 
    virtual OUString
        createAccessibleName() override;
 
public:
 
    virtual void SAL_CALL
        addAccessibleEventListener(
            const css::uno::Reference<css::accessibility::XAccessibleEventListener>& xListener) override;
 
    //  Remove an existing event listener.
    virtual void SAL_CALL
        removeAccessibleEventListener(
            const css::uno::Reference<css::accessibility::XAccessibleEventListener>& xListener) override;
 
 
    virtual OUString SAL_CALL
        getImplementationName() override;
 
 
    virtual css::uno::Sequence<sal_Int8> SAL_CALL
        getImplementationId() override;
 
private:
    std::unique_ptr<accessibility::AccessibleTextHelper> mpTextHelper;
    EditView*      mpEditView;
    VclPtr<vcl::Window> mpWindow;
protected:
    ScTextWnd* mpTextWnd;
private:
    EditObjectType meObjectType;
    bool           mbHasFocus;
 
    bool IsDefunc(sal_Int64 nParentStates);
 
    void CreateTextHelper();
    ScDocument *m_pScDoc;
    ScAddress m_curCellAddress;
 
    virtual sal_Int32 SAL_CALL getForeground(  ) override;
 
    virtual sal_Int32 SAL_CALL getBackground(  ) override;
 
    sal_Int32 GetFgBgColor(  const OUString &strPropColor) ;
};
 
class ScAccessibleEditControlObject : public ScAccessibleEditObject
{
private:
    weld::CustomWidgetController* m_pController;
 
protected:
    virtual tools::Rectangle GetBoundingBoxOnScreen() const override;
 
    virtual tools::Rectangle GetBoundingBox() const override;
 
public:
    ScAccessibleEditControlObject(weld::CustomWidgetController* pController, EditObjectType eObjectType)
        : ScAccessibleEditObject(eObjectType)
        , m_pController(pController)
    {
    }
 
    virtual css::uno::Reference< css::accessibility::XAccessibleRelationSet > SAL_CALL getAccessibleRelationSet(  ) override;
 
    // for mapping positions/sizes within the TextView to a11y
    virtual OutputDevice* GetOutputDeviceForView() override;
 
    using ScAccessibleContextBase::disposing;
    virtual void SAL_CALL disposing() override;
};
 
class ScAccessibleEditLineObject : public ScAccessibleEditControlObject
{
public:
    ScAccessibleEditLineObject(ScTextWnd* pTextWnd);
};
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */