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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_sheet_DataPilotFieldGroupBy_idl__
  21 #define __com_sun_star_sheet_DataPilotFieldGroupBy_idl__
  22
  23
  24 module com {  module sun {  module star {  module sheet {
  25
  26
  27 /** These constants select different types for grouping members of a DataPilot
  28     field by date or time.
  29
  30     @see DataPilotFieldGroupInfo
  31  */
  32 published constants DataPilotFieldGroupBy
  33 {
  34     /** Groups all members of a DataPilot field containing a date/time value
  35         by their current value for seconds.
  36
  37         <p>Example: The group <em>:02</em> will contain all members that
  38         contain a time with a seconds value of 2, regardless of the date,
  39         hours and minutes of the member, e.g. <em>2002-Jan-03 00:00:02</em> or
  40         <em>1999-May-02 12:45:02</em>.</p>
  41      */
  42     const long SECONDS = 1;
  43
  44     /** Groups all members of a DataPilot field containing a date/time value
  45         by their current value for minutes.
  46
  47         <p>Example: The group <em>:02</em> will contain all members that
  48         contain a time with a minutes value of 2, regardless of the date,
  49         hours and seconds of the member, e.g. <em>2002-Jan-03 00:02:00</em> or
  50         <em>1999-May-02 12:02:45</em>.</p>
  51      */
  52     const long MINUTES = 2;
  53
  54     /** Groups all members of a DataPilot field containing a date/time value
  55         by their current value for hours.
  56
  57         <p>Example: The group <em>02</em> will contain all members that
  58         contain a time with a hour value of 2, regardless of the date, minutes
  59         and seconds of the member, e.g. <em>2002-Jan-03 02:00:00</em> or
  60         <em>1999-May-02 02:12:45</em>.</p>
  61      */
  62     const long HOURS = 4;
  63
  64     /** Groups all members of a DataPilot field containing a date/time value
  65         by their calendar day, or by ranges of days.
  66
  67         <p>Examples:
  68         <ul>
  69         <li>Calendar day grouping: The group <em>Jan 03</em> will contain all
  70         members that contain the January 3rd, regardless of the year or time
  71         of the member, e.g. <em>2002-Jan-03 00:00:00</em> or
  72         <em>1999-Jan-03 02:12:45</em>.</li>
  73
  74         <li>Day range grouping: The group <em>2002-Jan-03 - 2002-Jan-09</em>
  75         will contain all members with a date/time in the range from
  76         2002-Jan-03 00:00:00 through 2002-Jan-09 23:59:59.</li>
  77         </ul></p>
  78
  79         <p>See descriptions for XDataPilotFieldGrouping::createDateGroup()
  80         for more details about day grouping.</p>
  81      */
  82     const long DAYS = 8;
  83
  84     /** Groups all members of a DataPilot field containing a date/time value
  85         by their month.
  86
  87         <p>Example: The group <em>Jan</em> will contain all members with a
  88         date in the month January, regardless of the year, day, or time of the
  89         member, e.g. <em>2002-Jan-03 00:00:00</em> or
  90         <em>1999-Jan-02 02:12:45</em>.</p>
  91      */
  92     const long MONTHS = 16;
  93
  94     /** Groups all members of a DataPilot field containing a date/time value
  95         by their quarter.
  96
  97         <p>Example: The group <em>Q1</em> will contain all members with a
  98         date in the first quarter of a year (i.e. the months January,
  99         February, and march), 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-Mar-02 02:12:45</em>.</p>
 102      */
 103     const long QUARTERS = 32;
 104
 105     /** Groups all members of a DataPilot field containing a date/time value
 106         by their year.
 107
 108         <p>Example: The group <em>1999</em> will contain all members with a
 109         date in the year 1999, regardless of the month, day, or time of the
 110         member, e.g. <em>1999-Jan-03 00:00:00</em> or
 111         <em>1999-May-02 02:12:45</em>.</p>
 112      */
 113     const long YEARS = 64;
 114 };
 115
 116
 117 }; }; }; };
 118
 119 #endif
 120
 121 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */