diff options
Diffstat (limited to 'offapi/com/sun/star/sheet/XNamedRange.idl')
-rw-r--r-- | offapi/com/sun/star/sheet/XNamedRange.idl | 111 |
1 files changed, 111 insertions, 0 deletions
diff --git a/offapi/com/sun/star/sheet/XNamedRange.idl b/offapi/com/sun/star/sheet/XNamedRange.idl new file mode 100644 index 000000000000..678594c41d15 --- /dev/null +++ b/offapi/com/sun/star/sheet/XNamedRange.idl @@ -0,0 +1,111 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org 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 version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_XNamedRange_idl__ +#define __com_sun_star_sheet_XNamedRange_idl__ + +#ifndef __com_sun_star_container_XNamed_idl__ +#include <com/sun/star/container/XNamed.idl> +#endif + +#ifndef __com_sun_star_table_CellAddress_idl__ +#include <com/sun/star/table/CellAddress.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** provides access to the settings of a named range in a spreadsheet + document. + + @see com::sun::star::sheet::NamedRange + */ +published interface XNamedRange: com::sun::star::container::XNamed +{ + //------------------------------------------------------------------------- + + /** returns the content of the named range. + + <p>The content can be a reference to a cell or cell range + or any formula expression.</p> + */ + string getContent(); + + //------------------------------------------------------------------------- + + /** sets the content of the named range. + + <p>The content can be a reference to a cell or cell range + or any formula expression.</p> + */ + void setContent( [in] string aContent ); + + //------------------------------------------------------------------------- + + /** returns the position in the document which is used as a + base for relative references in the content. + */ + com::sun::star::table::CellAddress getReferencePosition(); + + //------------------------------------------------------------------------- + + /** sets the position in the document which is used as a + base for relative references in the content. + */ + void setReferencePosition( + [in] com::sun::star::table::CellAddress aReferencePosition ); + + //------------------------------------------------------------------------- + + /** returns the type of the named range. + + <p>This is a combination of flags as defined in + <type>NamedRangeFlag</type>.</p> + */ + long getType(); + + //------------------------------------------------------------------------- + + /** sets the type of the named range. + + @param nType + a combination of flags that specify the type of a named range, + as defined in <type>NamedRangeFlag</type>. + */ + void setType( [in] long nType ); + +}; + +//============================================================================= + +}; }; }; }; + +#endif + |