/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: chartlis.hxx,v $
 * $Revision: 1.8 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef SC_CHARTLIS_HXX
#define SC_CHARTLIS_HXX


#include <vcl/timer.hxx>
#include <svtools/listener.hxx>
#include "collect.hxx"
#include "rangelst.hxx"

class ScDocument;
class ScChartUnoData;
#include <com/sun/star/chart/XChartData.hpp>
#include <com/sun/star/chart/XChartDataChangeEventListener.hpp>

class ScChartListener : public StrData, public SvtListener
{
private:
    ScRangeListRef	aRangeListRef;
    ScChartUnoData*	pUnoData;
    ScDocument* 	pDoc;
    BOOL			bUsed;	// fuer ScChartListenerCollection::FreeUnused
    BOOL			bDirty;
    BOOL			bSeriesRangesScheduled;

                    // not implemented
    ScChartListener& operator=( const ScChartListener& );

public:
                    ScChartListener( const String& rName, ScDocument* pDoc,
                                    const ScRange& rRange );
                    ScChartListener( const String& rName, ScDocument* pDoc,
                                    const ScRangeListRef& rRangeListRef );
                    ScChartListener( const ScChartListener& );
    virtual			~ScChartListener();
    virtual DataObject*	Clone() const;

    void			SetUno( const com::sun::star::uno::Reference< com::sun::star::chart::XChartDataChangeEventListener >& rListener,
                            const com::sun::star::uno::Reference< com::sun::star::chart::XChartData >& rSource );
    com::sun::star::uno::Reference< com::sun::star::chart::XChartDataChangeEventListener >	GetUnoListener() const;
    com::sun::star::uno::Reference< com::sun::star::chart::XChartData >						GetUnoSource() const;

    BOOL			IsUno() const	{ return (pUnoData != NULL); }

    virtual void 	Notify( SvtBroadcaster& rBC, const SfxHint& rHint );
    void			StartListeningTo();
    void			EndListeningTo();
    void			ChangeListening( const ScRangeListRef& rRangeListRef,
                                    BOOL bDirty = FALSE );
    void			Update();
    const ScRangeListRef&	GetRangeList() const { return aRangeListRef; }
    void			SetRangeList( const ScRangeListRef& rNew ) { aRangeListRef = rNew; }
    void			SetRangeList( const ScRange& rNew );
    BOOL			IsUsed() const { return bUsed; }
    void			SetUsed( BOOL bFlg ) { bUsed = bFlg; }
    BOOL			IsDirty() const { return bDirty; }
    void			SetDirty( BOOL bFlg ) { bDirty = bFlg; }

    void            UpdateChartIntersecting( const ScRange& rRange );

    // if chart series ranges are to be updated later on (e.g. DeleteTab, InsertTab)
    void			ScheduleSeriesRanges()		{ bSeriesRangesScheduled = TRUE; }
    void			UpdateScheduledSeriesRanges();
    void			UpdateSeriesRanges();

    BOOL			operator==( const ScChartListener& );
    BOOL			operator!=( const ScChartListener& r )
                        { return !operator==( r ); }
};

class ScChartListenerCollection : public StrCollection
{
private:
    Timer			aTimer;
    ScDocument*		pDoc;

                    DECL_LINK( TimerHdl, Timer* );

                    // not implemented
    ScChartListenerCollection& operator=( const ScChartListenerCollection& );

    using StrCollection::operator==;

public:
                    ScChartListenerCollection( ScDocument* pDoc );
                    ScChartListenerCollection( const ScChartListenerCollection& );
    virtual	DataObject*	Clone() const;

    virtual			~ScChartListenerCollection();

                    // nur nach copy-ctor noetig, wenn neu ins Dok gehaengt
    void			StartAllListeners();

    void			ChangeListening( const String& rName,
                                    const ScRangeListRef& rRangeListRef,
                                    BOOL bDirty = FALSE );
    // FreeUnused nur wie in ScDocument::UpdateChartListenerCollection verwenden!
    void			FreeUnused();
    void			FreeUno( const com::sun::star::uno::Reference< com::sun::star::chart::XChartDataChangeEventListener >& rListener,
                             const com::sun::star::uno::Reference< com::sun::star::chart::XChartData >& rSource );
    void			StartTimer();
    void			UpdateDirtyCharts();
    void			SetDirty();
    void			SetDiffDirty( const ScChartListenerCollection&,
                        BOOL bSetChartRangeLists = FALSE );

    void			SetRangeDirty( const ScRange& rRange );		// z.B. Zeilen/Spalten

    void			UpdateScheduledSeriesRanges();
    void            UpdateChartsContainingTab( SCTAB nTab );

    BOOL			operator==( const ScChartListenerCollection& );
};


#endif