offapi/com/sun/star/sheet/NamedRanges.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: NamedRanges.idl,v $
  10  * $Revision: 1.9 $
  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_NamedRanges_idl__
  32 #define __com_sun_star_sheet_NamedRanges_idl__
  33
  34 #ifndef __com_sun_star_container_XNameAccess_idl__
  35 #include <com/sun/star/container/XNameAccess.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_sheet_XNamedRanges_idl__
  39 #include <com/sun/star/sheet/XNamedRanges.idl>
  40 #endif
  41 #ifndef __com_sun_star_container_XEnumerationAccess_idl__
  42 #include <com/sun/star/container/XEnumerationAccess.idl>
  43 #endif
  44 #ifndef __com_sun_star_container_XIndexAccess_idl__
  45 #include <com/sun/star/container/XIndexAccess.idl>
  46 #endif
  47 #ifndef __com_sun_star_document_XActionLockable_idl__
  48 #include <com/sun/star/document/XActionLockable.idl>
  49 #endif
  50
  51 //=============================================================================
  52
  53 module com {  module sun {  module star {  module sheet {
  54
  55 //=============================================================================
  56
  57 /** represents a collection of named ranges in a spreadsheet document.
  58
  59     <p>In fact a named range is a named formula expression. A cell range
  60     address is one possible content of a named range.</p>
  61
  62     @see com::sun::star::sheet::SpreadsheetDocument
  63  */
  64 published service NamedRanges
  65 {
  66     //-------------------------------------------------------------------------
  67
  68     /** provides access to the named ranges and to insert and remove them.
  69      */
  70     interface com::sun::star::sheet::XNamedRanges;
  71
  72     //-------------------------------------------------------------------------
  73
  74     /** provides access to the named ranges via index.
  75
  76         @see com::sun::star::sheet::NamedRange
  77
  78      */
  79     interface com::sun::star::container::XIndexAccess;
  80
  81     //-------------------------------------------------------------------------
  82
  83     /** creates an enumeration of all named ranges.
  84
  85         @see com::sun::star::sheet::NamedRangesEnumeration
  86
  87      */
  88     interface com::sun::star::container::XEnumerationAccess;
  89
  90     //-------------------------------------------------------------------------
  91
  92     /** provides methods to control the internal update of named ranges.
  93
  94         @since OOo 3.0
  95      */
  96     [optional] interface com::sun::star::document::XActionLockable;
  97
  98 };
  99
 100 //=============================================================================
 101
 102 }; }; }; };
 103
 104 #endif
 105