extensions/source/propctrlr/defaulthelpprovider.cxx

   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: defaulthelpprovider.cxx,v $
  10  * $Revision: 1.4 $
  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 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_extensions.hxx"
  33
  34 #include "defaulthelpprovider.hxx"
  35 #include "pcrcommon.hxx"
  36 #include "modulepcr.hxx"
  37
  38 /** === begin UNO includes === **/
  39 #include <com/sun/star/ucb/AlreadyInitializedException.hpp>
  40 #include <com/sun/star/lang/IllegalArgumentException.hpp>
  41 #include <com/sun/star/awt/XVclWindowPeer.hpp>
  42 /** === end UNO includes === **/
  43
  44 #include <toolkit/helper/vclunohelper.hxx>
  45 #include <vcl/window.hxx>
  46 #include <tools/diagnose_ex.h>
  47
  48 //------------------------------------------------------------------------
  49 extern "C" void SAL_CALL createRegistryInfo_DefaultHelpProvider()
  50 {
  51     ::pcr::OAutoRegistration< ::pcr::DefaultHelpProvider > aAutoRegistration;
  52 }
  53
  54 //........................................................................
  55 namespace pcr
  56 {
  57 //........................................................................
  58
  59     /** === begin UNO using === **/
  60     using ::com::sun::star::uno::Reference;
  61     using ::com::sun::star::uno::XComponentContext;
  62     using ::com::sun::star::inspection::XPropertyControl;
  63     using ::com::sun::star::uno::RuntimeException;
  64     using ::com::sun::star::uno::Sequence;
  65     using ::com::sun::star::uno::Any;
  66     using ::com::sun::star::uno::Exception;
  67     using ::com::sun::star::inspection::XObjectInspectorUI;
  68     using ::com::sun::star::uno::XInterface;
  69     using ::com::sun::star::ucb::AlreadyInitializedException;
  70     using ::com::sun::star::lang::IllegalArgumentException;
  71     using ::com::sun::star::uno::UNO_QUERY;
  72     using ::com::sun::star::uno::UNO_QUERY_THROW;
  73     using ::com::sun::star::awt::XWindow;
  74     using ::com::sun::star::awt::XVclWindowPeer;
  75     /** === end UNO using === **/
  76
  77     //====================================================================
  78     //= DefaultHelpProvider
  79     //====================================================================
  80     //--------------------------------------------------------------------
  81     DefaultHelpProvider::DefaultHelpProvider( const Reference< XComponentContext >& _rxContext )
  82         :m_aContext( _rxContext )
  83         ,m_bConstructed( false )
  84     {
  85     }
  86
  87     //--------------------------------------------------------------------
  88     DefaultHelpProvider::~DefaultHelpProvider()
  89     {
  90     }
  91
  92     //------------------------------------------------------------------------
  93     ::rtl::OUString DefaultHelpProvider::getImplementationName_static(  ) throw(RuntimeException)
  94     {
  95         return ::rtl::OUString::createFromAscii( "org.openoffice.comp.extensions.DefaultHelpProvider");
  96     }
  97
  98     //------------------------------------------------------------------------
  99     Sequence< ::rtl::OUString > DefaultHelpProvider::getSupportedServiceNames_static(  ) throw(RuntimeException)
 100     {
 101         Sequence< ::rtl::OUString > aSupported(1);
 102         aSupported[0] = ::rtl::OUString::createFromAscii( "com.sun.star.inspection.DefaultHelpProvider" );
 103         return aSupported;
 104     }
 105
 106     //------------------------------------------------------------------------
 107     Reference< XInterface > SAL_CALL DefaultHelpProvider::Create( const Reference< XComponentContext >& _rxContext )
 108     {
 109         return *new DefaultHelpProvider( _rxContext );
 110     }
 111
 112     //--------------------------------------------------------------------
 113     void SAL_CALL DefaultHelpProvider::focusGained( const Reference< XPropertyControl >& _Control ) throw (RuntimeException)
 114     {
 115         if ( !m_xInspectorUI.is() )
 116             throw RuntimeException( ::rtl::OUString(), *this );
 117
 118         try
 119         {
 120             m_xInspectorUI->setHelpSectionText( impl_getHelpText_nothrow( _Control ) );
 121         }
 122         catch( const Exception& )
 123         {
 124             DBG_UNHANDLED_EXCEPTION();
 125         }
 126     }
 127
 128     //--------------------------------------------------------------------
 129     void SAL_CALL DefaultHelpProvider::valueChanged( const Reference< XPropertyControl >& /*_Control*/ ) throw (RuntimeException)
 130     {
 131         // not interested in
 132     }
 133
 134     //--------------------------------------------------------------------
 135     void SAL_CALL DefaultHelpProvider::initialize( const Sequence< Any >& _arguments ) throw (Exception, RuntimeException)
 136     {
 137         if ( m_bConstructed )
 138             throw AlreadyInitializedException();
 139
 140         StlSyntaxSequence< Any > arguments( _arguments );
 141         if ( arguments.size() == 1 )
 142         {   // constructor: "create( XObjectInspectorUI )"
 143             Reference< XObjectInspectorUI > xUI( arguments[0], UNO_QUERY );
 144             create( xUI );
 145             return;
 146         }
 147
 148         throw IllegalArgumentException( ::rtl::OUString(), *this, 0 );
 149     }
 150
 151     //--------------------------------------------------------------------
 152     void DefaultHelpProvider::create( const Reference< XObjectInspectorUI >& _rxUI )
 153     {
 154         if ( !_rxUI.is() )
 155             throw IllegalArgumentException( ::rtl::OUString(), *this, 1 );
 156
 157         try
 158         {
 159             m_xInspectorUI = _rxUI;
 160             m_xInspectorUI->registerControlObserver( this );
 161         }
 162         catch( const Exception& )
 163         {
 164             DBG_UNHANDLED_EXCEPTION();
 165         }
 166
 167         m_bConstructed = true;
 168     }
 169
 170     //--------------------------------------------------------------------
 171     Window* DefaultHelpProvider::impl_getVclControlWindow_nothrow( const Reference< XPropertyControl >& _rxControl )
 172     {
 173         Window* pControlWindow = NULL;
 174         OSL_PRECOND( _rxControl.is(), "DefaultHelpProvider::impl_getVclControlWindow_nothrow: illegal control!" );
 175         if ( !_rxControl.is() )
 176             return pControlWindow;
 177
 178         try
 179         {
 180             Reference< XWindow > xControlWindow( _rxControl->getControlWindow(), UNO_QUERY_THROW );
 181             pControlWindow = VCLUnoHelper::GetWindow( xControlWindow );
 182         }
 183         catch( const Exception& )
 184         {
 185             DBG_UNHANDLED_EXCEPTION();
 186         }
 187
 188         return pControlWindow;
 189     }
 190
 191     //--------------------------------------------------------------------
 192     ::rtl::OUString DefaultHelpProvider::impl_getHelpText_nothrow( const Reference< XPropertyControl >& _rxControl )
 193     {
 194         ::rtl::OUString sHelpText;
 195         OSL_PRECOND( _rxControl.is(), "DefaultHelpProvider::impl_getHelpText_nothrow: illegal control!" );
 196         if ( !_rxControl.is() )
 197             return sHelpText;
 198
 199         Window* pControlWindow( impl_getVclControlWindow_nothrow( _rxControl ) );
 200         OSL_ENSURE( pControlWindow, "DefaultHelpProvider::impl_getHelpText_nothrow: could not determine the VCL window!" );
 201         if ( !pControlWindow )
 202             return sHelpText;
 203
 204         sHelpText = pControlWindow->GetHelpText();
 205         return sHelpText;
 206     }
 207 //........................................................................
 208 } // namespace pcr
 209 //........................................................................