include/svtools/fileurlbox.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 INCLUDED_SVTOOLS_FILEURLBOX_HXX
  21 #define INCLUDED_SVTOOLS_FILEURLBOX_HXX
  22
  23 #include <svtools/svtdllapi.h>
  24 #include <svtools/inettbc.hxx>
  25
  26
  27 namespace svt
  28 {
  29
  30
  31
  32     //= FileURLBox
  33
  34     class SVT_DLLPUBLIC FileURLBox : public SvtURLBox
  35     {
  36     private:
  37         OUString      m_sPreservedText;
  38
  39     public:
  40         FileURLBox( vcl::Window* _pParent, WinBits _nStyle );
  41
  42     protected:
  43         virtual bool        PreNotify( NotifyEvent& rNEvt ) SAL_OVERRIDE;
  44         virtual bool        Notify( NotifyEvent& rNEvt ) SAL_OVERRIDE;
  45
  46     public:
  47         /** transforms the given URL content into a system-dependent notation, if possible, and
  48             sets it as current display text
  49
  50             <p>If the user enters an URL such as "file:///c:/some%20directory", then this will be converted
  51             to "c:\some directory" for better readability.</p>
  52
  53             @param _rURL
  54                 denotes the URL to set. Note that no check is made whether it is a valid URL - this
  55                 is the responsibility of the caller.
  56
  57             @see SvtURLBox::GetURL
  58         */
  59         void    DisplayURL( const OUString& _rURL );
  60     };
  61
  62
  63 }   // namespace svt
  64
  65
  66 #endif // INCLUDED_SVTOOLS_FILEURLBOX_HXX
  67
  68 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */