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