extensions/source/propctrlr/defaulthelpprovider.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_DEFAULTHELPPROVIDER_HXX
  29 #define EXTENSIONS_DEFAULTHELPPROVIDER_HXX
  30
  31 /** === begin UNO includes === **/
  32 #include <com/sun/star/inspection/XPropertyControlObserver.hpp>
  33 #include <com/sun/star/lang/XInitialization.hpp>
  34 #include <com/sun/star/inspection/XObjectInspectorUI.hpp>
  35 /** === end UNO includes === **/
  36
  37 #include <cppuhelper/implbase2.hxx>
  38 #include <comphelper/componentcontext.hxx>
  39
  40 class Window;
  41
  42 //........................................................................
  43 namespace pcr
  44 {
  45 //........................................................................
  46
  47     //====================================================================
  48     //= DefaultHelpProvider
  49     //====================================================================
  50     typedef ::cppu::WeakImplHelper2 <   ::com::sun::star::inspection::XPropertyControlObserver
  51                                     ,   ::com::sun::star::lang::XInitialization
  52                                     >   DefaultHelpProvider_Base;
  53     class DefaultHelpProvider : public DefaultHelpProvider_Base
  54     {
  55     private:
  56         ::comphelper::ComponentContext  m_aContext;
  57         bool                            m_bConstructed;
  58         ::com::sun::star::uno::Reference< ::com::sun::star::inspection::XObjectInspectorUI >
  59                                         m_xInspectorUI;
  60
  61     public:
  62         DefaultHelpProvider( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& _rxContext );
  63
  64         // XServiceInfo - static versions
  65         static ::rtl::OUString getImplementationName_static(  ) throw(::com::sun::star::uno::RuntimeException);
  66         static ::com::sun::star::uno::Sequence< ::rtl::OUString > getSupportedServiceNames_static(  ) throw(::com::sun::star::uno::RuntimeException);
  67         static ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface > SAL_CALL
  68                         Create(const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >&);
  69
  70     protected:
  71         ~DefaultHelpProvider();
  72
  73         // XPropertyControlObserver
  74         virtual void SAL_CALL focusGained( const ::com::sun::star::uno::Reference< ::com::sun::star::inspection::XPropertyControl >& Control ) throw (::com::sun::star::uno::RuntimeException);
  75         virtual void SAL_CALL valueChanged( const ::com::sun::star::uno::Reference< ::com::sun::star::inspection::XPropertyControl >& Control ) throw (::com::sun::star::uno::RuntimeException);
  76
  77         // XInitialization
  78         virtual void SAL_CALL initialize( const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any >& aArguments ) throw (::com::sun::star::uno::Exception, ::com::sun::star::uno::RuntimeException);
  79
  80     protected:
  81         // Service constructors
  82         void    create( const ::com::sun::star::uno::Reference< ::com::sun::star::inspection::XObjectInspectorUI >& _rxUI );
  83
  84     private:
  85         Window* impl_getVclControlWindow_nothrow( const ::com::sun::star::uno::Reference< ::com::sun::star::inspection::XPropertyControl >& _rxControl );
  86         ::rtl::OUString impl_getHelpText_nothrow( const ::com::sun::star::uno::Reference< ::com::sun::star::inspection::XPropertyControl >& _rxControl );
  87     };
  88
  89 //........................................................................
  90 } // namespace pcr
  91 //........................................................................
  92
  93 #endif // EXTENSIONS_DEFAULTHELPPROVIDER_HXX