INTEGRATION: CWS eforms2 (1.1.2); FILE ADDED

2004/08/09 15:17:45 fs 1.1.2.3: #i31958# UncheckedRefValue -> SecondaryRefValue
2004/06/24 09:55:13 fs 1.1.2.2: #i30674# allow second reference value for check boxes
2004/05/12 08:14:27 fs 1.1.2.1: #116712# base class for comonents supporting a reference value

1 files changed, 159 insertions, 0 deletions

diff --git a/forms/source/component/refvaluecomponent.hxx b/forms/source/component/refvaluecomponent.hxx
new file mode 100644
index 000000000000..062063244506
--- /dev/null
+++ b/forms/source/component/refvaluecomponent.hxx
@@ -0,0 +1,159 @@
+/*************************************************************************
+ *
+ *  $RCSfile: refvaluecomponent.hxx,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: obo $ $Date: 2004-11-16 10:42:28 $
+ *
+ *  The Contents of this file are made available subject to the terms of
+ *  either of the following licenses
+ *
+ *         - GNU Lesser General Public License Version 2.1
+ *         - Sun Industry Standards Source License Version 1.1
+ *
+ *  Sun Microsystems Inc., October, 2000
+ *
+ *  GNU Lesser General Public License Version 2.1
+ *  =============================================
+ *  Copyright 2000 by Sun Microsystems, Inc.
+ *  901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *  This library is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU Lesser General Public
+ *  License version 2.1, as published by the Free Software Foundation.
+ *
+ *  This library is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *  Lesser General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Lesser General Public
+ *  License along with this library; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *  MA  02111-1307  USA
+ *
+ *
+ *  Sun Industry Standards Source License Version 1.1
+ *  =================================================
+ *  The contents of this file are subject to the Sun Industry Standards
+ *  Source License Version 1.1 (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.openoffice.org/license.html.
+ *
+ *  Software provided under this License is provided on an "AS IS" basis,
+ *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+ *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ *  See the License for the specific provisions governing your rights and
+ *  obligations concerning the Software.
+ *
+ *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
+ *
+ *  Copyright: 2000 by Sun Microsystems, Inc.
+ *
+ *  All Rights Reserved.
+ *
+ *  Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+
+#ifndef EFORMS2_FORMS_SOURCE_COMPONENT_REFVALUECOMPONENT_HXX
+#define EFORMS2_FORMS_SOURCE_COMPONENT_REFVALUECOMPONENT_HXX
+
+#ifndef _FORMS_FORMCOMPONENT_HXX_
+#include "FormComponent.hxx"
+#endif
+
+/** === begin UNO includes === **/
+/** === end UNO includes === **/
+
+//........................................................................
+namespace frm
+{
+//........................................................................
+
+    enum { STATE_NOCHECK, STATE_CHECK, STATE_DONTKNOW };
+
+    //====================================================================
+    //= OReferenceValueComponent
+    //====================================================================
+    /** a OBoundControlModel which features the exchange of a reference value
+    */
+    class OReferenceValueComponent : public OBoundControlModel
+    {
+    private:
+        // <properties>
+        ::rtl::OUString     m_sReferenceValue;          // the reference value to use for data exchange
+        ::rtl::OUString     m_sNoCheckReferenceValue;   // the reference value to be exchanged when the control is not checked
+        sal_Int16           m_nDefaultChecked;          // the default check state
+        // </properties>
+
+        sal_Bool            m_bSupportSecondRefValue;       // do we support the SecondaryRefValue property?
+
+        /** type how we should transfer our selection to external value bindings
+        */
+        enum ValueExchangeType
+        {
+            eString,
+            eBoolean
+        };
+        ValueExchangeType   m_eValueExchangeType;
+
+    protected:
+        const ::rtl::OUString& getReferenceValue() const { return m_sReferenceValue; }
+        void                   setReferenceValue( const ::rtl::OUString& _rRefValue );
+
+        const ::rtl::OUString& getNoCheckReferenceValue() const { return m_sNoCheckReferenceValue; }
+        void                   setNoCheckReferenceValue( const ::rtl::OUString& _rNoCheckRefValue );
+
+        sal_Int16              getDefaultChecked() const { return m_nDefaultChecked; }
+        void                   setDefaultChecked( sal_Int16 _nChecked ) { m_nDefaultChecked = _nChecked; }
+
+    protected:
+        OReferenceValueComponent(
+            const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory>& _rxFactory,
+            const ::rtl::OUString& _rUnoControlModelTypeName,
+            const ::rtl::OUString& _rDefault,
+            sal_Bool _bSupportNoCheckRefValue = sal_False
+        );
+        DECLARE_DEFAULT_CLONE_CTOR( OReferenceValueComponent )
+        DECLARE_DEFAULT_DTOR( OReferenceValueComponent );
+
+        // OPropertySet and friends
+        virtual void SAL_CALL getFastPropertyValue(::com::sun::star::uno::Any& rValue, sal_Int32 nHandle) const;
+        virtual void SAL_CALL setFastPropertyValue_NoBroadcast( sal_Int32 nHandle, const ::com::sun::star::uno::Any& rValue )
+                    throw (::com::sun::star::uno::Exception);
+        virtual sal_Bool SAL_CALL convertFastPropertyValue(
+                    ::com::sun::star::uno::Any& _rConvertedValue, ::com::sun::star::uno::Any& _rOldValue, sal_Int32 _nHandle, const ::com::sun::star::uno::Any& _rValue )
+                    throw (::com::sun::star::lang::IllegalArgumentException);
+        virtual void fillProperties(
+            ::com::sun::star::uno::Sequence< ::com::sun::star::beans::Property >& /* [out] */ _rProps,
+            ::com::sun::star::uno::Sequence< ::com::sun::star::beans::Property >& /* [out] */ _rAggregateProps
+        ) const;
+
+        // OBoundControlModel overridables
+        virtual void            onConnectedExternalValue( );
+        virtual sal_Bool        approveValueBinding( const ::com::sun::star::uno::Reference< ::com::sun::star::form::binding::XValueBinding >& _rxBinding );
+
+        virtual ::com::sun::star::uno::Any
+                                translateExternalValueToControlValue( );
+        virtual ::com::sun::star::uno::Any
+                                translateControlValueToExternalValue( );
+
+        virtual ::com::sun::star::uno::Any
+                                getDefaultForReset() const;
+
+    private:
+        /** calculates the data type we need to use to exchange values with external bindings
+        */
+        void    calcValueExchangeType();
+    };
+
+//........................................................................
+} // namespace frm
+//........................................................................
+
+#endif // EFORMS2_FORMS_SOURCE_COMPONENT_REFVALUECOMPONENT_HXX
+