/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * 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 PAGE_LIST_WATCHER_HXX
#define PAGE_LIST_WATCHER_HXX

#include "pres.hxx"
#include <sal/types.h>
#include <vector>

class SdPage;
class SdrModel;

/** Maintain a map of page indices to page objects for faster access that
    remains valid during deletions and insertions of pages (#109538#).
*/
class ImpPageListWatcher
{
protected:
	// typedefs for a vector of SdPages
	typedef ::std::vector< SdPage* > SdPageVector;

	const SdrModel&					mrModel;

	SdPageVector					maPageVectorStandard;
	SdPageVector					maPageVectorNotes;
	SdPage*							mpHandoutPage;

	sal_Bool						mbPageListValid;

	void ImpRecreateSortedPageListOnDemand();
	virtual sal_uInt32 ImpGetPageCount() const = 0;

    /** Return the page with the given index.
        @param nIndex
            When given an invalid index then NULL is returned.
    */
	virtual SdPage* ImpGetPage (sal_uInt32 nIndex) const = 0;

public:
	ImpPageListWatcher(const SdrModel& rModel);
	virtual ~ImpPageListWatcher();

	void Invalidate() { mbPageListValid = sal_False; }
	SdPage* GetSdPage(PageKind ePgKind, sal_uInt32 nPgNum = 0L);
	sal_uInt32 GetSdPageCount(PageKind ePgKind);
};

//////////////////////////////////////////////////////////////////////////////

class ImpDrawPageListWatcher : public ImpPageListWatcher
{
protected:
	virtual sal_uInt32 ImpGetPageCount() const;
	virtual SdPage* ImpGetPage(sal_uInt32 nIndex) const;

public:
	ImpDrawPageListWatcher(const SdrModel& rModel);
	virtual ~ImpDrawPageListWatcher();
};

//////////////////////////////////////////////////////////////////////////////

class ImpMasterPageListWatcher : public ImpPageListWatcher
{
protected:
	virtual sal_uInt32 ImpGetPageCount() const;
	virtual SdPage* ImpGetPage(sal_uInt32 nIndex) const;

public:
	ImpMasterPageListWatcher(const SdrModel& rModel);
	virtual ~ImpMasterPageListWatcher();
};

#endif
