xref: /trunk/main/offapi/com/sun/star/util/Duration.idl (revision 34c958ab)

/**************************************************************
 *
 * 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
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/



#ifndef __com_sun_star_util_Duration_idl__
#define __com_sun_star_util_Duration_idl__


//========================================================================

module com {  module sun {  module star {  module util {

//========================================================================

/** represents a duration.

    <p>
    A duration is the difference of 2 <type>DateTime</type>s.
    </p>

    <p>
    Note that there are no constraints on the ranges of the members,
    except that every member must be non-negative:
    for example, a Duration of 400 Days is valid.
    </p>

    @since OpenOffice 3.3
 */
struct Duration
{
    //--------------------------------------------------------------------
    /** explicit sign bit.
     */
    boolean Negative;

    //--------------------------------------------------------------------
    /** contains the years.
     */
    unsigned short Years;

    //--------------------------------------------------------------------
    /** contains the months.
     */
    unsigned short Months;

    //--------------------------------------------------------------------
    /** contains the days.
     */
    unsigned short Days;

    //--------------------------------------------------------------------
    /** contains the hours.
     */
    unsigned short Hours;

    //--------------------------------------------------------------------
    /** contains the minutes.
     */
    unsigned short Minutes;

    //--------------------------------------------------------------------
    /** contains the seconds.
     */
    unsigned short Seconds;

    //--------------------------------------------------------------------
    /** contains the milliseconds.
     */
    unsigned short MilliSeconds;

};

//========================================================================

}; }; }; };

#endif