offapi/com/sun/star/sheet/XDDELinkResults.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: XDDELinkResults.idl,v $
  10  * $Revision: 1.4 $
  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_XDDELinkResults_idl__
  32 #define __com_sun_star_sheet_XDDELinkResults_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 the DDE link results.
  45
  46     @see com::sun::star::sheet::DDELink
  47
  48     @since OOo 3.0
  49  */
  50 published interface XDDELinkResults: com::sun::star::uno::XInterface
  51 {
  52     //-------------------------------------------------------------------------
  53
  54     /** returns the DDE link results.
  55
  56         @returns
  57             the DDE link results. The outer sequence contains the value rows.
  58             The inner sequences contain the result values for one row.
  59      */
  60     sequence< sequence< any > > getResults();
  61
  62     //-------------------------------------------------------------------------
  63
  64     /** sets the DDE link results.
  65
  66         @param aResults
  67             the DDE link results. The outer sequence contains the value rows.
  68             The inner sequences contain the result values for one row.
  69             If the outer sequence is empty, the existing DDE link results are
  70             cleared.
  71      */
  72     void setResults( [in] sequence< sequence< any > > aResults );
  73
  74 };
  75
  76 //=============================================================================
  77
  78 }; }; }; };
  79
  80 #endif