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 #pragma once
21 
22 #include <rtl/ustring.hxx>
23 #include <optional>
24 #include <string_view>
25 
26 #include <dp_backenddb.hxx>
27 
28 namespace com::sun::star::uno
29 {
30 class XComponentContext;
31 }
32 
34 {
35 /* The XML file stores the extensions which are currently registered.
36  They will be removed when they are revoked.
37  */
39 {
40 protected:
41  virtual OUString getDbNSName() override;
42 
43  virtual OUString getNSPrefix() override;
44 
45  virtual OUString getRootElementName() override;
46 
47  virtual OUString getKeyElementName() override;
48 
49 public:
50  struct Data
51  {
52  /* the URL to the folder containing the compiled help files, etc.
53  */
54  OUString dataUrl;
55  };
56 
57 public:
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(std::u16string_view 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 /* 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:2176
::std::optional< Data > getEntry(std::u16string_view url)
HelpBackendDb(css::uno::Reference< css::uno::XComponentContext > const &xContext, OUString const &url)