xref: /AOO41X/main/sc/source/core/inc/addinhelpid.hxx (revision 38d50f7b14e1cf975d8c6468d9633894cd59b523)
1*38d50f7bSAndrew Rist /**************************************************************
2cdf0e10cSrcweir  *
3*38d50f7bSAndrew Rist  * Licensed to the Apache Software Foundation (ASF) under one
4*38d50f7bSAndrew Rist  * or more contributor license agreements.  See the NOTICE file
5*38d50f7bSAndrew Rist  * distributed with this work for additional information
6*38d50f7bSAndrew Rist  * regarding copyright ownership.  The ASF licenses this file
7*38d50f7bSAndrew Rist  * to you under the Apache License, Version 2.0 (the
8*38d50f7bSAndrew Rist  * "License"); you may not use this file except in compliance
9*38d50f7bSAndrew Rist  * with the License.  You may obtain a copy of the License at
10cdf0e10cSrcweir  *
11*38d50f7bSAndrew Rist  *   http://www.apache.org/licenses/LICENSE-2.0
12cdf0e10cSrcweir  *
13*38d50f7bSAndrew Rist  * Unless required by applicable law or agreed to in writing,
14*38d50f7bSAndrew Rist  * software distributed under the License is distributed on an
15*38d50f7bSAndrew Rist  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*38d50f7bSAndrew Rist  * KIND, either express or implied.  See the License for the
17*38d50f7bSAndrew Rist  * specific language governing permissions and limitations
18*38d50f7bSAndrew Rist  * under the License.
19cdf0e10cSrcweir  *
20*38d50f7bSAndrew Rist  *************************************************************/
21*38d50f7bSAndrew Rist 
22*38d50f7bSAndrew Rist 
23cdf0e10cSrcweir 
24cdf0e10cSrcweir #ifndef SC_ADDINHELPID_HXX
25cdf0e10cSrcweir #define SC_ADDINHELPID_HXX
26cdf0e10cSrcweir 
27cdf0e10cSrcweir #include <rtl/ustring.hxx>
28cdf0e10cSrcweir #include <rtl/string.hxx>
29cdf0e10cSrcweir 
30cdf0e10cSrcweir // ============================================================================
31cdf0e10cSrcweir 
32cdf0e10cSrcweir struct ScUnoAddInHelpId;
33cdf0e10cSrcweir 
34cdf0e10cSrcweir /** Generates help IDs for standard Calc AddIns. */
35cdf0e10cSrcweir class ScUnoAddInHelpIdGenerator
36cdf0e10cSrcweir {
37cdf0e10cSrcweir private:
38cdf0e10cSrcweir     const ScUnoAddInHelpId*     pCurrHelpIds;       /// Array of function names and help IDs.
39cdf0e10cSrcweir     sal_uInt32                  nArrayCount;        /// Count of array entries.
40cdf0e10cSrcweir 
41cdf0e10cSrcweir     ScUnoAddInHelpIdGenerator(); // disabled
42cdf0e10cSrcweir public:
43cdf0e10cSrcweir                                 ScUnoAddInHelpIdGenerator( const ::rtl::OUString& rServiceName );
44cdf0e10cSrcweir 
45cdf0e10cSrcweir     /** Sets service name of the AddIn. Has to be done before requesting help IDs. */
46cdf0e10cSrcweir     void                        SetServiceName( const ::rtl::OUString& rServiceName );
47cdf0e10cSrcweir 
48cdf0e10cSrcweir     /** @return  The help ID of the function with given built-in name or 0 if not found. */
49cdf0e10cSrcweir     rtl::OString                GetHelpId( const ::rtl::OUString& rFuncName ) const;
50cdf0e10cSrcweir };
51cdf0e10cSrcweir 
52cdf0e10cSrcweir 
53cdf0e10cSrcweir // ============================================================================
54cdf0e10cSrcweir 
55cdf0e10cSrcweir #endif
56cdf0e10cSrcweir 
57