offapi/com/sun/star/sheet/NamedRanges.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_NamedRanges_idl__
  21 #define __com_sun_star_sheet_NamedRanges_idl__
  22
  23 #include <com/sun/star/container/XNameAccess.idl>
  24 #include <com/sun/star/sheet/XNamedRanges.idl>
  25 #include <com/sun/star/container/XEnumerationAccess.idl>
  26 #include <com/sun/star/container/XIndexAccess.idl>
  27 #include <com/sun/star/document/XActionLockable.idl>
  28
  29
  30 module com {  module sun {  module star {  module sheet {
  31
  32
  33 /** represents a collection of named ranges in a spreadsheet document.
  34
  35     <p>In fact a named range is a named formula expression. A cell range
  36     address is one possible content of a named range.</p>
  37
  38     @see com::sun::star::sheet::SpreadsheetDocument
  39  */
  40 published service NamedRanges
  41 {
  42
  43     /** provides access to the named ranges and to insert and remove them.
  44      */
  45     interface com::sun::star::sheet::XNamedRanges;
  46
  47
  48     /** provides access to the named ranges via index.
  49
  50         @see com::sun::star::sheet::NamedRange
  51
  52      */
  53     interface com::sun::star::container::XIndexAccess;
  54
  55
  56     /** creates an enumeration of all named ranges.
  57
  58         @see com::sun::star::sheet::NamedRangesEnumeration
  59
  60      */
  61     interface com::sun::star::container::XEnumerationAccess;
  62
  63
  64     /** provides methods to control the internal update of named ranges.
  65
  66         @since OOo 3.0
  67      */
  68     [optional] interface com::sun::star::document::XActionLockable;
  69
  70 };
  71
  72
  73 }; }; }; };
  74
  75 #endif
  76
  77 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */