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 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XValidatable.idl,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_form_validation_XValidatable_idl__
  32 #define __com_sun_star_form_validation_XValidatable_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_util_VetoException_idl__
  39 #include <com/sun/star/util/VetoException.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44 module com {  module sun {  module star {  module form { module validation {
  45
  46 interface XValidator;
  47
  48 //=============================================================================
  49
  50 /** specifies support for validating a component
  51
  52     @see XValidator
  53 */
  54 interface XValidatable : com::sun::star::uno::XInterface
  55 {
  56     /** sets an external instance which is able to validate the component
  57
  58         <p>Any previously active validator will be revoked - there can be only one!</p>
  59
  60         @param Validator
  61             the new validator which is to be used by the component. May be <NULL/>,
  62             in this case only the current validator is revoked.
  63
  64         @throws <type scope="com::sun::star::util">VetoException</type>
  65             if changing the validator is not allowed in the current component state
  66      */
  67     void    setValidator( [in] XValidator Validator )
  68                 raises ( com::sun::star::util::VetoException );
  69
  70     /** retrieves the external instance which is currently used to validate the component
  71     */
  72     XValidator
  73             getValidator( );
  74 };
  75
  76 //=============================================================================
  77
  78 }; }; }; }; };
  79
  80 #endif