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