diff options
Diffstat (limited to 'editeng/inc/editeng/AccessibleContextBase.hxx')
| -rw-r--r-- | editeng/inc/editeng/AccessibleContextBase.hxx | 402 |
1 files changed, 0 insertions, 402 deletions
diff --git a/editeng/inc/editeng/AccessibleContextBase.hxx b/editeng/inc/editeng/AccessibleContextBase.hxx deleted file mode 100644 index 4313035ba5..0000000000 --- a/editeng/inc/editeng/AccessibleContextBase.hxx +++ /dev/null @@ -1,402 +0,0 @@ -/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ -/************************************************************************* - * - * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * - * Copyright 2000, 2010 Oracle and/or its affiliates. - * - * OpenOffice.org - a multi-platform office productivity suite - * - * This file is part of OpenOffice.org. - * - * OpenOffice.org is free software: you can redistribute it and/or modify - * it under the terms of the GNU Lesser General Public License version 3 - * only, as published by the Free Software Foundation. - * - * OpenOffice.org is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU Lesser General Public License version 3 for more details - * (a copy is included in the LICENSE file that accompanied this code). - * - * You should have received a copy of the GNU Lesser General Public License - * version 3 along with OpenOffice.org. If not, see - * <http://www.openoffice.org/license.html> - * for a copy of the LGPLv3 License. - * - ************************************************************************/ - -#ifndef _SVX_ACCESSIBILITY_ACCESSIBLE_CONTEXT_BASE_HXX -#define _SVX_ACCESSIBILITY_ACCESSIBLE_CONTEXT_BASE_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/accessibility/XAccessibleStateSet.hpp> -#include <com/sun/star/accessibility/XAccessibleRelationSet.hpp> -#include <com/sun/star/accessibility/AccessibleEventObject.hpp> -#include <com/sun/star/accessibility/AccessibleEventId.hpp> -#include <com/sun/star/accessibility/IllegalAccessibleComponentStateException.hpp> -#include <com/sun/star/uno/Reference.hxx> -#include <com/sun/star/lang/XComponent.hpp> -#include <cppuhelper/weak.hxx> -#include <com/sun/star/lang/XServiceInfo.hpp> -#include <com/sun/star/lang/XTypeProvider.hpp> -#include <com/sun/star/lang/IndexOutOfBoundsException.hpp> -#include <com/sun/star/lang/DisposedException.hpp> -#include <osl/mutex.hxx> -#include <cppuhelper/compbase4.hxx> -#include <editeng/editengdllapi.h> - - -namespace accessibility { - -struct MutexOwner {mutable ::osl::Mutex maMutex;}; - -/** @descr - This base class provides an implementation of the - <type>AccessibleContext</type> service. Appart from the - <type>XXAccessible<type> and <type>XAccessibleContextContext</type> - interfaces it supports the <type>XServiceInfo</type> interface. -*/ -class EDITENG_DLLPUBLIC AccessibleContextBase - : public MutexOwner, - public cppu::PartialWeakComponentImplHelper4< - ::com::sun::star::accessibility::XAccessible, - ::com::sun::star::accessibility::XAccessibleContext, - ::com::sun::star::accessibility::XAccessibleEventBroadcaster, - ::com::sun::star::lang::XServiceInfo - > -{ -public: - - //===== internal ======================================================== - - /** The origin of the accessible name or description. - */ - enum StringOrigin { - ManuallySet, - FromShape, - AutomaticallyCreated, - NotSet - }; - - AccessibleContextBase ( - const ::com::sun::star::uno::Reference< - ::com::sun::star::accessibility::XAccessible>& rxParent, - const sal_Int16 aRole); - virtual ~AccessibleContextBase (void); - - - /** Call all accessiblity event listeners to inform them about the - specified event. - @param aEventId - Id of the event type. - @param rNewValue - New value of the modified attribute. Pass empty structure if - not applicable. - @param rOldValue - Old value of the modified attribute. Pass empty structure if - not applicable. - */ - void CommitChange (sal_Int16 aEventId, - const ::com::sun::star::uno::Any& rNewValue, - const ::com::sun::star::uno::Any& rOldValue); - - /** Set a new description and, provided that the new name differs from - the old one, broadcast an accessibility event. - @param rsDescription - The new description. - @param eDescriptionOrigin - The origin of the description. This is used to determine - whether the given description overrules the existing one. An - origin with a lower numerical value overrides one with a higher - value. - */ - void SetAccessibleDescription ( - const ::rtl::OUString& rsDescription, - StringOrigin eDescriptionOrigin) - throw (::com::sun::star::uno::RuntimeException); - - /** Set a new description and, provided that the new name differs from - the old one, broadcast an accessibility event. - @param rsName - The new name. - @param eNameOrigin - The origin of the name. This is used to determine whether the - given name overrules the existing one. An origin with a lower - numerical value overrides one with a higher value. - */ - void SetAccessibleName ( - const ::rtl::OUString& rsName, - StringOrigin eNameOrigin) - throw (::com::sun::star::uno::RuntimeException); - - /** Set the specified state (turn it on) and send events to all - listeners to inform them of the change. - - @param aState - The state to turn on. - - @return - If the specified state changed its value due to this call - <TRUE/> is returned, otherwise <FALSE/>. - */ - virtual sal_Bool SetState (sal_Int16 aState); - - /** Reset the specified state (turn it off) and send events to all - listeners to inform them of the change. - - @param aState - The state to turn off. - - @return - If the specified state changed its value due to this call - <TRUE/> is returned, otherwise <FALSE/>. - */ - virtual sal_Bool ResetState (sal_Int16 aState); - - /** Return the state of the specified state. - - @param aState - The state for which to return its value. - - @return - A value of <TRUE/> indicates that the state is set. A <FALSE/> - value indicates an unset state. - */ - sal_Bool GetState (sal_Int16 aState); - - /** Replace the current relation set with the specified one. Send - events for relations that are not in both sets. - - @param rRelationSet - The new relation set that replaces the old one. - */ - virtual void SetRelationSet ( - const ::com::sun::star::uno::Reference< - ::com::sun::star::accessibility::XAccessibleRelationSet>& rxRelationSet) - throw (::com::sun::star::uno::RuntimeException); - - - //===== XAccessible ===================================================== - - /// Return the XAccessibleContext. - virtual ::com::sun::star::uno::Reference< - ::com::sun::star::accessibility::XAccessibleContext> SAL_CALL - getAccessibleContext (void) throw (::com::sun::star::uno::RuntimeException); - - - //===== XAccessibleContext ============================================== - - /// Return the number of currently visible children. - virtual sal_Int32 SAL_CALL - getAccessibleChildCount (void) throw (::com::sun::star::uno::RuntimeException); - - /// Return the specified child or throw exception. - virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible> SAL_CALL - getAccessibleChild (sal_Int32 nIndex) - throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException); - - /// Return a reference to the parent. - virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible> SAL_CALL - getAccessibleParent (void) - throw (::com::sun::star::uno::RuntimeException); - - /// Return this objects index among the parents children. - virtual sal_Int32 SAL_CALL - getAccessibleIndexInParent (void) - throw (::com::sun::star::uno::RuntimeException); - - /// Return this object's role. - virtual sal_Int16 SAL_CALL - getAccessibleRole (void) - throw (::com::sun::star::uno::RuntimeException); - - /// Return this object's description. - virtual ::rtl::OUString SAL_CALL - getAccessibleDescription (void) - throw (::com::sun::star::uno::RuntimeException); - - /// Return the object's current name. - virtual ::rtl::OUString SAL_CALL - getAccessibleName (void) - throw (::com::sun::star::uno::RuntimeException); - - /// Return NULL to indicate that an empty relation set. - virtual ::com::sun::star::uno::Reference< - ::com::sun::star::accessibility::XAccessibleRelationSet> SAL_CALL - getAccessibleRelationSet (void) - throw (::com::sun::star::uno::RuntimeException); - - /// Return the set of current states. - virtual ::com::sun::star::uno::Reference< - ::com::sun::star::accessibility::XAccessibleStateSet> SAL_CALL - getAccessibleStateSet (void) - throw (::com::sun::star::uno::RuntimeException); - - /** Return the parents locale or throw exception if this object has no - parent yet/anymore. - */ - virtual ::com::sun::star::lang::Locale SAL_CALL - getLocale (void) - throw (::com::sun::star::uno::RuntimeException, - ::com::sun::star::accessibility::IllegalAccessibleComponentStateException); - - //===== XComponent ======================================================== - - using WeakComponentImplHelperBase::addEventListener; - using WeakComponentImplHelperBase::removeEventListener; - - //===== XAccessibleEventBroadcaster ======================================== - - virtual void SAL_CALL - addEventListener ( - const ::com::sun::star::uno::Reference< - ::com::sun::star::accessibility::XAccessibleEventListener >& xListener) - throw (::com::sun::star::uno::RuntimeException); - - virtual void SAL_CALL - removeEventListener ( - const ::com::sun::star::uno::Reference< - ::com::sun::star::accessibility::XAccessibleEventListener >& xListener) - throw (::com::sun::star::uno::RuntimeException); - - - //===== XServiceInfo ==================================================== - - /** Returns an identifier for the implementation of this object. - */ - virtual ::rtl::OUString SAL_CALL - getImplementationName (void) - throw (::com::sun::star::uno::RuntimeException); - - /** Return whether the specified service is supported by this class. - */ - virtual sal_Bool SAL_CALL - supportsService (const ::rtl::OUString& sServiceName) - throw (::com::sun::star::uno::RuntimeException); - - /** Returns a list of all supported services. In this case that is just - the AccessibleContext service. - */ - virtual ::com::sun::star::uno::Sequence< ::rtl::OUString> SAL_CALL - getSupportedServiceNames (void) - throw (::com::sun::star::uno::RuntimeException); - - - //===== XTypeProvider =================================================== - - /** Returns a sequence of all supported interfaces. - */ - virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type> SAL_CALL - getTypes (void) - throw (::com::sun::star::uno::RuntimeException); - - /** Returns a implementation id. - */ - virtual ::com::sun::star::uno::Sequence<sal_Int8> SAL_CALL - getImplementationId (void) - throw (::com::sun::star::uno::RuntimeException); - -protected: - /** The state set. - */ - ::com::sun::star::uno::Reference< - ::com::sun::star::accessibility::XAccessibleStateSet> mxStateSet; - - /** The relation set. Relations can be set or removed by calling the - <member>AddRelation</member> and <member>RemoveRelation</member> methods. - */ - ::com::sun::star::uno::Reference< - ::com::sun::star::accessibility::XAccessibleRelationSet> mxRelationSet; - - // This method is called from the component helper base class while disposing. - virtual void SAL_CALL disposing (void); - - /** Create the accessible object's name. This method may be called more - than once for a single object. - @return - The returned string is a unique (among the accessible object's - siblings) name. - */ - virtual ::rtl::OUString CreateAccessibleName (void) - throw (::com::sun::star::uno::RuntimeException); - - /** Create the accessible object's descriptive string. May be called - more than once. - @return - Descriptive string. Not necessarily unique. - */ - virtual ::rtl::OUString - CreateAccessibleDescription (void) - throw (::com::sun::star::uno::RuntimeException); - - void FireEvent (const ::com::sun::star::accessibility::AccessibleEventObject& aEvent); - - /** Check whether or not the object has been disposed (or is in the - state of beeing disposed). If that is the case then - DisposedException is thrown to inform the (indirect) caller of the - foul deed. - */ - void ThrowIfDisposed (void) - throw (::com::sun::star::lang::DisposedException); - - /** Check whether or not the object has been disposed (or is in the - state of beeing disposed). - - @return TRUE, if the object is disposed or in the course - of being disposed. Otherwise, FALSE is returned. - */ - sal_Bool IsDisposed (void); - - /** sets the role as returned by XaccessibleContext::getAccessibleRole - - <p>Caution: This is only to be used in the construction phase (means within - the ctor or late ctor), <em>never</em> when the object is still alive and part - of an Accessibility hierarchy.</p> - */ - void SetAccessibleRole( sal_Int16 _nRole ); - -private: - /// Reference to the parent object. - ::com::sun::star::uno::Reference< - ::com::sun::star::accessibility::XAccessible> mxParent; - - /** Description of this object. This is not a constant because it can - be set from the outside. Furthermore, it changes according the the - draw page's display mode. - */ - ::rtl::OUString msDescription; - - /** The origin of the description is used to determine whether new - descriptions given to the SetAccessibleDescription is ignored or - whether that replaces the old value in msDescription. - */ - StringOrigin meDescriptionOrigin; - - /** Name of this object. It changes according the the draw page's - display mode. - */ - ::rtl::OUString msName; - - /** The origin of the name is used to determine whether new - name given to the SetAccessibleName is ignored or - whether that replaces the old value in msName. - */ - StringOrigin meNameOrigin; - - /** client id in the AccessibleEventNotifier queue - */ - sal_uInt32 mnClientId; - - /** This is the role of this object. - */ - sal_Int16 maRole; -}; - -} - -#endif - -/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |