extensions/source/propctrlr/buttonnavigationhandler.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: buttonnavigationhandler.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_BUTTONNAVIGATIONHANDLER_HXX
  32 #define EXTENSIONS_SOURCE_PROPCTRLR_BUTTONNAVIGATIONHANDLER_HXX
  33
  34 #include "propertyhandler.hxx"
  35
  36 /** === begin UNO includes === **/
  37 /** === end UNO includes === **/
  38
  39 //........................................................................
  40 namespace pcr
  41 {
  42 //........................................................................
  43
  44     //====================================================================
  45     //= ButtonNavigationHandler
  46     //====================================================================
  47     class ButtonNavigationHandler;
  48     typedef HandlerComponentBase< ButtonNavigationHandler > ButtonNavigationHandler_Base;
  49     /** a property handler for any virtual string properties
  50     */
  51     class ButtonNavigationHandler : public ButtonNavigationHandler_Base
  52     {
  53     private:
  54         ::com::sun::star::uno::Reference< ::com::sun::star::inspection::XPropertyHandler >
  55             m_xSlaveHandler;
  56
  57     public:
  58         ButtonNavigationHandler(
  59             const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& _rxContext
  60         );
  61         static ::rtl::OUString SAL_CALL getImplementationName_static(  ) throw (::com::sun::star::uno::RuntimeException);
  62         static ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL getSupportedServiceNames_static(  ) throw (::com::sun::star::uno::RuntimeException);
  63
  64     protected:
  65         ~ButtonNavigationHandler();
  66
  67         static bool    isNavigationCapableButton( const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XPropertySet >& _rxComponent );
  68
  69     protected:
  70         // XPropertyHandler overriables
  71         virtual void                                    SAL_CALL inspect( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >& _rxIntrospectee ) throw (::com::sun::star::uno::RuntimeException, ::com::sun::star::lang::NullPointerException);
  72         virtual ::com::sun::star::uno::Any              SAL_CALL getPropertyValue( const ::rtl::OUString& _rPropertyName ) throw (::com::sun::star::beans::UnknownPropertyException, ::com::sun::star::uno::RuntimeException);
  73         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);
  74         virtual ::com::sun::star::beans::PropertyState  SAL_CALL getPropertyState( const ::rtl::OUString& _rPropertyName ) 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 ::com::sun::star::inspection::InteractiveSelectionResult
  78                                                         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);
  79         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);
  80         virtual ::com::sun::star::inspection::LineDescriptor
  81                                                         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);
  82
  83         // PropertyHandler overridables
  84         virtual ::com::sun::star::uno::Sequence< ::com::sun::star::beans::Property >
  85                                                         SAL_CALL doDescribeSupportedProperties() const;
  86     };
  87
  88 //........................................................................
  89 } // namespace pcr
  90 //........................................................................
  91
  92 #endif // EXTENSIONS_SOURCE_PROPCTRLR_BUTTONNAVIGATIONHANDLER_HXX
  93