include/basic/sbxcore.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_SBXCORE_HXX
  21 #define INCLUDED_BASIC_SBXCORE_HXX
  22
  23 #include <basic/basicdllapi.h>
  24 #include <basic/sbxdef.hxx>
  25 #include <rtl/ustring.hxx>
  26 #include <tools/ref.hxx>
  27
  28 class SvStream;
  29
  30 // The following Macro defines four (five) necessary methods within a
  31 // SBX object. LoadPrivateData() and StorePrivateData() must be implemented.
  32 // They are necessary for loading/storing the data of derived classes.
  33 // Load() and Store() must not be overridden.
  34
  35 // This version of the Macros does not define Load/StorePrivateData()-methods
  36 #define SBX_DECL_PERSIST_NODATA( nSbxId, nVer )       \
  37     virtual sal_uInt16 GetVersion() const override { return nVer;   }    \
  38     virtual sal_uInt16 GetSbxId() const override   { return nSbxId; }
  39
  40 class SbxFactory;
  41 class SbxObject;
  42
  43 class BASIC_DLLPUBLIC SbxBase : virtual public SvRefBase
  44 {
  45     virtual bool LoadData( SvStream&, sal_uInt16 ) = 0;
  46     virtual bool StoreData( SvStream& ) const = 0;
  47 protected:
  48     SbxFlagBits nFlags;          // Flag-Bits
  49
  50     SbxBase();
  51     SbxBase( const SbxBase& );
  52     SbxBase& operator=( const SbxBase& );
  53     virtual ~SbxBase() override;
  54
  55     virtual sal_uInt16 GetVersion() const = 0;
  56     virtual sal_uInt16 GetSbxId() const = 0;
  57
  58 public:
  59     inline void         SetFlags( SbxFlagBits n );
  60     inline SbxFlagBits  GetFlags() const;
  61     inline void         SetFlag( SbxFlagBits n );
  62     inline void         ResetFlag( SbxFlagBits n );
  63     inline bool         IsSet( SbxFlagBits n ) const;
  64     inline bool         IsReset( SbxFlagBits n ) const;
  65     inline bool         CanRead() const;
  66     inline bool         CanWrite() const;
  67     inline bool         IsModified() const;
  68     inline bool         IsHidden() const;
  69     inline bool         IsVisible() const;
  70
  71     virtual bool        IsFixed() const;
  72     virtual void        SetModified( bool );
  73
  74     virtual SbxDataType GetType()  const;
  75     virtual SbxClassType GetClass() const;
  76
  77     virtual void    Clear() = 0;
  78
  79     static SbxBase* Load( SvStream& );
  80     bool            Store( SvStream& );
  81     virtual bool    LoadCompleted();
  82
  83     static SbxError GetError();
  84     static void SetError( SbxError );
  85     static bool IsError();
  86     static void ResetError();
  87
  88     // Set the factory for Load/Store/Create
  89     static void AddFactory( SbxFactory* );
  90     static void RemoveFactory( SbxFactory* );
  91
  92     static SbxBase* Create( sal_uInt16, sal_uInt32 );
  93     static SbxObject* CreateObject( const OUString& );
  94 };
  95
  96 typedef tools::SvRef<SbxBase> SbxBaseRef;
  97
  98 inline void SbxBase::SetFlags( SbxFlagBits n )
  99 { nFlags = n; }
 100
 101 inline SbxFlagBits SbxBase::GetFlags() const
 102 { return nFlags; }
 103
 104 inline void SbxBase::SetFlag( SbxFlagBits n )
 105 { nFlags |= n; }
 106
 107 inline void SbxBase::ResetFlag( SbxFlagBits n )
 108 { nFlags &= ~n; }
 109
 110 inline bool SbxBase::IsSet( SbxFlagBits n ) const
 111 { return ( nFlags & n ) != SbxFlagBits::NONE; }
 112
 113 inline bool SbxBase::IsReset( SbxFlagBits n ) const
 114 { return ( nFlags & n ) == SbxFlagBits::NONE; }
 115
 116 inline bool SbxBase::CanRead() const
 117 { return IsSet( SbxFlagBits::Read ); }
 118
 119 inline bool SbxBase::CanWrite() const
 120 { return IsSet( SbxFlagBits::Write ); }
 121
 122 inline bool SbxBase::IsModified() const
 123 { return IsSet( SbxFlagBits::Modified ); }
 124
 125 inline bool SbxBase::IsHidden() const
 126 { return IsSet( SbxFlagBits::Hidden ); }
 127
 128 inline bool SbxBase::IsVisible() const
 129 { return IsReset( SbxFlagBits::Invisible ); }
 130
 131 #endif
 132
 133 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */