/*************************************************************************
 *
 * 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 _TOXMGR_HXX
#define _TOXMGR_HXX

#include "swdllapi.h"
#include "tox.hxx"
#include <authfld.hxx>

class SwWrtShell;
class SwForm;

/*--------------------------------------------------------------------
	Beschreibung: Manager fuer Verzeichnisfunktionalitaet
 --------------------------------------------------------------------*/
//one single method will be sufficient to insert AND upate indexes

class SW_DLLPUBLIC SwTOXDescription
{
	TOXTypes 			eTOXType;
	String				aStyleNames[MAXLEVEL];
	String				sSequenceName;
	String 				sMainEntryCharStyle;
	String 				sAutoMarkURL;
	String* 			pTitle;
	String* 			pTOUName;
	SwForm* 			pForm;
	sal_uInt16 				nContent;
	sal_uInt16 				nIndexOptions;
	sal_uInt16 				nOLEOptions;
    LanguageType        eLanguage;
    String              sSortAlgorithm;

    String              sAuthBrackets;
	SwCaptionDisplay	eCaptionDisplay;
	SwTOXSortKey 		eSortKey1;
	SwTOXSortKey 		eSortKey2;
	SwTOXSortKey 		eSortKey3;
	sal_uInt8 				nLevel;
	sal_Bool				bFromObjectNames : 1;
	sal_Bool				bFromChapter : 1;
	sal_Bool				bReadonly: 1;
	sal_Bool				bLevelFromChapter : 1;
	sal_Bool				bIsAuthSequence :1;
	sal_Bool 				bSortByDocument :1;

	//TODO: TemplateNames
	//const String* pTemplateName = 0, ???

	// forbidden and not implemented.
	SwTOXDescription();
	SwTOXDescription(SwTOXDescription&);
	SwTOXDescription & operator= (SwTOXDescription&);

public:
	// single argument ctors shall be explicit.
	explicit SwTOXDescription(TOXTypes eType) :
		eTOXType(eType),
		pTitle(0),
        pTOUName(0),
		pForm(0),
        nContent(nsSwTOXElement::TOX_MARK | nsSwTOXElement::TOX_OUTLINELEVEL),
        nIndexOptions(nsSwTOIOptions::TOI_SAME_ENTRY|nsSwTOIOptions::TOI_FF|nsSwTOIOptions::TOI_CASE_SENSITIVE),
        nOLEOptions(0),
        eLanguage((LanguageType)::GetAppLanguage()),
        eCaptionDisplay(CAPTION_COMPLETE),
        nLevel(MAXLEVEL),
		bFromObjectNames(sal_False),
		bFromChapter(sal_False),
		bReadonly(sal_True),
		bLevelFromChapter(sal_False),
		bIsAuthSequence(sal_False),
		bSortByDocument(sal_True)
		{}
	~SwTOXDescription()
		{
			delete pTitle;
			delete pForm;
			delete pTOUName;
		}

	void 			SetTOXType(TOXTypes eSet) { eTOXType = eSet;}
	TOXTypes 		GetTOXType() const { return eTOXType;}

    const String&   GetStyleNames(sal_uInt16 nLvl) const
                                {return aStyleNames[nLvl];}
    void            SetStyleNames(const String& rSet, sal_uInt16 nLvl)
                                {aStyleNames[nLvl] = rSet; }

	const String&	GetAutoMarkURL() const { return sAutoMarkURL;}
	void			SetAutoMarkURL(const String& rSet) {sAutoMarkURL = rSet;}

	void 			SetTitle(const String& pSet) {delete pTitle; pTitle = new String(pSet);}
	const String* 	GetTitle() const {return pTitle; }

	void 			SetTOUName(const String& pSet) {delete pTOUName; pTOUName = new String(pSet);}
	const String* 	GetTOUName() const {return pTOUName; }

	void 			SetForm(const SwForm& rSet) {delete pForm; pForm = new SwForm(rSet);}
	const SwForm* 	GetForm() const {return pForm;}

	void 			SetContentOptions(sal_uInt16 nSet) { nContent = nSet;}
	sal_uInt16  		GetContentOptions() const { return nContent;}

