diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 09:06:44 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 09:06:44 +0000 |
commit | ed5640d8b587fbcfed7dd7967f3de04b37a76f26 (patch) | |
tree | 7a5f7c6c9d02226d7471cb3cc8fbbf631b415303 /offapi/com/sun/star/sheet/DataPilotFieldGroupBy.idl | |
parent | Initial commit. (diff) | |
download | libreoffice-ed5640d8b587fbcfed7dd7967f3de04b37a76f26.tar.xz libreoffice-ed5640d8b587fbcfed7dd7967f3de04b37a76f26.zip |
Adding upstream version 4:7.4.7.upstream/4%7.4.7upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r-- | offapi/com/sun/star/sheet/DataPilotFieldGroupBy.idl | 121 |
1 files changed, 121 insertions, 0 deletions
diff --git a/offapi/com/sun/star/sheet/DataPilotFieldGroupBy.idl b/offapi/com/sun/star/sheet/DataPilotFieldGroupBy.idl new file mode 100644 index 000000000..0c0bf251e --- /dev/null +++ b/offapi/com/sun/star/sheet/DataPilotFieldGroupBy.idl @@ -0,0 +1,121 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ + +#ifndef __com_sun_star_sheet_DataPilotFieldGroupBy_idl__ +#define __com_sun_star_sheet_DataPilotFieldGroupBy_idl__ + + +module com { module sun { module star { module sheet { + + +/** These constants select different types for grouping members of a DataPilot + field by date or time. + + @see DataPilotFieldGroupInfo + */ +published constants DataPilotFieldGroupBy +{ + /** Groups all members of a DataPilot field containing a date/time value + by their current value for seconds. + + <p>Example: The group <em>:02</em> will contain all members that + contain a time with a seconds value of 2, regardless of the date, + hours and minutes of the member, e.g. <em>2002-Jan-03 00:00:02</em> or + <em>1999-May-02 12:45:02</em>.</p> + */ + const long SECONDS = 1; + + /** Groups all members of a DataPilot field containing a date/time value + by their current value for minutes. + + <p>Example: The group <em>:02</em> will contain all members that + contain a time with a minutes value of 2, regardless of the date, + hours and seconds of the member, e.g. <em>2002-Jan-03 00:02:00</em> or + <em>1999-May-02 12:02:45</em>.</p> + */ + const long MINUTES = 2; + + /** Groups all members of a DataPilot field containing a date/time value + by their current value for hours. + + <p>Example: The group <em>02</em> will contain all members that + contain a time with a hour value of 2, regardless of the date, minutes + and seconds of the member, e.g. <em>2002-Jan-03 02:00:00</em> or + <em>1999-May-02 02:12:45</em>.</p> + */ + const long HOURS = 4; + + /** Groups all members of a DataPilot field containing a date/time value + by their calendar day, or by ranges of days. + + <p>Examples: + <ul> + <li>Calendar day grouping: The group <em>Jan 03</em> will contain all + members that contain the January 3rd, regardless of the year or time + of the member, e.g. <em>2002-Jan-03 00:00:00</em> or + <em>1999-Jan-03 02:12:45</em>.</li> + + <li>Day range grouping: The group <em>2002-Jan-03 - 2002-Jan-09</em> + will contain all members with a date/time in the range from + 2002-Jan-03 00:00:00 through 2002-Jan-09 23:59:59.</li> + </ul></p> + + <p>See descriptions for XDataPilotFieldGrouping::createDateGroup() + for more details about day grouping.</p> + */ + const long DAYS = 8; + + /** Groups all members of a DataPilot field containing a date/time value + by their month. + + <p>Example: The group <em>Jan</em> will contain all members with a + date in the month January, regardless of the year, day, or time of the + member, e.g. <em>2002-Jan-03 00:00:00</em> or + <em>1999-Jan-02 02:12:45</em>.</p> + */ + const long MONTHS = 16; + + /** Groups all members of a DataPilot field containing a date/time value + by their quarter. + + <p>Example: The group <em>Q1</em> will contain all members with a + date in the first quarter of a year (i.e. the months January, + February, and march), regardless of the year, day, or time of the + member, e.g. <em>2002-Jan-03 00:00:00</em> or + <em>1999-Mar-02 02:12:45</em>.</p> + */ + const long QUARTERS = 32; + + /** Groups all members of a DataPilot field containing a date/time value + by their year. + + <p>Example: The group <em>1999</em> will contain all members with a + date in the year 1999, regardless of the month, day, or time of the + member, e.g. <em>1999-Jan-03 00:00:00</em> or + <em>1999-May-02 02:12:45</em>.</p> + */ + const long YEARS = 64; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |