extensions/source/propctrlr/eformspropertyhandler.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: eformspropertyhandler.hxx,v $
  10  * $Revision: 1.8 $
  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 EXTENSIONS_SOURCE_PROPCTRLR_EFORMSPROPERTYHANDLER_HXX
  32 #define EXTENSIONS_SOURCE_PROPCTRLR_EFORMSPROPERTYHANDLER_HXX
  33
  34 #include "propertyhandler.hxx"
  35
  36 /** === begin UNO includes === **/
  37 /** === end UNO includes === **/
  38
  39 #include <memory>
  40
  41 //........................................................................
  42 namespace pcr
  43 {
  44 //........................................................................
  45
  46     class EFormsHelper;
  47     //====================================================================
  48     //= EFormsPropertyHandler
  49     //====================================================================
  50     class EFormsPropertyHandler;
  51     typedef HandlerComponentBase< EFormsPropertyHandler > EFormsPropertyHandler_Base;
  52     class EFormsPropertyHandler : public EFormsPropertyHandler_Base
  53     {
  54     private:
  55         ::std::auto_ptr< EFormsHelper > m_pHelper;
  56         /** current value of the Model property, if there is no binding, yet
  57         */
  58         ::rtl::OUString                 m_sBindingLessModelName;
  59         /** are we currently simulating a propertyChange event of the Model property?
  60         */
  61         bool                            m_bSimulatingModelChange;
  62
  63     public:
  64         EFormsPropertyHandler(
  65             const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& _rxContext
  66         );
  67
  68         static ::rtl::OUString SAL_CALL getImplementationName_static(  ) throw (::com::sun::star::uno::RuntimeException);
  69         static ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL getSupportedServiceNames_static(  ) throw (::com::sun::star::uno::RuntimeException);
  70
  71     protected:
  72         ~EFormsPropertyHandler();
  73
  74     protected:
  75         // XPropertyHandler overriables
  76         virtual ::com::sun::star::uno::Any          SAL_CALL getPropertyValue( const ::rtl::OUString& _rPropertyName ) throw (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::uno::RuntimeException);
  77         virtual void                                SAL_CALL setPropertyValue( const ::rtl::OUString& _rPropertyName, const ::com::sun::star::uno::Any& _rValue ) throw (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::uno::RuntimeException);
  78         virtual ::com::sun::star::uno::Sequence< ::rtl::OUString >
  79                                                     SAL_CALL getActuatingProperties( ) throw (::com::sun::star::uno::RuntimeException);
  80         virtual ::com::sun::star::uno::Sequence< ::rtl::OUString >
  81                                                     SAL_CALL getSupersededProperties( ) throw (::com::sun::star::uno::RuntimeException);
  82         virtual ::com::sun::star::inspection::LineDescriptor
  83                                                     SAL_CALL describePropertyLine( const ::rtl::OUString& _rPropertyName, const ::com::sun::star::uno::Reference< ::com::sun::star::inspection::XPropertyControlFactory >& _rxControlFactory ) throw (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::NullPointerException, ::com::sun::star::uno::RuntimeException);
  84         virtual ::com::sun::star::inspection::InteractiveSelectionResult
  85                                                     SAL_CALL onInteractivePropertySelection( const ::rtl::OUString& _rPropertyName, sal_Bool _bPrimary, ::com::sun::star::uno::Any& _rData, const ::com::sun::star::uno::Reference< ::com::sun::star::inspection::XObjectInspectorUI >& _rxInspectorUI ) throw (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::lang::NullPointerException, ::com::sun::star::uno::RuntimeException);
  86         virtual void                                SAL_CALL actuatingPropertyChanged( const ::rtl::OUString& _rActuatingPropertyName, const ::com::sun::star::uno::Any& _rNewValue, const ::com::sun::star::uno::Any& _rOldValue, const ::com::sun::star::uno::Reference< ::com::sun::star::inspection::XObjectInspectorUI >& _rxInspectorUI, sal_Bool ) throw (::com::sun::star::lang::NullPointerException, ::com::sun::star::uno::RuntimeException);
  87         virtual ::com::sun::star::uno::Any          SAL_CALL convertToPropertyValue( const ::rtl::OUString& _rPropertyName, const ::com::sun::star::uno::Any& _rControlValue ) throw (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::uno::RuntimeException);
  88         virtual ::com::sun::star::uno::Any          SAL_CALL convertToControlValue( const ::rtl::OUString& _rPropertyName, const ::com::sun::star::uno::Any& _rPropertyValue, const ::com::sun::star::uno::Type& _rControlValueType ) throw (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::uno::RuntimeException);
  89         virtual void                                SAL_CALL addPropertyChangeListener( const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertyChangeListener >& _rxListener ) throw (::com::sun::star::uno::RuntimeException);
  90         virtual void                                SAL_CALL removePropertyChangeListener( const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertyChangeListener >& _rxListener ) throw (::com::sun::star::uno::RuntimeException);
  91
  92         // PropertyHandler overridables
  93         virtual ::com::sun::star::uno::Sequence< ::com::sun::star::beans::Property >
  94                                             SAL_CALL doDescribeSupportedProperties() const;
  95         virtual void onNewComponent();
  96
  97     protected:
  98         /** returns the value of the PROPERTY_XML_DATA_MODEL property.
  99
 100             An extra method is necessary here, which respects both the value set at our helper,
 101             and <member>m_sBindingLessModelName</member>
 102         */
 103         ::rtl::OUString getModelNamePropertyValue() const;
 104     };
 105
 106 //........................................................................
 107 } // namespace pcr
 108 //........................................................................
 109
 110 #endif // EXTENSIONS_SOURCE_PROPCTRLR_EFORMSPROPERTYHANDLER_HXX
 111