blob: 66b27e41cc3b2a19fe9aa92fcc6a884bbe65d71f [file] [log] [blame]
/**************************************************************
*
* 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
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
*************************************************************/
#ifndef SW_UNOBOOKMARK_HXX
#define SW_UNOBOOKMARK_HXX
#include <com/sun/star/lang/XUnoTunnel.hpp>
#include <com/sun/star/lang/XServiceInfo.hpp>
#include <com/sun/star/beans/XPropertySet.hpp>
#include <com/sun/star/container/XNamed.hpp>
#include <com/sun/star/text/XTextContent.hpp>
#include <com/sun/star/text/XFormField.hpp>
#include <cppuhelper/implbase5.hxx>
#include <sfx2/Metadatable.hxx>
#include <unobaseclass.hxx>
#include <IDocumentMarkAccess.hxx>
class SwDoc;
typedef ::cppu::ImplInheritanceHelper5
< ::sfx2::MetadatableMixin
, ::com::sun::star::lang::XUnoTunnel
, ::com::sun::star::lang::XServiceInfo
, ::com::sun::star::beans::XPropertySet
, ::com::sun::star::container::XNamed
, ::com::sun::star::text::XTextContent
> SwXBookmark_Base;
class SwXBookmark
: public SwXBookmark_Base
{
private:
class Impl;
::sw::UnoImplPtr<Impl> m_pImpl;
protected:
void attachToRangeEx(
const ::com::sun::star::uno::Reference<
::com::sun::star::text::XTextRange > & xTextRange,
IDocumentMarkAccess::MarkType eType)
throw (::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::uno::RuntimeException );
virtual void attachToRange(
const ::com::sun::star::uno::Reference<
::com::sun::star::text::XTextRange > & xTextRange)
throw (::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::uno::RuntimeException);
const ::sw::mark::IMark* GetBookmark() const;
virtual ~SwXBookmark();
/// @param pDoc and pMark != 0, but not & because of ImplInheritanceHelper
SwXBookmark(::sw::mark::IMark *const pMark, SwDoc *const pDoc);
void registerInMark( ::sw::mark::IMark *const pBkmk );
public:
/// descriptor
SwXBookmark();
static ::com::sun::star::uno::Reference< ::com::sun::star::text::XTextContent >
CreateXBookmark(SwDoc & rDoc, ::sw::mark::IMark & rBookmark);
/// @return IMark for this, but only if it lives in pDoc
static ::sw::mark::IMark const* GetBookmarkInDoc(SwDoc const*const pDoc,
const ::com::sun::star::uno::Reference<
::com::sun::star::lang::XUnoTunnel> & xUT);
// MetadatableMixin
virtual ::sfx2::Metadatable* GetCoreObject();
virtual ::com::sun::star::uno::Reference<
::com::sun::star::frame::XModel > GetModel();
static const ::com::sun::star::uno::Sequence< sal_Int8 >& getUnoTunnelId();
// XUnoTunnel
virtual sal_Int64 SAL_CALL getSomething(
const ::com::sun::star::uno::Sequence< sal_Int8 >& rIdentifier)
throw (::com::sun::star::uno::RuntimeException);
// XServiceInfo
virtual ::rtl::OUString SAL_CALL getImplementationName()
throw (::com::sun::star::uno::RuntimeException);
virtual sal_Bool SAL_CALL supportsService(
const ::rtl::OUString& rServiceName)
throw (::com::sun::star::uno::RuntimeException);
virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL
getSupportedServiceNames()
throw (::com::sun::star::uno::RuntimeException);
// XComponent
virtual void SAL_CALL dispose()
throw (::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL addEventListener(
const ::com::sun::star::uno::Reference<
::com::sun::star::lang::XEventListener > & xListener)
throw (::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL removeEventListener(
const ::com::sun::star::uno::Reference<
::com::sun::star::lang::XEventListener > & xListener)
throw (::com::sun::star::uno::RuntimeException);
// XPropertySet
virtual ::com::sun::star::uno::Reference<
::com::sun::star::beans::XPropertySetInfo > SAL_CALL
getPropertySetInfo()
throw (::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL setPropertyValue(
const ::rtl::OUString& rPropertyName,
const ::com::sun::star::uno::Any& rValue)
throw (::com::sun::star::beans::UnknownPropertyException,
::com::sun::star::beans::PropertyVetoException,
::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::lang::WrappedTargetException,
::com::sun::star::uno::RuntimeException);
virtual ::com::sun::star::uno::Any SAL_CALL getPropertyValue(
const ::rtl::OUString& rPropertyName)
throw (::com::sun::star::beans::UnknownPropertyException,
::com::sun::star::lang::WrappedTargetException,
::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL addPropertyChangeListener(
const ::rtl::OUString& rPropertyName,
const ::com::sun::star::uno::Reference<
::com::sun::star::beans::XPropertyChangeListener >& xListener)
throw (::com::sun::star::beans::UnknownPropertyException,
::com::sun::star::lang::WrappedTargetException,
::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL removePropertyChangeListener(
const ::rtl::OUString& rPropertyName,
const ::com::sun::star::uno::Reference<
::com::sun::star::beans::XPropertyChangeListener >& xListener)
throw (::com::sun::star::beans::UnknownPropertyException,
::com::sun::star::lang::WrappedTargetException,
::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL addVetoableChangeListener(
const ::rtl::OUString& rPropertyName,
const ::com::sun::star::uno::Reference<
::com::sun::star::beans::XVetoableChangeListener >& xListener)
throw (::com::sun::star::beans::UnknownPropertyException,
::com::sun::star::lang::WrappedTargetException,
::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL removeVetoableChangeListener(
const ::rtl::OUString& rPropertyName,
const ::com::sun::star::uno::Reference<
::com::sun::star::beans::XVetoableChangeListener >& xListener)
throw (::com::sun::star::beans::UnknownPropertyException,
::com::sun::star::lang::WrappedTargetException,
::com::sun::star::uno::RuntimeException);
// XNamed
virtual ::rtl::OUString SAL_CALL getName()
throw (::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL setName(const ::rtl::OUString& rName)
throw (::com::sun::star::uno::RuntimeException);
// XTextContent
virtual void SAL_CALL attach(
const ::com::sun::star::uno::Reference<
::com::sun::star::text::XTextRange > & xTextRange)
throw (::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::uno::RuntimeException);
virtual ::com::sun::star::uno::Reference<
::com::sun::star::text::XTextRange > SAL_CALL getAnchor()
throw (::com::sun::star::uno::RuntimeException);
};
class SwXFieldmarkParameters
: public ::cppu::WeakImplHelper1< ::com::sun::star::container::XNameContainer>
, private SwClient
{
public:
SwXFieldmarkParameters(::sw::mark::IFieldmark* const pFieldmark)
{
pFieldmark->Add(this);
}
// XNameContainer
virtual void SAL_CALL insertByName( const ::rtl::OUString& aName, const ::com::sun::star::uno::Any& aElement ) throw (::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::container::ElementExistException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL removeByName( const ::rtl::OUString& Name ) throw (::com::sun::star::container::NoSuchElementException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException);
// XNameReplace
virtual void SAL_CALL replaceByName( const ::rtl::OUString& aName, const ::com::sun::star::uno::Any& aElement ) throw (::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::container::NoSuchElementException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException);
// XNameAccess
virtual ::com::sun::star::uno::Any SAL_CALL getByName( const ::rtl::OUString& aName ) throw (::com::sun::star::container::NoSuchElementException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException);
virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL getElementNames( ) throw (::com::sun::star::uno::RuntimeException);
virtual ::sal_Bool SAL_CALL hasByName( const ::rtl::OUString& aName ) throw (::com::sun::star::uno::RuntimeException);
// XElementAccess
virtual ::com::sun::star::uno::Type SAL_CALL getElementType( ) throw (::com::sun::star::uno::RuntimeException);
virtual ::sal_Bool SAL_CALL hasElements( ) throw (::com::sun::star::uno::RuntimeException);
protected:
//SwClient
virtual void Modify( const SfxPoolItem* pOld, const SfxPoolItem *pNew );
private:
::sw::mark::IFieldmark::parameter_map_t* getCoreParameters() throw (::com::sun::star::uno::RuntimeException);
};
typedef cppu::ImplInheritanceHelper1< SwXBookmark,
::com::sun::star::text::XFormField > SwXFieldmark_Base;
class SwXFieldmark
: public SwXFieldmark_Base
{
private:
bool isReplacementObject;
SwXFieldmark(
bool _isReplacementObject,
::sw::mark::IMark *const pMark,
SwDoc *const pDoc );
public:
// <SwXFieldmark> instance not attached to the document - property descriptor available
SwXFieldmark( bool isReplacementObject );
// (as the parent class) newly created <SwXFieldmark> instances for an existing <IMark> instance needs to be registered in the Mark
static ::com::sun::star::uno::Reference< ::com::sun::star::text::XTextContent >
CreateXFieldmark(
SwDoc & rDoc,
::sw::mark::IMark & rBookmark );
virtual void attachToRange(
const ::com::sun::star::uno::Reference<
::com::sun::star::text::XTextRange > & xTextRange)
throw (::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::uno::RuntimeException);
virtual ::rtl::OUString SAL_CALL getFieldType(void)
throw( ::com::sun::star::uno::RuntimeException );
virtual void SAL_CALL setFieldType(const ::rtl::OUString& description )
throw (::com::sun::star::uno::RuntimeException);
virtual ::com::sun::star::uno::Reference< ::com::sun::star::container::XNameContainer > SAL_CALL getParameters( )
throw (::com::sun::star::uno::RuntimeException);
};
#endif // SW_UNOBOOKMARK_HXX