odk/examples/DevelopersGuide/Components/Addons/ProtocolHandlerAddon_cpp/addon.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  *  The Contents of this file are made available subject to the terms of
   5  *  the BSD license.
   6  *
   7  *  Copyright 2000, 2010 Oracle and/or its affiliates.
   8  *  All rights reserved.
   9  *
  10  *  Redistribution and use in source and binary forms, with or without
  11  *  modification, are permitted provided that the following conditions
  12  *  are met:
  13  *  1. Redistributions of source code must retain the above copyright
  14  *     notice, this list of conditions and the following disclaimer.
  15  *  2. Redistributions in binary form must reproduce the above copyright
  16  *     notice, this list of conditions and the following disclaimer in the
  17  *     documentation and/or other materials provided with the distribution.
  18  *  3. Neither the name of Sun Microsystems, Inc. nor the names of its
  19  *     contributors may be used to endorse or promote products derived
  20  *     from this software without specific prior written permission.
  21  *
  22  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  23  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  24  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  25  *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  26  *  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  27  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  28  *  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
  29  *  OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  30  *  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
  31  *  TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
  32  *  USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  33  *
  34  *************************************************************************/
  35
  36 #ifndef INCLUDED_EXAMPLES_COMPONENTS_ADDONS_PROTOCOLHANDLERADDON_CPP_ADDON_HXX
  37 #define INCLUDED_EXAMPLES_COMPONENTS_ADDONS_PROTOCOLHANDLERADDON_CPP_ADDON_HXX
  38
  39 #include <com/sun/star/lang/XInitialization.hpp>
  40 #include <com/sun/star/frame/XDispatchProvider.hpp>
  41 #include <com/sun/star/lang/XServiceInfo.hpp>
  42 #include <cppuhelper/implbase4.hxx>
  43
  44 #define IMPLEMENTATION_NAME "org.openoffice.Office.addon.example"
  45
  46 namespace com
  47 {
  48     namespace sun
  49     {
  50         namespace star
  51         {
  52             namespace frame
  53             {
  54                 class XFrame;
  55             }
  56             namespace awt
  57             {
  58                 class XToolkit;
  59             }
  60             namespace uno
  61             {
  62                 class XComponentContext;
  63             }
  64         }
  65     }
  66 }
  67
  68 class Addon : public cppu::WeakImplHelper4
  69 <
  70     com::sun::star::frame::XDispatchProvider,
  71     com::sun::star::frame::XDispatch,
  72     com::sun::star::lang::XInitialization,
  73     com::sun::star::lang::XServiceInfo
  74 >
  75 {
  76 private:
  77     ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext > mxContext;
  78     ::com::sun::star::uno::Reference< ::com::sun::star::frame::XFrame > mxFrame;
  79     ::com::sun::star::uno::Reference< ::com::sun::star::awt::XToolkit > mxToolkit;
  80
  81 public:
  82     Addon( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext > &rxContext)
  83         : mxContext( rxContext ) {}
  84
  85     // XDispatchProvider
  86     virtual ::com::sun::star::uno::Reference< ::com::sun::star::frame::XDispatch >
  87             SAL_CALL queryDispatch( const ::com::sun::star::util::URL& aURL,
  88                 const ::rtl::OUString& sTargetFrameName, sal_Int32 nSearchFlags )
  89                 throw( ::com::sun::star::uno::RuntimeException );
  90     virtual ::com::sun::star::uno::Sequence < ::com::sun::star::uno::Reference< ::com::sun::star::frame::XDispatch > >
  91         SAL_CALL queryDispatches(
  92             const ::com::sun::star::uno::Sequence < ::com::sun::star::frame::DispatchDescriptor >& seqDescriptor )
  93             throw( ::com::sun::star::uno::RuntimeException );
  94
  95     // XDispatch
  96     virtual void SAL_CALL dispatch( const ::com::sun::star::util::URL& aURL,
  97         const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& lArgs )
  98         throw (::com::sun::star::uno::RuntimeException);
  99     virtual void SAL_CALL addStatusListener( const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XStatusListener >& xControl,
 100         const ::com::sun::star::util::URL& aURL ) throw (::com::sun::star::uno::RuntimeException);
 101     virtual void SAL_CALL removeStatusListener( const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XStatusListener >& xControl,
 102         const ::com::sun::star::util::URL& aURL ) throw (::com::sun::star::uno::RuntimeException);
 103
 104     // XInitialization
 105     virtual void SAL_CALL initialize( const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any >& aArguments )
 106         throw (::com::sun::star::uno::Exception, ::com::sun::star::uno::RuntimeException);
 107
 108     // XServiceInfo
 109     virtual ::rtl::OUString SAL_CALL getImplementationName(  )
 110         throw (::com::sun::star::uno::RuntimeException);
 111     virtual sal_Bool SAL_CALL supportsService( const ::rtl::OUString& ServiceName )
 112         throw (::com::sun::star::uno::RuntimeException);
 113     virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL getSupportedServiceNames(  )
 114         throw (::com::sun::star::uno::RuntimeException);
 115 };
 116
 117 ::rtl::OUString Addon_getImplementationName()
 118     throw ( ::com::sun::star::uno::RuntimeException );
 119
 120 sal_Bool SAL_CALL Addon_supportsService( const ::rtl::OUString& ServiceName )
 121     throw ( ::com::sun::star::uno::RuntimeException );
 122
 123 ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL Addon_getSupportedServiceNames(  )
 124     throw ( ::com::sun::star::uno::RuntimeException );
 125
 126 ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface >
 127 SAL_CALL Addon_createInstance( const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext > & rContext)
 128     throw ( ::com::sun::star::uno::Exception );
 129
 130 #endif // INCLUDED_EXAMPLES_COMPONENTS_ADDONS_PROTOCOLHANDLERADDON_CPP_ADDON_HXX
 131
 132 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */