1 /**************************************************************
2  *
3  * Licensed to the Apache Software Foundation (ASF) under one
4  * or more contributor license agreements.  See the NOTICE file
5  * distributed with this work for additional information
6  * regarding copyright ownership.  The ASF licenses this file
7  * to you under the Apache License, Version 2.0 (the
8  * "License"); you may not use this file except in compliance
9  * with the License.  You may obtain a copy of the License at
10  *
11  *   http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing,
14  * software distributed under the License is distributed on an
15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16  * KIND, either express or implied.  See the License for the
17  * specific language governing permissions and limitations
18  * under the License.
19  *
20  *************************************************************/
21 
22 
23 
24 #if ! defined INCLUDED_DP_HELPBACKENDDB_HXX
25 #define INCLUDED_DP_HELPBACKENDDB_HXX
26 
27 #include "rtl/ustring.hxx"
28 #include <list>
29 #include "boost/optional.hpp"
30 #include "dp_backenddb.hxx"
31 
32 namespace css = ::com::sun::star;
33 
34 namespace com { namespace sun { namespace star {
35         namespace uno {
36         class XComponentContext;
37         }
38 }}}
39 
40 namespace dp_registry {
41 namespace backend {
42 namespace help {
43 
44 /* The XML file stores the extensions which are currently registered.
45    They will be removed when they are revoked.
46  */
47 class HelpBackendDb: public dp_registry::backend::BackendDb
48 {
49 protected:
50     virtual ::rtl::OUString getDbNSName();
51 
52     virtual ::rtl::OUString getNSPrefix();
53 
54     virtual ::rtl::OUString getRootElementName();
55 
56     virtual ::rtl::OUString getKeyElementName();
57 
58 public:
59     struct Data
60     {
61         /* the URL to the folder containing the compiled help files, etc.
62          */
63         ::rtl::OUString dataUrl;
64 
65     };
66 
67 public:
68 
69     HelpBackendDb( css::uno::Reference<css::uno::XComponentContext> const &  xContext,
70                         ::rtl::OUString const & url);
71 
72     void addEntry(::rtl::OUString const & url, Data const & data);
73 
74     ::boost::optional<Data> getEntry(::rtl::OUString const & url);
75     //must also return the data urls for entries with @activ="false". That is,
76     //those are currently revoked.
77     ::std::list< ::rtl::OUString> getAllDataUrls();
78 
79 };
80 
81 
82 
83 }
84 }
85 }
86 #endif
87 
88