diff options
Diffstat (limited to 'offapi/com/sun/star/sheet/SubTotalDescriptor.idl')
-rw-r--r-- | offapi/com/sun/star/sheet/SubTotalDescriptor.idl | 150 |
1 files changed, 150 insertions, 0 deletions
diff --git a/offapi/com/sun/star/sheet/SubTotalDescriptor.idl b/offapi/com/sun/star/sheet/SubTotalDescriptor.idl new file mode 100644 index 000000000000..399cb5b1d7d1 --- /dev/null +++ b/offapi/com/sun/star/sheet/SubTotalDescriptor.idl @@ -0,0 +1,150 @@ +/************************************************************************* + * + * 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_SubTotalDescriptor_idl__ +#define __com_sun_star_sheet_SubTotalDescriptor_idl__ + +#ifndef __com_sun_star_sheet_XSubTotalDescriptor_idl__ +#include <com/sun/star/sheet/XSubTotalDescriptor.idl> +#endif + +#ifndef __com_sun_star_beans_XPropertySet_idl__ +#include <com/sun/star/beans/XPropertySet.idl> +#endif +#ifndef __com_sun_star_container_XEnumerationAccess_idl__ +#include <com/sun/star/container/XEnumerationAccess.idl> +#endif +#ifndef __com_sun_star_container_XIndexAccess_idl__ +#include <com/sun/star/container/XIndexAccess.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** represents a description of how subtotals are created. + + <p>The descriptor contains properties and a collection of subtotal fields + which control the behaviour of operation.</p> + */ +published service SubTotalDescriptor +{ + //------------------------------------------------------------------------- + + /** provides access to the collection of subtotal fields. + */ + interface com::sun::star::sheet::XSubTotalDescriptor; + + //------------------------------------------------------------------------- + + /** creates an enumeration of all sub total fields. + + @see com::sun::star::sheet::SubTotalFieldsEnumeration + */ + interface com::sun::star::container::XEnumerationAccess; + + //------------------------------------------------------------------------- + + /** provides access to the sub total fields in the collection via index. + */ + interface com::sun::star::container::XIndexAccess; + + //------------------------------------------------------------------------- + +//!published service PropertySet + /** procides access to the properties. + */ + interface com::sun::star::beans::XPropertySet; + + //========================================================================= + + /** specifies if page breaks are inserted after each group change. + */ + [property] boolean InsertPageBreaks; + + //------------------------------------------------------------------------- + + /** specifies if the case of letters is important when comparing entries. + */ + [property] boolean IsCaseSensitive; + + //------------------------------------------------------------------------- + + /** specifies if a user defined sorting list is used. + */ + [property] boolean EnableUserSortList; + + //------------------------------------------------------------------------- + + /** specifies which user defined sorting list is used. + + <p>This property is only used if + <member>SubTotalDescriptor::EnableUserSortList</member> + is <TRUE/>.</p> + */ + [property] long UserSortListIndex; + + //------------------------------------------------------------------------- + + /** specifies if cell formats are moved with the contents they belong to. + */ + [property] boolean BindFormatsToContent; + + //------------------------------------------------------------------------- + + /** specifies if the contents of the fields will be sorted to groups + while performing a subtotal operation. + */ + [property] boolean EnableSort; + + //------------------------------------------------------------------------- + + /** specifies the sorting order if + <member>SubTotalDescriptor::EnableSort</member> is set to <TRUE/>. + */ + [property] boolean SortAscending; + + //------------------------------------------------------------------------- + + /** returns the maximum number of subtotal fields the descriptor can + hold. + + <p>This read-only property indicates the maximum count of fields the + current implementation supports.</p> + */ + [readonly, property] long MaxFieldCount; + +}; + +//============================================================================= + +}; }; }; }; + +#endif + |