2002-06-07 11:13:15 +00:00
|
|
|
/*************************************************************************
|
|
|
|
|
*
|
2008-04-10 17:20:56 +00:00
|
|
|
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
2002-06-07 11:13:15 +00:00
|
|
|
*
|
2010-02-12 15:01:35 +01:00
|
|
|
* Copyright 2000, 2010 Oracle and/or its affiliates.
|
2002-06-07 11:13:15 +00:00
|
|
|
*
|
2008-04-10 17:20:56 +00:00
|
|
|
* OpenOffice.org - a multi-platform office productivity suite
|
2002-06-07 11:13:15 +00:00
|
|
|
*
|
2008-04-10 17:20:56 +00:00
|
|
|
* This file is part of OpenOffice.org.
|
2002-06-07 11:13:15 +00:00
|
|
|
*
|
2008-04-10 17:20:56 +00:00
|
|
|
* 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.
|
2002-06-07 11:13:15 +00:00
|
|
|
*
|
2008-04-10 17:20:56 +00:00
|
|
|
* 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
|
2009-06-03 11:26:39 +00:00
|
|
|
* 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_ACCESSILE_STATIC_TEXT_BASE_HXX_
|
|
|
|
|
#define _SVX_ACCESSILE_STATIC_TEXT_BASE_HXX_
|
|
|
|
|
|
|
|
|
|
#include <memory>
|
|
|
|
|
#include <tools/gen.hxx>
|
|
|
|
|
#include <cppuhelper/implbase2.hxx>
|
|
|
|
|
#include <com/sun/star/uno/Any.hxx>
|
|
|
|
|
#include <com/sun/star/uno/Reference.hxx>
|
|
|
|
|
#include <com/sun/star/accessibility/XAccessible.hpp>
|
|
|
|
|
#include <com/sun/star/accessibility/XAccessibleText.hpp>
|
|
|
|
|
#include <com/sun/star/accessibility/XAccessibleTextAttributes.hpp>
|
|
|
|
|
#include <com/sun/star/accessibility/TextSegment.hpp>
|
|
|
|
|
#include "svx/svxdllapi.h"
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
class SvxEditSource;
|
2009-08-26 13:37:34 +00:00
|
|
|
class SvxEditViewForwarder;
|
2009-06-03 11:26:39 +00:00
|
|
|
|
|
|
|
|
namespace accessibility
|
|
|
|
|
{
|
|
|
|
|
|
|
|
|
|
class AccessibleStaticTextBase_Impl;
|
|
|
|
|
|
|
|
|
|
typedef ::cppu::ImplHelper2<
|
|
|
|
|
::com::sun::star::accessibility::XAccessibleText,
|
|
|
|
|
::com::sun::star::accessibility::XAccessibleTextAttributes > AccessibleStaticTextBase_BASE;
|
|
|
|
|
|
|
|
|
|
/** Helper class for objects containing EditEngine/Outliner text
|
|
|
|
|
|
|
|
|
|
This class implements the XAccessibleText interface for static
|
|
|
|
|
text, somewhat similar to the children of the
|
|
|
|
|
AccessibleTextHelper class. Currently, there are no children,
|
|
|
|
|
i.e. the whole text is presented in one big chunk. This might
|
|
|
|
|
change in the future, if a need for image bullets should
|
|
|
|
|
arise. These, by convention, would be represented as children
|
|
|
|
|
of the text.
|
|
|
|
|
|
|
|
|
|
You have to implement the SvxEditSource, SvxTextForwarder,
|
|
|
|
|
SvxViewForwarder and SvxEditViewForwarder interfaces in order
|
|
|
|
|
to enable your object to cooperate with this
|
|
|
|
|
class. SvxTextForwarder encapsulates the fact that text
|
|
|
|
|
objects do not necessarily have an EditEngine at their
|
|
|
|
|
disposal, SvxViewForwarder and SvxEditViewForwarder do the
|
|
|
|
|
same for the document and the edit view. The three mentioned
|
|
|
|
|
forwarder objects are not stored by the AccessibleTextHelper,
|
|
|
|
|
but fetched every time from the SvxEditSource. So you are best
|
|
|
|
|
off making your SvxEditSource::Get*Forwarder methods cache the
|
|
|
|
|
current forwarder.
|
|
|
|
|
|
|
|
|
|
As this class is intended for static (i.e. non-changing) text
|
|
|
|
|
only, no event broadcasting is necessary. You must handle
|
|
|
|
|
visibility by yourself, the bounding boxes returned by
|
|
|
|
|
getCharacterBounds() are relative to your accessibility
|
|
|
|
|
object.
|
|
|
|
|
|
|
|
|
|
@attention All public non-UNO methods (those are the uppercase
|
|
|
|
|
ones) must not be called with any mutex hold, except when
|
|
|
|
|
calling from the main thread (with holds the solar mutex),
|
|
|
|
|
unless stated otherwise. This is because they themselves might
|
|
|
|
|
need the solar mutex in addition to the object mutex, and the
|
|
|
|
|
ordering of the locking must be: first solar mutex, then
|
|
|
|
|
object mutex. Furthermore, state change events might be fired
|
|
|
|
|
internally.
|
|
|
|
|
|
|
|
|
|
@derive Use this class as a base for objects containing static
|
|
|
|
|
edit engine text. To avoid overwriting every interface method
|
|
|
|
|
to intercept derived object defunc state, just set NULL as the
|
|
|
|
|
edit source. Every interface method will then properly throw
|
|
|
|
|
an exception.
|
|
|
|
|
*/
|
|
|
|
|
class SVX_DLLPUBLIC AccessibleStaticTextBase : public AccessibleStaticTextBase_BASE
|
|
|
|
|
{
|
|
|
|
|
|
|
|
|
|
public:
|
|
|
|
|
/** Create accessible text object for given edit source
|
|
|
|
|
|
|
|
|
|
@param pEditSource
|
|
|
|
|
The edit source to use. Object ownership is transferred
|
|
|
|
|
from the caller to the callee. The object listens on the
|
|
|
|
|
SvxEditSource for object disposal, so no provisions have
|
|
|
|
|
to be taken if the caller destroys the data (e.g. the
|
|
|
|
|
model) contained in the given SvxEditSource.
|
|
|
|
|
|
|
|
|
|
*/
|
|
|
|
|
explicit AccessibleStaticTextBase( ::std::auto_ptr< SvxEditSource > pEditSource );
|
|
|
|
|
virtual ~AccessibleStaticTextBase();
|
|
|
|
|
|
|
|
|
|
private:
|
|
|
|
|
|
|
|
|
|
// declared, but not defined
|
|
|
|
|
SVX_DLLPRIVATE AccessibleStaticTextBase( const AccessibleStaticTextBase& );
|
|
|
|
|
// declared, but not defined
|
|
|
|
|
SVX_DLLPRIVATE AccessibleStaticTextBase& operator= ( const AccessibleStaticTextBase& );
|
|
|
|
|
|
|
|
|
|
public:
|
|
|
|
|
/** Query the current edit source
|
|
|
|
|
|
|
|
|
|
@attention This method returns by reference, so you are
|
|
|
|
|
responsible for serialization (typically, you aquired the
|
|
|
|
|
solar mutex when calling this method). Thus, the method
|
|
|
|
|
should only be called from the main office thread.
|
|
|
|
|
|
|
|
|
|
*/
|
|
|
|
|
virtual const SvxEditSource& GetEditSource() const SAL_THROW((::com::sun::star::uno::RuntimeException));
|
|
|
|
|
|
|
|
|
|
/** Set the current edit source
|
|
|
|
|
|
|
|
|
|
@attention You are required to have the solar mutex
|
|
|
|
|
locked, when calling this method. Thus, the method should
|
|
|
|
|
only be called from the main office thread.
|
|
|
|
|
|
|
|
|
|
The EditSource set here is required to broadcast out the
|
|
|
|
|
following hints: EDITSOURCE_HINT_PARASMOVED,
|
|
|
|
|
EDITSOURCE_HINT_SELECTIONCHANGED, TEXT_HINT_MODIFIED,
|
|
|
|
|
TEXT_HINT_PARAINSERTED, TEXT_HINT_PARAREMOVED,
|
|
|
|
|
TEXT_HINT_TEXTHEIGHTCHANGED,
|
|
|
|
|
TEXT_HINT_VIEWSCROLLED. Otherwise, not all state changes
|
|
|
|
|
will get noticed by the accessibility object. Further
|
|
|
|
|
more, when the corresponding core object or the model is
|
|
|
|
|
dying, either the edit source must be set to NULL or it
|
|
|
|
|
has to broadcast a SFX_HINT_DYING hint.
|
|
|
|
|
|
|
|
|
|
This class does not have a dispose method, since it is not
|
|
|
|
|
a UNO component. Nevertheless, it holds C++ references to
|
|
|
|
|
several core objects, so you should issue a
|
|
|
|
|
SetEditSource(::std::auto_ptr<SvxEditSource>(NULL)) in
|
|
|
|
|
your dispose() method.
|
|
|
|
|
|
|
|
|
|
@param pEditSource
|
|
|
|
|
The new edit source to set. Object ownership is transferred
|
|
|
|
|
from the caller to the callee.
|
|
|
|
|
*/
|
|
|
|
|
virtual void SetEditSource( ::std::auto_ptr< SvxEditSource > pEditSource ) SAL_THROW((::com::sun::star::uno::RuntimeException));
|
|
|
|
|
|
|
|
|
|
/** Set the event source
|
|
|
|
|
|
|
|
|
|
@attention When setting a reference here, you should call
|
|
|
|
|
Dispose() when you as the owner are disposing, since until
|
|
|
|
|
then this object will hold that reference
|
|
|
|
|
|
|
|
|
|
@param rInterface
|
|
|
|
|
The interface that should be set as the source for
|
|
|
|
|
accessibility events sent by this object.
|
|
|
|
|
*/
|
|
|
|
|
virtual void SetEventSource( const ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible >& rInterface );
|
|
|
|
|
|
|
|
|
|
/** Get the event source
|
|
|
|
|
|
|
|
|
|
@return the interface that is set as the source for
|
|
|
|
|
accessibility events sent by this object.
|
|
|
|
|
*/
|
|
|
|
|
virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible > GetEventSource() const;
|
|
|
|
|
|
|
|
|
|
/** Set offset of EditEngine from parent
|
|
|
|
|
|
|
|
|
|
@attention You are required to have the solar mutex
|
|
|
|
|
locked, when calling this method. Thus, the method should
|
|
|
|
|
only be called from the main office thread.
|
|
|
|
|
|
|
|
|
|
If the origin of the underlying EditEngine does
|
|
|
|
|
not correspond to the upper left corner of the object
|
|
|
|
|
using this class, you have to specify the offset.
|
|
|
|
|
|
|
|
|
|
@param rPoint
|
|
|
|
|
The offset in screen coordinates (i.e. pixel)
|
|
|
|
|
*/
|
|
|
|
|
virtual void SetOffset( const Point& rPoint );
|
|
|
|
|
|
|
|
|
|
/** Query offset of EditEngine from parent
|
|
|
|
|
|
|
|
|
|
@return the offset in screen coordinates (i.e. pixel)
|
|
|
|
|
*/
|
|
|
|
|
virtual Point GetOffset() const;
|
|
|
|
|
|
|
|
|
|
/** Update the visible children
|
|
|
|
|
|
|
|
|
|
As this class currently does not represent any content
|
|
|
|
|
using children, this does nothing at the moment.
|
|
|
|
|
|
|
|
|
|
@attention You are required to have the solar mutex
|
|
|
|
|
locked, when calling this method. Thus, the method should
|
|
|
|
|
only be called from the main office thread.
|
|
|
|
|
|
|
|
|
|
This method reevaluates the visibility of all
|
|
|
|
|
childrens. Call this method if your visibility state has
|
|
|
|
|
changed somehow, e.g. if the visible area has changed and
|
|
|
|
|
the AccessibleStaticTextHelper isn't notified
|
|
|
|
|
internally. Normally, there should not be a need to call
|
|
|
|
|
this method.
|
|
|
|
|
*/
|
|
|
|
|
virtual void UpdateChildren() SAL_THROW((::com::sun::star::uno::RuntimeException));
|
|
|
|
|
|
|
|
|
|
/** Drop all references and enter disposed state
|
|
|
|
|
|
|
|
|
|
This method drops all references to external objects (also
|
|
|
|
|
the event source reference set via SetEventSource()) and
|
|
|
|
|
sets the object into the disposed state (i.e. the methods
|
|
|
|
|
return default values or throw a uno::DisposedException
|
|
|
|
|
exception).
|
|
|
|
|
*/
|
|
|
|
|
virtual void Dispose();
|
|
|
|
|
|
|
|
|
|
// XAccessibleText interface implementation
|
|
|
|
|
virtual sal_Int32 SAL_CALL getCaretPosition() throw (::com::sun::star::uno::RuntimeException);
|
|
|
|
|
virtual sal_Bool SAL_CALL setCaretPosition( sal_Int32 nIndex ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException);
|
|
|
|
|
virtual sal_Unicode SAL_CALL getCharacter( sal_Int32 nIndex ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException);
|
|
|
|
|
virtual ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue > SAL_CALL getCharacterAttributes( sal_Int32 nIndex, const ::com::sun::star::uno::Sequence< ::rtl::OUString >& aRequestedAttributes ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException);
|
|
|
|
|
virtual ::com::sun::star::awt::Rectangle SAL_CALL getCharacterBounds( sal_Int32 nIndex ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException);
|
|
|
|
|
virtual sal_Int32 SAL_CALL getCharacterCount() throw (::com::sun::star::uno::RuntimeException);
|
|
|
|
|
virtual sal_Int32 SAL_CALL getIndexAtPoint( const ::com::sun::star::awt::Point& aPoint ) throw (::com::sun::star::uno::RuntimeException);
|
|
|
|
|
virtual ::rtl::OUString SAL_CALL getSelectedText() throw (::com::sun::star::uno::RuntimeException);
|
|
|
|
|
virtual sal_Int32 SAL_CALL getSelectionStart() throw (::com::sun::star::uno::RuntimeException);
|
|
|
|
|
virtual sal_Int32 SAL_CALL getSelectionEnd() throw (::com::sun::star::uno::RuntimeException);
|
|
|
|
|
/// This will only work with a functional SvxEditViewForwarder, i.e. an EditEngine/Outliner in edit mode
|
|
|
|
|
virtual sal_Bool SAL_CALL setSelection( sal_Int32 nStartIndex, sal_Int32 nEndIndex ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException);
|
|
|
|
|
virtual ::rtl::OUString SAL_CALL getText() throw (::com::sun::star::uno::RuntimeException);
|
|
|
|
|
virtual ::rtl::OUString SAL_CALL getTextRange( sal_Int32 nStartIndex, sal_Int32 nEndIndex ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException);
|
|
|
|
|
/// Does not support AccessibleTextType::SENTENCE (missing feature in EditEngine)
|
|
|
|
|
virtual ::com::sun::star::accessibility::TextSegment SAL_CALL getTextAtIndex( sal_Int32 nIndex, sal_Int16 aTextType ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::uno::RuntimeException);
|
|
|
|
|
/// Does not support AccessibleTextType::SENTENCE (missing feature in EditEngine)
|
|
|
|
|
virtual ::com::sun::star::accessibility::TextSegment SAL_CALL getTextBeforeIndex( sal_Int32 nIndex, sal_Int16 aTextType ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::uno::RuntimeException);
|
|
|
|
|
/// Does not support AccessibleTextType::SENTENCE (missing feature in EditEngine)
|
|
|
|
|
virtual ::com::sun::star::accessibility::TextSegment SAL_CALL getTextBehindIndex( sal_Int32 nIndex, sal_Int16 aTextType ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::uno::RuntimeException);
|
|
|
|
|
/// This will only work with a functional SvxEditViewForwarder, i.e. an EditEngine/Outliner in edit mode
|
|
|
|
|
virtual sal_Bool SAL_CALL copyText( sal_Int32 nStartIndex, sal_Int32 nEndIndex ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException);
|
|
|
|
|
|
|
|
|
|
// XAccessibleTextAttributes
|
|
|
|
|
virtual ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue > SAL_CALL getDefaultAttributes( const ::com::sun::star::uno::Sequence< ::rtl::OUString >& RequestedAttributes ) throw (::com::sun::star::uno::RuntimeException);
|
|
|
|
|
virtual ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue > SAL_CALL getRunAttributes( sal_Int32 Index, const ::com::sun::star::uno::Sequence< ::rtl::OUString >& RequestedAttributes ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException);
|
|
|
|
|
|
|
|
|
|
// child-related methods from XAccessibleContext
|
|
|
|
|
virtual sal_Int32 SAL_CALL getAccessibleChildCount() throw (::com::sun::star::uno::RuntimeException);
|
|
|
|
|
virtual ::com::sun::star::uno::Reference< ::com::sun::star::accessibility::XAccessible > SAL_CALL getAccessibleChild( sal_Int32 i ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::uno::RuntimeException);
|
|
|
|
|
|
|
|
|
|
// child-related methods from XAccessibleComponent
|
|
|
|
|
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);
|
|
|
|
|
|
|
|
|
|
protected:
|
|
|
|
|
Rectangle GetParagraphBoundingBox() const;
|
2009-08-26 13:37:34 +00:00
|
|
|
sal_Int32 GetParagraphCount() const;
|
|
|
|
|
sal_Int32 GetParagraphIndex() const;
|
|
|
|
|
sal_Int32 GetLineCount( sal_Int32 nParagraph ) const;
|
2009-06-03 11:26:39 +00:00
|
|
|
|
|
|
|
|
private:
|
|
|
|
|
|
|
|
|
|
/// @dyn
|
|
|
|
|
const std::auto_ptr< AccessibleStaticTextBase_Impl > mpImpl;
|
|
|
|
|
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
} // end of namespace accessibility
|
|
|
|
|
|
|
|
|
|
#endif /* _SVX_ACCESSILE_STATIC_TEXT_BASE_HXX_ */
|
