AOO410/main/offapi/com/sun/star/linguistic2/SpellFailure.idl

/**************************************************************
 * 
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 * 
 *************************************************************/


#ifndef __com_sun_star_linguistic2_SpellFailure_idl__
#define __com_sun_star_linguistic2_SpellFailure_idl__


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

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

//=============================================================================
/** these define the various return types for spellchecking to fail verification.

    <P>A value of this type is part of the
	<type scope="com::sun::star::linguistic2">XSpellAlternatives</type>
    interface which is the return type for an unsuccessfull
	spelling attempt.</P>

    @see    <type scope="com::sun::star::linguistic2">XSpellChecker</type>
*/
published constants SpellFailure
{
	//-------------------------------------------------------------------------
	/** The word is a negative one, that is, it should not be used.
	*/
	const short IS_NEGATIVE_WORD = 2;

	//-------------------------------------------------------------------------
    /** The capitalization of the word is wrong.
	*/
	const short CAPTION_ERROR = 3;

	//-------------------------------------------------------------------------
	/** The spelling of the word is wrong (or at least not known to be correct).
	*/
	const short SPELLING_ERROR = 4;

};

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

}; }; }; };

#endif