offapi/com/sun/star/form/validation/XValidator.idl

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