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