office-gobmx/sw/inc/unoframe.hxx
Noel Grandin 6b72343010 loplugin:unusedmethods
Change-Id: I6c6073e139f573f1680a7e9e52e95a221c9805b6
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/174296
Tested-by: Jenkins
Reviewed-by: Noel Grandin <noel.grandin@collabora.co.uk>
2024-10-01 11:16:21 +02:00

327 lines
13 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 INCLUDED_SW_INC_UNOFRAME_HXX
#define INCLUDED_SW_INC_UNOFRAME_HXX
#include "swdllapi.h"
#include <com/sun/star/beans/XPropertyState.hpp>
#include <com/sun/star/container/XNamed.hpp>
#include <com/sun/star/container/XEnumerationAccess.hpp>
#include <com/sun/star/document/XEmbeddedObjectSupplier2.hpp>
#include <com/sun/star/text/XTextFrame.hpp>
#include <com/sun/star/drawing/XShape.hpp>
#include <com/sun/star/util/XModifyListener.hpp>
#include <com/sun/star/document/XEventsSupplier.hpp>
#include <comphelper/interfacecontainer4.hxx>
#include <cppuhelper/implbase.hxx>
#include <sal/types.h>
#include <svl/listener.hxx>
#include "flyenum.hxx"
#include "frmfmt.hxx"
#include "unotext.hxx"
#include <memory>
#include <mutex>
class SdrObject;
class SwDoc;
class SwFormat;
class SwUnoInternalPaM;
class SfxItemPropertySet;
class SwXOLEListener;
namespace com::sun::star::frame { class XModel; }
class BaseFrameProperties_Impl;
class SAL_DLLPUBLIC_RTTI SAL_LOPLUGIN_ANNOTATE("crosscast") SwXFrame : public cppu::WeakImplHelper
<
css::lang::XServiceInfo,
css::beans::XPropertySet,
css::beans::XPropertyState,
css::drawing::XShape,
css::container::XNamed,
css::text::XTextContent
>,
public SvtListener
{
private:
std::mutex m_Mutex; // just for OInterfaceContainerHelper4
::comphelper::OInterfaceContainerHelper4<css::lang::XEventListener> m_EventListeners;
SwFrameFormat* m_pFrameFormat;
const SfxItemPropertySet* m_pPropSet;
SwDoc* m_pDoc;
const FlyCntType m_eType;
// Descriptor-interface
std::unique_ptr<BaseFrameProperties_Impl> m_pProps;
bool m_bIsDescriptor;
OUString m_sName;
sal_Int64 m_nDrawAspect;
sal_Int64 m_nVisibleAreaWidth;
sal_Int64 m_nVisibleAreaHeight;
css::uno::Reference<css::text::XText> m_xParentText;
css::uno::Reference< css::beans::XPropertySet > mxStyleData;
css::uno::Reference< css::container::XNameAccess > mxStyleFamily;
void DisposeInternal();
protected:
virtual void Notify(const SfxHint&) override;
virtual ~SwXFrame() override;
SwXFrame(FlyCntType eSet,
const SfxItemPropertySet* pPropSet,
SwDoc *pDoc ); //Descriptor-If
SwXFrame(SwFrameFormat& rFrameFormat, FlyCntType eSet,
const SfxItemPropertySet* pPropSet);
template<class Impl>
static rtl::Reference<Impl>
CreateXFrame(SwDoc & rDoc, SwFrameFormat *const pFrameFormat);
public:
//XNamed
SW_DLLPUBLIC virtual OUString SAL_CALL getName() override;
SW_DLLPUBLIC virtual void SAL_CALL setName(const OUString& Name_) override;
//XPropertySet
virtual css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo( ) override;
SW_DLLPUBLIC virtual void SAL_CALL setPropertyValue( const OUString& aPropertyName, const css::uno::Any& aValue ) override;
virtual css::uno::Any SAL_CALL getPropertyValue( const OUString& PropertyName ) override;
virtual void SAL_CALL addPropertyChangeListener( const OUString& aPropertyName, const css::uno::Reference< css::beans::XPropertyChangeListener >& xListener ) override;
virtual void SAL_CALL removePropertyChangeListener( const OUString& aPropertyName, const css::uno::Reference< css::beans::XPropertyChangeListener >& aListener ) override;
virtual void SAL_CALL addVetoableChangeListener( const OUString& PropertyName, const css::uno::Reference< css::beans::XVetoableChangeListener >& aListener ) override;
virtual void SAL_CALL removeVetoableChangeListener( const OUString& PropertyName, const css::uno::Reference< css::beans::XVetoableChangeListener >& aListener ) override;
//XPropertyState
virtual css::beans::PropertyState SAL_CALL getPropertyState( const OUString& PropertyName ) override;
virtual css::uno::Sequence< css::beans::PropertyState > SAL_CALL getPropertyStates( const css::uno::Sequence< OUString >& aPropertyName ) override;
virtual void SAL_CALL setPropertyToDefault( const OUString& PropertyName ) override;
virtual css::uno::Any SAL_CALL getPropertyDefault( const OUString& aPropertyName ) override;
//XShape
virtual css::awt::Point SAL_CALL getPosition( ) override;
virtual void SAL_CALL setPosition( const css::awt::Point& aPosition ) override;
virtual css::awt::Size SAL_CALL getSize( ) override;
virtual void SAL_CALL setSize( const css::awt::Size& aSize ) override;
//XShapeDescriptor
virtual OUString SAL_CALL getShapeType() override;
//Base implementation
//XComponent
virtual void SAL_CALL dispose() override;
virtual void SAL_CALL addEventListener(const css::uno::Reference<css::lang::XEventListener>& xListener) override;
virtual void SAL_CALL removeEventListener(const css::uno::Reference<css::lang::XEventListener>& xListener) override;
// XTextContent
virtual void SAL_CALL attach(const css::uno::Reference<css::text::XTextRange>& xTextRange) override;
virtual css::uno::Reference<css::text::XTextRange> SAL_CALL getAnchor() override;
//XServiceInfo
virtual OUString SAL_CALL getImplementationName() override;
virtual sal_Bool SAL_CALL supportsService(const OUString& ServiceName) override;
virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames() override;
/// @throws css::lang::IllegalArgumentException
/// @throws css::uno::RuntimeException
void attachToRange(css::uno::Reference<css::text::XTextRange> const& xTextRange,
SwPaM const* pCopySource = nullptr);
const SwFrameFormat* GetFrameFormat() const
{ return m_pFrameFormat; }
SwFrameFormat* GetFrameFormat()
{ return m_pFrameFormat; }
FlyCntType GetFlyCntType()const {return m_eType;}
bool IsDescriptor() const {return m_bIsDescriptor;}
void ResetDescriptor();
//copy text from a given source PaM
static SdrObject *GetOrCreateSdrObject(SwFlyFrameFormat &rFormat);
};
typedef cppu::ImplInheritanceHelper
<
SwXFrame,
css::text::XTextFrame,
css::container::XEnumerationAccess,
css::document::XEventsSupplier
>
SwXTextFrameBaseClass;
class SAL_DLLPUBLIC_RTTI SwXTextFrame final : public SwXTextFrameBaseClass,
public SwXText
{
friend class SwXFrame; // just for CreateXFrame
virtual const SwStartNode *GetStartNode() const override;
virtual ~SwXTextFrame() override;
SwXTextFrame(SwDoc *pDoc);
SwXTextFrame(SwFrameFormat& rFormat);
public:
static SW_DLLPUBLIC rtl::Reference<SwXTextFrame>
CreateXTextFrame(SwDoc & rDoc, SwFrameFormat * pFrameFormat);
// FIXME: EVIL HACK: make available for SwXFrame::attachToRange
using SwXText::SetDoc;
virtual css::uno::Any SAL_CALL queryInterface( const css::uno::Type& aType ) override;
virtual SW_DLLPUBLIC void SAL_CALL acquire( ) noexcept override;
virtual SW_DLLPUBLIC void SAL_CALL release( ) noexcept override;
//XTypeProvider
virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes( ) override;
virtual css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId( ) override;
//XTextFrame
virtual SW_DLLPUBLIC css::uno::Reference< css::text::XText > SAL_CALL getText() override;
//XText
virtual rtl::Reference< SwXTextCursor > createXTextCursor() override;
virtual rtl::Reference< SwXTextCursor > createXTextCursorByRange(
const ::css::uno::Reference< ::css::text::XTextRange >& aTextPosition ) override;
//XEnumerationAccess - was: XParagraphEnumerationAccess
virtual css::uno::Reference< css::container::XEnumeration > SAL_CALL createEnumeration() override;
//XElementAccess
virtual css::uno::Type SAL_CALL getElementType( ) override;
virtual sal_Bool SAL_CALL hasElements( ) override;
//XTextContent
virtual void SAL_CALL attach( const css::uno::Reference< css::text::XTextRange >& xTextRange ) override;
virtual css::uno::Reference< css::text::XTextRange > SAL_CALL getAnchor( ) override;
//XComponent
virtual void SAL_CALL dispose( ) override;
virtual void SAL_CALL addEventListener( const css::uno::Reference< css::lang::XEventListener >& xListener ) override;
virtual void SAL_CALL removeEventListener( const css::uno::Reference< css::lang::XEventListener >& aListener ) override;
//XServiceInfo
virtual OUString SAL_CALL getImplementationName() override;
virtual sal_Bool SAL_CALL supportsService(const OUString& ServiceName) override;
virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames() override;
// XEventsSupplier
virtual css::uno::Reference< css::container::XNameReplace > SAL_CALL getEvents( ) override;
//XPropertySet
virtual SW_DLLPUBLIC css::uno::Any SAL_CALL getPropertyValue( const OUString& PropertyName ) override;
using SwXFrame::setPropertyValue;
private:
rtl::Reference< SwXTextCursor > createXTextCursorByRangeImpl(SwFrameFormat& rFormat, SwUnoInternalPaM& rPam);
};
typedef cppu::ImplInheritanceHelper
< SwXFrame,
css::document::XEventsSupplier
>
SwXTextGraphicObjectBaseClass;
class SW_DLLPUBLIC SwXTextGraphicObject final : public SwXTextGraphicObjectBaseClass
{
friend class SwXFrame; // just for CreateXFrame
virtual ~SwXTextGraphicObject() override;
SwXTextGraphicObject( SwDoc *pDoc );
SwXTextGraphicObject(SwFrameFormat& rFormat);
public:
static rtl::Reference<SwXTextGraphicObject>
CreateXTextGraphicObject(SwDoc & rDoc, SwFrameFormat * pFrameFormat);
//XServiceInfo
virtual OUString SAL_CALL getImplementationName() override;
virtual sal_Bool SAL_CALL supportsService(const OUString& ServiceName) override;
virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames() override;
// XEventsSupplier
virtual css::uno::Reference< css::container::XNameReplace > SAL_CALL getEvents( ) override;
};
typedef cppu::ImplInheritanceHelper
< SwXFrame,
css::document::XEmbeddedObjectSupplier2,
css::document::XEventsSupplier
> SwXTextEmbeddedObjectBaseClass;
class SW_DLLPUBLIC SwXTextEmbeddedObject final : public SwXTextEmbeddedObjectBaseClass
{
rtl::Reference<SwXOLEListener> m_xOLEListener;
friend class SwXFrame; // just for CreateXFrame
virtual ~SwXTextEmbeddedObject() override;
SwXTextEmbeddedObject( SwDoc *pDoc );
SwXTextEmbeddedObject(SwFrameFormat& rFormat);
public:
static rtl::Reference<SwXTextEmbeddedObject>
CreateXTextEmbeddedObject(SwDoc & rDoc, SwFrameFormat * pFrameFormat);
//XEmbeddedObjectSupplier2
virtual css::uno::Reference< css::lang::XComponent > SAL_CALL getEmbeddedObject() override;
virtual css::uno::Reference< css::embed::XEmbeddedObject > SAL_CALL getExtendedControlOverEmbeddedObject() override;
virtual ::sal_Int64 SAL_CALL getAspect() override;
virtual void SAL_CALL setAspect( ::sal_Int64 _aspect ) override;
virtual css::uno::Reference< css::graphic::XGraphic > SAL_CALL getReplacementGraphic() override;
//XServiceInfo
virtual OUString SAL_CALL getImplementationName() override;
virtual sal_Bool SAL_CALL supportsService(const OUString& ServiceName) override;
virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames() override;
// XEventsSupplier
virtual css::uno::Reference< css::container::XNameReplace > SAL_CALL getEvents( ) override;
};
class SwXOLEListener final : public cppu::WeakImplHelper<css::util::XModifyListener>, public SvtListener
{
SwFormat* m_pOLEFormat;
css::uno::Reference<css::frame::XModel> m_xOLEModel;
public:
SwXOLEListener(SwFormat& rOLEFormat, css::uno::Reference< css::frame::XModel > xOLE);
virtual ~SwXOLEListener() override;
// css::lang::XEventListener
virtual void SAL_CALL disposing( const css::lang::EventObject& Source ) override;
// css::util::XModifyListener
virtual void SAL_CALL modified( const css::lang::EventObject& aEvent ) override;
virtual void Notify( const SfxHint& ) override;
};
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */