xref: /aoo41x/main/offapi/com/sun/star/sheet/FunctionDescriptions.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_sheet_FunctionDescriptions_idl__
#define __com_sun_star_sheet_FunctionDescriptions_idl__

#ifndef __com_sun_star_sheet_XFunctionDescriptions_idl__
#include <com/sun/star/sheet/XFunctionDescriptions.idl>
#endif

#ifndef __com_sun_star_container_XNameAccess_idl__
#include <com/sun/star/container/XNameAccess.idl>
#endif
#ifndef __com_sun_star_container_XEnumerationAccess_idl__
#include <com/sun/star/container/XEnumerationAccess.idl>
#endif

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

module com {  module sun {  module star {  module sheet {

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

/** represents a collection of function descriptions for all built-in
	functions as well as add-in functions available in the spreadsheet
	application.

	<p>All container access methods return a sequence of
	<type scope="com::sun::star::beans">PropertyValue</type> structs.
	The properties contained in the sequence are collected in the
	service <type>FunctionDescription</type>.</p>
 */
published service FunctionDescriptions
{
	//-------------------------------------------------------------------------

	/** provides access to the property sequence of a function description
		via function index or identifier.
	 */
	interface com::sun::star::sheet::XFunctionDescriptions;

	//-------------------------------------------------------------------------

	/** provides access to the property sequence of a function description
		via function name.

		<p>The localized uppercase name of the function has to be used
		here.</p>
	 */
	interface com::sun::star::container::XNameAccess;

	//-------------------------------------------------------------------------

	/** creates an enumeration of all function descriptions.

		@see com::sun::star::sheet::FunctionDescriptionEnumeration
	 */
	interface com::sun::star::container::XEnumerationAccess;

};

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

}; }; }; };

#endif