xref: /AOO41X/main/sw/source/ui/inc/fldmgr.hxx (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)

/*************************************************************************
 *
 * 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 _FLDMGR_HXX
#define _FLDMGR_HXX
#ifndef _SVSTDARR_HXX
#define _SVSTDARR_STRINGSDTOR
#include <svl/svstdarr.hxx>
#endif
#include <tools/string.hxx>
#include "swdllapi.h"
#include "swtypes.hxx"
#include <com/sun/star/uno/Reference.h>
#include <com/sun/star/uno/Any.h>

namespace com{namespace sun{namespace star{
	namespace container{
		class XNameAccess;
	}
	namespace text{
		class XNumberingTypeInfo;
	}
}}}

class SwWrtShell;
class SwField;
class SwFieldType;
class SbModule;
class SvxMacroItem;
class SvNumberFormatter;
class Window;
/*--------------------------------------------------------------------
	Beschreibung: Die Gruppen von Feldern
 --------------------------------------------------------------------*/

enum SwFldGroups
{
	GRP_DOC,
	GRP_FKT,
	GRP_REF,
	GRP_REG,
	GRP_DB,
	GRP_VAR
};

struct SwFldGroupRgn
{
	sal_uInt16 nStart;
	sal_uInt16 nEnd;
};

/*--------------------------------------------------------------------
	Beschreibung:  Der FeldManager handelt das Einfuegen von Felder
					ueber Command-Strings
 --------------------------------------------------------------------*/
struct SwInsertFld_Data
{
    sal_uInt16 nTypeId;
    sal_uInt16 nSubType;
    const String sPar1;
    const String sPar2;
    sal_uLong nFormatId;
    SwWrtShell* pSh;
    sal_Unicode cSeparator;
    sal_Bool bIsAutomaticLanguage;
    ::com::sun::star::uno::Any aDBDataSource;
    ::com::sun::star::uno::Any aDBConnection;
    ::com::sun::star::uno::Any aDBColumn;
    Window* pParent; // parent dialog used for SwWrtShell::StartInputFldDlg()

    SwInsertFld_Data(sal_uInt16 nType, sal_uInt16 nSub, const String& rPar1, const String& rPar2,
                    sal_uLong nFmtId, SwWrtShell* pShell = NULL, sal_Unicode cSep = ' ', sal_Bool bIsAutoLanguage = sal_True) :
        nTypeId(nType),
        nSubType(nSub),
        sPar1(rPar1),
        sPar2(rPar2),
        nFormatId(nFmtId),
        pSh(pShell),
        cSeparator(cSep),
        bIsAutomaticLanguage(bIsAutoLanguage),
        pParent(0) {}

    SwInsertFld_Data() :
        pSh(0),
        cSeparator(' '),
        bIsAutomaticLanguage(sal_True){}

};

class SW_DLLPUBLIC SwFldMgr
{
private:
	SwField*			pCurFld;
	SbModule*			pModule;
	const SvxMacroItem*	pMacroItem;
	SwWrtShell* 		pWrtShell; // darf auch NULL sein!
	String			aCurPar1;
	String			aCurPar2;
	String 			sCurFrame;

	String          sMacroPath;
	String          sMacroName;

	sal_uLong			nCurFmt;
	sal_Bool			bEvalExp;

	SW_DLLPRIVATE sal_uInt16			GetCurrLanguage() const;

	com::sun::star::uno::Reference<com::sun::star::container::XNameAccess> xDBContext;
	com::sun::star::uno::Reference<com::sun::star::text::XNumberingTypeInfo> xNumberingInfo;
	SW_DLLPRIVATE com::sun::star::uno::Reference<com::sun::star::text::XNumberingTypeInfo> GetNumberingInfo()const;

public:
	SwFldMgr(SwWrtShell* pSh = 0);
	~SwFldMgr();

    void                SetWrtShell( SwWrtShell* pShell )
                        {   pWrtShell = pShell;     }

    // Feld einfuegen ueber TypeId (TYP_ ...)
    sal_Bool            InsertFld(  const SwInsertFld_Data& rData );

	// Direkt das aktuelle Feld aendern
	void 			UpdateCurFld(sal_uLong nFormat,
								 const String& rPar1,
								 const String& rPar2,
                                 SwField * _pField = 0); // #111840#

