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
  21 module com {  module sun {  module star {  module sheet {
  22
  23
  24 /** These constants select different types for grouping members of a DataPilot
  25     field by date or time.
  26
  27     @see DataPilotFieldGroupInfo
  28  */
  29 published constants DataPilotFieldGroupBy
  30 {
  31     /** Groups all members of a DataPilot field containing a date/time value
  32         by their current value for seconds.
  33
  34         <p>Example: The group <em>:02</em> will contain all members that
  35         contain a time with a seconds value of 2, regardless of the date,
  36         hours and minutes of the member, e.g. <em>2002-Jan-03 00:00:02</em> or
  37         <em>1999-May-02 12:45:02</em>.</p>
  38      */
  39     const long SECONDS = 1;
  40
  41     /** Groups all members of a DataPilot field containing a date/time value
  42         by their current value for minutes.
  43
  44         <p>Example: The group <em>:02</em> will contain all members that
  45         contain a time with a minutes value of 2, regardless of the date,
  46         hours and seconds of the member, e.g. <em>2002-Jan-03 00:02:00</em> or
  47         <em>1999-May-02 12:02:45</em>.</p>
  48      */
  49     const long MINUTES = 2;
  50
  51     /** Groups all members of a DataPilot field containing a date/time value
  52         by their current value for hours.
  53
  54         <p>Example: The group <em>02</em> will contain all members that
  55         contain a time with a hour value of 2, regardless of the date, minutes
  56         and seconds of the member, e.g. <em>2002-Jan-03 02:00:00</em> or
  57         <em>1999-May-02 02:12:45</em>.</p>
  58      */
  59     const long HOURS = 4;
  60
  61     /** Groups all members of a DataPilot field containing a date/time value
  62         by their calendar day, or by ranges of days.
  63
  64         <p>Examples:
  65         <ul>
  66         <li>Calendar day grouping: The group <em>Jan 03</em> will contain all
  67         members that contain the January 3rd, regardless of the year or time
  68         of the member, e.g. <em>2002-Jan-03 00:00:00</em> or
  69         <em>1999-Jan-03 02:12:45</em>.</li>
  70
  71         <li>Day range grouping: The group <em>2002-Jan-03 - 2002-Jan-09</em>
  72         will contain all members with a date/time in the range from
  73         2002-Jan-03 00:00:00 through 2002-Jan-09 23:59:59.</li>
  74         </ul></p>
  75
  76         <p>See descriptions for XDataPilotFieldGrouping::createDateGroup()
  77         for more details about day grouping.</p>
  78      */
  79     const long DAYS = 8;
  80
  81     /** Groups all members of a DataPilot field containing a date/time value
  82         by their month.
  83
  84         <p>Example: The group <em>Jan</em> will contain all members with a
  85         date in the month January, regardless of the year, day, or time of the
  86         member, e.g. <em>2002-Jan-03 00:00:00</em> or
  87         <em>1999-Jan-02 02:12:45</em>.</p>
  88      */
  89     const long MONTHS = 16;
  90
  91     /** Groups all members of a DataPilot field containing a date/time value
  92         by their quarter.
  93
  94         <p>Example: The group <em>Q1</em> will contain all members with a
  95         date in the first quarter of a year (i.e. the months January,
  96         February, and march), regardless of the year, day, or time of the
  97         member, e.g. <em>2002-Jan-03 00:00:00</em> or
  98         <em>1999-Mar-02 02:12:45</em>.</p>
  99      */
 100     const long QUARTERS = 32;
 101
 102     /** Groups all members of a DataPilot field containing a date/time value
 103         by their year.
 104
 105         <p>Example: The group <em>1999</em> will contain all members with a
 106         date in the year 1999, regardless of the month, day, or time of the
 107         member, e.g. <em>1999-Jan-03 00:00:00</em> or
 108         <em>1999-May-02 02:12:45</em>.</p>
 109      */
 110     const long YEARS = 64;
 111 };
 112
 113
 114 }; }; }; };
 115
 116 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */