Difference between revisions of "Zh/Documentation/DevGuide/WritingUNO/Implementation"

  #include <stdio.h>
 
  #ifndef _RTL_USTRING_HXX_
  #include <rtl/ustring.hxx>
  #endif
 
  #ifndef _CPPUHELPER_QUERYINTERFACE_HXX_
  #include <cppuhelper/queryinterface.hxx> // helper for queryInterface() impl
  #endif
  #ifndef _CPPUHELPER_FACTORY_HXX_
  #include <cppuhelper/factory.hxx> // helper for component factory
  #endif
  // generated c++ interfaces
 
  #ifndef _COM_SUN_STAR_LANG_XSINGLESERVICEFACTORY_HPP_
  #include <com/sun/star/lang/XSingleServiceFactory.hpp>
  #endif
  #ifndef _COM_SUN_STAR_LANG_XMULTISERVICEFACTORY_HPP_
  #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  #endif
  #ifndef _COM_SUN_STAR_LANG_XSERVICEINFO_HPP_
  #include <com/sun/star/lang/XServiceInfo.hpp>
  #endif
  #ifndef _COM_SUN_STAR_REGISTRY_XREGISTRYKEY_HPP_
  #include <com/sun/star/registry/XRegistryKey.hpp>
  #endif
 
  // include our specific addon header to get access to functions and definitions
  #include <addon.hxx>
 
  using namespace ::rtl;
  using namespace ::osl;
  using namespace ::cppu;
  using namespace ::com::sun::star::uno;
  using namespace ::com::sun::star::lang;
  using namespace ::com::sun::star::registry; 
 
  //##################################################################################################
  //#### EXPORTED ####################################################################################
  //##################################################################################################
 
 
  /**
   *  Gives the environment this component belongs to.
   */
  extern "C" void SAL_CALL component_getImplementationEnvironment(const sal_Char **   ppEnvTypeName, uno_Environment ** ppEnv)
  {
      *ppEnvTypeName = CPPU_CURRENT_LANGUAGE_BINDING_NAME;
  }
 
  /**
   *  This function creates an implementation section in the registry and another subkey
   *
   *  for each supported service.
   *  @param pServiceManager the service manager
   *  @param pRegistryKey the registry key
   */
  extern "C" sal_Bool SAL_CALL component_writeInfo(void * pServiceManager, void * pRegistryKey) {
      sal_Bool result = sal_False;
 
      if (pRegistryKey) {
          try {
              Reference< XRegistryKey > xNewKey(
                  reinterpret_cast< XRegistryKey * >( pRegistryKey )->createKey(
                      OUString( RTL_CONSTASCII_USTRINGPARAM("/" IMPLEMENTATION_NAME "/UNO/SERVICES")) ) );
 
 
              const Sequence< OUString > & rSNL = Addon_getSupportedServiceNames();
              const OUString * pArray = rSNL.getConstArray();
              for ( sal_Int32 nPos = rSNL.getLength(); nPos--; )
                 xNewKey->createKey( pArray[nPos] );
 
              return sal_True;
          }
          catch (InvalidRegistryException &) {
             // we should not ignore exceptions
          }
      }
      return result;
  }
 
  /**
   *  This function is called to get service factories for an implementation.
   *
   *  @param pImplName name of implementation
   *  @param pServiceManager a service manager, need for component creation
   *  @param pRegistryKey the registry key for this component, need for persistent data
   *  @return a component factory 
   */
 
  extern "C" void * SAL_CALL component_getFactory(const sal_Char * pImplName,
          void * pServiceManager, void * pRegistryKey) {
      void * pRet = 0;
 
      if (rtl_str_compare( pImplName, IMPLEMENTATION_NAME ) == 0) {
          Reference< XSingleServiceFactory > xFactory(createSingleFactory(
              reinterpret_cast< XMultiServiceFactory * >(pServiceManager),
              OUString(RTL_CONSTASCII_USTRINGPARAM(IMPLEMENTATION_NAME)),
              Addon_createInstance,
              Addon_getSupportedServiceNames()));
 
          if (xFactory.is()) {
              xFactory->acquire();
              pRet = xFactory.get();
          }
      }
 
      return pRet;
  } 
 
  //##################################################################################################
  //#### Helper functions for the implementation of UNO component interfaces #########################
  //################################################################################################## 
  ::rtl::OUString Addon_getImplementationName()
  throw (RuntimeException) {
      return ::rtl::OUString ( RTL_CONSTASCII_USTRINGPARAM ( IMPLEMENTATION_NAME ) );
  }
 
  sal_Bool SAL_CALL Addon_supportsService( const ::rtl::OUString& ServiceName )
  throw (RuntimeException)
  {
      return ServiceName.equalsAsciiL( RTL_CONSTASCII_STRINGPARAM ( SERVICE_NAME ) );
  }
 
  Sequence< ::rtl::OUString > SAL_CALL Addon_getSupportedServiceNames()
  throw (RuntimeException)
  {
          Sequence < ::rtl::OUString > aRet(1);
      ::rtl::OUString* pArray = aRet.getArray();
      pArray[0] = ::rtl::OUString ( RTL_CONSTASCII_USTRINGPARAM ( SERVICE_NAME ) );
      return aRet;
  }
 
  Reference< XInterface > SAL_CALL Addon_createInstance( const Reference< XMultiServiceFactory > & rSMgr)
      throw( Exception )
  {
      return (cppu::OWeakObject*) new Addon( rSMgr );
  }

  #ifndef _Addon_HXX
  #include <addon.hxx>
  #endif
  #ifndef _OSL_DIAGNOSE_H_
  #include <osl/diagnose.h>
  #endif
  #ifndef _RTL_USTRING_HXX_
  #include <rtl/ustring.hxx>
  #endif
  #ifndef _COM_SUN_STAR_LANG_XMULTISERVICEFACTORY_HPP_
  #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  #endif
  #ifndef _COM_SUN_STAR_BEANS_PROPERTYVALUE_HPP_
  #include <com/sun/star/beans/PropertyValue.hpp>
  #endif
  #ifndef _COM_SUN_STAR_FRAME_XFRAME_HPP_
  #include <com/sun/star/frame/XFrame.hpp>
  #endif
  #ifndef _COM_SUN_STAR_FRAME_XCONTROLLER_HPP_
  #include <com/sun/star/frame/XController.hpp>
  #endif
  #ifndef _COM_SUN_STAR_AWT_XTOOLKIT_HPP_
  #include <com/sun/star/awt/XToolkit.hpp>
  #endif
  #ifndef _COM_SUN_STAR_AWT_XWINDOWPEER_HPP_
  #include <com/sun/star/awt/XWindowPeer.hpp>
  #endif
  #ifndef _COM_SUN_STAR_AWT_WINDOWATTRIBUTE_HPP_
  #include <com/sun/star/awt/WindowAttribute.hpp>
  #endif
  #ifndef _COM_SUN_STAR_AWT_XMESSAGEBOX_HPP_
  #include <com/sun/star/awt/XMessageBox.hpp>
  #endif
 
  using rtl::OUString;
  using namespace com::sun::star::uno;
  using namespace com::sun::star::frame;
  using namespace com::sun::star::awt;
  using com::sun::star::lang::XMultiServiceFactory;
  using com::sun::star::beans::PropertyValue;
  using com::sun::star::util::URL;
 
  // This is the service name an Add-On has to implement
  #define SERVICE_NAME "com.sun.star.frame.ProtocolHandler"
 
  /**
   *  Show a message box with the UNO based toolkit
   */
  static void ShowMessageBox(const Reference< XToolkit >& rToolkit, const Reference< XFrame >& rFrame, const OUString& aTitle, const OUString& aMsgText)
  {
      if ( rFrame.is() && rToolkit.is() )
      {
          // describe window properties. 
          WindowDescriptor                aDescriptor; 
          aDescriptor.Type              = WindowClass_MODALTOP ; 
          aDescriptor.WindowServiceName = OUString( RTL_CONSTASCII_USTRINGPARAM( "infobox" ));
          aDescriptor.ParentIndex       = -1 ; 
          aDescriptor.Parent            = Reference< XWindowPeer >( rFrame->getContainerWindow(), UNO_QUERY ) ; 
          aDescriptor.Bounds            = Rectangle(0,0,300,200) ; 
          aDescriptor.WindowAttributes  = WindowAttribute::BORDER   | 
                                          WindowAttribute::MOVEABLE | 
                                          WindowAttribute::CLOSEABLE; 
          Reference< XWindowPeer > xPeer = rToolkit->createWindow( aDescriptor ); if ( xPeer.is() ) 
          { 
              Reference< XMessageBox > xMsgBox( xPeer, UNO_QUERY );
              if ( xMsgBox.is() )
              { 
                  xMsgBox->setCaptionText( aTitle ); 
                  xMsgBox->setMessageText( aMsgText ); 
                  xMsgBox->execute(); 
              } 
          } 
      }
  }
 
  //##################################################################################################
  //#### Implementation of the ProtocolHandler and Dispatch Interfaces ###################
  //################################################################################################## 
  // XInitialization 
  /**
   *  Called by the Office framework.
   *  We store the context information
   *  given, like the frame we are bound to, into our members. 
   */
  void SAL_CALL Addon::initialize( const Sequence< Any >& aArguments ) throw ( Exception, RuntimeException)
  {
      Reference < XFrame > xFrame;
      if ( aArguments.getLength() )
      {
          aArguments[0] >>= xFrame;
          mxFrame = xFrame;
      }
 
      // Create the toolkit to have access to it later
      mxToolkit = Reference< XToolkit >( mxMSF->createInstance( 
                                          OUString( RTL_CONSTASCII_USTRINGPARAM( 
                                              "com.sun.star.awt.Toolkit" ))), UNO_QUERY );
  }
 
  // XDispatchProvider 
  /** 
   *  Called by the Office framework.
   *  We are ask to query the given URL and return a dispatch object if the URL
   *  contains an Add-On command.
   */
  Reference< XDispatch > SAL_CALL Addon::queryDispatch( const URL& aURL, const ::rtl::OUString& sTargetFrameName, sal_Int32 nSearchFlags )
                                  throw( RuntimeException )
  {
      Reference < XDispatch > xRet;
      if ( aURL.Protocol.compareToAscii("org.openoffice.Office.addon.example:") == 0 )
      {
          if ( aURL.Path.compareToAscii( "Function1" ) == 0 )
              xRet = this;
          else if ( aURL.Path.compareToAscii( "Function2" ) == 0 )
              xRet = this;
          else if ( aURL.Path.compareToAscii( "Help" ) == 0 )
              xRet = this;
      }
 
      return xRet;
  }
 
  /** 
   *  Called by the Office framework.
   *  We are ask to query the given sequence of URLs and return dispatch objects if the URLs
   *  contain Add-On commands.
   */
  Sequence < Reference< XDispatch > > SAL_CALL Addon::queryDispatches( 
          const Sequence < DispatchDescriptor >& seqDescripts )
          throw( RuntimeException )
  {
      sal_Int32 nCount = seqDescripts.getLength();
      Sequence < Reference < XDispatch > > lDispatcher( nCount );
 
      for( sal_Int32 i=0; i<nCount; ++i )
          lDispatcher[i] = queryDispatch( seqDescripts[i].FeatureURL, seqDescripts[i].FrameName, seqDescripts[i].SearchFlags );
 
      return lDispatcher;
  }
 
  // XDispatch 
  /** 
   *  Called by the Office framework.
   *  We are ask to execute the given Add-On command URL.
   */
  void SAL_CALL Addon::dispatch( const URL& aURL, const Sequence < PropertyValue >& lArgs ) throw (RuntimeException)
  {
      if ( aURL.Protocol.compareToAscii("org.openoffice.Office.addon.example:") == 0 )
      {
          if ( aURL.Path.compareToAscii( "Function1" ) == 0 )
          {
              ShowMessageBox( mxToolkit, mxFrame, 
                              OUString( RTL_CONSTASCII_USTRINGPARAM( "SDK Add-On example" )),
                              OUString( RTL_CONSTASCII_USTRINGPARAM( "Function 1 activated" )) );
          }
          else if ( aURL.Path.compareToAscii( "Function2" ) == 0 )
          {
              ShowMessageBox( mxToolkit, mxFrame, 
                              OUString( RTL_CONSTASCII_USTRINGPARAM( "SDK Add-On example" )),
                              OUString( RTL_CONSTASCII_USTRINGPARAM( "Function 2 activated" )) );
          }
          else if ( aURL.Path.compareToAscii( "Help" ) == 0 )
          {
              // Show info box
              ShowMessageBox( mxToolkit, mxFrame, 
                              OUString( RTL_CONSTASCII_USTRINGPARAM( "About SDK Add-On example" )),
                              OUString( RTL_CONSTASCII_USTRINGPARAM( "This is the SDK Add-On example")));
          }
      }
  }
  /** 
   *  Called by the Office framework.
   *  We are asked to store a status listener for the given URL.
   */
  void SAL_CALL Addon::addStatusListener( const Reference< XStatusListener >& xControl, const URL& aURL ) throw (RuntimeException)
  {
  }
 
  /** 
   *  Called by the Office framework.
   *  We are asked to remove a status listener for the given URL.
   */
  void SAL_CALL Addon::removeStatusListener( const Reference< XStatusListener >& xControl, 
          const URL& aURL ) 
          throw (RuntimeException)
  {
  }
 
  //##################################################################################################
  //#### Implementation of the recommended/mandatory interfaces of a UNO component ###################
  //################################################################################################## 
  // XServiceInfo 
  ::rtl::OUString SAL_CALL Addon::getImplementationName( )
          throw (RuntimeException)
  {
          return Addon_getImplementationName();
  }
 
  sal_Bool SAL_CALL Addon::supportsService( const ::rtl::OUString& rServiceName )
          throw (RuntimeException)
  {
          return Addon_supportsService( rServiceName );
  }
 
  Sequence< ::rtl::OUString > SAL_CALL Addon::getSupportedServiceNames( )
          throw (RuntimeException)
  {
          return Addon_getSupportedServiceNames();
  }