xref: /aoo41x/main/offapi/com/sun/star/util/Duration.idl (revision cdf0e10c) 
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_util_Duration_idl__
29#define __com_sun_star_util_Duration_idl__
30
31
32//========================================================================
33
34module com {  module sun {  module star {  module util {
35
36//========================================================================
37
38/** represents a duration.
39
40    <p>
41    A duration is the difference of 2 <type>DateTime</type>s.
42    </p>
43
44    <p>
45    Note that there are no constraints on the ranges of the members,
46    except that every member must be non-negative:
47    for example, a Duration of 400 Days is valid.
48    </p>
49
50    @since OOo 3.3
51 */
52struct Duration
53{
54    //--------------------------------------------------------------------
55    /** explicit sign bit.
56     */
57    boolean Negative;
58
59    //--------------------------------------------------------------------
60    /** contains the years.
61     */
62    unsigned short Years;
63
64    //--------------------------------------------------------------------
65    /** contains the months.
66     */
67    unsigned short Months;
68
69    //--------------------------------------------------------------------
70    /** contains the days.
71     */
72    unsigned short Days;
73
74    //--------------------------------------------------------------------
75    /** contains the hours.
76     */
77    unsigned short Hours;
78
79    //--------------------------------------------------------------------
80    /** contains the minutes.
81     */
82    unsigned short Minutes;
83
84    //--------------------------------------------------------------------
85    /** contains the seconds.
86     */
87    unsigned short Seconds;
88
89    //--------------------------------------------------------------------
90    /** contains the milliseconds.
91     */
92    unsigned short MilliSeconds;
93
94};
95
96//========================================================================
97
98}; }; }; };
99
100#endif
101
102