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/frame/XModel.hpp>
  30 #include <com/sun/star/document/XEventsSupplier.hpp>
  31
  32 #include <cppuhelper/implbase.hxx>
  33
  34 #include <sfx2/objsh.hxx>
  35
  36 #include <flyenum.hxx>
  37 #include <frmfmt.hxx>
  38 #include <unotext.hxx>
  39
  40 class SdrObject;
  41 class SwDoc;
  42 class SwFormat;
  43 class SwFlyFrameFormat;
  44
  45 class BaseFrameProperties_Impl;
  46 class SwXFrame : public cppu::WeakImplHelper
  47 <
  48     css::lang::XServiceInfo,
  49     css::lang::XUnoTunnel,
  50     css::beans::XPropertySet,
  51     css::beans::XPropertyState,
  52     css::drawing::XShape,
  53     css::container::XNamed,
  54     css::text::XTextContent
  55 >,
  56     public SwClient
  57 {
  58 private:
  59     class Impl;
  60     ::sw::UnoImplPtr<Impl> m_pImpl;
  61
  62     const SfxItemPropertySet*       m_pPropSet;
  63     SwDoc*                          m_pDoc;
  64
  65     const FlyCntType                eType;
  66
  67     // Descriptor-interface
  68     BaseFrameProperties_Impl*       pProps;
  69     bool bIsDescriptor;
  70     OUString                        m_sName;
  71
  72     SwPaM*                          m_pCopySource;
  73
  74 protected:
  75     css::uno::Reference< css::beans::XPropertySet > mxStyleData;
  76     css::uno::Reference< css::container::XNameAccess >  mxStyleFamily;
  77     virtual void Modify( const SfxPoolItem* pOld, const SfxPoolItem *pNew) override;
  78
  79     virtual ~SwXFrame() override;
  80
  81     SwXFrame(FlyCntType eSet,
  82                 const SfxItemPropertySet*    pPropSet,
  83                 SwDoc *pDoc ); //Descriptor-If
  84     SwXFrame(SwFrameFormat& rFrameFormat, FlyCntType eSet,
  85                 const SfxItemPropertySet*    pPropSet);
  86
  87     template<class Interface, class Impl>
  88     static css::uno::Reference<Interface>
  89     CreateXFrame(SwDoc & rDoc, SwFrameFormat *const pFrameFormat);
  90
  91 public:
  92     static const css::uno::Sequence< sal_Int8 > & getUnoTunnelId();
  93
  94     //XUnoTunnel
  95     virtual sal_Int64 SAL_CALL getSomething( const css::uno::Sequence< sal_Int8 >& aIdentifier ) override;
  96
  97
  98     //XNamed
  99     virtual OUString SAL_CALL getName() override;
 100     virtual void SAL_CALL setName(const OUString& Name_) override;
 101
 102     //XPropertySet
 103     virtual css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo(  ) override;
 104     virtual void SAL_CALL setPropertyValue( const OUString& aPropertyName, const css::uno::Any& aValue ) override;
 105     virtual css::uno::Any SAL_CALL getPropertyValue( const OUString& PropertyName ) override;
 106     virtual void SAL_CALL addPropertyChangeListener( const OUString& aPropertyName, const css::uno::Reference< css::beans::XPropertyChangeListener >& xListener ) override;
 107     virtual void SAL_CALL removePropertyChangeListener( const OUString& aPropertyName, const css::uno::Reference< css::beans::XPropertyChangeListener >& aListener ) override;
 108     virtual void SAL_CALL addVetoableChangeListener( const OUString& PropertyName, const css::uno::Reference< css::beans::XVetoableChangeListener >& aListener ) override;
 109     virtual void SAL_CALL removeVetoableChangeListener( const OUString& PropertyName, const css::uno::Reference< css::beans::XVetoableChangeListener >& aListener ) override;
 110
 111      //XPropertyState
 112     virtual css::beans::PropertyState SAL_CALL getPropertyState( const OUString& PropertyName ) override;
 113     virtual css::uno::Sequence< css::beans::PropertyState > SAL_CALL getPropertyStates( const css::uno::Sequence< OUString >& aPropertyName ) override;
 114     virtual void SAL_CALL setPropertyToDefault( const OUString& PropertyName ) override;
 115     virtual css::uno::Any SAL_CALL getPropertyDefault( const OUString& aPropertyName ) override;
 116
 117     //XShape
 118     virtual css::awt::Point SAL_CALL getPosition(  ) override;
 119     virtual void SAL_CALL setPosition( const css::awt::Point& aPosition ) override;
 120     virtual css::awt::Size SAL_CALL getSize(  ) override;
 121     virtual void SAL_CALL setSize( const css::awt::Size& aSize ) override;
 122
 123     //XShapeDescriptor
 124     virtual OUString SAL_CALL getShapeType() override;
 125
 126     //Base implementation
 127     //XComponent
 128     virtual void SAL_CALL dispose() override;
 129     virtual void SAL_CALL addEventListener(const css::uno::Reference<css::lang::XEventListener>& xListener) override;
 130     virtual void SAL_CALL removeEventListener(const css::uno::Reference<css::lang::XEventListener>& xListener) override;
 131
 132     // XTextContent
 133     virtual void SAL_CALL attach(const css::uno::Reference<css::text::XTextRange>& xTextRange) override;
 134     virtual css::uno::Reference<css::text::XTextRange>  SAL_CALL getAnchor() override;
 135
 136     //XServiceInfo
 137     virtual OUString SAL_CALL getImplementationName() override;
 138     virtual sal_Bool SAL_CALL supportsService(const OUString& ServiceName) override;
 139     virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames() override;
 140
 141     /// @throws css::lang::IllegalArgumentException
 142     /// @throws css::uno::RuntimeException
 143     void attachToRange(const css::uno::Reference< css::text::XTextRange > & xTextRange);
 144
 145     const SwFrameFormat* GetFrameFormat() const
 146     {
 147         return dynamic_cast<const SwFrameFormat*>( GetRegisteredIn()  );
 148     }
 149     SwFrameFormat* GetFrameFormat()
 150     {
 151         return dynamic_cast< SwFrameFormat*>( GetRegisteredIn() );
 152     }
 153     FlyCntType      GetFlyCntType()const {return eType;}
 154
 155     bool IsDescriptor() const {return bIsDescriptor;}
 156     void            ResetDescriptor();
 157     //copy text from a given source PaM
 158     void            SetSelection(SwPaM& rCopySource);
 159     static SW_DLLPUBLIC SdrObject *GetOrCreateSdrObject(SwFlyFrameFormat &rFormat);
 160 };
 161
 162 typedef cppu::WeakImplHelper
 163 <
 164     css::text::XTextFrame,
 165     css::container::XEnumerationAccess,
 166     css::document::XEventsSupplier
 167 >
 168 SwXTextFrameBaseClass;
 169
 170 class SwXTextFrame : public SwXTextFrameBaseClass,
 171     public SwXText,
 172     public SwXFrame
 173 {
 174 protected:
 175     friend class SwXFrame; // just for CreateXFrame
 176
 177     virtual const SwStartNode *GetStartNode() const override;
 178
 179     virtual css::uno::Reference< css::text::XTextCursor >
 180         CreateCursor() override;
 181
 182     virtual ~SwXTextFrame() override;
 183
 184     SwXTextFrame(SwDoc *pDoc);
 185     SwXTextFrame(SwFrameFormat& rFormat);
 186
 187 public:
 188     static SW_DLLPUBLIC css::uno::Reference<css::text::XTextFrame>
 189             CreateXTextFrame(SwDoc & rDoc, SwFrameFormat * pFrameFormat);
 190
 191     // FIXME: EVIL HACK:  make available for SwXFrame::attachToRange
 192     using SwXText::SetDoc;
 193
 194     virtual css::uno::Any SAL_CALL queryInterface( const css::uno::Type& aType ) override;
 195     virtual void SAL_CALL acquire(  ) throw() override;
 196     virtual void SAL_CALL release(  ) throw() override;
 197
 198     //XTypeProvider
 199     virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes(  ) override;
 200     virtual css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId(  ) override;
 201
 202     //XTextFrame
 203     virtual css::uno::Reference< css::text::XText >  SAL_CALL getText() override;
 204
 205     //XText
 206     virtual css::uno::Reference< css::text::XTextCursor >  SAL_CALL createTextCursor() override;
 207     virtual css::uno::Reference< css::text::XTextCursor >  SAL_CALL createTextCursorByRange(const css::uno::Reference< css::text::XTextRange > & aTextPosition) override;
 208
 209     //XEnumerationAccess - frueher XParagraphEnumerationAccess
 210     virtual css::uno::Reference< css::container::XEnumeration >  SAL_CALL createEnumeration() override;
 211
 212     //XElementAccess
 213     virtual css::uno::Type SAL_CALL getElementType(  ) override;
 214     virtual sal_Bool SAL_CALL hasElements(  ) override;
 215
 216     //XTextContent
 217     virtual void SAL_CALL attach( const css::uno::Reference< css::text::XTextRange >& xTextRange ) override;
 218     virtual css::uno::Reference< css::text::XTextRange > SAL_CALL getAnchor(  ) override;
 219
 220     //XComponent
 221     virtual void SAL_CALL dispose(  ) override;
 222     virtual void SAL_CALL addEventListener( const css::uno::Reference< css::lang::XEventListener >& xListener ) override;
 223     virtual void SAL_CALL removeEventListener( const css::uno::Reference< css::lang::XEventListener >& aListener ) override;
 224
 225     //XServiceInfo
 226     virtual OUString SAL_CALL getImplementationName() override;
 227     virtual sal_Bool SAL_CALL supportsService(const OUString& ServiceName) override;
 228     virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames() override;
 229
 230     // XEventsSupplier
 231     virtual css::uno::Reference< css::container::XNameReplace > SAL_CALL getEvents(  ) override;
 232
 233     //XUnoTunnel
 234     virtual sal_Int64 SAL_CALL getSomething( const css::uno::Sequence< sal_Int8 >& aIdentifier ) override;
 235
 236     //XPropertySet
 237     virtual css::uno::Any SAL_CALL getPropertyValue( const OUString& PropertyName ) override;
 238
 239     void * SAL_CALL operator new( size_t ) throw();
 240     void SAL_CALL operator delete( void * ) throw();
 241 };
 242
 243 typedef cppu::ImplInheritanceHelper
 244 <   SwXFrame,
 245     css::document::XEventsSupplier
 246 >
 247 SwXTextGraphicObjectBaseClass;
 248 class SwXTextGraphicObject : public SwXTextGraphicObjectBaseClass
 249 {
 250 protected:
 251     friend class SwXFrame; // just for CreateXFrame
 252
 253     virtual ~SwXTextGraphicObject() override;
 254
 255     SwXTextGraphicObject( SwDoc *pDoc );
 256     SwXTextGraphicObject(SwFrameFormat& rFormat);
 257
 258 public:
 259
 260     static css::uno::Reference<css::text::XTextContent>
 261         CreateXTextGraphicObject(SwDoc & rDoc, SwFrameFormat * pFrameFormat);
 262
 263     //XServiceInfo
 264     virtual OUString SAL_CALL getImplementationName() override;
 265     virtual sal_Bool SAL_CALL supportsService(const OUString& ServiceName) override;
 266     virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames() override;
 267
 268     // XEventsSupplier
 269     virtual css::uno::Reference< css::container::XNameReplace > SAL_CALL getEvents(  ) override;
 270
 271     void * SAL_CALL operator new( size_t ) throw();
 272     void SAL_CALL operator delete( void * ) throw();
 273 };
 274
 275 class SwOLENode;
 276 typedef cppu::ImplInheritanceHelper
 277 <   SwXFrame,
 278     css::document::XEmbeddedObjectSupplier2,
 279     css::document::XEventsSupplier
 280 > SwXTextEmbeddedObjectBaseClass;
 281
 282 class SwXTextEmbeddedObject : public SwXTextEmbeddedObjectBaseClass
 283 {
 284     css::uno::Reference<css::util::XModifyListener> m_xOLEListener;
 285 protected:
 286     friend class SwXFrame; // just for CreateXFrame
 287
 288     virtual ~SwXTextEmbeddedObject() override;
 289
 290     SwXTextEmbeddedObject( SwDoc *pDoc );
 291     SwXTextEmbeddedObject(SwFrameFormat& rFormat);
 292
 293 public:
 294
 295     static css::uno::Reference<css::text::XTextContent>
 296         CreateXTextEmbeddedObject(SwDoc & rDoc, SwFrameFormat * pFrameFormat);
 297
 298     //XEmbeddedObjectSupplier2
 299     virtual css::uno::Reference< css::lang::XComponent >  SAL_CALL getEmbeddedObject() override;
 300     virtual css::uno::Reference< css::embed::XEmbeddedObject > SAL_CALL getExtendedControlOverEmbeddedObject() override;
 301     virtual ::sal_Int64 SAL_CALL getAspect() override;
 302     virtual void SAL_CALL setAspect( ::sal_Int64 _aspect ) override;
 303     virtual css::uno::Reference< css::graphic::XGraphic > SAL_CALL getReplacementGraphic() override;
 304
 305     //XServiceInfo
 306     virtual OUString SAL_CALL getImplementationName() override;
 307     virtual sal_Bool SAL_CALL supportsService(const OUString& ServiceName) override;
 308     virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames() override;
 309
 310     // XEventsSupplier
 311     virtual css::uno::Reference< css::container::XNameReplace > SAL_CALL getEvents(  ) override;
 312     void * SAL_CALL operator new( size_t ) throw();
 313     void SAL_CALL operator delete( void * ) throw();
 314 };
 315
 316 class SwXOLEListener : public cppu::WeakImplHelper<css::util::XModifyListener>,
 317     public SwClient
 318 {
 319     css::uno::Reference< css::frame::XModel > xOLEModel;
 320
 321 public:
 322     SwXOLEListener(SwFormat& rOLEFormat, css::uno::Reference< css::frame::XModel > const & xOLE);
 323     virtual ~SwXOLEListener() override;
 324
 325 // css::lang::XEventListener
 326     virtual void SAL_CALL disposing( const css::lang::EventObject& Source ) override;
 327
 328 // css::util::XModifyListener
 329     virtual void SAL_CALL modified( const css::lang::EventObject& aEvent ) override;
 330
 331 protected:
 332     virtual void Modify( const SfxPoolItem* pOld, const SfxPoolItem *pNew) override;
 333 };
 334
 335 #endif
 336
 337 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */