xref: /aoo42x/main/offapi/com/sun/star/linguistic2/XMeaning.idl (revision cdf0e10c)

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

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif


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

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

//=============================================================================
/** one of the possible meanings for a word.

	<P> Represents one of the possible meanings that may be returned from a
 	<member scope="com::sun::star::linguistic2">XThesaurus::queryMeanings</member>
	call and allows for retrieval of its synonyms.
	</P>

    @see    <type scope="com::sun::star::linguistic2">XThesaurus</type>
 */
published interface XMeaning : com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------
	/**
	 	@returns
	 		the meaning represented by this object.
 	*/
	string getMeaning();

	//-------------------------------------------------------------------------
	/**
	 	@returns
		 	a sequence of strings where each entry is a synonym of the
		 	current objects meaning.
 	*/
	sequence<string> querySynonyms();

};

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

}; }; }; };

#endif