aw080/main/reportdesign/inc/RptObject.hxx

/**************************************************************
 * 
 * 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
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 * 
 *************************************************************/


#ifndef _REPORT_RPTUIOBJ_HXX
#define _REPORT_RPTUIOBJ_HXX

#include "dllapi.h"
#include <svx/svdoole2.hxx>
#include <svx/svdouno.hxx>


#include <comphelper/processfactory.hxx>
#include <com/sun/star/beans/XPropertyChangeListener.hpp>
#include <com/sun/star/container/XContainerListener.hpp>
#include <com/sun/star/report/XReportComponent.hpp>
#include <com/sun/star/report/XSection.hpp>
#include <svx/svdocirc.hxx>
#include <svx/svdogrp.hxx>
#include <svx/svdoashp.hxx>
#include <comphelper/stl_types.hxx>
#include <comphelper/implementationreference.hxx>


namespace rptui
{
typedef ::std::multimap< sal_Int16, ::rtl::OUString, ::std::less< sal_Int16 > > IndexToNameMap;
    enum DlgEdHintKind
	{
		RPTUI_HINT_UNKNOWN,
		RPTUI_HINT_WINDOWSCROLLED,
		RPTUI_HINT_LAYERCHANGED,
		RPTUI_HINT_OBJORDERCHANGED,
		RPTUI_HINT_SELECTIONCHANGED
	};

	class OUnoObject;
	class REPORTDESIGN_DLLPUBLIC DlgEdHint: public SfxHint
	{
	private:
		DlgEdHintKind	eHintKind;
		OUnoObject*		pDlgEdObj;

        DlgEdHint(DlgEdHint&);
        void operator =(DlgEdHint&);
	public:
		DlgEdHint( DlgEdHintKind eHint );
		virtual ~DlgEdHint();

		inline DlgEdHintKind	GetKind() const	{ return eHintKind; }
		inline OUnoObject*		GetObject() const { return pDlgEdObj; }
	};


class OReportPage;
class OPropertyMediator;

class REPORTDESIGN_DLLPUBLIC OObjectBase
{
public:
    typedef ::comphelper::ImplementationReference<OPropertyMediator,::com::sun::star::beans::XPropertyChangeListener> TMediator;

protected:
    mutable TMediator                                                                           m_xMediator;
	mutable ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertyChangeListener> m_xPropertyChangeListener;
	//mutable ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertyChangeListener> 
	mutable ::com::sun::star::uno::Reference< ::com::sun::star::report::XReportComponent>		m_xReportComponent;
	::com::sun::star::uno::Reference< ::com::sun::star::container::XContainerListener>	        m_xContainerListener;
	::com::sun::star::uno::Reference< ::com::sun::star::report::XSection>				        m_xSection;
    ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >                       m_xKeepShapeAlive;
	::rtl::OUString m_sComponentName;
	sal_Bool		m_bIsListening;

	OObjectBase(const ::com::sun::star::uno::Reference< ::com::sun::star::report::XReportComponent>& _xComponent);
	OObjectBase(const ::rtl::OUString& _sComponentName);

	virtual ~OObjectBase();	
	
	inline sal_Bool	isListening() const { return m_bIsListening; }

	void SetPropsFromRect(const Rectangle& _rRect);

	virtual void SetSnapRectImpl(const Rectangle& _rRect) = 0;
	virtual SdrPage* GetImplPage() const = 0;
    virtual void SetObjectItemHelper(const SfxPoolItem& rItem);

    /** called by instances of derived classes to implement their overloading of getUnoShape
    */
    ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >
            getUnoShapeOf( SdrObject& _rSdrObject );

private:
    static void    ensureSdrObjectOwnership(
                    const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& _rxShape );

public:
	void StartListening();
	void EndListening(sal_Bool bRemoveListener = sal_True);
	// PropertyChangeListener
	virtual void _propertyChange( const  ::com::sun::star::beans::PropertyChangeEvent& evt ) throw(::com::sun::star::uno::RuntimeException);
    virtual void initializeOle() {}

	sal_Bool		supportsService( const ::rtl::OUString& _sServiceName ) const;	

	::com::sun::star::uno::Reference< ::com::sun::star::report::XReportComponent> getReportComponent() const;
    virtual ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet> getAwtComponent();
	inline void setOldParent(const ::com::sun::star::uno::Reference< ::com::sun::star::report::XSection>& _xSection) { m_xSection = _xSection; }
	inline ::com::sun::star::uno::Reference< ::com::sun::star::report::XSection> getOldParent() const { return m_xSection;}
    ::com::sun::star::uno::Reference< ::com::sun::star::report::XSection> getSection() const;
    inline const ::rtl::OUString getServiceName() const { return m_sComponentName; }

    /** releases the reference to our UNO shape (m_xKeepShapeAlive)
    */
    void    releaseUnoShape() { m_xKeepShapeAlive.clear(); }

    static SdrObject* createObject(
		SdrModel* pTargetModel, 
		const ::com::sun::star::uno::Reference< ::com::sun::star::report::XReportComponent>& _xComponent);
    static sal_uInt16 getObjectType(const ::com::sun::star::uno::Reference< ::com::sun::star::report::XReportComponent>& _xComponent);
};
//============================================================================
// OCustomShape
//============================================================================
class REPORTDESIGN_DLLPUBLIC OCustomShape: public SdrObjCustomShape , public OObjectBase
{
	friend class OReportPage;
    friend class DlgEdFactory;

public:
    static OCustomShape* Create(SdrModel& rSdrModel, const ::com::sun::star::uno::Reference< ::com::sun::star::report::XReportComponent>& _xComponent);

