offapi/com/sun/star/sheet/DataPilotFieldGroupBy.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: DataPilotFieldGroupBy.idl,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_sheet_DataPilotFieldGroupBy_idl__
  32 #define __com_sun_star_sheet_DataPilotFieldGroupBy_idl__
  33
  34 //=============================================================================
  35
  36 module com {  module sun {  module star {  module sheet {
  37
  38 //=============================================================================
  39
  40 /** These constants select different types for grouping members of a DataPilot
  41     field by date or time.
  42
  43     @see DataPilotFieldGroupInfo
  44  */
  45 published constants DataPilotFieldGroupBy
  46 {
  47     // -----------------------------------------------------------------------
  48     /** Groups all members of a DataPilot field containing a date/time value
  49         by their current value for seconds.
  50
  51         <p>Example: The group <em>:02</em> will contain all members that
  52         contain a time with a seconds value of 2, regardless of the date,
  53         hours and minutes of the member, e.g. <em>2002-Jan-03 00:00:02</em> or
  54         <em>1999-May-02 12:45:02</em>.</p>
  55      */
  56     const long SECONDS = 1;
  57
  58     // -----------------------------------------------------------------------
  59     /** Groups all members of a DataPilot field containing a date/time value
  60         by their current value for minutes.
  61
  62         <p>Example: The group <em>:02</em> will contain all members that
  63         contain a time with a minutes value of 2, regardless of the date,
  64         hours and seconds of the member, e.g. <em>2002-Jan-03 00:02:00</em> or
  65         <em>1999-May-02 12:02:45</em>.</p>
  66      */
  67     const long MINUTES = 2;
  68
  69     // -----------------------------------------------------------------------
  70     /** Groups all members of a DataPilot field containing a date/time value
  71         by their current value for hours.
  72
  73         <p>Example: The group <em>02</em> will contain all members that
  74         contain a time with a hour value of 2, regardless of the date, minutes
  75         and seconds of the member, e.g. <em>2002-Jan-03 02:00:00</em> or
  76         <em>1999-May-02 02:12:45</em>.</p>
  77      */
  78     const long HOURS = 4;
  79
  80     // -----------------------------------------------------------------------
  81     /** Groups all members of a DataPilot field containing a date/time value
  82         by their calendar day, or by ranges of days.
  83
  84         <p>Examples:
  85         <ul>
  86         <li>Calendar day grouping: The group <em>Jan 03</em> will contain all
  87         members that contain the january 3rd, regardless of the year or time
  88         of the member, e.g. <em>2002-Jan-03 00:00:00</em> or
  89         <em>1999-Jan-03 02:12:45</em>.</li>
  90
  91         <li>Day range grouping: The group <em>2002-Jan-03 - 2002-Jan-09</em>
  92         will contain all members with a date/time in the range from
  93         2002-Jan-03 00:00:00 through 2002-Jan-09 23:59:59.</li>
  94         </ul></p>
  95
  96         <p>See descriptions for <member>XDataPilotFieldGrouping::createDateGroup
  97         </member> for more details about day grouping.</p>
  98      */
  99     const long DAYS = 8;
 100
 101     // -----------------------------------------------------------------------
 102     /** Groups all members of a DataPilot field containing a date/time value
 103         by their month.
 104
 105         <p>Example: The group <em>Jan</em> will contain all members with a
 106         date in the month january, regardless of the year, day, or time of the
 107         member, e.g. <em>2002-Jan-03 00:00:00</em> or
 108         <em>1999-Jan-02 02:12:45</em>.</p>
 109      */
 110     const long MONTHS = 16;
 111
 112     // -----------------------------------------------------------------------
 113     /** Groups all members of a DataPilot field containing a date/time value
 114         by their quarter.
 115
 116         <p>Example: The group <em>Q1</em> will contain all members with a
 117         date in the first quarter of a year (i.e. the months january,
 118         february, and march), regardless of the year, day, or time of the
 119         member, e.g. <em>2002-Jan-03 00:00:00</em> or
 120         <em>1999-Mar-02 02:12:45</em>.</p>
 121      */
 122     const long QUARTERS = 32;
 123
 124     // -----------------------------------------------------------------------
 125     /** Groups all members of a DataPilot field containing a date/time value
 126         by their year.
 127
 128         <p>Example: The group <em>1999</em> will contain all members with a
 129         date in the year 1999, regardless of the month, day, or time of the
 130         member, e.g. <em>1999-Jan-03 00:00:00</em> or
 131         <em>1999-May-02 02:12:45</em>.</p>
 132      */
 133     const long YEARS = 64;
 134 };
 135
 136 //=============================================================================
 137
 138 }; }; }; };
 139
 140 #endif
 141