forms/source/component/EditBase.hxx

   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 _FORMS_EDITBASE_HXX_
  21 #define _FORMS_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 #define PF_RESERVED_2           0x2000
  40 #define PF_RESERVED_3           0x1000
  41 #define PF_RESERVED_4           0x0800
  42 #define PF_RESERVED_5           0x0400
  43 #define PF_RESERVED_6           0x0200
  44 #define PF_RESERVED_7           0x0100
  45
  46 #define PF_SPECIAL_FLAGS        0xFF00
  47
  48 //.........................................................................
  49 namespace frm
  50 {
  51
  52 //==================================================================
  53 //= OEditBaseModel
  54 //==================================================================
  55 class OEditBaseModel :  public OBoundControlModel
  56 {
  57     sal_Int16                   m_nLastReadVersion;
  58
  59 protected:
  60 // [properties]         for all EditingFields
  61     ::com::sun::star::uno::Any  m_aDefault;
  62     OUString             m_aDefaultText;             // default value
  63     sal_Bool                    m_bEmptyIsNull : 1;         // empty string will be interepreted as NULL when committing
  64     sal_Bool                    m_bFilterProposal : 1;      // use a list of possible value in filtermode
  65 // [properties]
  66
  67     sal_Int16   getLastReadVersion() const { return m_nLastReadVersion; }
  68
  69 public:
  70     DECLARE_DEFAULT_BOUND_XTOR( OEditBaseModel );
  71
  72     // XPersistObject
  73     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);
  74     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);
  75
  76     // XPropertySet
  77     virtual void SAL_CALL getFastPropertyValue(::com::sun::star::uno::Any& rValue, sal_Int32 nHandle ) const;
  78     virtual sal_Bool SAL_CALL convertFastPropertyValue(::com::sun::star::uno::Any& rConvertedValue, ::com::sun::star::uno::Any& rOldValue,
  79                                           sal_Int32 nHandle, const ::com::sun::star::uno::Any& rValue )
  80                                         throw(::com::sun::star::lang::IllegalArgumentException);
  81     virtual void SAL_CALL setFastPropertyValue_NoBroadcast(sal_Int32 nHandle, const ::com::sun::star::uno::Any& rValue) throw ( ::com::sun::star::uno::Exception);
  82     using ::cppu::OPropertySetHelper::getFastPropertyValue;
  83
  84     // XPropertyState
  85     virtual ::com::sun::star::uno::Any getPropertyDefaultByHandle( sal_Int32 nHandle ) const;
  86
  87 protected:
  88     // new properties common to all edit models should be handled with the following two methods
  89     void SAL_CALL readCommonEditProperties(const ::com::sun::star::uno::Reference< ::com::sun::star::io::XObjectInputStream>& _rxInStream);
  90     void SAL_CALL writeCommonEditProperties(const ::com::sun::star::uno::Reference< ::com::sun::star::io::XObjectOutputStream>& _rxOutStream);
  91     void defaultCommonEditProperties();
  92
  93     virtual sal_uInt16 getPersistenceFlags() const;
  94         // derived classes may use this if they want this base class to write additional version flags
  95         // (one of the PF_.... constants). After ::read they may ask for that flags with getLastReadVersion
  96 };
  97
  98 //.........................................................................
  99 }
 100 //.........................................................................
 101
 102 #endif // _FORMS_EDITBASE_HXX_
 103
 104 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */