desktop/source/deployment/registry/help/dp_helpbackenddb.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_DESKTOP_SOURCE_DEPLOYMENT_REGISTRY_HELP_DP_HELPBACKENDDB_HXX
  21 #define INCLUDED_DESKTOP_SOURCE_DEPLOYMENT_REGISTRY_HELP_DP_HELPBACKENDDB_HXX
  22
  23 #include <rtl/ustring.hxx>
  24 #include <boost/optional.hpp>
  25 #include <dp_backenddb.hxx>
  26
  27 namespace com { namespace sun { namespace star {
  28         namespace uno {
  29         class XComponentContext;
  30         }
  31 }}}
  32
  33 namespace dp_registry {
  34 namespace backend {
  35 namespace help {
  36
  37 /* The XML file stores the extensions which are currently registered.
  38    They will be removed when they are revoked.
  39  */
  40 class HelpBackendDb: public dp_registry::backend::BackendDb
  41 {
  42 protected:
  43     virtual OUString getDbNSName() override;
  44
  45     virtual OUString getNSPrefix() override;
  46
  47     virtual OUString getRootElementName() override;
  48
  49     virtual OUString getKeyElementName() override;
  50
  51 public:
  52     struct Data
  53     {
  54         /* the URL to the folder containing the compiled help files, etc.
  55          */
  56         OUString dataUrl;
  57
  58     };
  59
  60 public:
  61
  62     HelpBackendDb( css::uno::Reference<css::uno::XComponentContext> const &  xContext,
  63                         OUString const & url);
  64
  65     void addEntry(OUString const & url, Data const & data);
  66
  67     ::boost::optional<Data> getEntry(OUString const & url);
  68     //must also return the data urls for entries with @active="false". That is,
  69     //those are currently revoked.
  70     std::vector< OUString> getAllDataUrls();
  71
  72 };
  73
  74
  75 }
  76 }
  77 }
  78 #endif
  79
  80 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */