basic/inc/basic/sbxcore.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: sbxcore.hxx,v $
  10  * $Revision: 1.4 $
  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 _SBXCORE_HXX
  32 #define _SBXCORE_HXX
  33
  34 #include <tools/rtti.hxx>
  35 #include <tools/ref.hxx>
  36 #include <tools/debug.hxx>
  37
  38 #include <basic/sbxdef.hxx>
  39
  40 class SvStream;
  41 class String;
  42 class UniString;
  43
  44 // The following Macro defines four (five) necessary methods within a
  45 // SBX object. LoadPrivateData() and StorePrivateData() must be implemented.
  46 // They are necessary for loading/storing the data of derived classes.
  47 // Load() and Store() must not be overridden.
  48
  49 // This version of the Macros does not define Load/StorePrivateData()-methods
  50 #define SBX_DECL_PERSIST_NODATA( nCre, nSbxId, nVer )           \
  51     virtual UINT32 GetCreator() const { return nCre;   }        \
  52     virtual UINT16 GetVersion() const { return nVer;   }        \
  53     virtual UINT16 GetSbxId() const       { return nSbxId; }
  54
  55 #define SBX_DECL_PERSIST_NODATA_()                                                      \
  56     virtual UINT32 GetCreator() const;                                          \
  57     virtual UINT16 GetVersion() const;                                          \
  58     virtual UINT16 GetSbxId() const;
  59
  60 // This version of the macro defines Load/StorePrivateData()-methods
  61 #define SBX_DECL_PERSIST( nCre, nSbxId, nVer )                          \
  62     virtual BOOL LoadPrivateData( SvStream&, USHORT );          \
  63     virtual BOOL StorePrivateData( SvStream& ) const;           \
  64     SBX_DECL_PERSIST_NODATA( nCre, nSbxId, nVer )
  65
  66 #define SBX_DECL_PERSIST_()                                                                     \
  67     virtual BOOL LoadPrivateData( SvStream&, USHORT );          \
  68     virtual BOOL StorePrivateData( SvStream& ) const;           \
  69     SBX_DECL_PERSIST_NODATA_()
  70
  71 #define SBX_IMPL_PERSIST( C, nCre, nSbxId, nVer )                       \
  72     UINT32 C::GetCreator() const { return nCre;   }                     \
  73     UINT16 C::GetVersion() const { return nVer;   }                     \
  74     UINT16 C::GetSbxId() const   { return nSbxId; }
  75
  76 class SbxBase;
  77 class SbxFactory;
  78 class SbxObject;
  79
  80 DBG_NAMEEX(SbxBase)
  81
  82 class SbxBaseImpl;
  83
  84 class SbxBase : virtual public SvRefBase
  85 {
  86     SbxBaseImpl* mpSbxBaseImpl; // Impl data
  87
  88     virtual BOOL LoadData( SvStream&, USHORT );
  89     virtual BOOL StoreData( SvStream& ) const;
  90 protected:
  91     USHORT nFlags;                      // Flag-Bits
  92
  93     SbxBase();
  94     SbxBase( const SbxBase& );
  95     SbxBase& operator=( const SbxBase& );
  96     virtual ~SbxBase();
  97     SBX_DECL_PERSIST(0,0,0);
  98 public:
  99     TYPEINFO();
 100     inline void         SetFlags( USHORT n );
 101     inline USHORT       GetFlags() const;
 102     inline void         SetFlag( USHORT n );
 103     inline void         ResetFlag( USHORT n );
 104     inline BOOL         IsSet( USHORT n ) const;
 105     inline BOOL         IsReset( USHORT n ) const;
 106     inline BOOL         CanRead() const;
 107     inline BOOL         CanWrite() const;
 108     inline BOOL         IsModified() const;
 109     inline BOOL         IsConst() const;
 110     inline BOOL         IsHidden() const;
 111     inline BOOL         IsVisible() const;
 112
 113     virtual BOOL IsFixed() const;
 114     virtual void SetModified( BOOL );
 115
 116     virtual SbxDataType  GetType()  const;
 117     virtual SbxClassType GetClass() const;
 118
 119     virtual void Clear();
 120
 121     static SbxBase* Load( SvStream& );
 122     static void Skip( SvStream& );
 123     BOOL Store( SvStream& );
 124     virtual BOOL LoadCompleted();
 125     virtual BOOL StoreCompleted();
 126
 127     static SbxError GetError();
 128     static void SetError( SbxError );
 129     static BOOL IsError();
 130     static void ResetError();
 131
 132     // Set the factory for Load/Store/Create
 133     static void AddFactory( SbxFactory* );
 134     static void RemoveFactory( SbxFactory* );
 135
 136     static SbxBase* Create( UINT16, UINT32=SBXCR_SBX );
 137     static SbxObject* CreateObject( const String& );
 138     // Sbx solution as replacement for SfxBroadcaster::Enable()
 139     static void StaticEnableBroadcasting( BOOL bEnable );
 140     static BOOL StaticIsEnabledBroadcasting( void );
 141 };
 142
 143 #ifndef SBX_BASE_DECL_DEFINED
 144 #define SBX_BASE_DECL_DEFINED
 145 SV_DECL_REF(SbxBase)
 146 #endif
 147
 148 inline void SbxBase::SetFlags( USHORT n )
 149 { DBG_CHKTHIS( SbxBase, 0 ); nFlags = n; }
 150
 151 inline USHORT SbxBase::GetFlags() const
 152 { DBG_CHKTHIS( SbxBase, 0 ); return nFlags; }
 153
 154 inline void SbxBase::SetFlag( USHORT n )
 155 { DBG_CHKTHIS( SbxBase, 0 ); nFlags |= n; }
 156
 157 inline void SbxBase::ResetFlag( USHORT n )
 158 { DBG_CHKTHIS( SbxBase, 0 ); nFlags &= ~n; }
 159
 160 inline BOOL SbxBase::IsSet( USHORT n ) const
 161 { DBG_CHKTHIS( SbxBase, 0 ); return BOOL( ( nFlags & n ) != 0 ); }
 162
 163 inline BOOL SbxBase::IsReset( USHORT n ) const
 164 { DBG_CHKTHIS( SbxBase, 0 ); return BOOL( ( nFlags & n ) == 0 ); }
 165
 166 inline BOOL SbxBase::CanRead() const
 167 { DBG_CHKTHIS( SbxBase, 0 ); return IsSet( SBX_READ ); }
 168
 169 inline BOOL SbxBase::CanWrite() const
 170 { DBG_CHKTHIS( SbxBase, 0 ); return IsSet( SBX_WRITE ); }
 171
 172 inline BOOL SbxBase::IsModified() const
 173 { DBG_CHKTHIS( SbxBase, 0 ); return IsSet( SBX_MODIFIED ); }
 174
 175 inline BOOL SbxBase::IsConst() const
 176 { DBG_CHKTHIS( SbxBase, 0 ); return IsSet( SBX_CONST ); }
 177
 178 inline BOOL SbxBase::IsHidden() const
 179 { DBG_CHKTHIS( SbxBase, 0 ); return IsSet( SBX_HIDDEN ); }
 180
 181 inline BOOL SbxBase::IsVisible() const
 182 { DBG_CHKTHIS( SbxBase, 0 ); return IsReset( SBX_INVISIBLE ); }
 183
 184 #endif