office-gobmx/forms/source/component/FormattedField.hxx

/* -*- 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 "EditBase.hxx"
#include <tools/link.hxx>
#include <cppuhelper/implbase1.hxx>
#include "errorbroadcaster.hxx"

#include <com/sun/star/util/XNumberFormatsSupplier.hpp>

struct ImplSVEvent;

namespace frm
{
class OFormattedModel final
                    :public OEditBaseModel
                    ,public OErrorBroadcaster
    {
        // the original, in case I faked the format properties of my aggregated model,
        // i.e. I just passed on the attributes of the field to which I am bound
        // (only valid if loaded)

        css::uno::Reference< css::util::XNumberFormatsSupplier>   m_xOriginalFormatter;
        css::util::Date        m_aNullDate;
        css::uno::Any          m_aSaveValue;

        sal_Int16                           m_nKeyType;
        bool                                m_bOriginalNumeric      : 1,
                                            m_bNumeric              : 1;    // analogous for the TreatAsNumeric-property

        css::uno::Reference< css::util::XNumberFormatsSupplier>  calcDefaultFormatsSupplier() const;
        css::uno::Reference< css::util::XNumberFormatsSupplier>  calcFormFormatsSupplier() const;
        css::uno::Reference< css::util::XNumberFormatsSupplier>  calcFormatsSupplier() const;

        OFormattedModel(
            const css::uno::Reference< css::uno::XComponentContext>& _rxFactory
        );
        OFormattedModel(
            const OFormattedModel* _pOriginal,
            const css::uno::Reference< css::uno::XComponentContext>& _rxFactory
        );
        virtual ~OFormattedModel() override;

        friend class OFormattedFieldWrapper;

    public:
        // XInterface
        DECLARE_UNO3_AGG_DEFAULTS( OFormattedModel, OEditBaseModel )

        // XTypeProvider
        virtual css::uno::Sequence< css::uno::Type> _getTypes() override;

        // XAggregation
        virtual css::uno::Any SAL_CALL queryAggregation(const css::uno::Type& _rType) override;

        // OComponentHelper
        virtual void SAL_CALL disposing() override;

        // XServiceInfo
        OUString SAL_CALL getImplementationName() override
        { return u"com.sun.star.form.OFormattedModel"_ustr; }

        virtual css::uno::Sequence<OUString> SAL_CALL getSupportedServiceNames() override;

        // XPersistObject
        virtual void SAL_CALL write(const css::uno::Reference< css::io::XObjectOutputStream>& _rxOutStream) override;
        virtual void SAL_CALL read(const css::uno::Reference< css::io::XObjectInputStream>& _rxInStream) override;
        virtual OUString SAL_CALL getServiceName() override;

        // XLoadListener
        virtual void SAL_CALL loaded(const css::lang::EventObject& rEvent) override;

        // XPropertyState
        void setPropertyToDefaultByHandle(sal_Int32 nHandle) override;
        css::uno::Any getPropertyDefaultByHandle(sal_Int32 nHandle) const override;

        void SAL_CALL setPropertyToDefault(const OUString& aPropertyName) override;
        css::uno::Any SAL_CALL getPropertyDefault( const OUString& aPropertyName ) override;

        // OControlModel's property handling
        virtual void describeFixedProperties(
            css::uno::Sequence< css::beans::Property >& /* [out] */ _rProps
        ) const override;
        virtual void describeAggregateProperties(
            css::uno::Sequence< css::beans::Property >& /* [out] */ _rAggregateProps
        ) const override;

        // XPropertyChangeListener
        virtual void _propertyChanged(const css::beans::PropertyChangeEvent& evt) override;

        // prevent method hiding
        using OEditBaseModel::disposing;
        using OEditBaseModel::getFastPropertyValue;

        virtual sal_uInt16 getPersistenceFlags() const override;
        // as we have an own version handling for persistence

        // OBoundControlModel overridables
        virtual css::uno::Any
                            translateDbColumnToControlValue( ) override;
        virtual bool        commitControlValueToDbColumn( bool _bPostReset ) override;

        virtual css::uno::Sequence< css::uno::Type >
                            getSupportedBindingTypes() override;
        virtual css::uno::Any
                            translateExternalValueToControlValue( const css::uno::Any& _rExternalValue ) const override;
        virtual css::uno::Any
                            translateControlValueToExternalValue( ) const override;
        virtual void onConnectedExternalValue( ) override;

        virtual css::uno::Any
                            getDefaultForReset() const override;
        virtual void        resetNoBroadcast() override;

        virtual void        onConnectedDbColumn( const css::uno::Reference< css::uno::XInterface >& _rxForm ) override;
        virtual void        onDisconnectedDbColumn() override;

        virtual css::uno::Reference< css::util::XCloneable > SAL_CALL createClone(  ) override;

        void implConstruct();

        void    updateFormatterNullDate();
    };

    typedef ::cppu::ImplHelper1< css::awt::XKeyListener> OFormattedControl_BASE;
    class OFormattedControl :    public OBoundControl
                                ,public OFormattedControl_BASE
    {
        ImplSVEvent * m_nKeyEvent;

    public:
        explicit OFormattedControl(const css::uno::Reference< css::uno::XComponentContext>& _rxContext);
        virtual ~OFormattedControl() override;

        DECLARE_UNO3_AGG_DEFAULTS(OFormattedControl, OBoundControl)
        virtual css::uno::Any SAL_CALL queryAggregation(const css::uno::Type& _rType) override;

        virtual css::uno::Sequence< css::uno::Type> _getTypes() override;

        // css::lang::XServiceInfo
        OUString SAL_CALL getImplementationName() override
        { return u"com.sun.star.form.OFormattedControl"_ustr; }

        virtual css::uno::Sequence<OUString> SAL_CALL getSupportedServiceNames() override;

        // css::lang::XEventListener
        virtual void SAL_CALL disposing(const css::lang::EventObject& _rSource) override;

        // css::awt::XKeyListener
        virtual void SAL_CALL keyPressed(const css::awt::KeyEvent& e) override;
        virtual void SAL_CALL keyReleased(const css::awt::KeyEvent& e) override;

        // css::awt::XControl
        using OBoundControl::setDesignMode;

        // disambiguation
        using OBoundControl::disposing;

    private:
        DECL_LINK( OnKeyPressed, void*, void );
    };
}

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */