eformshelper.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
 
#pragma once
 
#include "pcrcommon.hxx"
 
#include <com/sun/star/frame/XModel.hpp>
#include <com/sun/star/beans/XPropertySet.hpp>
#include <com/sun/star/xforms/XModel.hpp>
#include <com/sun/star/xforms/XFormsSupplier.hpp>
#include <com/sun/star/form/binding/XBindableValue.hpp>
#include <com/sun/star/form/binding/XListEntrySource.hpp>
#include <osl/mutex.hxx>
#include <rtl/ustring.hxx>
 
#include <vector>
#include <set>
#include <map>
 
 
namespace pcr
{
 
 
    typedef std::map< OUString, css::uno::Reference< css::beans::XPropertySet >, std::less< OUString > >
            MapStringToPropertySet;
 
 
    //= EFormsHelper
 
    class EFormsHelper
    {
    protected:
        css::uno::Reference< css::beans::XPropertySet >
                        m_xControlModel;
        css::uno::Reference< css::form::binding::XBindableValue >
                        m_xBindableControl;
        css::uno::Reference< css::xforms::XFormsSupplier >
                        m_xDocument;
        PropertyChangeListeners
                        m_aPropertyListeners;
        MapStringToPropertySet
                        m_aSubmissionUINames;   // only filled upon request
        MapStringToPropertySet
                        m_aBindingUINames;      // only filled upon request
 
    public:
        EFormsHelper(
            ::osl::Mutex& _rMutex,
            const css::uno::Reference< css::beans::XPropertySet >& _rxControlModel,
            const css::uno::Reference< css::frame::XModel >& _rxContextDocument
        );
 
        static  bool
                isEForm(
                    const css::uno::Reference< css::frame::XModel >& _rxContextDocument
                );
 
        void    registerBindingListener(
                    const css::uno::Reference< css::beans::XPropertyChangeListener >& _rxBindingListener
                );
 
        void    revokeBindingListener(
                    const css::uno::Reference< css::beans::XPropertyChangeListener >& _rxBindingListener
                );
 
        bool    canBindToDataType( sal_Int32 _nDataType = -1 ) const;
 
        bool    canBindToAnyDataType() const { return canBindToDataType(); }
 
        bool    isListEntrySink() const;
 
        void    getFormModelNames( std::vector< OUString >& /* [out] */ _rModelNames ) const;
 
        void    getBindingNames( const OUString& _rModelName, std::vector< OUString >& /* [out] */ _rBindingNames ) const;
 
        css::uno::Reference< css::xforms::XModel >
                getFormModelByName( const OUString& _rModelName ) const;
 
        css::uno::Reference< css::xforms::XModel >
                getCurrentFormModel() const;
 
        OUString
                getCurrentFormModelName() const;
 
        css::uno::Reference< css::beans::XPropertySet >
                getCurrentBinding() const;
 
        OUString
                getCurrentBindingName() const;
 
        void    setBinding( const css::uno::Reference< css::beans::XPropertySet >& _rxBinding );
 
        css::uno::Reference< css::form::binding::XListEntrySource >
                getCurrentListSourceBinding() const;
 
        void    setListSourceBinding( const css::uno::Reference< css::form::binding::XListEntrySource >& _rxListSource );
 
        css::uno::Reference< css::beans::XPropertySet >
            getOrCreateBindingForModel( const OUString& _rTargetModel, const OUString& _rBindingName ) const;
 
        enum ModelElementType
        {
            Submission,
            Binding
        };
 
        static OUString
                getModelElementUIName(
                    const ModelElementType _eType,
                    const css::uno::Reference< css::beans::XPropertySet >& _rxElement
                );
 
        css::uno::Reference< css::beans::XPropertySet >
                getModelElementFromUIName(
                    const ModelElementType _eType,
                    const OUString& _rUIName
                ) const;
 
        void    getAllElementUINames(
                    const ModelElementType _eType,
                    std::vector< OUString >& /* [out] */ _rElementNames,
                    bool _bPrepentEmptyEntry
                );
 
    protected:
        void    firePropertyChanges(
                    const css::uno::Reference< css::beans::XPropertySet >& _rxOldProps,
                    const css::uno::Reference< css::beans::XPropertySet >& _rxNewProps,
                    std::set< OUString >& _rFilter
                ) const;
 
        void    firePropertyChange(
                    const OUString& _rName,
                    const css::uno::Any& _rOldValue,
                    const css::uno::Any& _rNewValue
                ) const;
 
    private:
        void impl_switchBindingListening_throw( bool _bDoListening, const css::uno::Reference< css::beans::XPropertyChangeListener >& _rxListener );
 
        css::uno::Reference< css::beans::XPropertySet >
            implGetOrCreateBinding( const OUString& _rTargetModel, const OUString& _rBindingName ) const;
 
        void
            impl_toggleBindingPropertyListening_throw( bool _bDoListen, const css::uno::Reference< css::beans::XPropertyChangeListener >& _rxConcreteListenerOrNull );
 
    private:
        EFormsHelper( const EFormsHelper& ) = delete;
        EFormsHelper& operator=( const EFormsHelper& ) = delete;
    };
 
 
} // namespace pcr
 
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */