include/svl/inethist.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 #ifndef INCLUDED_SVL_INETHIST_HXX
  20 #define INCLUDED_SVL_INETHIST_HXX
  21
  22 #include <svl/SfxBroadcaster.hxx>
  23 #include <svl/hint.hxx>
  24 #include <svl/svldllapi.h>
  25 #include <tools/urlobj.hxx>
  26 #include <memory>
  27
  28 class INetURLHistory_Impl;
  29 class SVL_DLLPUBLIC INetURLHistory : public SfxBroadcaster
  30 {
  31     struct SAL_DLLPRIVATE StaticInstance
  32     {
  33         INetURLHistory * operator()();
  34     };
  35     friend INetURLHistory * StaticInstance::operator()();
  36
  37     /** Representation.
  38     */
  39     std::unique_ptr<INetURLHistory_Impl> m_pImpl;
  40
  41     /** Construction/Destruction.
  42     */
  43     SAL_DLLPRIVATE INetURLHistory();
  44     SAL_DLLPRIVATE virtual ~INetURLHistory() override;
  45
  46     /** Implementation.
  47     */
  48     SAL_DLLPRIVATE static void NormalizeUrl_Impl (INetURLObject &rUrl);
  49
  50     void PutUrl_Impl   (const INetURLObject &rUrl);
  51     bool QueryUrl_Impl (const INetURLObject &rUrl);
  52
  53     /** Not implemented.
  54     */
  55     INetURLHistory (const INetURLHistory&) = delete;
  56     INetURLHistory& operator= (const INetURLHistory&) = delete;
  57
  58 public:
  59     /** GetOrCreate.
  60     */
  61     static INetURLHistory* GetOrCreate();
  62
  63     /** QueryProtocol.
  64     */
  65     bool QueryProtocol (INetProtocol eProto) const
  66     {
  67         return ((eProto == INetProtocol::File ) ||
  68                 (eProto == INetProtocol::Ftp  ) ||
  69                 (eProto == INetProtocol::Http ) ||
  70                 (eProto == INetProtocol::Https)    );
  71     }
  72
  73     /** QueryUrl.
  74     */
  75     bool QueryUrl (const INetURLObject &rUrl)
  76     {
  77         if (QueryProtocol (rUrl.GetProtocol()))
  78             return QueryUrl_Impl (rUrl);
  79         else
  80             return false;
  81     }
  82
  83     bool QueryUrl (const OUString &rUrl)
  84     {
  85         INetProtocol eProto =
  86             INetURLObject::CompareProtocolScheme (rUrl);
  87         if (QueryProtocol (eProto))
  88             return QueryUrl_Impl (INetURLObject (rUrl));
  89         else
  90             return false;
  91     }
  92
  93     /** PutUrl.
  94     */
  95     void PutUrl (const INetURLObject &rUrl)
  96     {
  97         if (QueryProtocol (rUrl.GetProtocol()))
  98             PutUrl_Impl (rUrl);
  99     }
 100 };
 101
 102 // broadcasted from PutUrl().
 103 class SVL_DLLPUBLIC INetURLHistoryHint: public SfxHint
 104 {
 105     const INetURLObject* pObj;
 106 public:
 107     explicit INetURLHistoryHint( const INetURLObject* Object ) : pObj(Object) {}
 108     const INetURLObject* GetObject() const { return pObj; }
 109 };
 110
 111 #endif // INCLUDED_SVL_INETHIST_HXX
 112
 113 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */