diff options
Diffstat (limited to 'offapi/com/sun/star/form/validation/XValidator.idl')
-rw-r--r-- | offapi/com/sun/star/form/validation/XValidator.idl | 93 |
1 files changed, 93 insertions, 0 deletions
diff --git a/offapi/com/sun/star/form/validation/XValidator.idl b/offapi/com/sun/star/form/validation/XValidator.idl new file mode 100644 index 000000000..bacca7703 --- /dev/null +++ b/offapi/com/sun/star/form/validation/XValidator.idl @@ -0,0 +1,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 Value + 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 Value + 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 com::sun::star::lang::NullPointerException + 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 com::sun::star::lang::NullPointerException + 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: */ |