reportdesign/inc/RptObject.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_REPORTDESIGN_INC_RPTOBJECT_HXX
  20 #define INCLUDED_REPORTDESIGN_INC_RPTOBJECT_HXX
  21
  22 #include "dllapi.h"
  23
  24 #include <svx/svdoole2.hxx>
  25 #include <svx/svdouno.hxx>
  26
  27
  28 #include <com/sun/star/beans/XPropertyChangeListener.hpp>
  29 #include <com/sun/star/container/XContainerListener.hpp>
  30 #include <com/sun/star/report/XReportComponent.hpp>
  31 #include <com/sun/star/report/XSection.hpp>
  32 #include <svx/svdocirc.hxx>
  33 #include <svx/svdogrp.hxx>
  34 #include <svx/svdoashp.hxx>
  35
  36 namespace rptui
  37 {
  38 typedef ::std::multimap< sal_Int16, OUString > IndexToNameMap;
  39     enum DlgEdHintKind
  40     {
  41         RPTUI_HINT_WINDOWSCROLLED,
  42         RPTUI_HINT_SELECTIONCHANGED
  43     };
  44
  45     class OUnoObject;
  46     class REPORTDESIGN_DLLPUBLIC DlgEdHint: public SfxHint
  47     {
  48     private:
  49         DlgEdHintKind   eHintKind;
  50
  51         DlgEdHint(DlgEdHint&) = delete;
  52         void operator =(DlgEdHint&) = delete;
  53     public:
  54         DlgEdHint( DlgEdHintKind eHint );
  55         virtual ~DlgEdHint() override;
  56
  57         DlgEdHintKind    GetKind() const { return eHintKind; }
  58     };
  59
  60
  61 class OReportPage;
  62 class OPropertyMediator;
  63
  64 class REPORTDESIGN_DLLPUBLIC OObjectBase
  65 {
  66 protected:
  67     mutable rtl::Reference<OPropertyMediator>                         m_xMediator;
  68     mutable css::uno::Reference< css::beans::XPropertyChangeListener> m_xPropertyChangeListener;
  69     mutable css::uno::Reference< css::report::XReportComponent>       m_xReportComponent;
  70     css::uno::Reference< css::uno::XInterface >                       m_xKeepShapeAlive;
  71     OUString m_sComponentName;
  72     bool        m_bIsListening;
  73
  74     OObjectBase(const css::uno::Reference< css::report::XReportComponent>& _xComponent);
  75     OObjectBase(const OUString& _sComponentName);
  76
  77     virtual ~OObjectBase();
  78
  79     bool isListening() const { return m_bIsListening; }
  80
  81     void SetPropsFromRect(const tools::Rectangle& _rRect);
  82
  83     virtual SdrPage* GetImplPage() const = 0;
  84
  85     /** called by instances of derived classes to implement their overriding of getUnoShape
  86     */
  87     css::uno::Reference< css::uno::XInterface >
  88             getUnoShapeOf( SdrObject& _rSdrObject );
  89
  90 private:
  91     static void    ensureSdrObjectOwnership(
  92                     const css::uno::Reference< css::uno::XInterface >& _rxShape );
  93
  94 public:
  95     OObjectBase(const OObjectBase&) = delete;
  96     OObjectBase& operator=(const OObjectBase&) = delete;
  97     void StartListening();
  98     void EndListening();
  99     // PropertyChangeListener
 100     /// @throws css::uno::RuntimeException
 101     virtual void _propertyChange( const  css::beans::PropertyChangeEvent& evt );
 102     virtual void initializeOle() {}
 103
 104     bool        supportsService( const OUString& _sServiceName ) const;
 105
 106     const css::uno::Reference< css::report::XReportComponent>& getReportComponent() const { return m_xReportComponent;}
 107     virtual css::uno::Reference< css::beans::XPropertySet> getAwtComponent();
 108     css::uno::Reference< css::report::XSection> getSection() const;
 109     const OUString& getServiceName() const { return m_sComponentName; }
 110
 111     /** releases the reference to our UNO shape (m_xKeepShapeAlive)
 112     */
 113     void    releaseUnoShape() { m_xKeepShapeAlive.clear(); }
 114
 115     static SdrObject* createObject(
 116         SdrModel& rTargetModel,
 117         const css::uno::Reference< css::report::XReportComponent>& _xComponent);
 118     static sal_uInt16 getObjectType(const css::uno::Reference< css::report::XReportComponent>& _xComponent);
 119 };
 120
 121 // OCustomShape
 122
 123 class REPORTDESIGN_DLLPUBLIC OCustomShape final : public SdrObjCustomShape , public OObjectBase
 124 {
 125     friend class OReportPage;
 126     friend class DlgEdFactory;
 127
 128 private:
 129     // protected destructor - due to final, make private
 130     virtual ~OCustomShape() override;
 131
 132 public:
 133     static OCustomShape* Create(
 134         SdrModel& rSdrModel,
 135         const css::uno::Reference< css::report::XReportComponent>& _xComponent)
 136     {
 137         return new OCustomShape(rSdrModel, _xComponent );
 138     }
 139
 140     virtual css::uno::Reference< css::beans::XPropertySet> getAwtComponent() override;
 141
 142     virtual css::uno::Reference< css::uno::XInterface > getUnoShape() override;
 143     virtual sal_uInt16 GetObjIdentifier() const override;
 144     virtual SdrInventor GetObjInventor() const override;
 145
 146 private:
 147     virtual void impl_setUnoShape( const css::uno::Reference< css::uno::XInterface >& rxUnoShape ) override;
 148
 149     OCustomShape(
 150         SdrModel& rSdrModel,
 151         const css::uno::Reference< css::report::XReportComponent>& _xComponent);
 152     OCustomShape(
 153         SdrModel& rSdrModel,
 154         const OUString& _sComponentName);
 155
 156     virtual void NbcMove( const Size& rSize ) override;
 157     virtual void NbcResize(const Point& rRef, const Fraction& xFact, const Fraction& yFact) override;
 158     virtual void NbcSetLogicRect(const tools::Rectangle& rRect) override;
 159     virtual bool EndCreate(SdrDragStat& rStat, SdrCreateCmd eCmd) override;
 160
 161     virtual SdrPage* GetImplPage() const override;
 162 };
 163
 164
 165 // OOle2Obj
 166
 167 class REPORTDESIGN_DLLPUBLIC OOle2Obj final : public SdrOle2Obj , public OObjectBase
 168 {
 169     friend class OReportPage;
 170     friend class DlgEdFactory;
 171
 172 private:
 173     // protected destructor - due to final, make private
 174     virtual ~OOle2Obj() override;
 175
 176 public:
 177     static OOle2Obj* Create(
 178         SdrModel& rSdrModel,
 179         const css::uno::Reference< css::report::XReportComponent>& _xComponent,
 180         sal_uInt16 _nType)
 181     {
 182         return new OOle2Obj(rSdrModel, _xComponent, _nType);
 183     }
 184
 185     virtual css::uno::Reference< css::beans::XPropertySet> getAwtComponent() override;
 186
 187     virtual css::uno::Reference< css::uno::XInterface > getUnoShape() override;
 188     virtual sal_uInt16 GetObjIdentifier() const override;
 189     virtual SdrInventor GetObjInventor() const override;
 190     // Clone() should make a complete copy of the object.
 191     virtual OOle2Obj* CloneSdrObject(SdrModel& rTargetModel) const override;
 192     virtual void initializeOle() override;
 193
 194     OOle2Obj& operator=(const OOle2Obj& rObj);
 195
 196     void initializeChart( const css::uno::Reference< css::frame::XModel>& _xModel);
 197
 198 private:
 199     OOle2Obj(
 200         SdrModel& rSdrModel,
 201         const css::uno::Reference< css::report::XReportComponent>& _xComponent,
 202         sal_uInt16 _nType);
 203     OOle2Obj(
 204         SdrModel& rSdrModel,
 205         const OUString& _sComponentName,
 206         sal_uInt16 _nType);
 207
 208     virtual void NbcMove( const Size& rSize ) override;
 209     virtual void NbcResize(const Point& rRef, const Fraction& xFact, const Fraction& yFact) override;
 210     virtual void NbcSetLogicRect(const tools::Rectangle& rRect) override;
 211     virtual bool EndCreate(SdrDragStat& rStat, SdrCreateCmd eCmd) override;
 212
 213     virtual SdrPage* GetImplPage() const override;
 214
 215     void impl_createDataProvider_nothrow( const css::uno::Reference< css::frame::XModel>& _xModel);
 216     virtual void impl_setUnoShape( const css::uno::Reference< css::uno::XInterface >& rxUnoShape ) override;
 217
 218     sal_uInt16 m_nType;
 219     bool    m_bOnlyOnce;
 220 };
 221
 222
 223 // OUnoObject
 224
 225 class REPORTDESIGN_DLLPUBLIC OUnoObject: public SdrUnoObj , public OObjectBase
 226 {
 227     friend class OReportPage;
 228     friend class OObjectBase;
 229     friend class DlgEdFactory;
 230
 231     sal_uInt16   m_nObjectType;
 232 protected:
 233     OUnoObject(SdrModel& rSdrModel,
 234         const OUString& _sComponentName,
 235         const OUString& rModelName,
 236         sal_uInt16   _nObjectType);
 237     OUnoObject(
 238         SdrModel& rSdrModel,
 239         const css::uno::Reference< css::report::XReportComponent>& _xComponent,
 240         const OUString& rModelName,
 241         sal_uInt16 _nObjectType);
 242
 243     // protected destructor
 244     virtual ~OUnoObject() override;
 245
 246     virtual void NbcMove( const Size& rSize ) override;
 247     virtual void NbcResize(const Point& rRef, const Fraction& xFact, const Fraction& yFact) override;
 248     virtual void NbcSetLogicRect(const tools::Rectangle& rRect) override;
 249     virtual bool EndCreate(SdrDragStat& rStat, SdrCreateCmd eCmd) override;
 250
 251     virtual SdrPage* GetImplPage() const override;
 252
 253 public:
 254
 255     virtual void _propertyChange( const  css::beans::PropertyChangeEvent& evt ) override;
 256
 257     /** creates the m_xMediator when it doesn't already exist.
 258         @param  _bReverse   when set to <TRUE/> then the properties from the uno control will be copied into report control
 259     */
 260     void CreateMediator(bool _bReverse = false);
 261
 262     virtual css::uno::Reference< css::beans::XPropertySet> getAwtComponent() override;
 263
 264     static OUString GetDefaultName(const OUnoObject* _pObj);
 265
 266     virtual css::uno::Reference< css::uno::XInterface > getUnoShape() override;
 267     virtual sal_uInt16 GetObjIdentifier() const override;
 268     virtual SdrInventor GetObjInventor() const override;
 269     virtual OUnoObject* CloneSdrObject(SdrModel& rTargetModel) const override;
 270
 271     OUnoObject& operator=(const OUnoObject& rObj);
 272
 273 private:
 274     virtual void impl_setUnoShape( const css::uno::Reference< css::uno::XInterface >& rxUnoShape ) override;
 275     void    impl_setReportComponent_nothrow();
 276     void    impl_initializeModel_nothrow();
 277 };
 278
 279
 280 } // rptui
 281
 282 #endif // INCLUDED_REPORTDESIGN_INC_RPTOBJECT_HXX
 283
 284 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */