LibreOffice LibreOffice 26.2 SDK API Reference

FunctionDescription.idl
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20
21module com { module sun { module star { module sheet {
22
23
28published service FunctionDescription
29{
30
35 [readonly, property] long Id;
36
37
42 [readonly, property] long Category;
43
44
47 [readonly, property] string Name;
48
49
52 [readonly, property] string Description;
53
54
58 [readonly, property] sequence< com::sun::star::sheet::FunctionArgument > Arguments;
59
60};
61
62
63}; }; }; };
64
65/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com
Definition: Ambiguous.idl:20
com::sun::star::sheet::FunctionDescription
collects all properties used to describe a function.
Definition: FunctionDescription.idl:29
com::sun::star::sheet::FunctionDescription::Description
string Description
returns a localized description of the function.
Definition: FunctionDescription.idl:52
com::sun::star::sheet::FunctionDescription::Name
string Name
returns the localized function's name.
Definition: FunctionDescription.idl:47
com::sun::star::sheet::FunctionDescription::Arguments
sequence< com::sun::star::sheet::FunctionArgument > Arguments
returns a sequence of localized descriptions of the function's arguments (in the order specified by t...
Definition: FunctionDescription.idl:58
com::sun::star::sheet::FunctionDescription::Category
long Category
returns the function's category.
Definition: FunctionDescription.idl:42
com::sun::star::sheet::FunctionDescription::Id
long Id
returns the function's unique identifier.
Definition: FunctionDescription.idl:35