xref: /trunk/main/offapi/com/sun/star/sheet/SubTotalDescriptor.idl (revision ffd38472365e95f6a578737bc9a5eb0fac624a86)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the 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