fmvwimp.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 .
 */
#ifndef INCLUDED_SVX_SOURCE_INC_FMVWIMP_HXX
#define INCLUDED_SVX_SOURCE_INC_FMVWIMP_HXX
 
#include <sal/config.h>
 
#include <map>
#include <memory>
#include <set>
#include <string_view>
 
#include <svx/svdmark.hxx>
#include <svx/svdobj.hxx>
#include "fmdocumentclassification.hxx"
 
#include <com/sun/star/form/XForm.hpp>
#include <com/sun/star/container/XIndexAccess.hpp>
#include <com/sun/star/form/runtime/XFormController.hpp>
#include <com/sun/star/form/runtime/XFormControllerContext.hpp>
#include <com/sun/star/container/XContainerListener.hpp>
#include <com/sun/star/container/ContainerEvent.hpp>
#include <com/sun/star/awt/XFocusListener.hpp>
#include <com/sun/star/sdb/SQLErrorEvent.hpp>
#include <com/sun/star/sdbc/XDataSource.hpp>
#include <com/sun/star/uno/XComponentContext.hpp>
 
#include <tools/link.hxx>
#include <cppuhelper/implbase.hxx>
#include <rtl/ref.hxx>
#include <vcl/vclptr.hxx>
 
class SdrPageWindow;
 
class SdrObject;
class FmFormObj;
class FmFormModel;
class FmFormView;
class FmFormShell;
namespace vcl { class Window; }
class OutputDevice;
class SdrUnoObj;
struct ImplSVEvent;
enum class SdrInventor : sal_uInt32;
 
namespace com::sun::star {
    namespace awt {
        class XControl;
        class XWindow;
    }
    namespace beans {
        class XPropertySet;
    }
    namespace util {
        class XNumberFormats;
    }
}
 
class FmXFormView;
 
namespace svx {
    class ODataAccessDescriptor;
    struct OXFormsDescriptor;
}
 
 
// FormViewPageWindowAdapter
 
typedef ::cppu::WeakImplHelper <   css::container::XIndexAccess
                                ,   css::form::runtime::XFormControllerContext
                                >   FormViewPageWindowAdapter_Base;
 
class FormViewPageWindowAdapter final : public FormViewPageWindowAdapter_Base
{
    friend class FmXFormView;
 
    ::std::vector< css::uno::Reference< css::form::runtime::XFormController > >   m_aControllerList;
    css::uno::Reference< css::awt::XControlContainer >                            m_xControlContainer;
    css::uno::Reference<css::uno::XComponentContext>                              m_xContext;
    FmXFormView*                m_pViewImpl;
    VclPtr<vcl::Window>         m_pWindow;
 
public:
    FormViewPageWindowAdapter(  css::uno::Reference<css::uno::XComponentContext> _xContext,
        const SdrPageWindow&, FmXFormView* pView);
        //const SdrPageViewWinRec*, FmXFormView* pView);
 
    // XElementAccess
    virtual css::uno::Type SAL_CALL getElementType() override;
    virtual sal_Bool SAL_CALL hasElements() override;
 
    // XIndexAccess
    virtual sal_Int32 SAL_CALL getCount() override;
    virtual css::uno::Any SAL_CALL getByIndex(sal_Int32 Index) override;
 
    // XFormControllerContext
    virtual void SAL_CALL makeVisible( const css::uno::Reference< css::awt::XControl >& Control ) override;
 
    const ::std::vector< css::uno::Reference< css::form::runtime::XFormController > >& GetList() const {return m_aControllerList;}
 
private:
    virtual ~FormViewPageWindowAdapter() override;
 
    css::uno::Reference< css::form::runtime::XFormController >  getController( const css::uno::Reference< css::form::XForm >& xForm ) const;
    void setController(
            const css::uno::Reference< css::form::XForm >& xForm,
            const css::uno::Reference< css::form::runtime::XFormController >& _rxParentController );
    const css::uno::Reference< css::awt::XControlContainer >&  getControlContainer() const { return m_xControlContainer; }
    void updateTabOrder( const css::uno::Reference< css::form::XForm >& _rxForm );
    void dispose();
    vcl::Window* getWindow() const {return m_pWindow;}
};
 
class SdrModel;
 