	/// create a copy, evtl. with a different target model (if given)
	virtual SdrObject* CloneSdrObject(SdrModel* pTargetModel = 0) const;

protected:
	/// method to copy all data from given source
	virtual void copyDataFromSdrObject(const SdrObject& rSource);

	OCustomShape(SdrModel& rSdrModel, const ::com::sun::star::uno::Reference< ::com::sun::star::report::XReportComponent>& _xComponent);
	OCustomShape(SdrModel& rSdrModel, const ::rtl::OUString& _sComponentName);

	virtual void setSdrObjectTransformation(const basegfx::B2DHomMatrix& rTransformation);
	virtual bool EndCreate(SdrDragStat& rStat, SdrCreateCmd eCmd);

	virtual void SetSnapRectImpl(const Rectangle& _rRect);
	virtual SdrPage* GetImplPage() const;
    void SetObjectItemHelper(const SfxPoolItem& rItem);

public:
	virtual ~OCustomShape();
	
	virtual sal_Int32	GetStep() const;
    virtual ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet> getAwtComponent();

    virtual ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > getUnoShape();
    virtual sal_uInt16 GetObjIdentifier() const;
    virtual sal_uInt32 GetObjInventor() const;
};

//============================================================================
// OOle2Obj
//============================================================================
class REPORTDESIGN_DLLPUBLIC OOle2Obj: public SdrOle2Obj , public OObjectBase
{
private:
	friend class OReportPage;
    friend class DlgEdFactory;

    sal_uInt16 m_nType;
    bool    m_bOnlyOnce;
    void impl_createDataProvider_nothrow( const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel>& _xModel);

protected:
	OOle2Obj(
		SdrModel& rSdrModel, 
		const ::com::sun::star::uno::Reference< ::com::sun::star::report::XReportComponent >& _xComponent,
		sal_uInt16 _nType);
	OOle2Obj(
		SdrModel& rSdrModel, 
		::rtl::OUString _sComponentName,
		sal_uInt16 _nType);
    
	virtual ~OOle2Obj();

	virtual void setSdrObjectTransformation(const basegfx::B2DHomMatrix& rTransformation);
	virtual bool EndCreate(SdrDragStat& rStat, SdrCreateCmd eCmd);

	virtual void SetSnapRectImpl(const Rectangle& _rRect);
	virtual SdrPage* GetImplPage() const;

	/// method to copy all data from given source
	virtual void copyDataFromSdrObject(const SdrObject& rSource);

public:
	/// create a copy, evtl. with a different target model (if given)
	virtual SdrObject* CloneSdrObject(SdrModel* pTargetModel = 0) const;
	static OOle2Obj* Create(SdrModel& rSdrModel, const ::com::sun::star::uno::Reference< ::com::sun::star::report::XReportComponent >& _xComponent, sal_uInt16 _nType);
	
	virtual sal_Int32	GetStep() const;
    virtual ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet> getAwtComponent();

    virtual ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > getUnoShape();
    virtual sal_uInt16 GetObjIdentifier() const;
    virtual sal_uInt32 GetObjInventor() const;
    virtual void initializeOle();

    void initializeChart( const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel>& _xModel);
};

//============================================================================
// OUnoObject
//============================================================================
class REPORTDESIGN_DLLPUBLIC OUnoObject: public SdrUnoObj , public OObjectBase
{
private:
	friend class OReportPage;
	friend class OObjectBase;
    friend class DlgEdFactory;

    sal_uInt16   m_nObjectType;

    void    impl_setReportComponent_nothrow();
    void    impl_initializeModel_nothrow();

protected:
	OUnoObject(SdrModel& rSdrModel
				,const ::rtl::OUString& _sComponentName
				,const ::rtl::OUString& rModelName
                ,sal_uInt16   _nObjectType);
    OUnoObject(	 SdrModel& rSdrModel
				,const ::com::sun::star::uno::Reference< ::com::sun::star::report::XReportComponent>& _xComponent
                ,const ::rtl::OUString& rModelName
                ,sal_uInt16   _nObjectType);

	virtual ~OUnoObject();
	
	virtual void setSdrObjectTransformation(const basegfx::B2DHomMatrix& rTransformation);
	virtual bool EndCreate(SdrDragStat& rStat, SdrCreateCmd eCmd);

	virtual void SetSnapRectImpl(const Rectangle& _rRect);
	virtual SdrPage* GetImplPage() const;

	/// method to copy all data from given source
	virtual void copyDataFromSdrObject(const SdrObject& rSource);

public:
	/// create a copy, evtl. with a different target model (if given)
	virtual SdrObject* CloneSdrObject(SdrModel* pTargetModel = 0) const;

	virtual sal_Int32	GetStep() const;
    virtual void _propertyChange( const  ::com::sun::star::beans::PropertyChangeEvent& evt ) throw(::com::sun::star::uno::RuntimeException);

	/** creates the m_xMediator when it doesn't already exist.
		@param	_bReverse	when set to <TRUE/> then the properties from the uno control will be copied into report control
	*/
	void CreateMediator(sal_Bool _bReverse = sal_False);

    virtual ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet> getAwtComponent();

    static ::rtl::OUString GetDefaultName(const OUnoObject* _pObj);

    virtual ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > getUnoShape();
    virtual sal_uInt16 GetObjIdentifier() const;
    virtual sal_uInt32 GetObjInventor() const;
};

//============================================================================
} // rptui
//============================================================================
#endif // _REPORT_RPTUIOBJ_HXX