extensions/source/propctrlr/xsdvalidationhelper.hxx

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