xref: /trunk/main/offapi/com/sun/star/sheet/XRecentFunctions.idl (revision 1ecadb572e7010ff3b3382ad9bf179dbc6efadbb)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_sheet_XRecentFunctions_idl__
29#define __com_sun_star_sheet_XRecentFunctions_idl__
30
31#ifndef __com_sun_star_uno_XInterface_idl__
32#include <com/sun/star/uno/XInterface.idl>
33#endif
34
35//=============================================================================
36
37module com {  module sun {  module star {  module sheet {
38
39//=============================================================================
40
41/** provides access to a list of recently used functions.
42
43    @see com::sun::star::sheet::RecentFunctions
44 */
45published interface XRecentFunctions: com::sun::star::uno::XInterface
46{
47    //-------------------------------------------------------------------------
48
49    /** returns a sequence of those functions that were most recently used.
50
51        <P>The functions are represented by their identifiers.</P>
52
53        @returns
54            the sequence of function identifiers most recently used.
55     */
56    sequence< long > getRecentFunctionIds();
57
58    //-------------------------------------------------------------------------
59
60    /** sets the list of those functions that were most recently used.
61
62        <p>The functions are represented by their identifiers.</p>
63
64        @param aRecentFunctionIds
65            the sequence of function identifiers most recently used.
66     */
67    void setRecentFunctionIds( [in] sequence< long > aRecentFunctionIds );
68
69    //-------------------------------------------------------------------------
70
71    /** returns the maximum number of entries that will be stored as
72        recently used functions.
73     */
74    long getMaxRecentFunctions();
75
76};
77
78//=============================================================================
79
80}; }; }; };
81
82#endif
83
84