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