diff options
Diffstat (limited to 'offapi/com/sun/star/sheet/XNamedRanges.idl')
-rw-r--r-- | offapi/com/sun/star/sheet/XNamedRanges.idl | 160 |
1 files changed, 160 insertions, 0 deletions
diff --git a/offapi/com/sun/star/sheet/XNamedRanges.idl b/offapi/com/sun/star/sheet/XNamedRanges.idl new file mode 100644 index 000000000..ca4d9feb4 --- /dev/null +++ b/offapi/com/sun/star/sheet/XNamedRanges.idl @@ -0,0 +1,160 @@ +/************************************************************************* + * + * $RCSfile: XNamedRanges.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:22:05 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ +#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 service com::sun::star::sheet::NamedRanges + */ +[ uik(E2281505-33D6-11D1-AABE00A0-249D5590), ident( "XNamedRanges", 1.0 ) ] +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. + */ + 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 + part of the original range, excluding the labels.</p> + */ + 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 + /** removes a named range from the collection. + */ + void removeByName( [in] string aName ); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::sheet::XNamedRanges::outputList + /** writes a list of all named ranges into the document. + + + + <p>The first column of the list contains the names. The second + column contains the contents of the named ranges.</p> + */ + void outputList( [in] com::sun::star::table::CellAddress aOutputPosition ); + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + 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 |