	inline const String& GetCurFldPar1() const;
	inline const String& GetCurFldPar2() const;
	inline sal_uLong   GetCurFldFmt() const;

	// Ein Feld ermitteln
	SwField*		GetCurFld();

	void			InsertFldType(SwFieldType& rType);

	sal_Bool			ChooseMacro(const String &rSelMacro = aEmptyStr);
	void			SetMacroPath(const String& rPath);
	inline const String& GetMacroPath() const		  { return (sMacroPath); }
	inline const String& GetMacroName() const		  { return (sMacroName); }
	inline void		SetMacroModule(SbModule* pMod)	  { pModule = pMod; }

	// Vorheriger Naechster gleichen Typ
	sal_Bool GoNextPrev( sal_Bool bNext = sal_True, SwFieldType* pTyp = 0 );
	sal_Bool GoNext( SwFieldType* pTyp = 0 )	{ return GoNextPrev( sal_True, pTyp ); }
	sal_Bool GoPrev( SwFieldType* pTyp = 0 )	{ return GoNextPrev( sal_False, pTyp ); }

	// Erfragen von Werten aus Datenbankfeldern (BASIC )
//	String			GetDataBaseFieldValue(const String &rDBName, const String &rFieldName, SwWrtShell* pSh);
	sal_Bool			IsDBNumeric(const String& rDBName, const String& rTblQryName,
										sal_Bool bIsTable, const String& rFldName);

	// RefMark mit Namen organisieren
	sal_Bool 			CanInsertRefMark( const String& rStr );


	// Zugriff ueber ResId auf Feldtypen
	sal_uInt16 			GetFldTypeCount(sal_uInt16 nResId = USHRT_MAX) const;
	SwFieldType* 	GetFldType(sal_uInt16 nResId, sal_uInt16 nId = 0) const;
	SwFieldType* 	GetFldType(sal_uInt16 nResId, const String& rName) const;

	void 			RemoveFldType(sal_uInt16 nResId, const String& rName);

	// Zugriff ueber TypeId aus dem Dialog
	// Ids fuer einen Bereich von Feldern
	const SwFldGroupRgn& GetGroupRange(sal_Bool bHtmlMode, sal_uInt16 nGrpId) const;
	sal_uInt16			GetGroup(sal_Bool bHtmlMode, sal_uInt16 nTypeId, sal_uInt16 nSubType = 0) const;

	// TypeId des aktuellen Feldes
	sal_uInt16			GetCurTypeId() const;

    // TypeId fuer einen konkrete Pos in der Liste
    static sal_uInt16   GetTypeId(sal_uInt16 nPos);
	// Name des Typen in der Liste der Felder
    static const String&  GetTypeStr(sal_uInt16 nPos);

	// Pos in der Liste der Felder
    static sal_uInt16   GetPos(sal_uInt16 nTypeId);

	// Untertypen zu einem Typ
    sal_Bool            GetSubTypes(sal_uInt16 nId, SvStringsDtor& rToFill);

	// Formate zu einem Typ
	sal_uInt16 			GetFormatCount(sal_uInt16 nTypeId, sal_Bool bIsText, sal_Bool bHtmlMode = sal_False) const;
	String 			GetFormatStr(sal_uInt16 nTypeId, sal_uLong nFormatId) const;
	sal_uInt16			GetFormatId(sal_uInt16 nTypeId, sal_uLong nFormatId) const;
	sal_uLong			GetDefaultFormat(sal_uInt16 nTypeId, sal_Bool bIsText, SvNumberFormatter* pFormatter, double* pVal = 0L);

	// Evaluierung der ExpressionFelder ausschalten fuer das Einfuegen
	// vieler Expressionfelder (siehe Etiketten)
	//
	inline void		SetEvalExpFlds(sal_Bool bEval);
	void			EvalExpFlds(SwWrtShell* pSh = NULL);
};

inline void SwFldMgr::SetEvalExpFlds(sal_Bool bEval)
	{ bEvalExp = bEval; }

inline const String& SwFldMgr::GetCurFldPar1() const
	{ return aCurPar1; }

inline const String& SwFldMgr::GetCurFldPar2() const
	{ return aCurPar2; }

inline sal_uLong SwFldMgr::GetCurFldFmt() const
	{ return nCurFmt; }


#endif