	void 			SetIndexOptions(sal_uInt16 nSet) { nIndexOptions = nSet;}
	sal_uInt16 			GetIndexOptions() const { return nIndexOptions;}

	const String&	GetMainEntryCharStyle() const {return sMainEntryCharStyle;}
	void			SetMainEntryCharStyle(const String& rSet)  {sMainEntryCharStyle = rSet;}

	void 			SetLevel(sal_uInt8 nSet) {nLevel = nSet;}
	sal_uInt8 			GetLevel()const  {return nLevel; }

	void			SetCreateFromObjectNames(sal_Bool bSet) { bFromObjectNames = bSet;}
	sal_Bool			IsCreateFromObjectNames() const {return bFromObjectNames;}

	const String&	GetSequenceName() const {return sSequenceName;}
	void			SetSequenceName(const String& rSet) {sSequenceName = rSet;}

	SwCaptionDisplay	GetCaptionDisplay() const { return eCaptionDisplay;}
	void				SetCaptionDisplay(SwCaptionDisplay eSet) {eCaptionDisplay = eSet;}

	void			SetFromChapter(sal_Bool bSet) { bFromChapter = bSet;}
	sal_Bool			IsFromChapter() const {return bFromChapter;}

	void			SetReadonly(sal_Bool bSet){bReadonly = bSet;}
	sal_Bool			IsReadonly() const {return bReadonly;}

	sal_uInt16 			GetOLEOptions() const {return nOLEOptions;}
	void   			SetOLEOptions(sal_uInt16 nOpt) {nOLEOptions = nOpt;}

	sal_Bool			IsLevelFromChapter() const {return bLevelFromChapter;}
	void			SetLevelFromChapter(sal_Bool bSet) {bLevelFromChapter = bSet;}

	String			GetAuthBrackets() const {return sAuthBrackets;}
	void		    SetAuthBrackets(const String& rSet) {sAuthBrackets = rSet;}

	sal_Bool			IsAuthSequence() const {return bIsAuthSequence;}
	void 			SetAuthSequence(sal_Bool bSet){bIsAuthSequence = bSet;}

	sal_Bool			IsSortByDocument()const {return bSortByDocument ;}
	void 			SetSortByDocument(sal_Bool bSet) {bSortByDocument = bSet;}

	void SetSortKeys(SwTOXSortKey eKey1,
						SwTOXSortKey eKey2,
							SwTOXSortKey eKey3);

	SwTOXSortKey GetSortKey1() const {return eSortKey1;}
	SwTOXSortKey GetSortKey2() const {return eSortKey2;}
	SwTOXSortKey GetSortKey3() const {return eSortKey3;}

    LanguageType    GetLanguage() const {return eLanguage;}
    void            SetLanguage(LanguageType nLang)  {eLanguage = nLang;}

    const String&   GetSortAlgorithm()const {return sSortAlgorithm;}
    void            SetSortAlgorithm(const String& rSet) {sSortAlgorithm = rSet;}

    void            ApplyTo(SwTOXBase& rTOXBase);

};
// --------------------------------------------------------------------------------
class SwTOXMarkDescription
{
	TOXTypes 	eTOXType;
	int 		nLevel;
	sal_Bool		bMainEntry;

	String* 	pPrimKey;
	String* 	pSecKey;
	String* 	pAltStr;
	String* 	pTOUName;

	String* 	pPhoneticReadingOfAltStr;
	String* 	pPhoneticReadingOfPrimKey;
	String* 	pPhoneticReadingOfSecKey;

	// forbidden and not implemented.
	SwTOXMarkDescription();
	SwTOXMarkDescription(SwTOXMarkDescription&);
	SwTOXMarkDescription & operator= (SwTOXMarkDescription&);

public:
	// single argument ctors shall be explicit.
	explicit SwTOXMarkDescription(TOXTypes eType) :
		eTOXType(eType),
        nLevel(0),
        bMainEntry(sal_False),
		pPrimKey(0),
		pSecKey(0),
		pAltStr(0),
		pTOUName(0),
		pPhoneticReadingOfAltStr(0),
		pPhoneticReadingOfPrimKey(0),
        pPhoneticReadingOfSecKey(0)
		{
		}
	~SwTOXMarkDescription()
	{
		delete pPrimKey;
		delete pSecKey;
		delete pAltStr;
		delete pTOUName;
		delete pPhoneticReadingOfAltStr;
		delete pPhoneticReadingOfPrimKey;
		delete pPhoneticReadingOfSecKey;
	}

