xref: /trunk/main/offapi/com/sun/star/awt/XTimeField.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_XTimeField_idl__
24#define __com_sun_star_awt_XTimeField_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 time field.
38 */
39published interface XTimeField: com::sun::star::uno::XInterface
40{
41	//-------------------------------------------------------------------------
42
43	/** sets the time value which is displayed in the time field.
44
45        <p>The time value must be specified in the format HHMMSShh,
46        where HH are hours, MM are minutes, SS are seconds and hh are
47        hundredth seconds.</p>
48	 */
49	[oneway] void setTime( [in] long Time );
50
51	//-------------------------------------------------------------------------
52
53	/** returns the time value which is currently displayed in the time field.
54	 */
55	long getTime();
56
57	//-------------------------------------------------------------------------
58
59	/** sets the minimum time value that can be entered by the user.
60	 */
61	[oneway] void setMin( [in] long Time );
62
63	//-------------------------------------------------------------------------
64
65	/** returns the currently set minimum time value that can be entered by
66        the user.
67	 */
68	long getMin();
69
70	//-------------------------------------------------------------------------
71
72	/** sets the maximum time value that can be entered by the user.
73	 */
74	[oneway] void setMax( [in] long Time );
75
76	//-------------------------------------------------------------------------
77
78	/** returns the currently set maximum time value that can be entered by
79        the user.
80     */
81	long getMax();
82
83	//-------------------------------------------------------------------------
84
85	/** sets the first value to be set on POS1 key.
86	 */
87	[oneway] void setFirst( [in] long Time );
88
89	//-------------------------------------------------------------------------
90
91	/** returns the currently set first value which is set on POS1 key.
92	 */
93	long getFirst();
94
95	//-------------------------------------------------------------------------
96
97	/** sets the last value to be set on END key.
98	 */
99	[oneway] void setLast( [in] long Time );
100
101	//-------------------------------------------------------------------------
102
103	/** returns the currently set last value which is set on END key.
104	 */
105	long getLast();
106
107	//-------------------------------------------------------------------------
108
109	/** sets an empty value for the time.
110	 */
111	void setEmpty();
112
113	//-------------------------------------------------------------------------
114
115	/** returns whether currently an empty value is set for the time.
116	 */
117	boolean isEmpty();
118
119	//-------------------------------------------------------------------------
120
121	/** determines if the format is checked during user input.
122	 */
123	[oneway] void setStrictFormat( [in] boolean bStrict );
124
125	//-------------------------------------------------------------------------
126
127	/** returns whether the format is currently checked during user input.
128	 */
129	boolean isStrictFormat();
130
131};
132
133//=============================================================================
134
135}; }; }; };
136
137#endif
138