Line data    Source code

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