Branch libreoffice-5-0-4
[LibreOffice.git] / include / basic / sbxobj.hxx
blob4526f25fb30b883981cb955440911104b2b417ae
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3 * This file is part of the LibreOffice project.
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/.
9 * This file incorporates work covered by the following license notice:
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 .
20 #ifndef INCLUDED_BASIC_SBXOBJ_HXX
21 #define INCLUDED_BASIC_SBXOBJ_HXX
23 #include <svl/lstner.hxx>
24 #include <basic/sbxvar.hxx>
25 #include <basic/basicdllapi.h>
28 class SbxProperty;
30 class BASIC_DLLPUBLIC SbxObject : public SbxVariable, public SfxListener
32 BASIC_DLLPRIVATE SbxArray* FindVar( SbxVariable*, sal_uInt16& );
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 virtual bool LoadData( SvStream&, sal_uInt16 ) SAL_OVERRIDE;
41 virtual bool StoreData( SvStream& ) const SAL_OVERRIDE;
42 virtual ~SbxObject();
43 virtual void SFX_NOTIFY( SfxBroadcaster& rBC, const TypeId& rBCType,
44 const SfxHint& rHint, const TypeId& rHintType ) SAL_OVERRIDE;
45 public:
46 SBX_DECL_PERSIST_NODATA(SBXCR_SBX,SBXID_OBJECT,1);
47 TYPEINFO_OVERRIDE();
48 SbxObject( const OUString& rClassname );
49 SbxObject( const SbxObject& );
50 SbxObject& operator=( const SbxObject& );
51 virtual SbxDataType GetType() const SAL_OVERRIDE;
52 virtual SbxClassType GetClass() const SAL_OVERRIDE;
53 virtual void Clear() SAL_OVERRIDE;
55 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 SbxProperty* GetDfltProperty();
60 void SetDfltProperty( const OUString& r );
61 // Search for an element
62 virtual SbxVariable* FindUserData( sal_uInt32 nUserData );
63 virtual SbxVariable* Find( const OUString&, SbxClassType );
64 SbxVariable* FindQualified( const OUString&, SbxClassType );
65 // Quick-Call-Interface for Methods
66 virtual bool Call( const OUString&, SbxArray* = NULL );
67 // Execution of DDE-Commands
68 SbxVariable* Execute( const OUString& );
69 // Manage elements
70 SbxVariable* Make( const OUString&, SbxClassType, SbxDataType, bool bIsRuntimeFunction = false );
71 virtual void Insert( SbxVariable* );
72 // AB 23.4.1997, Optimization, Insertion without check for duplicate Entries and
73 // without Broadcasts, only used in SO2/auto.cxx
74 void QuickInsert( SbxVariable* );
75 void Remove( const OUString&, SbxClassType );
76 virtual void Remove( SbxVariable* );
78 // Direct access on arrays
79 SbxArray* GetMethods() { return pMethods; }
80 SbxArray* GetProperties() { return pProps; }
81 SbxArray* GetObjects() { return pObjs; }
82 // Debugging
83 void Dump( SvStream&, bool bDumpAll=false );
86 typedef tools::SvRef<SbxObject> SbxObjectRef;
88 #endif // INCLUDED_BASIC_SBXOBJ_HXX
90 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */