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
  21 module com {  module sun {  module star {  module sheet {
  22
  23
  24 /** provides access to the settings of a named range in a spreadsheet
  25     document.
  26
  27     @see com::sun::star::sheet::NamedRange
  28  */
  29 published interface XNamedRange: com::sun::star::container::XNamed
  30 {
  31
  32     /** returns the content of the named range.
  33
  34         <p>The content can be a reference to a cell or cell range
  35         or any formula expression.</p>
  36      */
  37     string getContent();
  38
  39
  40     /** sets the content of the named range.
  41
  42         <p>The content can be a reference to a cell or cell range
  43         or any formula expression.</p>
  44      */
  45     void setContent( [in] string aContent );
  46
  47
  48     /** returns the position in the document which is used as a
  49         base for relative references in the content.
  50      */
  51     com::sun::star::table::CellAddress getReferencePosition();
  52
  53
  54     /** sets the position in the document which is used as a
  55         base for relative references in the content.
  56      */
  57     void setReferencePosition(
  58             [in] com::sun::star::table::CellAddress aReferencePosition );
  59
  60
  61     /** returns the type of the named range.
  62
  63         <p>This is a combination of flags as defined in
  64         NamedRangeFlag.</p>
  65      */
  66     long getType();
  67
  68
  69     /** sets the type of the named range.
  70
  71         @param nType
  72             a combination of flags that specify the type of a named range,
  73             as defined in NamedRangeFlag.
  74      */
  75     void setType( [in] long nType );
  76
  77 };
  78
  79
  80 }; }; }; };
  81
  82 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */