diff options
Diffstat (limited to 'offapi/com/sun/star/sheet/FunctionDescription.idl')
-rw-r--r-- | offapi/com/sun/star/sheet/FunctionDescription.idl | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/offapi/com/sun/star/sheet/FunctionDescription.idl b/offapi/com/sun/star/sheet/FunctionDescription.idl new file mode 100644 index 000000000..ef2d91ca1 --- /dev/null +++ b/offapi/com/sun/star/sheet/FunctionDescription.idl @@ -0,0 +1,72 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * 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 . + */ + +#ifndef __com_sun_star_sheet_FunctionDescription_idl__ +#define __com_sun_star_sheet_FunctionDescription_idl__ + +#include <com/sun/star/sheet/FunctionArgument.idl> + + +module com { module sun { module star { module sheet { + + +/** collects all properties used to describe a function. + + @see com::sun::star::sheet::FunctionDescriptions + */ +published service FunctionDescription +{ + + /** returns the function's unique identifier. + + @see com::sun::star::sheet::XFunctionDescriptions + */ + [readonly, property] long Id; + + + /** returns the function's category. + + @see com::sun::star::sheet::FunctionCategory + */ + [readonly, property] long Category; + + + /** returns the localized function's name. + */ + [readonly, property] string Name; + + + /** returns a localized description of the function. + */ + [readonly, property] string Description; + + + /** returns a sequence of localized descriptions of the function's + arguments (in the order specified by the function). + */ + [readonly, property] sequence< com::sun::star::sheet::FunctionArgument > Arguments; + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |