sc/source/core/inc/addinhelpid.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: addinhelpid.hxx,v $
  10  * $Revision: 1.4.32.1 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef SC_ADDINHELPID_HXX
  32 #define SC_ADDINHELPID_HXX
  33
  34 #include <rtl/ustring.hxx>
  35
  36
  37 // ============================================================================
  38
  39 struct ScUnoAddInHelpId;
  40
  41 /** Generates help IDs for standard Calc AddIns. */
  42 class ScUnoAddInHelpIdGenerator
  43 {
  44 private:
  45     const ScUnoAddInHelpId*     pCurrHelpIds;       /// Array of function names and help IDs.
  46     sal_uInt32                  nArrayCount;        /// Count of array entries.
  47
  48     ScUnoAddInHelpIdGenerator(); // disabled
  49 public:
  50                                 ScUnoAddInHelpIdGenerator( const ::rtl::OUString& rServiceName );
  51
  52     /** Sets service name of the AddIn. Has to be done before requesting help IDs. */
  53     void                        SetServiceName( const ::rtl::OUString& rServiceName );
  54
  55     /** @return  The help ID of the function with given built-in name or 0 if not found. */
  56     sal_uInt16                  GetHelpId( const ::rtl::OUString& rFuncName ) const;
  57 };
  58
  59
  60 // ============================================================================
  61
  62 #endif
  63