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 #ifndef SC_ADDINHELPID_HXX 29 #define SC_ADDINHELPID_HXX 30 31 #include <rtl/ustring.hxx> 32 #include <rtl/string.hxx> 33 34 // ============================================================================ 35 36 struct ScUnoAddInHelpId; 37 38 /** Generates help IDs for standard Calc AddIns. */ 39 class ScUnoAddInHelpIdGenerator 40 { 41 private: 42 const ScUnoAddInHelpId* pCurrHelpIds; /// Array of function names and help IDs. 43 sal_uInt32 nArrayCount; /// Count of array entries. 44 45 ScUnoAddInHelpIdGenerator(); // disabled 46 public: 47 ScUnoAddInHelpIdGenerator( const ::rtl::OUString& rServiceName ); 48 49 /** Sets service name of the AddIn. Has to be done before requesting help IDs. */ 50 void SetServiceName( const ::rtl::OUString& rServiceName ); 51 52 /** @return The help ID of the function with given built-in name or 0 if not found. */ 53 rtl::OString GetHelpId( const ::rtl::OUString& rFuncName ) const; 54 }; 55 56 57 // ============================================================================ 58 59 #endif 60 61