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

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