summaryrefslogtreecommitdiff
path: root/sc/source/core/inc/addinhelpid.hxx
blob: 59ffc1e4b3f6ffa2d8d761031b72f7f7ea823407 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#ifndef INCLUDED_SC_SOURCE_CORE_INC_ADDINHELPID_HXX
#define INCLUDED_SC_SOURCE_CORE_INC_ADDINHELPID_HXX

#include <rtl/ustring.hxx>
#include <rtl/string.hxx>

struct ScUnoAddInHelpId;

/** Generates help IDs for standard Calc AddIns. */
class ScUnoAddInHelpIdGenerator
{
private:
    const ScUnoAddInHelpId*     pCurrHelpIds;       /// Array of function names and help IDs.
    sal_uInt32                  nArrayCount;        /// Count of array entries.

    ScUnoAddInHelpIdGenerator(); // disabled
public:
                                ScUnoAddInHelpIdGenerator( const OUString& rServiceName );

    /** Sets service name of the AddIn. Has to be done before requesting help IDs. */
    void                        SetServiceName( const OUString& rServiceName );

    /** @return  The help ID of the function with given built-in name or 0 if not found. */
    OString                GetHelpId( const OUString& rFuncName ) const;
};

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */