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_SUBMISSIONHANDLER_HXX 29 #define EXTENSIONS_SOURCE_PROPCTRLR_SUBMISSIONHANDLER_HXX 30 31 #include "propertyhandler.hxx" 32 #include "eformshelper.hxx" 33 34 /** === begin UNO includes === **/ 35 #include <com/sun/star/xforms/XSubmission.hpp> 36 /** === end UNO includes === **/ 37 #include <comphelper/propmultiplex.hxx> 38 39 namespace comphelper 40 { 41 class OPropertyChangeMultiplexer; 42 } 43 44 //........................................................................ 45 namespace pcr 46 { 47 //........................................................................ 48 49 //==================================================================== 50 //= SubmissionHelper 51 //==================================================================== 52 class SubmissionHelper : public EFormsHelper 53 { 54 public: 55 SubmissionHelper( 56 osl::Mutex& _rMutex, 57 const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxIntrospectee, 58 const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel >& _rxContextDocument 59 ); 60 61 /** determines whether the given control model is able to trigger submissions 62 63 Instances of the <type>SubmissionHelper</type> class should not be instantiated 64 for components where this method returned <FALSE/> 65 */ 66 static bool canTriggerSubmissions( 67 const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxControlModel, 68 const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel >& _rxContextDocument 69 ) SAL_THROW(()); 70 }; 71 72 //==================================================================== 73 //= SubmissionPropertyHandler 74 //==================================================================== 75 class SubmissionPropertyHandler; 76 typedef HandlerComponentBase< SubmissionPropertyHandler > EditPropertyHandler_Base; 77 /** a property handler for any virtual string properties 78 */ 79 class SubmissionPropertyHandler : public EditPropertyHandler_Base, public ::comphelper::OPropertyChangeListener 80 { 81 private: 82 ::osl::Mutex m_aMutex; 83 ::std::auto_ptr< SubmissionHelper > m_pHelper; 84 ::comphelper::OPropertyChangeMultiplexer* m_pPropChangeMultiplexer; 85 86 public: 87 SubmissionPropertyHandler( 88 const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& _rxContext 89 ); 90 91 static ::rtl::OUString SAL_CALL getImplementationName_static( ) throw (::com::sun::star::uno::RuntimeException); 92 static ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL getSupportedServiceNames_static( ) throw (::com::sun::star::uno::RuntimeException); 93 94 ~SubmissionPropertyHandler(); 95 96 protected: 97 // XPropertyHandler overriables 98 virtual ::com::sun::star::uno::Any SAL_CALL getPropertyValue( const ::rtl::OUString& _rPropertyName ) throw (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::uno::RuntimeException); 99 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); 100 virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > 101 SAL_CALL getActuatingProperties( ) throw (::com::sun::star::uno::RuntimeException); 102 virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > 103 SAL_CALL getSupersededProperties( ) throw (::com::sun::star::uno::RuntimeException); 104 virtual ::com::sun::star::inspection::LineDescriptor 105 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); 106 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); 107 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); 108 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); 109 110 // PropertyHandler overridables 111 virtual ::com::sun::star::uno::Sequence< ::com::sun::star::beans::Property > 112 SAL_CALL doDescribeSupportedProperties() const; 113 virtual void onNewComponent(); 114 115 private: 116 // OPropertyChangeListener 117 virtual void _propertyChanged(const ::com::sun::star::beans::PropertyChangeEvent& _rEvent) throw( ::com::sun::star::uno::RuntimeException); 118 }; 119 120 //........................................................................ 121 } // namespace pcr 122 //........................................................................ 123 124 #endif // EXTENSIONS_SOURCE_PROPCTRLR_SUBMISSIONHANDLER_HXX 125 126