extensions/source/propctrlr/xsdvalidationhelper.hxx

   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: xsdvalidationhelper.hxx,v $
  10  * $Revision: 1.6 $
  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 EXTENSIONS_SOURCE_PROPCTRLR_XSDVALIDATIONHELPER_HXX
  32 #define EXTENSIONS_SOURCE_PROPCTRLR_XSDVALIDATIONHELPER_HXX
  33
  34 #include "eformshelper.hxx"
  35 #include "xsddatatypes.hxx"
  36
  37 /** === begin UNO includes === **/
  38 #include <com/sun/star/xsd/XDataType.hpp>
  39 #include <com/sun/star/beans/XPropertySet.hpp>
  40 /** === end UNO includes === **/
  41 #include <rtl/ref.hxx>
  42
  43 //........................................................................
  44 namespace pcr
  45 {
  46 //........................................................................
  47
  48     class XSDDataType;
  49     //====================================================================
  50     //= XSDValidationHelper
  51     //====================================================================
  52     class XSDValidationHelper : public EFormsHelper
  53     {
  54     private:
  55         bool    m_bInspectingFormattedField;
  56     public:
  57         bool    isInspectingFormattedField() const { return m_bInspectingFormattedField; }
  58
  59     public:
  60         XSDValidationHelper(
  61             ::osl::Mutex& _rMutex,
  62             const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxIntrospectee,
  63             const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel >& _rxContextDocument
  64         );
  65
  66         /** retrieves the names of all XForms models in the document the control lives in
  67         */
  68         void    getAvailableDataTypeNames( ::std::vector< ::rtl::OUString >& /* [out] */ _rNames ) const SAL_THROW(());
  69
  70         /** retrieves a particular data type given by name
  71         */
  72         ::rtl::Reference< XSDDataType >
  73                 getDataTypeByName( const ::rtl::OUString& _rName ) const SAL_THROW(());
  74
  75         /** retrieves the DataType instance which the control model is currently validated against
  76
  77             If there is a binding set at our control model, which at the same time acts as validator,
  78             and if this validator is bound to an XDataType, then this data type is retrieved here.
  79         */
  80         ::rtl::Reference< XSDDataType >
  81                 getValidatingDataType( ) const SAL_THROW(());
  82
  83         /** retrieves the name of the data type which the control model is currently validated against
  84
  85             @seealso getValidatingDataType
  86         */
  87         ::rtl::OUString
  88                 getValidatingDataTypeName( ) const SAL_THROW(());
  89
  90         /** binds the validator to a new data type
  91
  92             To be called with an active binding only.
  93         */
  94         void    setValidatingDataTypeByName( const ::rtl::OUString& _rName ) const SAL_THROW(());
  95
  96         /** removes the data type given by name from the data type repository
  97         */
  98         bool    removeDataTypeFromRepository( const ::rtl::OUString& _rName ) const SAL_THROW(());
  99
 100         /** creates a new data type, which is a clone of an existing data type
 101         */
 102         bool    cloneDataType( const ::rtl::Reference< XSDDataType >& _pDataType, const ::rtl::OUString& _rNewName ) const SAL_THROW(());
 103
 104         /** retrieves the name of the basic data type which has the given class
 105         */
 106         ::rtl::OUString
 107                 getBasicTypeNameForClass( sal_Int16 _eClass ) const SAL_THROW(());
 108
 109         /** copy a data type from one model to another
 110
 111             If a data type with the given name already exists in the target model, then nothing
 112             happens. In particular, the facets of the data type are not copied.
 113         */
 114         void    copyDataType( const ::rtl::OUString& _rFromModel, const ::rtl::OUString& _rToModel,
 115                     const ::rtl::OUString& _rDataTypeName ) const SAL_THROW(());
 116
 117         /** finds (and sets) a default format for the formatted field we're inspecting,
 118             according to the current data type the control value is evaluated against
 119         */
 120         void findDefaultFormatForIntrospectee() SAL_THROW(());
 121
 122     private:
 123         /** retrieves the data type repository associated with the current model
 124         */
 125         ::com::sun::star::uno::Reference< ::com::sun::star::xforms::XDataTypeRepository >
 126                 getDataTypeRepository() const SAL_THROW((::com::sun::star::uno::Exception));
 127
 128         /** retrieves the data type repository associated with any model
 129         */
 130         ::com::sun::star::uno::Reference< ::com::sun::star::xforms::XDataTypeRepository >
 131                 getDataTypeRepository( const ::rtl::OUString& _rModelName ) const SAL_THROW((::com::sun::star::uno::Exception));
 132
 133         /** retrieves the data type object for the given name
 134         */
 135         ::com::sun::star::uno::Reference< ::com::sun::star::xsd::XDataType >
 136             getDataType( const ::rtl::OUString& _rName ) const
 137                 SAL_THROW((::com::sun::star::uno::Exception));
 138
 139         /** retrieves the name of the basic data type which has the given class, in the given repository
 140         */
 141         ::rtl::OUString
 142                 getBasicTypeNameForClass(
 143                     sal_Int16 _nClass,
 144                     ::com::sun::star::uno::Reference< ::com::sun::star::xforms::XDataTypeRepository > _rxRepository
 145                 ) const SAL_THROW(());
 146     };
 147
 148 //........................................................................
 149 } // namespace pcr
 150 //........................................................................
 151
 152 #endif // EXTENSIONS_SOURCE_PROPCTRLR_XSDVALIDATIONHELPER_HXX
 153