/*************************************************************************
 *
 *  $RCSfile: CalendarFieldIndex.idl,v $
 *
 *  $Revision: 1.6 $
 *
 *  last change: $Author: er $ $Date: 2002-05-02 17:10:44 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (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.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/

#ifndef __com_sun_star_i18n_CalendarFieldIndex_idl__
#define __com_sun_star_i18n_CalendarFieldIndex_idl__

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

module com { module sun { module star { module i18n {

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


/**
    Field indexes to be passed to various <type>XCalendar</type> methods.

    <p> Field is writable only if marked both Get/Set. </p>

    <p> ZONE_OFFSET and DST_OFFSET cooperate such that both values are added,
    for example, ZoneOffset=1*60 and DstOffset=1*60 results in a time
    difference of GMT+2. The calculation is
    GMT = LocalTime - ZoneOffset - DstOffset </p>
 */
constants CalendarFieldIndex
{
    /// Get     <type>AmPmValue</type>.
    const short AM_PM			= 0;
    /// Get/Set [1-31]
    const short DAY_OF_MONTH	= 1;
    /// Get     [0-6]
    const short DAY_OF_WEEK		= 2;
    /// Get
    const short DAY_OF_YEAR		= 3;
    /// Get/Set daylight saving time offset in minutes [0*60..1*60]
    const short DST_OFFSET		= 4;
    /// Get/Set [0-23]
    const short HOUR			= 5;
    /// Get/Set [0-59]
    const short MINUTE			= 6;
    /// Get/Set [0-59]
    const short SECOND			= 7;
    /// Get/Set [0-999]
    const short MILLISECOND		= 8;
    /// Get
    const short WEEK_OF_MONTH	= 9;
    /// Get
    const short WEEK_OF_YEAR	= 10;
    /// Get/Set
    const short YEAR			= 11;
    /// Get/Set [0-...]
    const short MONTH			= 12;
    /// Get/Set
    const short ERA				= 13;
    /// Get/Set time zone offset in minutes [-12*60..12*60]
    const short ZONE_OFFSET		= 14;
    /// Total number of fields
    const short FIELD_COUNT		= 15;
};

//=============================================================================
}; }; }; };
//=============================================================================
#endif