xref: /trunk/main/offapi/com/sun/star/awt/XDateField.idl (revision d1766043)
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#ifndef __com_sun_star_awt_XDateField_idl__
24#define __com_sun_star_awt_XDateField_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30
31//=============================================================================
32
33 module com {  module sun {  module star {  module awt {
34
35//=============================================================================
36
37/** gives access to the value and settings of a date field.
38 */
39published interface XDateField: com::sun::star::uno::XInterface
40{
41	//-------------------------------------------------------------------------
42
43	/** sets the date value which is displayed in the date field.
44
45        <p>The date value must be specified in the format
46        YYYYMMDD.</p>
47	 */
48	[oneway] void setDate( [in] long Date );
49
50	//-------------------------------------------------------------------------
51
52	/** returns the date value which is currently displayed in the date field.
53	 */
54	long getDate();
55
56	//-------------------------------------------------------------------------
57
58	/** sets the minimum date value that can be entered by the user.
59	 */
60	[oneway] void setMin( [in] long Date );
61
62	//-------------------------------------------------------------------------
63
64	/** returns the currently set minimum date value that can be entered by
65        the user.
66	 */
67	long getMin();
68
69	//-------------------------------------------------------------------------
70
71	/** sets the maximum date value that can be entered by the user.
72	 */
73	[oneway] void setMax( [in] long Date );
74
75	//-------------------------------------------------------------------------
76
77	/** returns the currently set maximum date value that can be entered by
78        the user.
79	 */
80	long getMax();
81
82	//-------------------------------------------------------------------------
83
84	/** sets the first value to be set on POS1 key.
85	 */
86	[oneway] void setFirst( [in] long Date );
87
88	//-------------------------------------------------------------------------
89
90	/** returns the currently set first value which is set on POS1 key.
91	 */
92	long getFirst();
93
94	//-------------------------------------------------------------------------
95
96	/** sets the last value to be set on END key.
97	 */
98	[oneway] void setLast( [in] long Date );
99
100	//-------------------------------------------------------------------------
101
102	/** returns the currently set last value which is set on END key.
103	 */
104	long getLast();
105
106	//-------------------------------------------------------------------------
107
108	/** determines if the long date format is to be used.
109	 */
110	[oneway] void setLongFormat( [in] boolean bLong );
111
112	//-------------------------------------------------------------------------
113
114	/** determines if the long date format is currently used.
115	 */
116	boolean isLongFormat();
117
118	//-------------------------------------------------------------------------
119
120	/** sets an empty value for the date.
121	 */
122	void setEmpty();
123
124	//-------------------------------------------------------------------------
125
126	/** returns whether currently an empty value is set for the date.
127	 */
128	boolean isEmpty();
129
130	//-------------------------------------------------------------------------
131
132	/** determines if the format is checked during user input.
133	 */
134	[oneway] void setStrictFormat( [in] boolean bStrict );
135
136	//-------------------------------------------------------------------------
137
138	/** returns whether the format is currently checked during user input.
139	 */
140	boolean isStrictFormat();
141
142};
143
144//=============================================================================
145
146}; }; }; };
147
148#endif
149