sc/source/core/inc/addinhelpid.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #pragma once
  21
  22 #include <rtl/ustring.hxx>
  23 #include <rtl/string.hxx>
  24
  25 struct ScUnoAddInHelpId;
  26
  27 /** Generates help IDs for standard Calc AddIns. */
  28 class ScUnoAddInHelpIdGenerator
  29 {
  30 private:
  31     const ScUnoAddInHelpId*     pCurrHelpIds;       /// Array of function names and help IDs.
  32     sal_uInt32                  nArrayCount;        /// Count of array entries.
  33
  34 public:
  35                                 ScUnoAddInHelpIdGenerator() = delete;
  36                                 ScUnoAddInHelpIdGenerator( std::u16string_view rServiceName );
  37
  38     /** Sets service name of the AddIn. Has to be done before requesting help IDs. */
  39     void                        SetServiceName( std::u16string_view rServiceName );
  40
  41     /** @return  The help ID of the function with given built-in name or 0 if not found. */
  42     OUString                GetHelpId( std::u16string_view rFuncName ) const;
  43 };
  44
  45 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */