INTEGRATION: CWS pbrwuno (1.1.2); FILE ADDED

2005/11/02 12:17:15 fs 1.1.2.10: #i10000# exception specifications
2005/11/02 11:43:41 fs 1.1.2.9: #i10000# exception specifications
2005/10/25 07:13:10 fs 1.1.2.8: #i53095# knitting lose ends (amongst others, make the handlers available as service)
2005/10/24 08:41:45 fs 1.1.2.7: start making the handlers full-fledged components, with using a new infrastructure replacing extensions/source/inc/componentmodule.*
2005/10/17 14:09:18 fs 1.1.2.6: #i53095# some cleanup of remaining TODOs
2005/10/17 13:19:00 fs 1.1.2.5: #i53095# proper listener administration: allow multiple listeners per handler
2005/10/13 13:01:02 fs 1.1.2.4: #i53095# introduce an XObjectInspector/Model
2005/10/11 13:29:11 fs 1.1.2.3: #i53095# phase 3:
introduced XPropertyHandler and XObjectInspectorUI
same open issues as in previous phase
(plus probably some more, since not everything is tested, yet :-\)
2005/09/05 07:41:49 fs 1.1.2.2: #i53095# phase 3, part 1: introduced XPropertyControl and relatives,
describing one control in the ObjectInspector, responsible for one
property
known issues:
- rebuildPropertyUI can cause problems now: If the user clicks into
the control for property A, which causes property B to be committed,
which causes the UI for property A to be rebuilt, then this will
crash currently. Reason: rebuildPropertyUI now synchronously replaces
the VCL-Window of the rebuilt control, which is exactly the one
which is still in some MouseButtonDown-handler.
possible solutions:
- see if rebuiltPropertyUI can be obsoleted - handlers should be able
to just obtain the XPropertyControl from the PropertyUI, and
re-initialize the control. Shouldn't they?`
- make one of the steps in the chain (mouse-click, handler-call,
rebuildPropertyUI-callback) asynchronous.
2005/08/18 12:44:28 fs 1.1.2.1: #i53095#, phase 2

moved (nearly) all property handling to dedicated handlers, the controller is
now simply managing a set of handlers

open issues for making the property browser completely generic:
- target page for a property - at the moment, the pbrw uses form-specific
knowledge
- relative position of properties. Again, the pbrw uses the OPropertyInfoService
which is not generic
- isComposeable for a given property. Also OPropertyInfoService-dependent ATM
- help ids of pages and the pbrw as a whole. They're hard-coded at the moment

other open issues:
everything in the code which is tagged with TOD/UNOize. Those are items which
do not immediately hinder phase 3 (real UNOization, i.e. definition of new
UNO interfaces for the handlers, the controller, and so on), but need to be
addressed in phase 4 (knit lose ends)

1 files changed, 279 insertions, 0 deletions

