1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_sheet_DataPilotFieldGroupBy_idl__
25#define __com_sun_star_sheet_DataPilotFieldGroupBy_idl__
26
27//=============================================================================
28
29module com {  module sun {  module star {  module sheet {
30
31//=============================================================================
32
33/** These constants select different types for grouping members of a DataPilot
34    field by date or time.
35
36    @see DataPilotFieldGroupInfo
37 */
38published constants DataPilotFieldGroupBy
39{
40    // -----------------------------------------------------------------------
41    /** Groups all members of a DataPilot field containing a date/time value
42        by their current value for seconds.
43
44        <p>Example: The group <em>:02</em> will contain all members that
45        contain a time with a seconds value of 2, regardless of the date,
46        hours and minutes of the member, e.g. <em>2002-Jan-03 00:00:02</em> or
47        <em>1999-May-02 12:45:02</em>.</p>
48     */
49    const long SECONDS = 1;
50
51    // -----------------------------------------------------------------------
52    /** Groups all members of a DataPilot field containing a date/time value
53        by their current value for minutes.
54
55        <p>Example: The group <em>:02</em> will contain all members that
56        contain a time with a minutes value of 2, regardless of the date,
57        hours and seconds of the member, e.g. <em>2002-Jan-03 00:02:00</em> or
58        <em>1999-May-02 12:02:45</em>.</p>
59     */
60    const long MINUTES = 2;
61
62    // -----------------------------------------------------------------------
63    /** Groups all members of a DataPilot field containing a date/time value
64        by their current value for hours.
65
66        <p>Example: The group <em>02</em> will contain all members that
67        contain a time with a hour value of 2, regardless of the date, minutes
68        and seconds of the member, e.g. <em>2002-Jan-03 02:00:00</em> or
69        <em>1999-May-02 02:12:45</em>.</p>
70     */
71    const long HOURS = 4;
72
73    // -----------------------------------------------------------------------
74    /** Groups all members of a DataPilot field containing a date/time value
75        by their calendar day, or by ranges of days.
76
77        <p>Examples:
78        <ul>
79        <li>Calendar day grouping: The group <em>Jan 03</em> will contain all
80        members that contain the january 3rd, regardless of the year or time
81        of the member, e.g. <em>2002-Jan-03 00:00:00</em> or
82        <em>1999-Jan-03 02:12:45</em>.</li>
83
84        <li>Day range grouping: The group <em>2002-Jan-03 - 2002-Jan-09</em>
85        will contain all members with a date/time in the range from
86        2002-Jan-03 00:00:00 through 2002-Jan-09 23:59:59.</li>
87        </ul></p>
88
89        <p>See descriptions for <member>XDataPilotFieldGrouping::createDateGroup
90        </member> for more details about day grouping.</p>
91     */
92    const long DAYS = 8;
93
94    // -----------------------------------------------------------------------
95    /** Groups all members of a DataPilot field containing a date/time value
96        by their month.
97
98        <p>Example: The group <em>Jan</em> will contain all members with a
99        date in the month january, regardless of the year, day, or time of the
100        member, e.g. <em>2002-Jan-03 00:00:00</em> or
101        <em>1999-Jan-02 02:12:45</em>.</p>
102     */
103    const long MONTHS = 16;
104
105    // -----------------------------------------------------------------------
106    /** Groups all members of a DataPilot field containing a date/time value
107        by their quarter.
108
109        <p>Example: The group <em>Q1</em> will contain all members with a
110        date in the first quarter of a year (i.e. the months january,
111        february, and march), regardless of the year, day, or time of the
112        member, e.g. <em>2002-Jan-03 00:00:00</em> or
113        <em>1999-Mar-02 02:12:45</em>.</p>
114     */
115    const long QUARTERS = 32;
116
117    // -----------------------------------------------------------------------
118    /** Groups all members of a DataPilot field containing a date/time value
119        by their year.
120
121        <p>Example: The group <em>1999</em> will contain all members with a
122        date in the year 1999, regardless of the month, day, or time of the
123        member, e.g. <em>1999-Jan-03 00:00:00</em> or
124        <em>1999-May-02 02:12:45</em>.</p>
125     */
126    const long YEARS = 64;
127};
128
129//=============================================================================
130
131}; }; }; };
132
133#endif
134
135