xref: /trunk/main/forms/source/component/EditBase.hxx (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
1 /*************************************************************************
2  *
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * Copyright 2000, 2010 Oracle and/or its affiliates.
6  *
7  * OpenOffice.org - a multi-platform office productivity suite
8  *
9  * This file is part of OpenOffice.org.
10  *
11  * OpenOffice.org is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser General Public License version 3
13  * only, as published by the Free Software Foundation.
14  *
15  * OpenOffice.org is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU Lesser General Public License version 3 for more details
19  * (a copy is included in the LICENSE file that accompanied this code).
20  *
21  * You should have received a copy of the GNU Lesser General Public License
22  * version 3 along with OpenOffice.org.  If not, see
23  * <http://www.openoffice.org/license.html>
24  * for a copy of the LGPLv3 License.
25  *
26  ************************************************************************/
27 
28 #ifndef _FORMS_EDITBASE_HXX_
29 #define _FORMS_EDITBASE_HXX_
30 
31 #include "FormComponent.hxx"
32 #include <tools/date.hxx>
33 #include <tools/link.hxx>
34 #include <com/sun/star/util/XNumberFormatter.hpp>
35 #include <com/sun/star/awt/XFocusListener.hpp>
36 #include <com/sun/star/awt/XKeyListener.hpp>
37 #include <com/sun/star/form/XChangeBroadcaster.hpp>
38 #include <com/sun/star/lang/XEventListener.hpp>
39 #include <com/sun/star/lang/XServiceInfo.hpp>
40 #include <com/sun/star/lang/XComponent.hpp>
41 
42 // persistence flags for use with the version id
43 #define PF_HANDLE_COMMON_PROPS  0x8000
44     // Derived classes which use their own persistence methods (read/write) and have an own
45     // version handling therein may want to clear this flag in getPersistenceFlags.
46     // If done so, this class will write an version without a call to writeCommonEditProperties.
47 #define PF_FAKE_FORMATTED_FIELD 0x4000
48     // .... hmmm .... a fake, as the name suggests. see OFormattedFieldWrapper
49 #define PF_RESERVED_2           0x2000
50 #define PF_RESERVED_3           0x1000
51 #define PF_RESERVED_4           0x0800
52 #define PF_RESERVED_5           0x0400
53 #define PF_RESERVED_6           0x0200
54 #define PF_RESERVED_7           0x0100
55 
56 #define PF_SPECIAL_FLAGS        0xFF00
57 
58 //.........................................................................
59 namespace frm
60 {
61 
62 //==================================================================
63 //= OEditBaseModel
64 //==================================================================
65 class OEditBaseModel :  public OBoundControlModel
66 {
67     sal_Int16                   m_nLastReadVersion;
68 
69 protected:
70 // [properties]         fuer all Editierfelder
71     ::com::sun::star::uno::Any  m_aDefault;
72     ::rtl::OUString             m_aDefaultText;             // default value
73     sal_Bool                    m_bEmptyIsNull : 1;         // empty string will be interepreted as NULL when committing
74     sal_Bool                    m_bFilterProposal : 1;      // use a list of possible value in filtermode
75 // [properties]
76 
77     sal_Int16   getLastReadVersion() const { return m_nLastReadVersion; }
78 
79 public:
80     DECLARE_DEFAULT_BOUND_XTOR( OEditBaseModel );
81 
82     // XPersistObject
83     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);
84     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);
85 
86     // XPropertySet
87     virtual void SAL_CALL getFastPropertyValue(::com::sun::star::uno::Any& rValue, sal_Int32 nHandle ) const;
88     virtual sal_Bool SAL_CALL convertFastPropertyValue(::com::sun::star::uno::Any& rConvertedValue, ::com::sun::star::uno::Any& rOldValue,
89                                           sal_Int32 nHandle, const ::com::sun::star::uno::Any& rValue )
90                                         throw(::com::sun::star::lang::IllegalArgumentException);
91     virtual void SAL_CALL setFastPropertyValue_NoBroadcast(sal_Int32 nHandle, const ::com::sun::star::uno::Any& rValue) throw ( ::com::sun::star::uno::Exception);
92     using ::cppu::OPropertySetHelper::getFastPropertyValue;
93 
94     // XPropertyState
95     virtual ::com::sun::star::uno::Any getPropertyDefaultByHandle( sal_Int32 nHandle ) const;
96 
97 protected:
98     // new properties common to all edit models should be handled with the following two methods
99     void SAL_CALL readCommonEditProperties(const ::com::sun::star::uno::Reference< ::com::sun::star::io::XObjectInputStream>& _rxInStream);
100     void SAL_CALL writeCommonEditProperties(const ::com::sun::star::uno::Reference< ::com::sun::star::io::XObjectOutputStream>& _rxOutStream);
101     void defaultCommonEditProperties();
102 
103     virtual sal_uInt16 getPersistenceFlags() const;
104         // derived classes may use this if they want this base class to write additinal version flags
105         // (one of the PF_.... constants). After ::read they may ask for that flags with getLastReadVersion
106 };
107 
108 //.........................................................................
109 }
110 //.........................................................................
111 
112 #endif // _FORMS_EDITBASE_HXX_
113 
114