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

#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif
#ifndef __com_sun_star_beans_XFastPropertySet_idl__
#include <com/sun/star/beans/XFastPropertySet.idl>
#endif
#ifndef __com_sun_star_lang_XComponent_idl__
#include <com/sun/star/lang/XComponent.idl>
#endif
#ifndef __com_sun_star_lang_XServiceInfo_idl__
#include <com/sun/star/lang/XServiceInfo.idl>
#endif
#ifndef __com_sun_star_lang_Locale_idl__
#include <com/sun/star/lang/Locale.idl>
#endif

//=============================================================================

module com { module sun { module star { module linguistic2 {

//=============================================================================
/**	the set of linguistic relevant properties.
*/
published service LinguProperties
{
	interface com::sun::star::beans::XPropertySet;
	interface com::sun::star::beans::XFastPropertySet;
	interface com::sun::star::lang::XComponent;
	interface com::sun::star::lang::XServiceInfo;

	//-------------------------------------------------------------------------
	/**	defines whether new German spelling rules should be used for German
	 	text or not when doing spellchecking or hyphenation, or using the 
	 	thesaurus.

        @deprecated since OOo 3.0.1
	  */
    [property, maybevoid] boolean IsGermanPreReform;

	//-------------------------------------------------------------------------
	/**	defines if the dictionary-list should be used for spellchecking
	 	and hyphenation or not.
	*/
	[property] boolean IsUseDictionaryList;

	//-------------------------------------------------------------------------
	/**	defines if control characters should be ignored or not, by the linguistic
	 	(i.e., spellchecker, hyphenator and thesaurus).
	*/
	[property] boolean IsIgnoreControlCharacters;

	//-------------------------------------------------------------------------
	/**	defines if words with only uppercase letters should be 
	 	subject to spellchecking or not.
	*/
	[property] boolean IsSpellUpperCase;

	//-------------------------------------------------------------------------
	/**	defines if words containing digits (or numbers) should be
	 	subject to spellchecking or not.
	*/
	[property] boolean IsSpellWithDigits;

	//-------------------------------------------------------------------------
	/**	defines if the captitalization of words should be checked or not.
	*/
	[property] boolean IsSpellCapitalization;

	//-------------------------------------------------------------------------
	/**	the minimum number of characters of a word to remain before the 
	 	hyphen when doing hyphenation.
	*/
	[property] short HyphMinLeading;
	
	//-------------------------------------------------------------------------
	/**	the minimum number of characters of a word to remain after the 
	 	hyphen when doing hyphenation.
	*/
	[property] short HyphMinTrailing;
	
	//-------------------------------------------------------------------------
	/**	the minimum length of a word in order to be hyphenated.
	*/
	[property] short HyphMinWordLength;

	//-------------------------------------------------------------------------
    /** the default western language for new documents.
	*/
	[property] com::sun::star::lang::Locale DefaultLocale;

	//-------------------------------------------------------------------------
	/**	defines whether interactive hyphenation should be performed without
        requiring the user to select every hyphenation position after the user 
        has triggered the hyphenation.
	*/
	[property] boolean IsHyphAuto;

	//-------------------------------------------------------------------------
	/**	defines whether hyphenation should be done in special regions of 
	 	documents or not.
	*/
	[property] boolean IsHyphSpecial;
	
	//-------------------------------------------------------------------------
	/**	indicates whether spellchecking should be done automatically or not.
	*/
	[property] boolean IsSpellAuto;

	//-------------------------------------------------------------------------
	/**	indicates whether the markings for incorrectly spelled text should be
	 	hidden or not.
        
        @deprecated since OOo 3.0.1
	*/
    [property, maybevoid] boolean IsSpellHide;
	
	//-------------------------------------------------------------------------
	/**	indicates if spellchecking should be performed in all available
	 	languages.
    
        @deprecated since OOo 3.0.1
    */
    [property, maybevoid] boolean IsSpellInAllLanguages;

	//-------------------------------------------------------------------------
	/**	defines whether spellchecking should be done in special regions of
	 	documents or not.
	*/
	[property] boolean IsSpellSpecial;
	
	//-------------------------------------------------------------------------
	/**	defines whether spellchecking should be done in reverse 
	 	direction or not.
	*/
	[property] boolean IsWrapReverse;

	//-------------------------------------------------------------------------
	/**	the default language for CJK languages.
	*/
	[property] com::sun::star::lang::Locale DefaultLocale_CJK;

	//-------------------------------------------------------------------------
	/**	the default language for CTL languages.
	*/
	[property] com::sun::star::lang::Locale DefaultLocale_CTL;

};

//=============================================================================

}; }; }; };

#endif