entrylisthelper.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 <com/sun/star/form/binding/XListEntrySink.hpp>
#include <com/sun/star/util/XRefreshable.hpp>
#include <com/sun/star/form/binding/XListEntryListener.hpp>
 
#include <cppuhelper/implbase3.hxx>
#include <comphelper/interfacecontainer3.hxx>
 
 
namespace frm
{
 
 
    class OControlModel;
    class ControlModelLock;
 
 
    //= OEntryListHelper
 
    typedef ::cppu::ImplHelper3 <   css::form::binding::XListEntrySink
                                ,   css::form::binding::XListEntryListener
                                ,   css::util::XRefreshable
                                >   OEntryListHelper_BASE;
 
    class OEntryListHelper : public OEntryListHelper_BASE
    {
    private:
        OControlModel&  m_rControlModel;
 
        css::uno::Reference< css::form::binding::XListEntrySource >
                        m_xListSource;      
        std::vector< OUString >
                        m_aStringItems;     
        css::uno::Sequence< css::uno::Any >
                        m_aTypedItems;      
        ::comphelper::OInterfaceContainerHelper3<css::util::XRefreshListener>
                        m_aRefreshListeners;
 
 
    protected:
        explicit OEntryListHelper( OControlModel& _rControlModel );
        OEntryListHelper( const OEntryListHelper& _rSource, OControlModel& _rControlModel );
        virtual ~OEntryListHelper( );
 
        const std::vector< OUString >&
                    getStringItemList() const { return m_aStringItems; }
 
        const css::uno::Sequence< css::uno::Any >&
                    getTypedItemList() const { return m_aTypedItems; }
 
        bool hasExternalListSource( ) const { return m_xListSource.is(); }
 
        bool        handleDisposing( const css::lang::EventObject& _rEvent );
 
        void        disposing( );
 
        // prevent method hiding
        virtual void SAL_CALL disposing( const css::lang::EventObject& Source ) override = 0;
 
        bool    convertNewListSourceProperty(
                        css::uno::Any& _rConvertedValue,
                        css::uno::Any& _rOldValue,
                        const css::uno::Any& _rValue
                    );
 
        void        setNewStringItemList( const css::uno::Any& _rValue, ControlModelLock& _rInstanceLock );
 
        void        setNewTypedItemList( const css::uno::Any& _rValue, ControlModelLock& _rInstanceLock );
 
        virtual void    stringItemListChanged( ControlModelLock& _rInstanceLock ) = 0;
 
        virtual void    refreshInternalEntryList() = 0;
 
    private:
        // XListEntrySink
        virtual void SAL_CALL setListEntrySource( const css::uno::Reference< css::form::binding::XListEntrySource >& _rxSource ) override;
        virtual css::uno::Reference< css::form::binding::XListEntrySource > SAL_CALL getListEntrySource(  ) override;
 
        // XListEntryListener
        virtual void SAL_CALL entryChanged( const css::form::binding::ListEntryEvent& _rSource ) override;
        virtual void SAL_CALL entryRangeInserted( const css::form::binding::ListEntryEvent& _rSource ) override;
        virtual void SAL_CALL entryRangeRemoved( const css::form::binding::ListEntryEvent& _rSource ) override;
        virtual void SAL_CALL allEntriesChanged( const css::lang::EventObject& _rSource ) override;
 
        // XRefreshable
        virtual void SAL_CALL refresh() override;
        virtual void SAL_CALL addRefreshListener(const css::uno::Reference< css::util::XRefreshListener>& _rxListener) override;
        virtual void SAL_CALL removeRefreshListener(const css::uno::Reference< css::util::XRefreshListener>& _rxListener) override;
 
    private:
        void        disconnectExternalListSource( );
 
        void        connectExternalListSource(
                        const css::uno::Reference< css::form::binding::XListEntrySource >& _rxSource,
                        ControlModelLock& _rInstanceLock
                    );
 
        void        obtainListSourceEntries( ControlModelLock& _rInstanceLock );
 
        void        impl_lock_refreshList( ControlModelLock& _rInstanceLock );
 
    private:
        OEntryListHelper( const OEntryListHelper& ) = delete;
        OEntryListHelper& operator=( const OEntryListHelper& ) = delete;
    };
 
 
}   // namespace frm
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */