offapi/com/sun/star/text/textfield/DateTime.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: DateTime.idl,v $
  10  * $Revision: 1.12 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_text_textfield_DateTime_idl__
  32 #define __com_sun_star_text_textfield_DateTime_idl_
  33
  34 #include <com/sun/star/text/TextField.idl>
  35 #include <com/sun/star/util/DateTime.idl>
  36
  37 //=============================================================================
  38
  39 module com { module sun { module star { module text { module textfield {
  40
  41 //=============================================================================
  42 /**     specifies service of a date or time text field.
  43     @see com::sun::star::text::TextField
  44 */
  45 published service DateTime
  46 {
  47     service  com::sun::star::text::TextField;
  48
  49     /** If this flag is set to <FALSE/> the date or time
  50         is always displayed as the current date or time.
  51
  52         @since OOo 1.1.2
  53      */
  54     [optional, property] boolean IsFixed;
  55
  56     /** If this flag is set to <TRUE/> this field represents
  57         a date with an optional time. If it is set to <FALSE/>
  58         only the time is used here.
  59      */
  60     [property] boolean IsDate;
  61
  62     /** the is the content of this field.
  63     */
  64     [optional, property] com::sun::star::util::DateTime DateTimeValue;
  65
  66     /** this is the number format for this field
  67         @see com::sun::star::util::NumberFormatter
  68     */
  69     [optional, property] long NumberFormat;
  70
  71     /** this is the display format for this field.
  72         Depending on <member>IsDate</member>, this
  73         is either a
  74         <type scope="com::sun::star::text">DateDisplayFormat</type> or
  75         <type scope="com::sun::star::text">TimeDisplayFormat</type>.
  76
  77         This property is deprecated and is here only
  78         for components that do not support a
  79         <type scope="com::sun::star::util">NumberFormatter</type>.
  80
  81         @see com::sun::star::text::DateDisplayFormat
  82         @see com::sun::star::text::TimeDisplayFormat
  83
  84         @deprecated
  85     */
  86     [optional, property] short DateTimeFormat;
  87     /** contains an offset to the date or time value in minutes.
  88     */
  89     [optional, property] long Adjust;
  90     /** determines whether changes in language attributes at the position the text field
  91         is located also change the number format as appropriate for this language.
  92      */
  93     [optional, property] boolean IsFixedLanguage;
  94 };
  95
  96 //=============================================================================
  97
  98 }; }; }; }; };
  99
 100 #endif
 101