1 /************************************************************************* 2 * 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * Copyright 2000, 2010 Oracle and/or its affiliates. 6 * 7 * OpenOffice.org - a multi-platform office productivity suite 8 * 9 * This file is part of OpenOffice.org. 10 * 11 * OpenOffice.org is free software: you can redistribute it and/or modify 12 * it under the terms of the GNU Lesser General Public License version 3 13 * only, as published by the Free Software Foundation. 14 * 15 * OpenOffice.org is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU Lesser General Public License version 3 for more details 19 * (a copy is included in the LICENSE file that accompanied this code). 20 * 21 * You should have received a copy of the GNU Lesser General Public License 22 * version 3 along with OpenOffice.org. If not, see 23 * <http://www.openoffice.org/license.html> 24 * for a copy of the LGPLv3 License. 25 * 26 ************************************************************************/ 27 28 #if ! defined INCLUDED_DP_HELPBACKENDDB_HXX 29 #define INCLUDED_DP_HELPBACKENDDB_HXX 30 31 #include "rtl/ustring.hxx" 32 #include <list> 33 #include "boost/optional.hpp" 34 #include "dp_backenddb.hxx" 35 36 namespace css = ::com::sun::star; 37 38 namespace com { namespace sun { namespace star { 39 namespace uno { 40 class XComponentContext; 41 } 42 }}} 43 44 namespace dp_registry { 45 namespace backend { 46 namespace help { 47 48 /* The XML file stores the extensions which are currently registered. 49 They will be removed when they are revoked. 50 */ 51 class HelpBackendDb: public dp_registry::backend::BackendDb 52 { 53 protected: 54 virtual ::rtl::OUString getDbNSName(); 55 56 virtual ::rtl::OUString getNSPrefix(); 57 58 virtual ::rtl::OUString getRootElementName(); 59 60 virtual ::rtl::OUString getKeyElementName(); 61 62 public: 63 struct Data 64 { 65 /* the URL to the folder containing the compiled help files, etc. 66 */ 67 ::rtl::OUString dataUrl; 68 69 }; 70 71 public: 72 73 HelpBackendDb( css::uno::Reference<css::uno::XComponentContext> const & xContext, 74 ::rtl::OUString const & url); 75 76 void addEntry(::rtl::OUString const & url, Data const & data); 77 78 ::boost::optional<Data> getEntry(::rtl::OUString const & url); 79 //must also return the data urls for entries with @activ="false". That is, 80 //those are currently revoked. 81 ::std::list< ::rtl::OUString> getAllDataUrls(); 82 83 }; 84 85 86 87 } 88 } 89 } 90 #endif 91 92