AccessibleContextBase.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_EDITENG_ACCESSIBLECONTEXTBASE_HXX
#define INCLUDED_EDITENG_ACCESSIBLECONTEXTBASE_HXX
 
#include <com/sun/star/accessibility/XAccessible.hpp>
#include <com/sun/star/accessibility/XAccessibleContext.hpp>
#include <com/sun/star/accessibility/XAccessibleEventBroadcaster.hpp>
#include <com/sun/star/uno/Reference.hxx>
#include <com/sun/star/lang/XServiceInfo.hpp>
#include <cppuhelper/compbase.hxx>
#include <cppuhelper/basemutex.hxx>
#include <editeng/editengdllapi.h>
#include <rtl/ref.hxx>
 
namespace com::sun::star::accessibility { class XAccessibleRelationSet; }
namespace com::sun::star::accessibility { struct AccessibleEventObject; }
 
namespace accessibility {
 
class EDITENG_DLLPUBLIC AccessibleContextBase
    :   public cppu::BaseMutex,
        public cppu::WeakComponentImplHelper<
        css::accessibility::XAccessible,
        css::accessibility::XAccessibleContext,
        css::accessibility::XAccessibleEventBroadcaster,
        css::lang::XServiceInfo
        >
{
public:
 
    //=====  internal  ========================================================
 
    enum StringOrigin {
        ManuallySet,
        FromShape,
        AutomaticallyCreated,
        NotSet
    };
 
    AccessibleContextBase (
        css::uno::Reference< css::accessibility::XAccessible> xParent,
        const sal_Int16 aRole);
    virtual ~AccessibleContextBase() override;
 
 
    void CommitChange (sal_Int16 aEventId,
        const css::uno::Any& rNewValue,
        const css::uno::Any& rOldValue,
        sal_Int32 nValueIndex);
 
    void SetAccessibleDescription (
        const OUString& rsDescription,
        StringOrigin eDescriptionOrigin);
 
    void SetAccessibleName (
        const OUString& rsName,
        StringOrigin eNameOrigin);
 
    virtual bool SetState (sal_Int64 aState);
 
    virtual bool ResetState (sal_Int64 aState);
 
    bool GetState (sal_Int64 aState);
 
    void SetRelationSet (
        const css::uno::Reference< css::accessibility::XAccessibleRelationSet>& rxRelationSet);
 
 
    //=====  XAccessible  =====================================================
 
    virtual css::uno::Reference< css::accessibility::XAccessibleContext> SAL_CALL
        getAccessibleContext() override;
 
 
    //=====  XAccessibleContext  ==============================================
 
    virtual sal_Int64 SAL_CALL
        getAccessibleChildCount() override;
 
    virtual css::uno::Reference< css::accessibility::XAccessible> SAL_CALL
        getAccessibleChild (sal_Int64 nIndex) override;
 
    virtual css::uno::Reference< css::accessibility::XAccessible> SAL_CALL
        getAccessibleParent() override;
 
    virtual sal_Int64 SAL_CALL
        getAccessibleIndexInParent() override;
 
    virtual sal_Int16 SAL_CALL
        getAccessibleRole() override;
 
    virtual OUString SAL_CALL
        getAccessibleDescription() override;
 
    virtual OUString SAL_CALL
        getAccessibleName() override;
 
    virtual css::uno::Reference< css::accessibility::XAccessibleRelationSet> SAL_CALL
        getAccessibleRelationSet() override;
 
    virtual sal_Int64 SAL_CALL getAccessibleStateSet() override;
 
    virtual css::lang::Locale SAL_CALL
        getLocale() override;
 
    //=====  XAccessibleEventBroadcaster  ========================================
 
    virtual void SAL_CALL
        addAccessibleEventListener (
            const css::uno::Reference< css::accessibility::XAccessibleEventListener >& xListener) override;
 
    virtual void SAL_CALL
        removeAccessibleEventListener (
            const css::uno::Reference< css::accessibility::XAccessibleEventListener >& xListener) override;
 
 
    //=====  XServiceInfo  ====================================================
 
    virtual OUString SAL_CALL
        getImplementationName() override;
 
    virtual sal_Bool SAL_CALL
        supportsService (const OUString& sServiceName) override;
 
    virtual css::uno::Sequence< OUString> SAL_CALL
        getSupportedServiceNames() override;
 
 
    //=====  XTypeProvider  ===================================================
 
    virtual css::uno::Sequence<sal_Int8> SAL_CALL
        getImplementationId() override;
 
    bool IsDisposed() const;
 
protected:
    sal_Int64 mnStateSet;
 
    css::uno::Reference< css::accessibility::XAccessibleRelationSet> mxRelationSet;
 
    // This method is called from the component helper base class while disposing.
    virtual void SAL_CALL disposing() override;
 
    virtual OUString CreateAccessibleName();
 
    void FireEvent (const css::accessibility::AccessibleEventObject& aEvent);
 
    void ThrowIfDisposed();
 
    void SetAccessibleRole( sal_Int16 _nRole );
 
private:
    css::uno::Reference< css::accessibility::XAccessible> mxParent;
 
    OUString msDescription;
 
    StringOrigin meDescriptionOrigin;
 
    OUString msName;
 
    StringOrigin meNameOrigin;
 
    sal_uInt32 mnClientId;
 
    sal_Int16 maRole;
};
 
}
 
#endif
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */