forms/source/component/Edit.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: Edit.hxx,v $
  10  * $Revision: 1.18 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef _FORMS_EDIT_HXX_
  32 #define _FORMS_EDIT_HXX_
  33
  34 #include "EditBase.hxx"
  35
  36 #include <cppuhelper/implbase3.hxx>
  37
  38 namespace dbtools { class FormattedColumnValue; }
  39
  40 //.........................................................................
  41 namespace frm
  42 {
  43
  44 //==================================================================
  45 //= OEditModel
  46 //==================================================================
  47 class OEditModel
  48                 :public OEditBaseModel
  49 {
  50     ::com::sun::star::uno::Any  m_aLastKnownValue;
  51     ::std::auto_ptr< ::dbtools::FormattedColumnValue >
  52                                 m_pValueFormatter;
  53     sal_Bool                                    m_bMaxTextLenModified : 1;      // set to <TRUE/> when we change the MaxTextLen of the aggregate
  54
  55     sal_Bool                                    m_bWritingFormattedFake : 1;
  56         // are we writing something which should be interpreted as formatted upon reading?
  57
  58 protected:
  59     virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type> _getTypes();
  60
  61     DECLARE_DEFAULT_LEAF_XTOR( OEditModel );
  62
  63     void enableFormattedWriteFake() { m_bWritingFormattedFake = sal_True; }
  64     void disableFormattedWriteFake() { m_bWritingFormattedFake = sal_False; }
  65     sal_Bool lastReadWasFormattedFake() const { return (getLastReadVersion() & PF_FAKE_FORMATTED_FIELD) != 0; }
  66
  67     friend InterfaceRef SAL_CALL OEditModel_CreateInstance(const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory>& _rxFactory);
  68     friend class OFormattedFieldWrapper;
  69     friend class OFormattedModel;       // temporary
  70
  71 public:
  72     virtual void SAL_CALL disposing();
  73
  74     // XPropertySet
  75     virtual void SAL_CALL getFastPropertyValue(::com::sun::star::uno::Any& rValue, sal_Int32 nHandle ) const;
  76
  77     // XPersistObject
  78     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);
  79     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);
  80     virtual ::rtl::OUString SAL_CALL getServiceName() throw ( ::com::sun::star::uno::RuntimeException);
  81
  82     // XPropertySet
  83     using OBoundControlModel::getFastPropertyValue;
  84
  85     // XReset
  86     virtual void SAL_CALL reset(  ) throw(::com::sun::star::uno::RuntimeException);
  87
  88     // XServiceInfo
  89     IMPLEMENTATION_NAME(OEditModel);
  90     virtual StringSequence SAL_CALL getSupportedServiceNames() throw();
  91
  92     // OControlModel's property handling
  93     virtual void describeFixedProperties(
  94         ::com::sun::star::uno::Sequence< ::com::sun::star::beans::Property >& /* [out] */ _rProps
  95     ) const;
  96     virtual void describeAggregateProperties(
  97         ::com::sun::star::uno::Sequence< ::com::sun::star::beans::Property >& /* [out] */ _rAggregateProps
  98     ) const;
  99
 100     // XEventListener
 101     using OBoundControlModel::disposing;
 102
 103 protected:
 104     // OControlModel overridables
 105     virtual void writeAggregate( const ::com::sun::star::uno::Reference< ::com::sun::star::io::XObjectOutputStream >& _rxOutStream ) const;
 106     virtual void readAggregate( const ::com::sun::star::uno::Reference< ::com::sun::star::io::XObjectInputStream >& _rxInStream );
 107
 108     // OBoundControlModel overridables
 109     virtual ::com::sun::star::uno::Any
 110                             translateDbColumnToControlValue( );
 111     virtual sal_Bool        commitControlValueToDbColumn( bool _bPostReset );
 112
 113     virtual ::com::sun::star::uno::Any
 114                             getDefaultForReset() const;
 115
 116     virtual void            onConnectedDbColumn( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& _rxForm );
 117     virtual void            onDisconnectedDbColumn();
 118
 119     virtual sal_Bool            approveDbColumnType( sal_Int32 _nColumnType );
 120
 121 protected:
 122     virtual sal_uInt16 getPersistenceFlags() const;
 123
 124     DECLARE_XCLONEABLE();
 125
 126 private:
 127     bool    implActsAsRichText( ) const;
 128 };
 129
 130 //==================================================================
 131 //= OEditControl
 132 //==================================================================
 133 typedef ::cppu::ImplHelper3<    ::com::sun::star::awt::XFocusListener,
 134                                 ::com::sun::star::awt::XKeyListener,
 135                                 ::com::sun::star::form::XChangeBroadcaster > OEditControl_BASE;
 136
 137 class OEditControl : public OBoundControl
 138                       ,public OEditControl_BASE
 139 {
 140     ::cppu::OInterfaceContainerHelper
 141                         m_aChangeListeners;
 142
 143     ::rtl::OUString                     m_aHtmlChangeValue;
 144     sal_uInt32                          m_nKeyEvent;
 145
 146 public:
 147     OEditControl(const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory>& _rxFactory);
 148     virtual ~OEditControl();
 149
 150     DECLARE_UNO3_AGG_DEFAULTS(OEditControl, OBoundControl);
 151     virtual ::com::sun::star::uno::Any SAL_CALL queryAggregation(const ::com::sun::star::uno::Type& _rType) throw(::com::sun::star::uno::RuntimeException);
 152
 153     virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type> _getTypes();
 154
 155 // OComponentHelper
 156     virtual void SAL_CALL disposing();
 157
 158 // ::com::sun::star::lang::XEventListener
 159     virtual void SAL_CALL disposing(const ::com::sun::star::lang::EventObject& _rSource) throw(::com::sun::star::uno::RuntimeException);
 160
 161 // ::com::sun::star::lang::XServiceInfo
 162     IMPLEMENTATION_NAME(OEditControl);
 163     virtual StringSequence SAL_CALL getSupportedServiceNames() throw();
 164
 165 // ::com::sun::star::form::XChangeBroadcaster
 166     virtual void SAL_CALL addChangeListener(const ::com::sun::star::uno::Reference< ::com::sun::star::form::XChangeListener>& _rxListener) throw ( ::com::sun::star::uno::RuntimeException);
 167     virtual void SAL_CALL removeChangeListener(const ::com::sun::star::uno::Reference< ::com::sun::star::form::XChangeListener>& _rxListener) throw ( ::com::sun::star::uno::RuntimeException);
 168
 169 // ::com::sun::star::awt::XFocusListener
 170     virtual void SAL_CALL focusGained( const ::com::sun::star::awt::FocusEvent& e ) throw ( ::com::sun::star::uno::RuntimeException);
 171     virtual void SAL_CALL focusLost( const ::com::sun::star::awt::FocusEvent& e ) throw ( ::com::sun::star::uno::RuntimeException);
 172
 173 // ::com::sun::star::awt::XKeyListener
 174     virtual void SAL_CALL keyPressed(const ::com::sun::star::awt::KeyEvent& e) throw ( ::com::sun::star::uno::RuntimeException);
 175     virtual void SAL_CALL keyReleased(const ::com::sun::star::awt::KeyEvent& e) throw ( ::com::sun::star::uno::RuntimeException);
 176
 177     // XControl
 178     virtual void SAL_CALL createPeer( const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XToolkit >& _rxToolkit, const ::com::sun::star::uno::Reference< ::com::sun::star::awt::XWindowPeer >& _rxParent ) throw ( ::com::sun::star::uno::RuntimeException );
 179
 180 private:
 181     DECL_LINK( OnKeyPressed, void* );
 182 };
 183
 184 //.........................................................................
 185 }
 186 //.........................................................................
 187
 188 #endif // _FORMS_EDIT_HXX_
 189