office-gobmx/sd/source/ui/inc/AccessibleSlideSorterObject.hxx
Thorsten Behrens 70626249cd API CHANGE a11y unpublishing and add/removeListener rename.
The a11y API has never really been picked up by tools vendors, let's
not tie ourselves up here for no good reason.

This unpublishes all css::accessibility, and dependend API.

With that, we can change the rather unfortunately-named add/
removeEventListener to be add/removeAccessibleEventListener, thus
not conflicting with the XComponent methods of the same name.

Change-Id: I595598c3a8e46415f80b2780f333333174865fe4
2012-11-29 16:58:16 +01:00

247 lines
9.4 KiB
C++

/* -*- 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 SD_ACCESSIBILITY_ACCESSIBLE_SLIDE_SORTER_OBJECT_HXX
#define SD_ACCESSIBILITY_ACCESSIBLE_SLIDE_SORTER_OBJECT_HXX
#include "MutexOwner.hxx"
#include <cppuhelper/compbase5.hxx>
#include <com/sun/star/accessibility/XAccessible.hpp>
#include <com/sun/star/accessibility/XAccessibleContext.hpp>
#include <com/sun/star/accessibility/XAccessibleComponent.hpp>
#include <com/sun/star/accessibility/XAccessibleSelection.hpp>
#include <com/sun/star/accessibility/XAccessibleEventBroadcaster.hpp>
#include <com/sun/star/awt/XFocusListener.hpp>
#include <com/sun/star/lang/XServiceInfo.hpp>
#include <com/sun/star/lang/DisposedException.hpp>
class SdPage;
namespace sd { namespace slidesorter {
class SlideSorter;
} }
namespace accessibility {
typedef ::cppu::PartialWeakComponentImplHelper5<
::com::sun::star::accessibility::XAccessible,
::com::sun::star::accessibility::XAccessibleEventBroadcaster,
::com::sun::star::accessibility::XAccessibleContext,
::com::sun::star::accessibility::XAccessibleComponent,
::com::sun::star::lang::XServiceInfo > AccessibleSlideSorterObjectBase;
/** This class makes page objects of the slide sorter accessible.
*/
class AccessibleSlideSorterObject
: public ::sd::MutexOwner,
public AccessibleSlideSorterObjectBase
{
public:
/** Create a new object that represents a page object in the slide
sorter.
@param rxParent
The accessible parent.
@param rSlideSorter
The slide sorter whose model manages the page.
@param nPageNumber
The number of the page in the range [0,nPageCount).
*/
AccessibleSlideSorterObject(
const ::com::sun::star::uno::Reference<
::com::sun::star::accessibility::XAccessible >& rxParent,
::sd::slidesorter::SlideSorter& rSlideSorter,
sal_uInt16 nPageNumber);
~AccessibleSlideSorterObject (void);
/** Return the page that is made accessible by the called object.
*/
SdPage* GetPage (void) const;
/** The page number as given to the constructor.
*/
sal_uInt16 GetPageNumber (void) const;
void FireAccessibleEvent (
short nEventId,
const ::com::sun::star::uno::Any& rOldValue,
const ::com::sun::star::uno::Any& rNewValue);
virtual void SAL_CALL disposing (void);
//===== XComponent ==============================================
virtual void SAL_CALL dispose()throw (::com::sun::star::uno::RuntimeException)
{ WeakComponentImplHelperBase::dispose(); }
virtual void SAL_CALL addEventListener(const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XEventListener > & xListener)throw (::com::sun::star::uno::RuntimeException)
{ WeakComponentImplHelperBase::addEventListener(xListener); }
virtual void SAL_CALL removeEventListener(const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XEventListener > & xListener)throw (::com::sun::star::uno::RuntimeException)
{ WeakComponentImplHelperBase::removeEventListener(xListener); }
//===== XAccessible =======================================================
virtual ::com::sun::star::uno::Reference<
::com::sun::star::accessibility::XAccessibleContext > SAL_CALL
getAccessibleContext (void)
throw (::com::sun::star::uno::RuntimeException);
//===== XAccessibleEventBroadcaster =======================================
virtual void SAL_CALL
addAccessibleEventListener(
const ::com::sun::star::uno::Reference<
::com::sun::star::accessibility::XAccessibleEventListener >& rxListener)
throw (::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL
removeAccessibleEventListener(
const ::com::sun::star::uno::Reference<
::com::sun::star::accessibility::XAccessibleEventListener >& rxListener )
throw (::com::sun::star::uno::RuntimeException);
//===== XAccessibleContext ==============================================
virtual sal_Int32 SAL_CALL
getAccessibleChildCount (void) throw (::com::sun::star::uno::RuntimeException);
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);
virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible> SAL_CALL
getAccessibleParent (void)
throw (::com::sun::star::uno::RuntimeException);
virtual sal_Int32 SAL_CALL
getAccessibleIndexInParent (void)
throw (::com::sun::star::uno::RuntimeException);
virtual sal_Int16 SAL_CALL
getAccessibleRole (void)
throw (::com::sun::star::uno::RuntimeException);
virtual ::rtl::OUString SAL_CALL
getAccessibleDescription (void)
throw (::com::sun::star::uno::RuntimeException);
virtual ::rtl::OUString SAL_CALL
getAccessibleName (void)
throw (::com::sun::star::uno::RuntimeException);
virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessibleRelationSet> SAL_CALL
getAccessibleRelationSet (void)
throw (::com::sun::star::uno::RuntimeException);
virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessibleStateSet> SAL_CALL
getAccessibleStateSet (void)
throw (::com::sun::star::uno::RuntimeException);
virtual ::com::sun::star::lang::Locale SAL_CALL
getLocale (void)
throw (::com::sun::star::uno::RuntimeException,
::com::sun::star::accessibility::IllegalAccessibleComponentStateException);
//===== XAccessibleComponent ================================================
virtual sal_Bool SAL_CALL containsPoint (
const ::com::sun::star::awt::Point& aPoint)
throw (::com::sun::star::uno::RuntimeException);
virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible > SAL_CALL
getAccessibleAtPoint (
const ::com::sun::star::awt::Point& aPoint)
throw (::com::sun::star::uno::RuntimeException);
virtual ::com::sun::star::awt::Rectangle SAL_CALL getBounds (void)
throw (::com::sun::star::uno::RuntimeException);
virtual ::com::sun::star::awt::Point SAL_CALL getLocation (void)
throw (::com::sun::star::uno::RuntimeException);
virtual ::com::sun::star::awt::Point SAL_CALL getLocationOnScreen (void)
throw (::com::sun::star::uno::RuntimeException);
virtual ::com::sun::star::awt::Size SAL_CALL getSize (void)
throw (::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL grabFocus (void)
throw (::com::sun::star::uno::RuntimeException);
virtual sal_Int32 SAL_CALL getForeground (void)
throw (::com::sun::star::uno::RuntimeException);
virtual sal_Int32 SAL_CALL getBackground (void)
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.
*/
virtual ::com::sun::star::uno::Sequence< ::rtl::OUString> SAL_CALL
getSupportedServiceNames (void)
throw (::com::sun::star::uno::RuntimeException);
private:
::com::sun::star::uno::Reference<
::com::sun::star::accessibility::XAccessible> mxParent;
sal_uInt16 mnPageNumber;
::sd::slidesorter::SlideSorter& mrSlideSorter;
sal_uInt32 mnClientId;
/** 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 sal_True, if the object is disposed or in the course
of being disposed. Otherwise, sal_False is returned.
*/
sal_Bool IsDisposed (void);
};
} // end of namespace ::accessibility
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */