summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sheet/XNamedRanges.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/sheet/XNamedRanges.idl')
-rw-r--r--offapi/com/sun/star/sheet/XNamedRanges.idl203
1 files changed, 107 insertions, 96 deletions
diff --git a/offapi/com/sun/star/sheet/XNamedRanges.idl b/offapi/com/sun/star/sheet/XNamedRanges.idl
index aa84a73e7..49ae610d8 100644
--- a/offapi/com/sun/star/sheet/XNamedRanges.idl
+++ b/offapi/com/sun/star/sheet/XNamedRanges.idl
@@ -2,9 +2,9 @@
*
* $RCSfile: XNamedRanges.idl,v $
*
- * $Revision: 1.5 $
+ * $Revision: 1.6 $
*
- * last change: $Author: jsc $ $Date: 2001-03-16 16:41:38 $
+ * last change: $Author: mi $ $Date: 2002-10-03 13:08:22 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -58,108 +58,119 @@
*
*
************************************************************************/
-#ifndef __com_sun_star_sheet_XNamedRanges_idl__
-#define __com_sun_star_sheet_XNamedRanges_idl__
-
-#ifndef __com_sun_star_container_XNameAccess_idl__
-#include <com/sun/star/container/XNameAccess.idl>
-#endif
-
-#ifndef __com_sun_star_table_CellAddress_idl__
-#include <com/sun/star/table/CellAddress.idl>
-#endif
-
-#ifndef __com_sun_star_table_CellRangeAddress_idl__
-#include <com/sun/star/table/CellRangeAddress.idl>
-#endif
-
-#ifndef __com_sun_star_sheet_Border_idl__
-#include <com/sun/star/sheet/Border.idl>
-#endif
-
-
-//=============================================================================
-
- module com { module sun { module star { module sheet {
-
-//=============================================================================
-
-// DocMerge from xml: interface com::sun::star::sheet::XNamedRanges
-/** represents a collection of named ranges.@see com::sun::star::sheet::NamedRanges
+
+#ifndef __com_sun_star_sheet_XNamedRanges_idl__
+#define __com_sun_star_sheet_XNamedRanges_idl__
+
+#ifndef __com_sun_star_container_XNameAccess_idl__
+#include <com/sun/star/container/XNameAccess.idl>
+#endif
+
+#ifndef __com_sun_star_table_CellAddress_idl__
+#include <com/sun/star/table/CellAddress.idl>
+#endif
+
+#ifndef __com_sun_star_table_CellRangeAddress_idl__
+#include <com/sun/star/table/CellRangeAddress.idl>
+#endif
+
+#ifndef __com_sun_star_sheet_Border_idl__
+#include <com/sun/star/sheet/Border.idl>
+#endif
+
+//=============================================================================
+
+module com { module sun { module star { module sheet {
+
+//=============================================================================
+
+/** provides access to the members in a collection of named ranges and to
+ insert and remove them.
+
+ @see com::sun::star::sheet::NamedRanges
+ @see com::sun::star::sheet::NamedRange
*/
interface XNamedRanges: com::sun::star::container::XNameAccess
-{
- //-------------------------------------------------------------------------
-
- // DocMerge from xml: method com::sun::star::sheet::XNamedRanges::addNewByName
+{
+ //-------------------------------------------------------------------------
+
/** adds a new named range to the collection.
+
+ @param aName
+ the new name of the named range.
+
+ @param aContent
+ the formula expression.
+
+ <p>A cell range address is one possible content of a named
+ range.</p>
+
+ @param aPosition
+ specifies the base address for relative cell references.
+
+ @param nType
+ a combination of flags that specify the type of a named range,
+ as defined in <type>NamedRangeFlags</type>.
+
+ <p>This parameter will be zero for any common named range.</p>
*/
- void addNewByName( [in] string aName,
- [in] string aContent,
- [in] com::sun::star::table::CellAddress aPosition,
- [in] long nType );
-
- //-------------------------------------------------------------------------
-
- // DocMerge from xml: method com::sun::star::sheet::XNamedRanges::addNewFromTitles
- /** creates named ranges from titles in a cell range.
-
-
-
- <p>Names for the named ranges are taken from titles in the
- top or bottom row, or the left or right column of the range.
- The named ranges refer to single columns or rows in the inner
+ void addNewByName(
+ [in] string aName,
+ [in] string aContent,
+ [in] com::sun::star::table::CellAddress aPosition,
+ [in] long nType );
+
+ //-------------------------------------------------------------------------
+
+ /** creates named cell ranges from titles in a cell range.
+
+ <p>The names for the named ranges are taken from title cells in the
+ top or bottom row, or from the cells of the left or right column
+ of the range (depending on the parameter <const>aBorder</const>.
+ The named ranges refer to single columns or rows in the inner
part of the original range, excluding the labels.</p>
+
+ <p>Example: The source range is A1:B3. The named ranges shall be
+ created using row titles. This requires <member>Border::TOP</member>
+ for the second parameter. The method creates two named ranges. The
+ name of the first is equal to the content of cell A1 and contains the
+ range $Sheet.$A$2:$A$3 (excluding the title cell). The latter named
+ range is named using cell B1 and contains the cell range address
+ $Sheet.$B$2:$B$3.</p>
+
+ @param aSource
+ the cell range used to create the named ranges.
+
+ @param aBorder
+ specifies the location of the title cells.
*/
- void addNewFromTitles( [in] com::sun::star::table::CellRangeAddress aSource,
- [in] com::sun::star::sheet::Border aBorder );
-
- //-------------------------------------------------------------------------
-
- // DocMerge from xml: method com::sun::star::sheet::XNamedRanges::removeByName
+ void addNewFromTitles(
+ [in] com::sun::star::table::CellRangeAddress aSource,
+ [in] com::sun::star::sheet::Border aBorder );
+
+ //-------------------------------------------------------------------------
+
/** removes a named range from the collection.
*/
- void removeByName( [in] string aName );
-
- //-------------------------------------------------------------------------
-
- // DocMerge from xml: method com::sun::star::sheet::XNamedRanges::outputList
+ void removeByName( [in] string aName );
+
+ //-------------------------------------------------------------------------
+
/** writes a list of all named ranges into the document.
-
-
-
- <p>The first column of the list contains the names. The second
+
+ <p>The first column of the list contains the names. The second
column contains the contents of the named ranges.</p>
+
+ @param aOutputPosition
+ specifies the top left cell of the output range.
*/
- void outputList( [in] com::sun::star::table::CellAddress aOutputPosition );
-
-};
-
-//=============================================================================
-
-}; }; }; };
-
-/*=============================================================================
-
- $Log: not supported by cvs2svn $
- Revision 1.4 2000/12/21 08:35:12 mi
- @see interface/service/... ident -> @see ident - for new docu generator
-
- Revision 1.3 2000/11/08 12:43:47 mi
- moved from api
-
- Revision 1.2 2000/10/09 14:24:58 mi
- #78715# exchanged stardiv::... by com::sun::star::... (especially in @see tags)
-
- Revision 1.1.1.1 2000/09/18 23:35:51 hjs
- initial import
-
- Revision 1.3 2000/09/11 11:52:51 mi
- documentation merged from XML
-
- Revision 1.1.1.1 1999/11/11 09:48:45 jsc
- new
-
-
-=============================================================================*/
-#endif
+ void outputList( [in] com::sun::star::table::CellAddress aOutputPosition );
+
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif
+
generated by cgit v1.2.3 (git 2.39.1) at 2024-10-16 23:30:56 +0000