offapi/com/sun/star/sheet/XRecentFunctions.idl

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