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

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