Line data    Source code

       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             : #ifndef INCLUDED_FORMS_SOURCE_COMPONENT_EDITBASE_HXX
      21             : #define INCLUDED_FORMS_SOURCE_COMPONENT_EDITBASE_HXX
      22             : 
      23             : #include "FormComponent.hxx"
      24             : #include <com/sun/star/util/XNumberFormatter.hpp>
      25             : #include <com/sun/star/awt/XFocusListener.hpp>
      26             : #include <com/sun/star/awt/XKeyListener.hpp>
      27             : #include <com/sun/star/form/XChangeBroadcaster.hpp>
      28             : #include <com/sun/star/lang/XEventListener.hpp>
      29             : #include <com/sun/star/lang/XServiceInfo.hpp>
      30             : #include <com/sun/star/lang/XComponent.hpp>
      31             : 
      32             : // persistence flags for use with the version id
      33             : #define PF_HANDLE_COMMON_PROPS  0x8000
      34             :     // Derived classes which use their own persistence methods (read/write) and have an own
      35             :     // version handling therein may want to clear this flag in getPersistenceFlags.
      36             :     // If done so, this class will write an version without a call to writeCommonEditProperties.
      37             : #define PF_FAKE_FORMATTED_FIELD 0x4000
      38             :     // .... hmmm .... a fake, as the name suggests. see OFormattedFieldWrapper
      39             : 
      40             : #define PF_SPECIAL_FLAGS        0xFF00
      41             : 
      42             : 
      43             : namespace frm
      44             : {
      45             : 
      46             : class OEditBaseModel :  public OBoundControlModel
      47             : {
      48             :     sal_Int16                   m_nLastReadVersion;
      49             : 
      50             : protected:
      51             : // [properties]         for all EditingFields
      52             :     ::com::sun::star::uno::Any  m_aDefault;
      53             :     OUString                m_aDefaultText;             // default value
      54             :     bool                    m_bEmptyIsNull : 1;         // empty string will be interepreted as NULL when committing
      55             :     bool                    m_bFilterProposal : 1;      // use a list of possible value in filtermode
      56             : // [properties]
      57             : 
      58           1 :     sal_Int16   getLastReadVersion() const { return m_nLastReadVersion; }
      59             : 
      60             : public:
      61             :     DECLARE_DEFAULT_BOUND_XTOR( OEditBaseModel );
      62             : 
      63             :     // XPersistObject
      64             :     virtual void SAL_CALL write(const ::com::sun::star::uno::Reference< ::com::sun::star::io::XObjectOutputStream>& _rxOutStream) throw ( ::com::sun::star::io::IOException, ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
      65             :     virtual void SAL_CALL read(const ::com::sun::star::uno::Reference< ::com::sun::star::io::XObjectInputStream>& _rxInStream) throw ( ::com::sun::star::io::IOException, ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
      66             : 
      67             :     // XPropertySet
      68             :     virtual void SAL_CALL getFastPropertyValue(::com::sun::star::uno::Any& rValue, sal_Int32 nHandle ) const SAL_OVERRIDE;
      69             :     virtual sal_Bool SAL_CALL convertFastPropertyValue(::com::sun::star::uno::Any& rConvertedValue, ::com::sun::star::uno::Any& rOldValue,
      70             :                                           sal_Int32 nHandle, const ::com::sun::star::uno::Any& rValue )
      71             :                                         throw(::com::sun::star::lang::IllegalArgumentException) SAL_OVERRIDE;
      72             :     virtual void SAL_CALL setFastPropertyValue_NoBroadcast(sal_Int32 nHandle, const ::com::sun::star::uno::Any& rValue) throw ( ::com::sun::star::uno::Exception, std::exception) SAL_OVERRIDE;
      73             :     using ::cppu::OPropertySetHelper::getFastPropertyValue;
      74             : 
      75             :     // XPropertyState
      76             :     virtual ::com::sun::star::uno::Any getPropertyDefaultByHandle( sal_Int32 nHandle ) const SAL_OVERRIDE;
      77             : 
      78             : protected:
      79             :     // new properties common to all edit models should be handled with the following two methods
      80             :     void SAL_CALL readCommonEditProperties(const ::com::sun::star::uno::Reference< ::com::sun::star::io::XObjectInputStream>& _rxInStream);
      81             :     void SAL_CALL writeCommonEditProperties(const ::com::sun::star::uno::Reference< ::com::sun::star::io::XObjectOutputStream>& _rxOutStream);
      82             :     void defaultCommonEditProperties();
      83             : 
      84             :     virtual sal_uInt16 getPersistenceFlags() const;
      85             :     // derived classes may use this if they want this base class to write additional version flags
      86             :     // (one of the PF_.... constants). After ::read they may ask for that flags with getLastReadVersion
      87             : };
      88             : 
      89             : 
      90             : }
      91             : 
      92             : 
      93             : #endif // INCLUDED_FORMS_SOURCE_COMPONENT_EDITBASE_HXX
      94             : 
      95             : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */