/************************************************************************* * * 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 * * for a copy of the LGPLv3 License. * ************************************************************************/ #ifndef __com_sun_star_sheet_XDataPilotFieldGrouping_idl__ #define __com_sun_star_sheet_XDataPilotFieldGrouping_idl__ #ifndef __com_sun_star_uno_XInterface_idl__ #include #endif #ifndef __com_sun_star_sheet_DataPilotFieldGroupInfo_idl__ #include #endif #ifndef __com_sun_star_lang_IllegalArgumentException_idl__ #include #endif //============================================================================= module com { module sun { module star { module sheet { //============================================================================= /** Provides methods to create new DataPilot fields where some or all items of this DataPilot field are grouped in some way. @see DataPilotField */ published interface XDataPilotFieldGrouping: com::sun::star::uno::XInterface { //------------------------------------------------------------------------- /** Creates a new DataPilot field which contains a group containing the given DataPilot field items (members).

It is possible to create multiple groups by calling this method several times at the same DataPilot field. On subsequent calls, the DataPilot field created at the first call is used to insert the new groups.

The collection of groups can be accessed via the DataPilotField::GroupInfo property. The returned struct contains the sequence of groups in its member DataPilotFieldGroupInfo::Groups.

@param aItems a sequence containing the names of the items (members) which will be part of the new group. Must be names of items contained in the current field. @returns the new created field if there is one created on the first call of this method. is returned on subsequent calls. @see DataPilotField @see DataPilotFieldGroupInfo */ XDataPilotField createNameGroup([in] sequence< string > aItems) raises( com::sun::star::lang::IllegalArgumentException ); //------------------------------------------------------------------------- /** Groups the members of this field by dates, according to the passed settings.

If this field is already grouped by dates, a new DataPilot field will be created and returned. If this field is not grouped at all, the date grouping is perfomed inside of this field (no new field will be created). There must not be any other grouping (by member names or by numeric ranges), otherwise an exception is thrown.

@param aInfo contains the information how to group the items of the field. The members of this struct have to fulfill the following requirements:
  • If the member DataPilotFieldGroupInfo::HasAutoStart is set to , then the value of DataPilotFieldGroupInfo::Start must be a floating-point value representing a valid date/time value (if DataPilotFieldGroupInfo::HasAutoStart is set to , the value of DataPilotFieldGroupInfo::Start will be ignored).
  • If the member DataPilotFieldGroupInfo::HasAutoEnd is set to , then the value of DataPilotFieldGroupInfo::End must be a floating-point value representing a valid date/time value( if DataPilotFieldGroupInfo::HasAutoEnd is set to , the value of DataPilotFieldGroupInfo::End will be ignored).
  • If the members DataPilotFieldGroupInfo::HasAutoStart and DataPilotFieldGroupInfo::HasAutoEnd are set to both, then the value of DataPilotFieldGroupInfo::Start must be less than or equal to the value of DataPilotFieldGroupInfo::End.
  • The member DataPilotFieldGroupInfo::HasDateValues must be set to .
  • The member DataPilotFieldGroupInfo::Step must be zero, unless ranges of days have to be grouped (see the description of the member GroupBy below), in that case the value must be greater than or equal to 1 and less than or equal to 32767. The fractional part of the value will be ignored.
  • The member DataPilotFieldGroupInfo::GroupBy must contain exactly one of the flags from DataPilotFieldGroupBy. A combination of several flags will not be accepted. If DataPilotFieldGroupBy::DAYS is specified, the value of the member DataPilotFieldGroupInfo::Step will specify the type of day grouping (see above). If that value is zero, grouping is performed on all days of the year (e.g. the members containing the 1st of January of any year are grouped together). If that value is greater than zero, grouping is done on ranges of days, and the value specifies the number of days grouped into one range (e.g. a value of 7 groups the members of a week into a range).
  • The contents of the member DataPilotFieldGroupInfo::SourceField will be ignored.
  • The contents of the member DataPilotFieldGroupInfo::Groups will be ignored.
@returns the new created field if there is one created. is returned, if date grouping is performed inside this field (i.e. this field was not grouped by dates before). @throws com::sun::star::lang::IllegalArgumentException if the passed struct does not contain valid settings as described, or if this field is already grouped by member names or numeric ranges. @see DataPilotField */ XDataPilotField createDateGroup([in] DataPilotFieldGroupInfo aInfo) raises( com::sun::star::lang::IllegalArgumentException ); }; //============================================================================= }; }; }; }; #endif