diff --git a/extensions/source/propctrlr/eventhandler.hxx b/extensions/source/propctrlr/eventhandler.hxx
new file mode 100644
index 000000000000..934358674f68
--- /dev/null
+++ b/extensions/source/propctrlr/eventhandler.hxx
@@ -0,0 +1,279 @@
+/*************************************************************************
+ *
+ *  OpenOffice.org - a multi-platform office productivity suite
+ *
+ *  $RCSfile: eventhandler.hxx,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: vg $ $Date: 2006-03-14 11:22:22 $
+ *
+ *  The Contents of this file are made available subject to
+ *  the terms of GNU Lesser General Public License Version 2.1.
+ *
+ *
+ *    GNU Lesser General Public License Version 2.1
+ *    =============================================
+ *    Copyright 2005 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
+ *
+ ************************************************************************/
+
+#ifndef EXTENSIONS_SOURCE_PROPCTRLR_EVENTHANDLER_HXX
+#define EXTENSIONS_SOURCE_PROPCTRLR_EVENTHANDLER_HXX
+
+#ifndef EXTENSIONS_SOURCE_PROPCTRLR_PROPERTYHANDLER_HXX
+#include "propertyhandler.hxx"
+#endif
+#ifndef EXTENSIONS_SOURCE_PROPCTRLR_PCROMPONENTCONTEXT_HXX
+#include "pcrcomponentcontext.hxx"
+#endif
+#ifndef EXTENSIONS_SOURCE_PROPCTRLR_PCRCOMMONTYPES_HXX
+#include "pcrcommontypes.hxx"
+#endif
+#ifndef _EXTENSIONS_PROPCTRLR_PCRCOMMON_HXX_
+#include "pcrcommon.hxx"
+#endif
+
+/** === begin UNO includes === **/
+#ifndef _COM_SUN_STAR_SCRIPT_SCRIPTEVENTDESCRIPTOR_HPP_
+#include <com/sun/star/script/ScriptEventDescriptor.hpp>
+#endif
+#ifndef _COM_SUN_STAR_LANG_XSERVICEINFO_HPP_
+#include <com/sun/star/lang/XServiceInfo.hpp>
+#endif
+/** === end UNO includes === **/
+
+#ifndef _CPPUHELPER_COMPBASE2_HXX_
+#include <cppuhelper/compbase2.hxx>
+#endif
+#ifndef COMPHELPER_INC_COMPHELPER_LISTENERNOTIFICATION_HXX
+#include <comphelper/listenernotification.hxx>
+#endif
+
+//........................................................................
+namespace pcr
+{
+//........................................................................
+
+    //====================================================================
+    //= EventDescription
+    //====================================================================
+    typedef sal_Int32   EventId;
+    struct EventDescription
+    {
+    public:
+        ::rtl::OUString sDisplayName;
+        ::rtl::OUString sListenerClassName;
+        ::rtl::OUString sListenerMethodName;
+        sal_Int32       nHelpId;
+        sal_Int32       nUniqueBrowseId;
+        EventId         nId;
+
+        EventDescription()
+            :nId( 0 )
+            ,nHelpId( 0 )
+            ,nUniqueBrowseId( 0 )
+            {
+            }
+
+        EventDescription(
+            EventId _nId,
+            const sal_Char* _pListenerNamespaceAscii,
+            const sal_Char* _pListenerClassAsciiName,
+            const sal_Char* _pListenerMethodAsciiName,
+            sal_uInt16 _nDisplayNameResId,
+            sal_Int32 _nHelpId,
+            sal_Int32 _nUniqueBrowseId );
+    };
+
+    typedef ::std::hash_map< ::rtl::OUString, EventDescription, ::rtl::OUStringHash >   EventMap;
+
+    //====================================================================
+    //= EventHandler
+    //====================================================================
+    typedef ::cppu::WeakComponentImplHelper2    <   ::com::sun::star::inspection::XPropertyHandler
+                                                ,   ::com::sun::star::lang::XServiceInfo
+                                                >   EventHandler_Base;
+    class EventHandler : public EventHandler_Base
+    {
+    private:
+        mutable ::osl::Mutex    m_aMutex;
+
+        /// the context in which the instance was created
+        ComponentContext                                                            m_aContext;
+        /// the properties of the object we're handling
+        ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >   m_xComponent;
+        /// our XPropertyChangeListener(s)
+        PropertyChangeListeners                                                     m_aPropertyListeners;
+        /// cache of the events we found at our introspectee
+        EventMap                                                                    m_aEvents;
+        /// has m_aEvents been initialized?
+        bool                                                                        m_bEventsMapInitialized;
+        /// is our introspectee a dialog element?
+        bool                                                                        m_bIsDialogElement;
+            // TODO: move different handling into different derived classes?
+
+    public:
+        // XServiceInfo - static versions
+        static ::rtl::OUString SAL_CALL getImplementationName_static(  ) throw (::com::sun::star::uno::RuntimeException);
+        static ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL getSupportedServiceNames_static(  ) throw (::com::sun::star::uno::RuntimeException);
+        static ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > Create( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& _rxContext );
+
+    protected:
+        EventHandler(
+            const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& _rxContext
+       );
+
+        ~EventHandler();
+
+    protected:
+        // XPropertyHandler overridables
+        virtual void                                                SAL_CALL inspect( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& _rxIntrospectee ) throw (::com::sun::star::lang::NullPointerException, ::com::sun::star::uno::RuntimeException);
+        virtual ::com::sun::star::uno::Any                          SAL_CALL getPropertyValue( const ::rtl::OUString& _rPropertyName ) throw (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::uno::RuntimeException);
+        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);
+        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);
+        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);
+        virtual ::com::sun::star::beans::PropertyState              SAL_CALL getPropertyState( const ::rtl::OUString& _rPropertyName ) throw (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::uno::RuntimeException);
+        virtual void                                                SAL_CALL addPropertyChangeListener( const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertyChangeListener >& _rxListener ) throw (::com::sun::star::uno::RuntimeException);
+        virtual void                                                SAL_CALL removePropertyChangeListener( const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertyChangeListener >& _rxListener ) throw (::com::sun::star::uno::RuntimeException);
+        virtual ::com::sun::star::uno::Sequence< ::com::sun::star::beans::Property >
+                                                                    SAL_CALL getSupportedProperties() throw (::com::sun::star::uno::RuntimeException);
+        virtual ::com::sun::star::uno::Sequence< ::rtl::OUString >  SAL_CALL getSupersededProperties( ) throw (::com::sun::star::uno::RuntimeException);
+        virtual ::com::sun::star::uno::Sequence< ::rtl::OUString >  SAL_CALL getActuatingProperties( ) throw (::com::sun::star::uno::RuntimeException);
+        virtual void                                                SAL_CALL describePropertyLine( const ::rtl::OUString& _rPropertyName, ::com::sun::star::inspection::LineDescriptor& /* [out] */ _rDescriptor, 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);
+        virtual ::sal_Bool                                          SAL_CALL isComposable( const ::rtl::OUString& _rPropertyName ) throw (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::uno::RuntimeException);
+        virtual ::com::sun::star::inspection::InteractiveSelectionResult
+                                                                    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);
+        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);
+        virtual sal_Bool                                            SAL_CALL suspend( sal_Bool _bSuspend ) throw (::com::sun::star::uno::RuntimeException);
+
+        // XComponent
+        DECLARE_XCOMPONENT();
+        virtual void                                                SAL_CALL disposing();
+
+        // XServiceInfo
+        virtual ::rtl::OUString SAL_CALL getImplementationName(  ) throw (::com::sun::star::uno::RuntimeException);
+        virtual ::sal_Bool SAL_CALL supportsService( const ::rtl::OUString& ServiceName ) throw (::com::sun::star::uno::RuntimeException);
+        virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL getSupportedServiceNames(  ) throw (::com::sun::star::uno::RuntimeException);
+
+    private:
+        /** returns the script events associated with our introspectee
+            @param  _out_rEvents
+                Takes, upon successfull return, the events currently associated with the introspectee
+            @precond
+                Our introspectee is a form component
+        */
+        void    impl_getFormComponentScriptEvents_nothrow(
+                    ::com::sun::star::uno::Sequence< ::com::sun::star::script::ScriptEventDescriptor >& _out_rEvents
+                ) const;
+
+        /** returns the script events associated with our introspectee
+            @param  _out_rEvents
+                Takes, upon successfull return, the events currently associated with the introspectee
+            @precond
+                Our introspectee is a dialog element
+        */
+        void    impl_getDialogElementScriptEvents_nothrow(
+                    ::com::sun::star::uno::Sequence< ::com::sun::star::script::ScriptEventDescriptor >& _out_rEvents
+                ) const;
+
+        /** returns the script events associated with our introspectee
+            @param  _out_rEvents
+                Takes, the events currently associated with the introspectee
+        */
+        inline void impl_getComponentScriptEvents_nothrow(
+                    ::com::sun::star::uno::Sequence< ::com::sun::star::script::ScriptEventDescriptor >& _out_rEvents
+                ) const
+        {
+            if ( m_bIsDialogElement )
+                impl_getDialogElementScriptEvents_nothrow( _out_rEvents );
+            else
+                impl_getFormComponentScriptEvents_nothrow( _out_rEvents );
+        }
+
+        /** returns the types of the listeners which can be registered at our introspectee
+            @param  _out_rTypes
+                Takes, upon successfull return, the types of possible listeners at the introspectee
+        */
+        void    impl_getCopmonentListenerTypes_nothrow(
+                    ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Type >& _out_rTypes
+                ) const;
+
+        /** returns a secondary component to be used for event inspection
+
+            In the UI, we want to mix events for the control model with events for the control.
+            Since our introspectee is a model, this method creates a control for it (if possible).
+
+            @return
+                the secondary component whose events should be mixed with the introspectee's events
+                The caller takes the ownership of the component (if not <NULL/>).
+
+            @throws
+                if an unexpected error occurs during creation of the secondary component.
+                A <NULL/> component to be returned is not unexpected, but allowed
+
+            @precond
+                ->m_xComponent is not <NULL/>
+        */
+        ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >
+                impl_getSecondaryComponentForEventInspection_throw( ) const;
+
+        /** returns the event description for the given (programmatic) property name
+            @param  _rPropertyName
+                the name whose event description should be looked up
+            @return
+                the event description for the property name
+            @throws ::com::sun::star::beans::UnknownPropertyException
+                if our introspectee does not have an event with the given logical name (see ->getSupportedProperties)
+        */
+        const EventDescription&
+                impl_getEventForName_throw( const ::rtl::OUString& _rPropertyName ) const;
+
+        /** returns the index of our component within its parent, if this parent can be
+            obtained  (XChild::getParent) and supports an ->XIndexAccess interface
+        */
+        sal_Int32   impl_getComponentIndexInParent_throw() const;
+
+        /** sets a given script code as event handler at a form component, for a given event
+            @param  _rForEvent
+                the event whose script code is to be set
+            @param  _rScriptCode
+                the script code to set
+        */
+        void    impl_setFormComponentScriptEvent_nothrow( const EventDescription& _rForEvent, const ::rtl::OUString& _rScriptCode );
+
+        /** sets a given script code as event handler at a dialog element, for a given event
+            @param  _rForEvent
+                the event whose script code is to be set
+            @param  _rScriptCode
+                the script code to set
+        */
+        void    impl_setDialogElementScriptEvent_nothrow( const EventDescription& _rForEvent, const ::rtl::OUString& _rScriptCode );
+
+    private:
+        EventHandler();                                 // never implemented
+        EventHandler( const EventHandler& );            // never implemented
+        EventHandler& operator=( const EventHandler& ); // never implemented
+    };
+
+//........................................................................
+} // namespace pcr
+//........................................................................
+
+#endif // EXTENSIONS_SOURCE_PROPCTRLR_EVENTHANDLER_HXX
+