xref: /trunk/main/offapi/com/sun/star/awt/XPatternField.idl (revision 1ecadb572e7010ff3b3382ad9bf179dbc6efadbb)
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_XPatternField_idl__
28#define __com_sun_star_awt_XPatternField_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 formatting of a pattern field.
42 */
43published interface XPatternField: com::sun::star::uno::XInterface
44{
45    //-------------------------------------------------------------------------
46
47    /** sets the pattern mask.
48     */
49    [oneway] void setMasks( [in] string EditMask,
50             [in] string LiteralMask );
51
52    //-------------------------------------------------------------------------
53
54    /** returns the currently set pattern mask.
55     */
56    void getMasks( [out] string EditMask,
57             [out] string LiteralMask );
58
59    //-------------------------------------------------------------------------
60
61    /** sets the string value of the pattern field.
62     */
63    [oneway] void setString( [in] string Str );
64
65    //-------------------------------------------------------------------------
66
67    /** returns the currently set string value of the pattern field.
68     */
69    string getString();
70
71    //-------------------------------------------------------------------------
72
73    /** determines if the format is checked during user input.
74     */
75    [oneway] void setStrictFormat( [in] boolean bStrict );
76
77    //-------------------------------------------------------------------------
78
79    /** returns whether the format is currently checked during user input.
80     */
81    boolean isStrictFormat();
82
83};
84
85//=============================================================================
86
87}; }; }; };
88
89#endif
90