class FmXFormView final : public ::cppu::WeakImplHelper<
                            css::form::XFormControllerListener,
                            css::awt::XFocusListener,
                            css::container::XContainerListener>
{
    friend class FmFormView;
    friend class FmFormShell;
    friend class FmXFormShell;
    friend class FormViewPageWindowAdapter;
    class ObjectRemoveListener;
    friend class ObjectRemoveListener;
 
    css::uno::Reference< css::awt::XWindow>                   m_xWindow;
    css::uno::Reference< css::beans::XPropertySet >           m_xLastCreatedControlModel;
 
    FmFormObj*      m_pMarkedGrid;
    FmFormView*     m_pView;
    ImplSVEvent *   m_nActivationEvent;
    ImplSVEvent *   m_nErrorMessageEvent;   // event for an asynchronous error message. See also m_aAsyncError
    ImplSVEvent *   m_nAutoFocusEvent;      // event for asynchronously setting the focus to a control
    ImplSVEvent *   m_nControlWizardEvent;  // event for asynchronously setting the focus to a control
 
    css::sdb::SQLErrorEvent
                    m_aAsyncError;          // error event which is to be displayed asyn. See m_nErrorMessageEvent.
 
    std::vector< rtl::Reference< FormViewPageWindowAdapter > >
                    m_aPageWindowAdapters;  // to be filled in alive mode only
    typedef ::std::set< css::uno::Reference< css::form::XForm > > SetOfForms;
    std::map< css::uno::Reference< css::awt::XControlContainer >, SetOfForms >
                    m_aNeedTabOrderUpdate; // map control container to set of forms
 
    // list of selected objects, used for restoration when switching from Alive to DesignMode
    SdrMarkList             m_aMark;
    std::unique_ptr<ObjectRemoveListener>
                    m_pWatchStoredList;
 
    bool            m_bFirstActivation;
    bool            m_isTabOrderUpdateSuspended;
 
    FmFormShell* GetFormShell() const;
 
    css::uno::Reference<css::awt::XWindow> GetParentWindow() const;
 
    FmXFormView( FmFormView* _pView );
    virtual ~FmXFormView() override;
 
    void    saveMarkList();
    void    restoreMarkList( SdrMarkList& _rRestoredMarkList );
    void    stopMarkListWatching();
    void    startMarkListWatching();
 
    void    notifyViewDying( );
        // notifies this impl class that the anti-impl instance (m_pView) is going to die
 
public:
    // UNO binding
 
// css::lang::XEventListener
    virtual void SAL_CALL disposing(const css::lang::EventObject& Source) override;
 
// css::container::XContainerListener
    virtual void SAL_CALL elementInserted(const  css::container::ContainerEvent& rEvent) override;
    virtual void SAL_CALL elementReplaced(const  css::container::ContainerEvent& rEvent) override;
    virtual void SAL_CALL elementRemoved(const  css::container::ContainerEvent& rEvent) override;
 
// css::form::XFormControllerListener
    virtual void SAL_CALL formActivated(const css::lang::EventObject& rEvent) override;
    virtual void SAL_CALL formDeactivated(const css::lang::EventObject& rEvent) override;
 
    // XFocusListener
    virtual void SAL_CALL focusGained( const css::awt::FocusEvent& e ) override;
    virtual void SAL_CALL focusLost( const css::awt::FocusEvent& e ) override;
 
    FmFormView* getView() const {return m_pView;}
    rtl::Reference< FormViewPageWindowAdapter >  findWindow( const css::uno::Reference< css::awt::XControlContainer >& _rxCC ) const;
 
    css::uno::Reference< css::form::runtime::XFormController >
            getFormController( const css::uno::Reference< css::form::XForm >& _rxForm, const OutputDevice& _rDevice ) const;
 
    // activation handling
    bool        hasEverBeenActivated( ) const { return !m_bFirstActivation; }
    void        setHasBeenActivated( ) { m_bFirstActivation = false; }
 
            void        onFirstViewActivation( const FmFormModel* _pDocModel );
 
    void    suspendTabOrderUpdate();
 
    void    resumeTabOrderUpdate();
 
    void    onCreatedFormObject( FmFormObj const & _rFormObject );
 
    void    breakCreateFormObject();
 
    static bool
            isFocusable( const css::uno::Reference< css::awt::XControl >& i_rControl );
 
private:
    //void addWindow(const SdrPageViewWinRec*);
    void addWindow(const SdrPageWindow&);
    void removeWindow( const css::uno::Reference< css::awt::XControlContainer >& _rxCC );
    void Activate(bool bSync = false);
    void Deactivate(bool bDeactivateController = true);
 
    rtl::Reference<SdrObject> implCreateFieldControl( const svx::ODataAccessDescriptor& _rColumnDescriptor );
    rtl::Reference<SdrObject> implCreateXFormsControl( const svx::OXFormsDescriptor &_rDesc );
 
    static bool createControlLabelPair(
        OutputDevice const & _rOutDev,
        sal_Int32 _nXOffsetMM,
        sal_Int32 _nYOffsetMM,
        const css::uno::Reference< css::beans::XPropertySet >& _rxField,
        const css::uno::Reference< css::util::XNumberFormats >& _rxNumberFormats,
        SdrObjKind _nControlObjectID,
        std::u16string_view _rFieldPostfix,
        SdrInventor _nInventor,
        SdrObjKind _nLabelObjectID,
 
        // tdf#118963 Need a SdrModel for SdrObject creation. To make the
        // demand clear, hand over a SdrMldel&
        SdrModel& _rModel,
 
        rtl::Reference<SdrUnoObj>& _rpLabel,
        rtl::Reference<SdrUnoObj>& _rpControl
    );
 
    bool    createControlLabelPair(
        OutputDevice const & _rOutDev,
        sal_Int32 _nXOffsetMM,
        sal_Int32 _nYOffsetMM,
        const css::uno::Reference< css::beans::XPropertySet >& _rxField,
        const css::uno::Reference< css::util::XNumberFormats >& _rxNumberFormats,
        SdrObjKind _nControlObjectID,
        std::u16string_view _rFieldPostfix,
        rtl::Reference<SdrUnoObj>& _rpLabel,
        rtl::Reference<SdrUnoObj>& _rpControl,
        const css::uno::Reference< css::sdbc::XDataSource >& _rxDataSource,
        const OUString& _rDataSourceName,
        const OUString& _rCommand,
        const sal_Int32 _nCommandType
    );
 
    void ObjectRemovedInAliveMode(const SdrObject* pObject);
 
    // asynchronously displays an error message. See also OnDelayedErrorMessage.
    void    displayAsyncErrorMessage( const css::sdb::SQLErrorEvent& _rEvent );
 
    // cancels all pending async events
    void cancelEvents();
 
    void AutoFocus();
    DECL_LINK( OnActivate, void*, void );
    DECL_LINK( OnAutoFocus, void*, void );
    DECL_LINK( OnDelayedErrorMessage, void*, void );
    DECL_LINK( OnStartControlWizard, void*, void );
 
private:
    ::svxform::DocumentType impl_getDocumentType() const;
};
 
 
#endif // INCLUDED_SVX_SOURCE_INC_FMVWIMP_HXX
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */