sw/inc/unoframe.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef INCLUDED_SW_INC_UNOFRAME_HXX
  20 #define INCLUDED_SW_INC_UNOFRAME_HXX
  21
  22 #include <com/sun/star/beans/XPropertyState.hpp>
  23 #include <com/sun/star/container/XNamed.hpp>
  24 #include <com/sun/star/container/XEnumerationAccess.hpp>
  25 #include <com/sun/star/document/XEmbeddedObjectSupplier2.hpp>
  26 #include <com/sun/star/text/XTextFrame.hpp>
  27 #include <com/sun/star/drawing/XShape.hpp>
  28 #include <com/sun/star/util/XModifyListener.hpp>
  29 #include <com/sun/star/document/XEventsSupplier.hpp>
  30
  31 #include <cppuhelper/implbase.hxx>
  32 #include <svl/listener.hxx>
  33
  34 #include "flyenum.hxx"
  35 #include "frmfmt.hxx"
  36 #include "unotext.hxx"
  37
  38 #include <memory>
  39
  40 class SdrObject;
  41 class SwDoc;
  42 class SwFormat;
  43 class SfxItemPropertySet;
  44 namespace com::sun::star::frame { class XModel; }
  45
  46 class BaseFrameProperties_Impl;
  47 class SwXFrame : public cppu::WeakImplHelper
  48 <
  49     css::lang::XServiceInfo,
  50     css::lang::XUnoTunnel,
  51     css::beans::XPropertySet,
  52     css::beans::XPropertyState,
  53     css::drawing::XShape,
  54     css::container::XNamed,
  55     css::text::XTextContent
  56 >,
  57     public SvtListener
  58 {
  59 private:
  60     class Impl;
  61     ::sw::UnoImplPtr<Impl> m_pImpl;
  62     SwFrameFormat* m_pFrameFormat;
  63
  64     const SfxItemPropertySet*       m_pPropSet;
  65     SwDoc*                          m_pDoc;
  66
  67     const FlyCntType                m_eType;
  68
  69     // Descriptor-interface
  70     std::unique_ptr<BaseFrameProperties_Impl> m_pProps;
  71     bool m_bIsDescriptor;
  72     OUString                        m_sName;
  73
  74     sal_Int64                       m_nDrawAspect;
  75     sal_Int64                       m_nVisibleAreaWidth;
  76     sal_Int64                       m_nVisibleAreaHeight;
  77     css::uno::Reference<css::text::XText> m_xParentText;
  78     void DisposeInternal();
  79
  80 protected:
  81     css::uno::Reference< css::beans::XPropertySet > mxStyleData;
  82     css::uno::Reference< css::container::XNameAccess >  mxStyleFamily;
  83     virtual void Notify(const SfxHint&) override;
  84
  85     virtual ~SwXFrame() override;
  86
  87     SwXFrame(FlyCntType eSet,
  88                 const SfxItemPropertySet*    pPropSet,
  89                 SwDoc *pDoc ); //Descriptor-If
  90     SwXFrame(SwFrameFormat& rFrameFormat, FlyCntType eSet,
  91                 const SfxItemPropertySet*    pPropSet);
  92
  93     template<class Interface, class Impl>
  94     static css::uno::Reference<Interface>
  95     CreateXFrame(SwDoc & rDoc, SwFrameFormat *const pFrameFormat);
  96
  97 public:
  98     static const css::uno::Sequence< sal_Int8 > & getUnoTunnelId();
  99
 100     //XUnoTunnel
 101     virtual sal_Int64 SAL_CALL getSomething( const css::uno::Sequence< sal_Int8 >& aIdentifier ) override;
 102
 103
 104     //XNamed
 105     virtual OUString SAL_CALL getName() override;
 106     virtual void SAL_CALL setName(const OUString& Name_) override;
 107
 108     //XPropertySet
 109     virtual css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo(  ) override;
 110     virtual void SAL_CALL setPropertyValue( const OUString& aPropertyName, const css::uno::Any& aValue ) override;
 111     virtual css::uno::Any SAL_CALL getPropertyValue( const OUString& PropertyName ) override;
 112     virtual void SAL_CALL addPropertyChangeListener( const OUString& aPropertyName, const css::uno::Reference< css::beans::XPropertyChangeListener >& xListener ) override;
 113     virtual void SAL_CALL removePropertyChangeListener( const OUString& aPropertyName, const css::uno::Reference< css::beans::XPropertyChangeListener >& aListener ) override;
 114     virtual void SAL_CALL addVetoableChangeListener( const OUString& PropertyName, const css::uno::Reference< css::beans::XVetoableChangeListener >& aListener ) override;
 115     virtual void SAL_CALL removeVetoableChangeListener( const OUString& PropertyName, const css::uno::Reference< css::beans::XVetoableChangeListener >& aListener ) override;
 116
 117      //XPropertyState
 118     virtual css::beans::PropertyState SAL_CALL getPropertyState( const OUString& PropertyName ) override;
 119     virtual css::uno::Sequence< css::beans::PropertyState > SAL_CALL getPropertyStates( const css::uno::Sequence< OUString >& aPropertyName ) override;
 120     virtual void SAL_CALL setPropertyToDefault( const OUString& PropertyName ) override;
 121     virtual css::uno::Any SAL_CALL getPropertyDefault( const OUString& aPropertyName ) override;
 122
 123     //XShape
 124     virtual css::awt::Point SAL_CALL getPosition(  ) override;
 125     virtual void SAL_CALL setPosition( const css::awt::Point& aPosition ) override;
 126     virtual css::awt::Size SAL_CALL getSize(  ) override;
 127     virtual void SAL_CALL setSize( const css::awt::Size& aSize ) override;
 128
 129     //XShapeDescriptor
 130     virtual OUString SAL_CALL getShapeType() override;
 131
 132     //Base implementation
 133     //XComponent
 134     virtual void SAL_CALL dispose() override;
 135     virtual void SAL_CALL addEventListener(const css::uno::Reference<css::lang::XEventListener>& xListener) override;
 136     virtual void SAL_CALL removeEventListener(const css::uno::Reference<css::lang::XEventListener>& xListener) override;
 137
 138     // XTextContent
 139     virtual void SAL_CALL attach(const css::uno::Reference<css::text::XTextRange>& xTextRange) override;
 140     virtual css::uno::Reference<css::text::XTextRange>  SAL_CALL getAnchor() override;
 141
 142     //XServiceInfo
 143     virtual OUString SAL_CALL getImplementationName() override;
 144     virtual sal_Bool SAL_CALL supportsService(const OUString& ServiceName) override;
 145     virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames() override;
 146
 147     /// @throws css::lang::IllegalArgumentException
 148     /// @throws css::uno::RuntimeException
 149     void attachToRange(css::uno::Reference<css::text::XTextRange> const& xTextRange,
 150             SwPaM const* pCopySource = nullptr);
 151
 152     const SwFrameFormat* GetFrameFormat() const
 153         { return m_pFrameFormat; }
 154     SwFrameFormat* GetFrameFormat()
 155         { return m_pFrameFormat; }
 156
 157     FlyCntType      GetFlyCntType()const {return m_eType;}
 158
 159     bool IsDescriptor() const {return m_bIsDescriptor;}
 160     void            ResetDescriptor();
 161     //copy text from a given source PaM
 162     static SdrObject *GetOrCreateSdrObject(SwFlyFrameFormat &rFormat);
 163 };
 164
 165 typedef cppu::WeakImplHelper
 166 <
 167     css::text::XTextFrame,
 168     css::container::XEnumerationAccess,
 169     css::document::XEventsSupplier
 170 >
 171 SwXTextFrameBaseClass;
 172
 173 class SwXTextFrame final : public SwXTextFrameBaseClass,
 174     public SwXText,
 175     public SwXFrame
 176 {
 177     friend class SwXFrame; // just for CreateXFrame
 178
 179     virtual const SwStartNode *GetStartNode() const override;
 180
 181     virtual css::uno::Reference< css::text::XTextCursor >
 182         CreateCursor() override;
 183
 184     virtual ~SwXTextFrame() override;
 185
 186     SwXTextFrame(SwDoc *pDoc);
 187     SwXTextFrame(SwFrameFormat& rFormat);
 188
 189 public:
 190     static SW_DLLPUBLIC css::uno::Reference<css::text::XTextFrame>
 191             CreateXTextFrame(SwDoc & rDoc, SwFrameFormat * pFrameFormat);
 192
 193     // FIXME: EVIL HACK:  make available for SwXFrame::attachToRange
 194     using SwXText::SetDoc;
 195
 196     virtual css::uno::Any SAL_CALL queryInterface( const css::uno::Type& aType ) override;
 197     virtual void SAL_CALL acquire(  ) throw() override;
 198     virtual void SAL_CALL release(  ) throw() override;
 199
 200     //XTypeProvider
 201     virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes(  ) override;
 202     virtual css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId(  ) override;
 203
 204     //XTextFrame
 205     virtual css::uno::Reference< css::text::XText >  SAL_CALL getText() override;
 206
 207     //XText
 208     virtual css::uno::Reference< css::text::XTextCursor >  SAL_CALL createTextCursor() override;
 209     virtual css::uno::Reference< css::text::XTextCursor >  SAL_CALL createTextCursorByRange(const css::uno::Reference< css::text::XTextRange > & aTextPosition) override;
 210
 211     //XEnumerationAccess - frueher XParagraphEnumerationAccess
 212     virtual css::uno::Reference< css::container::XEnumeration >  SAL_CALL createEnumeration() override;
 213
 214     //XElementAccess
 215     virtual css::uno::Type SAL_CALL getElementType(  ) override;
 216     virtual sal_Bool SAL_CALL hasElements(  ) override;
 217
 218     //XTextContent
 219     virtual void SAL_CALL attach( const css::uno::Reference< css::text::XTextRange >& xTextRange ) override;
 220     virtual css::uno::Reference< css::text::XTextRange > SAL_CALL getAnchor(  ) override;
 221
 222     //XComponent
 223     virtual void SAL_CALL dispose(  ) override;
 224     virtual void SAL_CALL addEventListener( const css::uno::Reference< css::lang::XEventListener >& xListener ) override;
 225     virtual void SAL_CALL removeEventListener( const css::uno::Reference< css::lang::XEventListener >& aListener ) override;
 226
 227     //XServiceInfo
 228     virtual OUString SAL_CALL getImplementationName() override;
 229     virtual sal_Bool SAL_CALL supportsService(const OUString& ServiceName) override;
 230     virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames() override;
 231
 232     // XEventsSupplier
 233     virtual css::uno::Reference< css::container::XNameReplace > SAL_CALL getEvents(  ) override;
 234
 235     //XUnoTunnel
 236     virtual sal_Int64 SAL_CALL getSomething( const css::uno::Sequence< sal_Int8 >& aIdentifier ) override;
 237
 238     //XPropertySet
 239     virtual css::uno::Any SAL_CALL getPropertyValue( const OUString& PropertyName ) override;
 240 };
 241
 242 typedef cppu::ImplInheritanceHelper
 243 <   SwXFrame,
 244     css::document::XEventsSupplier
 245 >
 246 SwXTextGraphicObjectBaseClass;
 247 class SwXTextGraphicObject final : public SwXTextGraphicObjectBaseClass
 248 {
 249     friend class SwXFrame; // just for CreateXFrame
 250
 251     virtual ~SwXTextGraphicObject() override;
 252
 253     SwXTextGraphicObject( SwDoc *pDoc );
 254     SwXTextGraphicObject(SwFrameFormat& rFormat);
 255
 256 public:
 257
 258     static css::uno::Reference<css::text::XTextContent>
 259         CreateXTextGraphicObject(SwDoc & rDoc, SwFrameFormat * pFrameFormat);
 260
 261     //XServiceInfo
 262     virtual OUString SAL_CALL getImplementationName() override;
 263     virtual sal_Bool SAL_CALL supportsService(const OUString& ServiceName) override;
 264     virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames() override;
 265
 266     // XEventsSupplier
 267     virtual css::uno::Reference< css::container::XNameReplace > SAL_CALL getEvents(  ) override;
 268 };
 269
 270 typedef cppu::ImplInheritanceHelper
 271 <   SwXFrame,
 272     css::document::XEmbeddedObjectSupplier2,
 273     css::document::XEventsSupplier
 274 > SwXTextEmbeddedObjectBaseClass;
 275
 276 class SwXTextEmbeddedObject final : public SwXTextEmbeddedObjectBaseClass
 277 {
 278     css::uno::Reference<css::util::XModifyListener> m_xOLEListener;
 279
 280     friend class SwXFrame; // just for CreateXFrame
 281
 282     virtual ~SwXTextEmbeddedObject() override;
 283
 284     SwXTextEmbeddedObject( SwDoc *pDoc );
 285     SwXTextEmbeddedObject(SwFrameFormat& rFormat);
 286
 287 public:
 288
 289     static css::uno::Reference<css::text::XTextContent>
 290         CreateXTextEmbeddedObject(SwDoc & rDoc, SwFrameFormat * pFrameFormat);
 291
 292     //XEmbeddedObjectSupplier2
 293     virtual css::uno::Reference< css::lang::XComponent >  SAL_CALL getEmbeddedObject() override;
 294     virtual css::uno::Reference< css::embed::XEmbeddedObject > SAL_CALL getExtendedControlOverEmbeddedObject() override;
 295     virtual ::sal_Int64 SAL_CALL getAspect() override;
 296     virtual void SAL_CALL setAspect( ::sal_Int64 _aspect ) override;
 297     virtual css::uno::Reference< css::graphic::XGraphic > SAL_CALL getReplacementGraphic() override;
 298
 299     //XServiceInfo
 300     virtual OUString SAL_CALL getImplementationName() override;
 301     virtual sal_Bool SAL_CALL supportsService(const OUString& ServiceName) override;
 302     virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames() override;
 303
 304     // XEventsSupplier
 305     virtual css::uno::Reference< css::container::XNameReplace > SAL_CALL getEvents(  ) override;
 306 };
 307
 308 class SwXOLEListener final : public cppu::WeakImplHelper<css::util::XModifyListener>, public SvtListener
 309 {
 310     SwFormat* m_pOLEFormat;
 311     css::uno::Reference<css::frame::XModel> m_xOLEModel;
 312
 313 public:
 314     SwXOLEListener(SwFormat& rOLEFormat, css::uno::Reference< css::frame::XModel > const & xOLE);
 315     virtual ~SwXOLEListener() override;
 316
 317 // css::lang::XEventListener
 318     virtual void SAL_CALL disposing( const css::lang::EventObject& Source ) override;
 319
 320 // css::util::XModifyListener
 321     virtual void SAL_CALL modified( const css::lang::EventObject& aEvent ) override;
 322
 323     virtual void Notify( const SfxHint& ) override;
 324 };
 325
 326 #endif
 327
 328 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */