include/sfx2/minfitem.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 <sal/config.h>
  24 #include <sfx2/dllapi.h>
  25 #include <svl/poolitem.hxx>
  26 #include <config_features.h>
  27
  28 #if HAVE_FEATURE_SCRIPTING
  29
  30 class BasicManager;
  31
  32 class SFX2_DLLPUBLIC SfxMacroInfoItem final : public SfxPoolItem
  33 {
  34     const BasicManager*     pBasicManager;
  35     OUString                aLibName;
  36     OUString                aModuleName;
  37     OUString                aMethodName;
  38     OUString                aCommentText;
  39     OUString aLocationName;
  40
  41 public:
  42     static SfxPoolItem* CreateDefault();
  43     SfxMacroInfoItem( sal_uInt16 nWhich,
  44                     const BasicManager* pMgr,
  45                     OUString aLibName,
  46                     OUString aModuleName,
  47                     OUString aMethodName,
  48                     OUString aComment,
  49                     OUString aLocation = OUString());
  50
  51     virtual SfxMacroInfoItem* Clone( SfxItemPool *pPool = nullptr ) const override;
  52     virtual bool            operator==( const SfxPoolItem& ) const override;
  53     const OUString&         GetMethod() const
  54                                 { return aMethodName; }
  55     void                    SetMethod( const OUString& r )
  56                                 { aMethodName = r; }
  57     const OUString&         GetModule() const
  58                                 { return aModuleName; }
  59     void                    SetModule( const OUString& r )
  60                                 { aModuleName = r; }
  61     const OUString&         GetLib() const
  62                                 { return aLibName; }
  63     void                    SetLib( const OUString& r )
  64                                 { aLibName = r; }
  65     const BasicManager*     GetBasicManager() const
  66                             { return pBasicManager; }
  67     const OUString& GetLocation() const { return aLocationName; }
  68 };
  69
  70 #endif
  71
  72 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */