forms/source/inc/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.4 $
  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 FORMS_SOURCE_INC_URLTRANSFORMER_HXX
  32 #define FORMS_SOURCE_INC_URLTRANSFORMER_HXX
  33
  34 /** === begin UNO includes === **/
  35 #include <com/sun/star/util/XURLTransformer.hpp>
  36 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  37 #include <com/sun/star/util/URL.hpp>
  38 /** === end UNO includes === **/
  39
  40 //........................................................................
  41 namespace frm
  42 {
  43 //........................................................................
  44
  45     //====================================================================
  46     //= UrlTransformer
  47     //====================================================================
  48     class UrlTransformer
  49     {
  50     private:
  51         ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >
  52                         m_xORB;
  53         mutable ::com::sun::star::uno::Reference< ::com::sun::star::util::XURLTransformer >
  54                         m_xTransformer;
  55         mutable bool    m_bTriedToCreateTransformer;
  56
  57     public:
  58         UrlTransformer( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _rxORB );
  59
  60         /** returns an URL object for the given URL string
  61         */
  62         ::com::sun::star::util::URL
  63             getStrictURL( const ::rtl::OUString& _rURL ) const;
  64
  65         /** returns an URL object for the given URL ASCII string
  66         */
  67         ::com::sun::star::util::URL
  68             getStrictURLFromAscii( const sal_Char* _pAsciiURL ) const;
  69
  70         /** parses a given URL smartly, with a protocol given by ASCII string
  71         */
  72         void
  73             parseSmartWithAsciiProtocol( ::com::sun::star::util::URL& _rURL, const sal_Char* _pAsciiURL ) const;
  74
  75     private:
  76         /** ensures that we have an URLTransformer instance in <member>m_xTransformer</member>
  77
  78             @return
  79                 <TRUE/> if and only if m_xTransformer is not <NULL/>
  80         */
  81         bool    implEnsureTransformer() const;
  82     };
  83
  84 //........................................................................
  85 } // namespace frm
  86 //........................................................................
  87
  88 #endif // FORMS_SOURCE_INC_URLTRANSFORMER_HXX
  89