extensions/source/propctrlr/cellbindinghandler.hxx

   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 EXTENSIONS_SOURCE_PROPCTRLR_CELLBINDINGHANDLER_HXX
  29 #define EXTENSIONS_SOURCE_PROPCTRLR_CELLBINDINGHANDLER_HXX
  30
  31 #include "propertyhandler.hxx"
  32
  33 /** === begin UNO includes === **/
  34 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  35 /** === end UNO includes === **/
  36 #include <rtl/ref.hxx>
  37
  38 #include <memory>
  39
  40 //........................................................................
  41 namespace pcr
  42 {
  43 //........................................................................
  44
  45     class CellBindingHelper;
  46     class IPropertyEnumRepresentation;
  47     //====================================================================
  48     //= CellBindingPropertyHandler
  49     //====================================================================
  50     class CellBindingPropertyHandler;
  51     typedef HandlerComponentBase< CellBindingPropertyHandler > CellBindingPropertyHandler_Base;
  52     class CellBindingPropertyHandler : public CellBindingPropertyHandler_Base
  53     {
  54     private:
  55         ::std::auto_ptr< CellBindingHelper >            m_pHelper;
  56         ::rtl::Reference< IPropertyEnumRepresentation > m_pCellExchangeConverter;
  57
  58     public:
  59         CellBindingPropertyHandler(
  60             const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& _rxContext
  61         );
  62
  63         static ::rtl::OUString SAL_CALL getImplementationName_static(  ) throw (::com::sun::star::uno::RuntimeException);
  64         static ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL getSupportedServiceNames_static(  ) throw (::com::sun::star::uno::RuntimeException);
  65
  66     protected:
  67         ~CellBindingPropertyHandler();
  68
  69     protected:
  70         // XPropertyHandler overriables
  71         virtual ::com::sun::star::uno::Any      SAL_CALL getPropertyValue( const ::rtl::OUString& _rPropertyName ) throw (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::uno::RuntimeException);
  72         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);
  73         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);
  74         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);
  75         virtual ::com::sun::star::uno::Sequence< ::rtl::OUString >
  76                                                 SAL_CALL getActuatingProperties( ) throw (::com::sun::star::uno::RuntimeException);
  77         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 _bFirstTimeInit ) throw (::com::sun::star::lang::NullPointerException, ::com::sun::star::uno::RuntimeException);
  78
  79         // PropertyHandler overridables
  80         virtual ::com::sun::star::uno::Sequence< ::com::sun::star::beans::Property >
  81                                                 SAL_CALL doDescribeSupportedProperties() const;
  82         virtual void onNewComponent();
  83
  84     private:
  85         /** updates a property (UI) whose state depends on more than one other property
  86
  87             ->actuatingPropertyChanged is called for certain properties in whose changes
  88             we expressed interes (->getActuatingProperty). Now such a property change can
  89             result in simple UI updates, for instance another property being enabled or disabled.
  90
  91             However, it can also result in a more complex change: The current (UI) state might
  92             depend on the value of more than one other property. Those dependent properties (their
  93             UI, more precisly) are updated in this method.
  94
  95             @param _nPropid
  96                 the ->PropertyId of the dependent property whose UI state is to be updated
  97
  98             @param _rxInspectorUI
  99                 provides access to the property browser UI. Must not be <NULL/>.
 100         */
 101         void impl_updateDependentProperty_nothrow( PropertyId _nPropId, const ::com::sun::star::uno::Reference< ::com::sun::star::inspection::XObjectInspectorUI >& _rxInspectorUI ) const;
 102     };
 103
 104 //........................................................................
 105 } // namespace pcr
 106 //........................................................................
 107
 108 #endif // EXTENSIONS_SOURCE_PROPCTRLR_CELLBINDINGHANDLER_HXX
 109