framework/inc/services/urltransformer.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __FRAMEWORK_SERVICES_URLTRANSFORMER_HXX_
  21 #define __FRAMEWORK_SERVICES_URLTRANSFORMER_HXX_
  22
  23 #include <threadhelp/threadhelpbase.hxx>
  24 #include <macros/generic.hxx>
  25 #include <macros/debug.hxx>
  26 #include <macros/xinterface.hxx>
  27 #include <macros/xtypeprovider.hxx>
  28 #include <macros/xserviceinfo.hxx>
  29 #include <general.h>
  30
  31 #include <com/sun/star/util/XURLTransformer.hpp>
  32 #include <com/sun/star/util/URL.hpp>
  33
  34 #include <cppuhelper/implbase2.hxx>
  35
  36 namespace framework{
  37
  38 /*-************************************************************************************************************//**
  39     @short
  40
  41     @descr      -
  42
  43     @implements XInterface
  44                 XTypeProvider
  45                 XServiceInfo
  46                 XURLTransformer
  47
  48     @base       ThreadHelpBase
  49                 OWeakObject
  50 *//*-*************************************************************************************************************/
  51
  52 class URLTransformer    :   public ::cppu::WeakImplHelper2< ::com::sun::star::util::XURLTransformer, css::lang::XServiceInfo>
  53 {
  54     //-------------------------------------------------------------------------------------------------------------
  55     //  public methods
  56     //-------------------------------------------------------------------------------------------------------------
  57
  58     public:
  59
  60         //---------------------------------------------------------------------------------------------------------
  61         //  constructor / destructor
  62         //---------------------------------------------------------------------------------------------------------
  63
  64         /*-****************************************************************************************************//**
  65             @short      -
  66             @descr      -
  67
  68             @seealso    -
  69
  70             @param      -
  71             @return     -
  72
  73             @onerror    -
  74         *//*-*****************************************************************************************************/
  75
  76          URLTransformer( const css::uno::Reference< css::lang::XMultiServiceFactory >& sFactory );
  77
  78         /*-****************************************************************************************************//**
  79             @short      -
  80             @descr      -
  81
  82             @seealso    -
  83
  84             @param      -
  85             @return     -
  86
  87             @onerror    -
  88         *//*-*****************************************************************************************************/
  89
  90         virtual ~URLTransformer();
  91
  92         //---------------------------------------------------------------------------------------------------------
  93         //  XInterface, XTypeProvider, XServiceInfo
  94         //---------------------------------------------------------------------------------------------------------
  95
  96         DECLARE_XSERVICEINFO
  97
  98         //---------------------------------------------------------------------------------------------------------
  99         //  XURLTransformer
 100         //---------------------------------------------------------------------------------------------------------
 101
 102         /*-****************************************************************************************************//**
 103             @short      -
 104             @descr      -
 105
 106             @seealso    -
 107
 108             @param      -
 109             @return     -
 110
 111             @onerror    -
 112         *//*-*****************************************************************************************************/
 113
 114         virtual sal_Bool SAL_CALL parseStrict( css::util::URL& aURL ) throw( css::uno::RuntimeException );
 115
 116         /*-****************************************************************************************************//**
 117             @short      -
 118             @descr      -
 119
 120             @seealso    -
 121
 122             @param      -
 123             @return     -
 124
 125             @onerror    -
 126         *//*-*****************************************************************************************************/
 127
 128         virtual sal_Bool SAL_CALL parseSmart(           css::util::URL&     aURL            ,
 129                                                 const   OUString&    sSmartProtocol  ) throw( css::uno::RuntimeException );
 130
 131         /*-****************************************************************************************************//**
 132             @short      -
 133             @descr      -
 134
 135             @seealso    -
 136
 137             @param      -
 138             @return     -
 139
 140             @onerror    -
 141         *//*-*****************************************************************************************************/
 142
 143         virtual sal_Bool SAL_CALL assemble( css::util::URL& aURL ) throw( css::uno::RuntimeException );
 144
 145         /*-****************************************************************************************************//**
 146             @short      -
 147             @descr      -
 148
 149             @seealso    -
 150
 151             @param      -
 152             @return     -
 153
 154             @onerror    -
 155         *//*-*****************************************************************************************************/
 156
 157         virtual OUString SAL_CALL getPresentation(   const   css::util::URL&     aURL            ,
 158                                                                     sal_Bool            bWithPassword   ) throw( css::uno::RuntimeException );
 159
 160     //-------------------------------------------------------------------------------------------------------------
 161     //  protected methods
 162     //-------------------------------------------------------------------------------------------------------------
 163
 164     protected:
 165
 166     //-------------------------------------------------------------------------------------------------------------
 167     //  private methods
 168     //-------------------------------------------------------------------------------------------------------------
 169
 170     private:
 171
 172     //-------------------------------------------------------------------------------------------------------------
 173     //  debug methods
 174     //  (should be private everyway!)
 175     //-------------------------------------------------------------------------------------------------------------
 176
 177
 178     //-------------------------------------------------------------------------------------------------------------
 179     //  variables
 180     //  (should be private everyway!)
 181     //-------------------------------------------------------------------------------------------------------------
 182
 183     private:
 184
 185         css::uno::Reference< css::lang::XMultiServiceFactory >      m_xFactory          ;   /// reference to factory, which has created this instance
 186
 187 };      //  class URLTransformer
 188
 189 }       //  namespace framework
 190
 191 #endif  //  #ifndef __FRAMEWORK_SERVICES_URLTRANSFORMER_HXX_
 192
 193 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */