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 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_text_textfield_DateTime_idl__
  29 #define __com_sun_star_text_textfield_DateTime_idl_
  30
  31 #include <com/sun/star/text/TextField.idl>
  32 #include <com/sun/star/util/DateTime.idl>
  33
  34 //=============================================================================
  35
  36 module com { module sun { module star { module text { module textfield {
  37
  38 //=============================================================================
  39 /** specifies service of a date or time text field.
  40     @see com::sun::star::text::TextField
  41 */
  42 published service DateTime
  43 {
  44     service  com::sun::star::text::TextField;
  45
  46     /** If this flag is set to <FALSE/> the date or time
  47         is always displayed as the current date or time.
  48
  49         @since OOo 1.1.2
  50      */
  51     [optional, property] boolean IsFixed;
  52
  53     /** If this flag is set to <TRUE/> this field represents
  54         a date with an optional time. If it is set to <FALSE/>
  55         only the time is used here.
  56      */
  57     [property] boolean IsDate;
  58
  59     /** the is the content of this field.
  60     */
  61     [optional, property] com::sun::star::util::DateTime DateTimeValue;
  62
  63     /** this is the number format for this field
  64         @see com::sun::star::util::NumberFormatter
  65     */
  66     [optional, property] long NumberFormat;
  67
  68     /** this is the display format for this field.
  69         Depending on <member>IsDate</member>, this
  70         is either a
  71         <type scope="com::sun::star::text">DateDisplayFormat</type> or
  72         <type scope="com::sun::star::text">TimeDisplayFormat</type>.
  73
  74         This property is deprecated and is here only
  75         for components that do not support a
  76         <type scope="com::sun::star::util">NumberFormatter</type>.
  77
  78         @see com::sun::star::text::DateDisplayFormat
  79         @see com::sun::star::text::TimeDisplayFormat
  80
  81         @deprecated
  82     */
  83     [optional, property] short DateTimeFormat;
  84     /** contains an offset to the date or time value in minutes.
  85     */
  86     [optional, property] long Adjust;
  87     /** determines whether changes in language attributes at the position the text field
  88         is located also change the number format as appropriate for this language.
  89      */
  90     [optional, property] boolean IsFixedLanguage;
  91 };
  92
  93 //=============================================================================
  94
  95 }; }; }; }; };
  96
  97 #endif
  98