offapi/com/sun/star/sheet/XNamedRange.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: XNamedRange.idl,v $
  10  * $Revision: 1.11 $
  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_XNamedRange_idl__
  32 #define __com_sun_star_sheet_XNamedRange_idl__
  33
  34 #ifndef __com_sun_star_container_XNamed_idl__
  35 #include <com/sun/star/container/XNamed.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_table_CellAddress_idl__
  39 #include <com/sun/star/table/CellAddress.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44 module com {  module sun {  module star {  module sheet {
  45
  46 //=============================================================================
  47
  48 /** provides access to the settings of a named range in a spreadsheet
  49     document.
  50
  51     @see com::sun::star::sheet::NamedRange
  52  */
  53 published interface XNamedRange: com::sun::star::container::XNamed
  54 {
  55     //-------------------------------------------------------------------------
  56
  57     /** returns the content of the named range.
  58
  59         <p>The content can be a reference to a cell or cell range
  60         or any formula expression.</p>
  61      */
  62     string getContent();
  63
  64     //-------------------------------------------------------------------------
  65
  66     /** sets the content of the named range.
  67
  68         <p>The content can be a reference to a cell or cell range
  69         or any formula expression.</p>
  70      */
  71     void setContent( [in] string aContent );
  72
  73     //-------------------------------------------------------------------------
  74
  75     /** returns the position in the document which is used as a
  76         base for relative references in the content.
  77      */
  78     com::sun::star::table::CellAddress getReferencePosition();
  79
  80     //-------------------------------------------------------------------------
  81
  82     /** sets the position in the document which is used as a
  83         base for relative references in the content.
  84      */
  85     void setReferencePosition(
  86             [in] com::sun::star::table::CellAddress aReferencePosition );
  87
  88     //-------------------------------------------------------------------------
  89
  90     /** returns the type of the named range.
  91
  92         <p>This is a combination of flags as defined in
  93         <type>NamedRangeFlag</type>.</p>
  94      */
  95     long getType();
  96
  97     //-------------------------------------------------------------------------
  98
  99     /** sets the type of the named range.
 100
 101         @param nType
 102             a combination of flags that specify the type of a named range,
 103             as defined in <type>NamedRangeFlag</type>.
 104      */
 105     void setType( [in] long nType );
 106
 107 };
 108
 109 //=============================================================================
 110
 111 }; }; }; };
 112
 113 #endif
 114