include/basic/sbxobj.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 #ifndef INCLUDED_BASIC_SBXOBJ_HXX
  21 #define INCLUDED_BASIC_SBXOBJ_HXX
  22
  23 #include <svl/lstner.hxx>
  24 #include <basic/sbxvar.hxx>
  25 #include <basic/basicdllapi.h>
  26
  27
  28 class SbxProperty;
  29
  30 class BASIC_DLLPUBLIC SbxObject : public SbxVariable, public SfxListener
  31 {
  32     BASIC_DLLPRIVATE SbxArray* FindVar( SbxVariable const *, sal_uInt32& );
  33 protected:
  34     SbxArrayRef  pMethods;                  // Methods
  35     SbxArrayRef  pProps;                    // Properties
  36     SbxArrayRef  pObjs;                     // Objects
  37     SbxProperty* pDfltProp;                 // Default-Property
  38     OUString     aClassName;                // Classname
  39     OUString     aDfltPropName;
  40     SAL_DLLPRIVATE virtual bool LoadData( SvStream&, sal_uInt16 ) override;
  41     SAL_DLLPRIVATE virtual std::pair<bool, sal_uInt32> StoreData( SvStream& ) const override;
  42     SAL_DLLPRIVATE virtual ~SbxObject() override;
  43     SAL_DLLPRIVATE virtual void Notify( SfxBroadcaster& rBC, const SfxHint& rHint ) override;
  44     SAL_DLLPRIVATE virtual bool IsOptionCompatible() const; // Module's Option Compatible
  45
  46 public:
  47     SBX_DECL_PERSIST_NODATA(SBXID_OBJECT,1);
  48     SAL_DLLPRIVATE SbxObject( const OUString& rClassname );
  49     SAL_DLLPRIVATE SbxObject( const SbxObject& );
  50     SAL_DLLPRIVATE SbxObject& operator=( const SbxObject& );
  51     SAL_DLLPRIVATE virtual SbxDataType GetType() const override;
  52     SAL_DLLPRIVATE virtual SbxClassType GetClass() const override;
  53     SAL_DLLPRIVATE virtual void Clear() override;
  54
  55     SAL_DLLPRIVATE virtual bool IsClass( const OUString& ) const;
  56     const OUString& GetClassName() const { return aClassName; }
  57     void SetClassName( const OUString &rNew ) { aClassName = rNew; }
  58     // Default-Property
  59     SAL_DLLPRIVATE SbxProperty* GetDfltProperty();
  60     SAL_DLLPRIVATE void SetDfltProperty( const OUString& r );
  61     // Search for an element
  62     SAL_DLLPRIVATE virtual SbxVariable* Find( const OUString&, SbxClassType );
  63     SAL_DLLPRIVATE SbxVariable* FindQualified( const OUString&, SbxClassType );
  64     // Quick-Call-Interface for Methods
  65     SAL_DLLPRIVATE virtual bool Call( const OUString&, SbxArray* = nullptr );
  66     // Execution of DDE-Commands
  67     SbxVariable* Execute( const OUString& );
  68     // Manage elements
  69     SAL_DLLPRIVATE SbxVariable* Make( const OUString&, SbxClassType, SbxDataType, bool bIsRuntimeFunction = false );
  70     SAL_DLLPRIVATE virtual void Insert( SbxVariable* );
  71     // AB 23.4.1997, Optimization, Insertion without check for duplicate Entries and
  72     // without Broadcasts, only used in SO2/auto.cxx
  73     SAL_DLLPRIVATE void QuickInsert( SbxVariable* );
  74     SAL_DLLPRIVATE void Remove( const OUString&, SbxClassType );
  75     SAL_DLLPRIVATE virtual void Remove( SbxVariable* );
  76
  77     // Direct access on arrays
  78     SbxArray* GetMethods()      { return pMethods.get(); }
  79     SbxArray* GetProperties()   { return pProps.get(); }
  80     SbxArray* GetObjects()      { return pObjs.get(); }
  81     // Debugging
  82     SAL_DLLPRIVATE void Dump( SvStream&, bool bDumpAll );
  83 };
  84
  85 #endif // INCLUDED_BASIC_SBXOBJ_HXX
  86
  87 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */