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