blob: 31a2f95e43d1d202c2ba9cde59634cbe406f78a5 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef __com_sun_star_form_validation_XValidator_idl__
#define __com_sun_star_form_validation_XValidator_idl__
#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/lang/NullPointerException.idl>
module com { module sun { module star { module form { module validation {
interface XValidityConstraintListener;
/** specifies a component able to validate (the content of) other components
<p>Validators support simple validity checks and retrieving justifications for
invalidity.</p>
<p>Validators may additionally support dynamic validity constraints. In such a case,
the validity of a given value may change, without the value changing itself.<br/>
To be notified about this, interested components should register as XValidityConstraintListener.
@see XValidatable
*/
interface XValidator : com::sun::star::uno::XInterface
{
/** determines whether the given value is valid
@param aValue
the value to check for validity
@return
<TRUE/> if and only if the value is considered valid.
*/
boolean isValid( [in] any Value );
/** retrieves a justification for the invalidity of the given value
@param aValue
the value which has been recognized as being invalid
@return
a human-readable string, which explains why the given value is considered invalid.
*/
string explainInvalid( [in] any Value );
/** registers the given validity listener.
<p>Usually, an XValidatable instance will also add itself as validity listener,
as soon as the validator is introduced to it.</p>
<p>Implementations which do not support dynamic validity constraints should simply ignore this
call.</p>
@throws <type scope="com::sun::star::lang">NullPointerException</type>
if the given listener is <NULL/>
@see XValidityConstraintListener
*/
void addValidityConstraintListener( [in] XValidityConstraintListener Listener )
raises( com::sun::star::lang::NullPointerException );
/** revokes the given validity listener
@throws <type scope="com::sun::star::lang">NullPointerException</type>
if the given listener is <NULL/>
@see XValidityConstraintListener
*/
void removeValidityConstraintListener( [in] XValidityConstraintListener Listener )
raises( com::sun::star::lang::NullPointerException );
};
}; }; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
