xref: /AOO41X/main/offapi/com/sun/star/text/textfield/DateTime.idl (revision 2a413f170de95afb9972effe5557e28dd83e2121)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_text_textfield_DateTime_idl__
25#define __com_sun_star_text_textfield_DateTime_idl_
26
27#include <com/sun/star/text/TextField.idl>
28#include <com/sun/star/util/DateTime.idl>
29
30//=============================================================================
31
32module com { module sun { module star { module text { module textfield {
33
34//=============================================================================
35/** specifies service of a date or time text field.
36    @see com::sun::star::text::TextField
37*/
38published service DateTime
39{
40    service  com::sun::star::text::TextField;
41
42    /** If this flag is set to <FALSE/> the date or time
43        is always displayed as the current date or time.
44
45        @since OpenOffice 1.1.2
46     */
47    [optional, property] boolean IsFixed;
48
49    /** If this flag is set to <TRUE/> this field represents
50        a date with an optional time. If it is set to <FALSE/>
51        only the time is used here.
52     */
53    [property] boolean IsDate;
54
55    /** the is the content of this field.
56    */
57    [optional, property] com::sun::star::util::DateTime DateTimeValue;
58
59    /** this is the number format for this field
60        @see com::sun::star::util::NumberFormatter
61    */
62    [optional, property] long NumberFormat;
63
64    /** this is the display format for this field.
65        Depending on <member>IsDate</member>, this
66        is either a
67        <type scope="com::sun::star::text">DateDisplayFormat</type> or
68        <type scope="com::sun::star::text">TimeDisplayFormat</type>.
69
70        This property is deprecated and is here only
71        for components that do not support a
72        <type scope="com::sun::star::util">NumberFormatter</type>.
73
74        @see com::sun::star::text::DateDisplayFormat
75        @see com::sun::star::text::TimeDisplayFormat
76
77        @deprecated
78    */
79    [optional, property] short DateTimeFormat;
80    /** contains an offset to the date or time value in minutes.
81    */
82    [optional, property] long Adjust;
83    /** determines whether changes in language attributes at the position the text field
84        is located also change the number format as appropriate for this language.
85     */
86    [optional, property] boolean IsFixedLanguage;
87};
88
89//=============================================================================
90
91}; }; }; }; };
92
93#endif
94
95