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/implbase2.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 ::cppu::WeakImplHelper2< ::com::sun::star::util::XURLTransformer, css::lang::XServiceInfo>
  88 {
  89     //-------------------------------------------------------------------------------------------------------------
  90     //  public methods
  91     //-------------------------------------------------------------------------------------------------------------
  92
  93     public:
  94
  95         //---------------------------------------------------------------------------------------------------------
  96         //      constructor / destructor
  97         //---------------------------------------------------------------------------------------------------------
  98
  99         /*-****************************************************************************************************//**
 100             @short              -
 101             @descr              -
 102
 103             @seealso    -
 104
 105             @param              -
 106             @return             -
 107
 108             @onerror    -
 109         *//*-*****************************************************************************************************/
 110
 111          URLTransformer( const css::uno::Reference< css::lang::XMultiServiceFactory >& sFactory );
 112
 113         /*-****************************************************************************************************//**
 114             @short              -
 115             @descr              -
 116
 117             @seealso    -
 118
 119             @param              -
 120             @return             -
 121
 122             @onerror    -
 123         *//*-*****************************************************************************************************/
 124
 125         virtual ~URLTransformer();
 126
 127         //---------------------------------------------------------------------------------------------------------
 128         //      XInterface, XTypeProvider, XServiceInfo
 129         //---------------------------------------------------------------------------------------------------------
 130
 131         DECLARE_XSERVICEINFO
 132
 133         //---------------------------------------------------------------------------------------------------------
 134         //      XURLTransformer
 135         //---------------------------------------------------------------------------------------------------------
 136
 137         /*-****************************************************************************************************//**
 138             @short              -
 139             @descr              -
 140
 141             @seealso    -
 142
 143             @param              -
 144             @return             -
 145
 146             @onerror    -
 147         *//*-*****************************************************************************************************/
 148
 149         virtual sal_Bool SAL_CALL parseStrict( css::util::URL& aURL ) throw( css::uno::RuntimeException );
 150
 151         /*-****************************************************************************************************//**
 152             @short              -
 153             @descr              -
 154
 155             @seealso    -
 156
 157             @param              -
 158             @return             -
 159
 160             @onerror    -
 161         *//*-*****************************************************************************************************/
 162
 163         virtual sal_Bool SAL_CALL parseSmart(                   css::util::URL&         aURL                    ,
 164                                                 const   ::rtl::OUString&        sSmartProtocol  ) throw( css::uno::RuntimeException );
 165
 166         /*-****************************************************************************************************//**
 167             @short              -
 168             @descr              -
 169
 170             @seealso    -
 171
 172             @param              -
 173             @return             -
 174
 175             @onerror    -
 176         *//*-*****************************************************************************************************/
 177
 178         virtual sal_Bool SAL_CALL assemble( css::util::URL& aURL ) throw( css::uno::RuntimeException );
 179
 180         /*-****************************************************************************************************//**
 181             @short              -
 182             @descr              -
 183
 184             @seealso    -
 185
 186             @param              -
 187             @return             -
 188
 189             @onerror    -
 190         *//*-*****************************************************************************************************/
 191
 192         virtual ::rtl::OUString SAL_CALL getPresentation(       const   css::util::URL&         aURL                    ,
 193                                                                     sal_Bool                    bWithPassword   ) throw( css::uno::RuntimeException );
 194
 195     //-------------------------------------------------------------------------------------------------------------
 196     //  protected methods
 197     //-------------------------------------------------------------------------------------------------------------
 198
 199     protected:
 200
 201     //-------------------------------------------------------------------------------------------------------------
 202     //  private methods
 203     //-------------------------------------------------------------------------------------------------------------
 204
 205     private:
 206
 207     //-------------------------------------------------------------------------------------------------------------
 208     //  debug methods
 209     //  (should be private everyway!)
 210     //-------------------------------------------------------------------------------------------------------------
 211
 212
 213     //-------------------------------------------------------------------------------------------------------------
 214     //  variables
 215     //  (should be private everyway!)
 216     //-------------------------------------------------------------------------------------------------------------
 217
 218     private:
 219
 220         css::uno::Reference< css::lang::XMultiServiceFactory >          m_xFactory                      ;       /// reference to factory, which has created this instance
 221
 222 };              //      class URLTransformer
 223
 224 }               //      namespace framework
 225
 226 #endif  //      #ifndef __FRAMEWORK_SERVICES_URLTRANSFORMER_HXX_