	TOXTypes		GetTOXType()const {return eTOXType;}

	void 			SetLevel(int nSet) {nLevel = nSet;}
	int 			GetLevel() const {return nLevel;}

	void			SetMainEntry(sal_Bool bSet) {bMainEntry = bSet;}
	sal_Bool			IsMainEntry() const {return bMainEntry;}

	void			SetPrimKey(const String& rSet)
								{delete pPrimKey; pPrimKey = new String(rSet);}
	const String* 	GetPrimKey() const {return pPrimKey;}

	void 			SetSecKey(const String& rSet)
								{delete pSecKey;  pSecKey  = new String(rSet);}
	const String* 	GetSecKey() const {	return pSecKey; }

	void 			SetAltStr(const String& rSet)
								{delete pAltStr;  pAltStr  = new String(rSet);}
	const String* 	GetAltStr() const {	return pAltStr; }

	void			SetTOUName(const String& rSet)
								{delete pTOUName; pTOUName = new String(rSet);}
	const String* 	GetTOUName() const {return pTOUName;}


	void 			SetPhoneticReadingOfAltStr(const String& rSet)
								{delete pPhoneticReadingOfAltStr;  pPhoneticReadingOfAltStr  = new String(rSet);}
	const String* 	GetPhoneticReadingOfAltStr() const {	return pPhoneticReadingOfAltStr; }

	void 			SetPhoneticReadingOfPrimKey(const String& rSet)
								{delete pPhoneticReadingOfPrimKey;  pPhoneticReadingOfPrimKey  = new String(rSet);}
	const String* 	GetPhoneticReadingOfPrimKey() const {	return pPhoneticReadingOfPrimKey; }

	void 			SetPhoneticReadingOfSecKey(const String& rSet)
								{delete pPhoneticReadingOfSecKey;  pPhoneticReadingOfSecKey  = new String(rSet);}
	const String* 	GetPhoneticReadingOfSecKey() const {	return pPhoneticReadingOfSecKey; }
};

class SW_DLLPUBLIC SwTOXMgr
{
	SwWrtShell* 		pSh;
	SwTOXMark*			pCurTOXMark;
	SwTOXMarks			aCurMarks;

	SW_DLLPRIVATE sal_uInt16 				GetUserTypeID(const String& rStr);

public:
	// single argument ctors shall be explicit.
	explicit SwTOXMgr(SwWrtShell* pShell);

	//
	// Methoden fuer Verzeichnismarkierungen
	//
	void	InsertTOXMark(const SwTOXMarkDescription& rDesc);

	void	UpdateTOXMark(const SwTOXMarkDescription& rDesc);


	void				DeleteTOXMark();
	void				NextTOXMark(sal_Bool bSame=sal_False);
	void				PrevTOXMark(sal_Bool bSame=sal_False);

	// Aktuelle TOXmarks holen
	sal_uInt16				GetTOXMarks();
	sal_uInt16				GetTOXMarkCount();
	SwTOXMark*			GetTOXMark(sal_uInt16 nId);
	SwTOXMark*			GetCurTOXMark();
	void				SetCurTOXMark(sal_uInt16 nId);

	//
	// Methoden fuer Verzeichnisse
	//
	sal_Bool 	UpdateOrInsertTOX(const SwTOXDescription& rDesc, SwTOXBase** ppBase = 0, const SfxItemSet* pSet = 0);

	const SwTOXType* 	GetTOXType(TOXTypes eTyp, sal_uInt16 nId) const;
	const SwTOXBase*	GetCurTOX();

};


/*--------------------------------------------------------------------
	Beschreibung: Inlines
 --------------------------------------------------------------------*/

inline sal_uInt16 SwTOXMgr::GetTOXMarkCount()
	{	return aCurMarks.Count();	}


inline SwTOXMark* SwTOXMgr::GetCurTOXMark()
	{	return pCurTOXMark;	}

#endif