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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_sheet_XNamedRange_idl__
  21 #define __com_sun_star_sheet_XNamedRange_idl__
  22
  23 #include <com/sun/star/container/XNamed.idl>
  24 #include <com/sun/star/table/CellAddress.idl>
  25
  26
  27 module com {  module sun {  module star {  module sheet {
  28
  29
  30 /** provides access to the settings of a named range in a spreadsheet
  31     document.
  32
  33     @see com::sun::star::sheet::NamedRange
  34  */
  35 published interface XNamedRange: com::sun::star::container::XNamed
  36 {
  37
  38     /** returns the content of the named range.
  39
  40         <p>The content can be a reference to a cell or cell range
  41         or any formula expression.</p>
  42      */
  43     string getContent();
  44
  45
  46     /** sets the content of the named range.
  47
  48         <p>The content can be a reference to a cell or cell range
  49         or any formula expression.</p>
  50      */
  51     void setContent( [in] string aContent );
  52
  53
  54     /** returns the position in the document which is used as a
  55         base for relative references in the content.
  56      */
  57     com::sun::star::table::CellAddress getReferencePosition();
  58
  59
  60     /** sets the position in the document which is used as a
  61         base for relative references in the content.
  62      */
  63     void setReferencePosition(
  64             [in] com::sun::star::table::CellAddress aReferencePosition );
  65
  66
  67     /** returns the type of the named range.
  68
  69         <p>This is a combination of flags as defined in
  70         NamedRangeFlag.</p>
  71      */
  72     long getType();
  73
  74
  75     /** sets the type of the named range.
  76
  77         @param nType
  78             a combination of flags that specify the type of a named range,
  79             as defined in NamedRangeFlag.
  80      */
  81     void setType( [in] long nType );
  82
  83 };
  84
  85
  86 }; }; }; };
  87
  88 #endif
  89
  90 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */