framework/inc/services/urltransformer.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: urltransformer.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 __FRAMEWORK_SERVICES_URLTRANSFORMER_HXX_
  32 #define __FRAMEWORK_SERVICES_URLTRANSFORMER_HXX_
  33
  34 //_________________________________________________________________________________________________________________
  35 //      my own includes
  36 //_________________________________________________________________________________________________________________
  37
  38 #ifndef __FRAMEWORK_OMUTEXMEMBER_HXX_
  39 #include <threadhelp/threadhelpbase.hxx>
  40 #endif
  41 #include <macros/generic.hxx>
  42 #include <macros/debug.hxx>
  43 #include <macros/xinterface.hxx>
  44 #include <macros/xtypeprovider.hxx>
  45 #include <macros/xserviceinfo.hxx>
  46 #include <general.h>
  47
  48 //_________________________________________________________________________________________________________________
  49 //      interface includes
  50 //_________________________________________________________________________________________________________________
  51 #include <com/sun/star/util/XURLTransformer.hpp>
  52 #include <com/sun/star/util/URL.hpp>
  53
  54 //_________________________________________________________________________________________________________________
  55 //      other includes
  56 //_________________________________________________________________________________________________________________
  57 #include <cppuhelper/weak.hxx>
  58
  59 //_________________________________________________________________________________________________________________
  60 //      namespace
  61 //_________________________________________________________________________________________________________________
  62
  63 namespace framework{
  64
  65 //_________________________________________________________________________________________________________________
  66 //      exported const
  67 //_________________________________________________________________________________________________________________
  68
  69 //_________________________________________________________________________________________________________________
  70 //      exported definitions
  71 //_________________________________________________________________________________________________________________
  72
  73 /*-************************************************************************************************************//**
  74     @short
  75
  76     @descr              -
  77
  78     @implements XInterface
  79                 XTypeProvider
  80                 XServiceInfo
  81                 XURLTransformer
  82
  83     @base               ThreadHelpBase
  84                 OWeakObject
  85 *//*-*************************************************************************************************************/
  86
  87 class URLTransformer    :       public css::lang::XTypeProvider         ,
  88                             public css::lang::XServiceInfo              ,
  89                             public css::util::XURLTransformer   ,
  90                             public ThreadHelpBase                                       ,
  91                             public ::cppu::OWeakObject
  92 {
  93     //-------------------------------------------------------------------------------------------------------------
  94     //  public methods
  95     //-------------------------------------------------------------------------------------------------------------
  96
  97     public:
  98
  99         //---------------------------------------------------------------------------------------------------------
 100         //      constructor / destructor
 101         //---------------------------------------------------------------------------------------------------------
 102
 103         /*-****************************************************************************************************//**
 104             @short              -
 105             @descr              -
 106
 107             @seealso    -
 108
 109             @param              -
 110             @return             -
 111
 112             @onerror    -
 113         *//*-*****************************************************************************************************/
 114
 115          URLTransformer( const css::uno::Reference< css::lang::XMultiServiceFactory >& sFactory );
 116
 117         /*-****************************************************************************************************//**
 118             @short              -
 119             @descr              -
 120
 121             @seealso    -
 122
 123             @param              -
 124             @return             -
 125
 126             @onerror    -
 127         *//*-*****************************************************************************************************/
 128
 129         virtual ~URLTransformer();
 130
 131         //---------------------------------------------------------------------------------------------------------
 132         //      XInterface, XTypeProvider, XServiceInfo
 133         //---------------------------------------------------------------------------------------------------------
 134
 135         FWK_DECLARE_XINTERFACE
 136         FWK_DECLARE_XTYPEPROVIDER
 137         DECLARE_XSERVICEINFO
 138
 139         //---------------------------------------------------------------------------------------------------------
 140         //      XURLTransformer
 141         //---------------------------------------------------------------------------------------------------------
 142
 143         /*-****************************************************************************************************//**
 144             @short              -
 145             @descr              -
 146
 147             @seealso    -
 148
 149             @param              -
 150             @return             -
 151
 152             @onerror    -
 153         *//*-*****************************************************************************************************/
 154
 155         virtual sal_Bool SAL_CALL parseStrict( css::util::URL& aURL ) throw( css::uno::RuntimeException );
 156
 157         /*-****************************************************************************************************//**
 158             @short              -
 159             @descr              -
 160
 161             @seealso    -
 162
 163             @param              -
 164             @return             -
 165
 166             @onerror    -
 167         *//*-*****************************************************************************************************/
 168
 169         virtual sal_Bool SAL_CALL parseSmart(                   css::util::URL&         aURL                    ,
 170                                                 const   ::rtl::OUString&        sSmartProtocol  ) throw( css::uno::RuntimeException );
 171
 172         /*-****************************************************************************************************//**
 173             @short              -
 174             @descr              -
 175
 176             @seealso    -
 177
 178             @param              -
 179             @return             -
 180
 181             @onerror    -
 182         *//*-*****************************************************************************************************/
 183
 184         virtual sal_Bool SAL_CALL assemble( css::util::URL& aURL ) throw( css::uno::RuntimeException );
 185
 186         /*-****************************************************************************************************//**
 187             @short              -
 188             @descr              -
 189
 190             @seealso    -
 191
 192             @param              -
 193             @return             -
 194
 195             @onerror    -
 196         *//*-*****************************************************************************************************/
 197
 198         virtual ::rtl::OUString SAL_CALL getPresentation(       const   css::util::URL&         aURL                    ,
 199                                                                     sal_Bool                    bWithPassword   ) throw( css::uno::RuntimeException );
 200
 201     //-------------------------------------------------------------------------------------------------------------
 202     //  protected methods
 203     //-------------------------------------------------------------------------------------------------------------
 204
 205     protected:
 206
 207     //-------------------------------------------------------------------------------------------------------------
 208     //  private methods
 209     //-------------------------------------------------------------------------------------------------------------
 210
 211     private:
 212
 213     //-------------------------------------------------------------------------------------------------------------
 214     //  debug methods
 215     //  (should be private everyway!)
 216     //-------------------------------------------------------------------------------------------------------------
 217
 218
 219     //-------------------------------------------------------------------------------------------------------------
 220     //  variables
 221     //  (should be private everyway!)
 222     //-------------------------------------------------------------------------------------------------------------
 223
 224     private:
 225
 226         css::uno::Reference< css::lang::XMultiServiceFactory >          m_xFactory                      ;       /// reference to factory, which has created this instance
 227
 228 };              //      class URLTransformer
 229
 230 }               //      namespace framework
 231
 232 #endif  //      #ifndef __FRAMEWORK_SERVICES_URLTRANSFORMER_HXX_