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