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