/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: DateTime.idl,v $
 * $Revision: 1.12 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#ifndef __com_sun_star_text_textfield_DateTime_idl__
#define __com_sun_star_text_textfield_DateTime_idl_

#include <com/sun/star/text/TextField.idl>
#include <com/sun/star/util/DateTime.idl>

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

module com { module sun { module star { module text { module textfield {

//=============================================================================
/** specifies service of a date or time text field.
    @see com::sun::star::text::TextField
*/
published service DateTime
{
    service  com::sun::star::text::TextField;

    /** If this flag is set to <FALSE/> the date or time
        is always displayed as the current date or time.

        @since OOo 1.1.2
     */
    [optional, property] boolean IsFixed;

    /** If this flag is set to <TRUE/> this field represents
        a date with an optional time. If it is set to <FALSE/>
        only the time is used here.
     */
    [property] boolean IsDate;

    /** the is the content of this field.
    */
    [optional, property] com::sun::star::util::DateTime DateTimeValue;

    /** this is the number format for this field
        @see com::sun::star::util::NumberFormatter
    */
    [optional, property] long NumberFormat;

    /** this is the display format for this field.
        Depending on <member>IsDate</member>, this
        is either a
        <type scope="com::sun::star::text">DateDisplayFormat</type> or
        <type scope="com::sun::star::text">TimeDisplayFormat</type>.

        This property is deprecated and is here only
        for components that do not support a
        <type scope="com::sun::star::util">NumberFormatter</type>.

        @see com::sun::star::text::DateDisplayFormat
        @see com::sun::star::text::TimeDisplayFormat

        @deprecated
    */
    [optional, property] short DateTimeFormat;
    /** contains an offset to the date or time value in minutes.
    */
    [optional, property] long Adjust;
    /** determines whether changes in language attributes at the position the text field
        is located also change the number format as appropriate for this language.
     */
    [optional, property] boolean IsFixedLanguage;
};

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

}; }; }; }; };

#endif