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

   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
  28 #ifndef __com_sun_star_form_validation_XValidatable_idl__
  29 #define __com_sun_star_form_validation_XValidatable_idl__
  30
  31 #ifndef __com_sun_star_uno_XInterface_idl__
  32 #include <com/sun/star/uno/XInterface.idl>
  33 #endif
  34
  35 #ifndef __com_sun_star_util_VetoException_idl__
  36 #include <com/sun/star/util/VetoException.idl>
  37 #endif
  38
  39 //=============================================================================
  40
  41 module com {  module sun {  module star {  module form { module validation {
  42
  43 interface XValidator;
  44
  45 //=============================================================================
  46
  47 /** specifies support for validating a component
  48
  49     @see XValidator
  50 */
  51 interface XValidatable : com::sun::star::uno::XInterface
  52 {
  53     /** sets an external instance which is able to validate the component
  54
  55         <p>Any previously active validator will be revoked - there can be only one!</p>
  56
  57         @param Validator
  58             the new validator which is to be used by the component. May be <NULL/>,
  59             in this case only the current validator is revoked.
  60
  61         @throws <type scope="com::sun::star::util">VetoException</type>
  62             if changing the validator is not allowed in the current component state
  63      */
  64     void    setValidator( [in] XValidator Validator )
  65                 raises ( com::sun::star::util::VetoException );
  66
  67     /** retrieves the external instance which is currently used to validate the component
  68     */
  69     XValidator
  70             getValidator( );
  71 };
  72
  73 //=============================================================================
  74
  75 }; }; }; }; };
  76
  77 #endif