accessibleeventnotifier.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_COMPHELPER_ACCESSIBLEEVENTNOTIFIER_HXX
#define INCLUDED_COMPHELPER_ACCESSIBLEEVENTNOTIFIER_HXX
 
#include <comphelper/comphelperdllapi.h>
 
namespace com::sun::star::uno { class XInterface; }
namespace com::sun::star::uno { template <class interface_type> class Reference; }
namespace com::sun::star::accessibility { class XAccessibleEventListener; }
namespace com::sun::star::accessibility { struct AccessibleEventObject; }
 
namespace comphelper {
 
class COMPHELPER_DLLPUBLIC AccessibleEventNotifier
{
public:
    typedef sal_uInt32 TClientId;
 
public:
    AccessibleEventNotifier() = delete;
    ~AccessibleEventNotifier() = delete;
    AccessibleEventNotifier( const AccessibleEventNotifier& ) = delete;
    AccessibleEventNotifier& operator=( const AccessibleEventNotifier& ) = delete;
 
    static TClientId registerClient();
 
    static void revokeClient( const TClientId _nClient );
 
    static void revokeClientNotifyDisposing(
        const TClientId _nClient,
        const css::uno::Reference< css::uno::XInterface >& _rxEventSource );
 
    static sal_Int32 addEventListener(
        const TClientId _nClient,
        const css::uno::Reference< css::accessibility::XAccessibleEventListener >& _rxListener );
 
    static sal_Int32 removeEventListener(
        const TClientId _nClient,
        const css::uno::Reference< css::accessibility::XAccessibleEventListener >& _rxListener );
 
    static void addEvent(
        const TClientId _nClient,
        const css::accessibility::AccessibleEventObject& _rEvent );
 
    // to be called at application shutdown to clear the static map, so we don't get crashes on shutdown
    static void shutdown();
 
};
 
}   // namespace comphelper
 
#endif // INCLUDED_COMPHELPER_ACCESSIBLEEVENTNOTIFIER_HXX
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */