include/svx/sdr/properties/properties.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_SVX_SDR_PROPERTIES_PROPERTIES_HXX
  21 #define INCLUDED_SVX_SDR_PROPERTIES_PROPERTIES_HXX
  22
  23 #include <sal/config.h>
  24
  25 #include <memory>
  26
  27 #include <sal/types.h>
  28 #include <svx/svxdllapi.h>
  29 #include <svl/typedwhich.hxx>
  30
  31 struct _xmlTextWriter;
  32 typedef struct _xmlTextWriter* xmlTextWriterPtr;
  33 class SdrObject;
  34 class SfxItemSet;
  35 class SfxPoolItem;
  36 class SfxStyleSheet;
  37 class Fraction;
  38 class SfxItemPool;
  39 class SdrModel;
  40
  41 namespace sdr::properties
  42 {
  43     class ItemChangeBroadcaster;
  44 }
  45
  46
  47 ////////////////////////////////////////////////////////////////////////////////////////////////////
  48 //
  49 //  BaseProperties
  50 //      DefaultProperties                   ->SfxItemSet
  51 //          AttributeProperties             ->SfxStyleSheet
  52 //              E3dProperties
  53 //                  E3dCompoundProperties
  54 //                      E3dExtrudeProperties
  55 //                      E3dLatheProperties
  56 //                      E3dSphereProperties
  57 //                  E3dSceneProperties
  58 //              TextProperties              ->maVersion
  59 //                  ConnectorProperties
  60 //                  CustomShapeProperties
  61 //                  MeasureProperties
  62 //                  RectangleProperties
  63 //                      CaptionProperties
  64 //                      CircleProperties
  65 //                      GraphicProperties
  66 //                      OleProperties
  67 //                  CellProperties
  68 //                  TableProperties
  69 //          GroupProperties
  70 //      EmptyProperties
  71 //          PageProperties
  72
  73 namespace sdr::properties
  74     {
  75         class SVXCORE_DLLPUBLIC BaseProperties
  76         {
  77         private:
  78             // the owner of this Properties. Set from constructor and not
  79             // to be changed in any way.
  80             SdrObject&                                      mrObject;
  81
  82         protected:
  83             // apply the correct SfyStyleSheet from SdrObject's SdrModel
  84             virtual void applyDefaultStyleSheetFromSdrModel();
  85
  86             // create a new object specific itemset with object specific ranges.
  87             virtual std::unique_ptr<SfxItemSet> CreateObjectSpecificItemSet(SfxItemPool& pPool) = 0;
  88
  89             // internal access to SdrObject
  90             const SdrObject& GetSdrObject() const;
  91
  92             SdrObject& GetSdrObject();
  93
  94             // Test changeability for a single item. If an implementation wants to prevent
  95             // changing an item it should override this method.
  96             virtual bool AllowItemChange(const sal_uInt16 nWhich, const SfxPoolItem* pNewItem = nullptr) const = 0;
  97
  98             // Do the internal ItemChange. If only nWhich is given, the item needs to be cleared.
  99             // Also needs to handle if nWhich and pNewItem is 0, which means to clear all items.
 100             virtual void ItemChange(const sal_uInt16 nWhich, const SfxPoolItem* pNewItem = nullptr) = 0;
 101
 102             // Called after ItemChange() is done for all items. Allows local reactions on
 103             // specific item changes
 104             virtual void PostItemChange(const sal_uInt16 nWhich) = 0;
 105
 106             // Internally react on ItemSet changes. The given ItemSet contains all changed items, the new ones.
 107             virtual void ItemSetChanged(const SfxItemSet& rSet) = 0;
 108
 109         public:
 110             // basic constructor, used from SdrObject.
 111             explicit BaseProperties(SdrObject& rObj);
 112
 113             // destructor
 114             virtual ~BaseProperties();
 115
 116             // Clone() operator, normally just calls the local copy constructor,
 117             // see above.
 118             virtual std::unique_ptr<BaseProperties> Clone(SdrObject& rObj) const = 0;
 119
 120             // Get the local ItemSet. This directly returns the local ItemSet of the object. No
 121             // merging of ItemSets is done for e.g. Group objects.
 122             virtual const SfxItemSet& GetObjectItemSet() const = 0;
 123
 124             // get merged ItemSet. Normally, this maps directly to GetObjectItemSet(), but may
 125             // be overridden e.g for group objects to return a merged ItemSet of the object.
 126             // When using this method the returned ItemSet may contain items in the state
 127             // SfxItemState::DONTCARE which means there were several such items with different
 128             // values.
 129             virtual const SfxItemSet& GetMergedItemSet() const;
 130
 131             // Sets all items which are on state SfxItemState::SET in rSet at the local ItemSet.
 132             // Uses AllowItemChange(), ItemChange(), PostItemChange() and ItemSetChanged() calls.
 133             virtual void SetObjectItemSet(const SfxItemSet& rSet) = 0;
 134
 135             // Set merged ItemSet. Normally, this maps to SetObjectItemSet().
 136             virtual void SetMergedItemSet(const SfxItemSet& rSet, bool bClearAllItems = false);
 137
 138             // Set single item at the local ItemSet. Uses AllowItemChange(),
 139             // ItemChange(), PostItemChange() and ItemSetChanged() calls.
 140             virtual void SetObjectItem(const SfxPoolItem& rItem) = 0;
 141
 142             // Set a single item direct. Only uses AllowItemChange() and ItemChange(),
 143             // but not PostItemChange() and ItemSetChanged() calls.
 144             virtual void SetObjectItemDirect(const SfxPoolItem& rItem) = 0;
 145
 146             // Clear a single local item. Uses AllowItemChange(),
 147             // ItemChange(), PostItemChange() and ItemSetChanged() calls.
 148             virtual void ClearObjectItem(const sal_uInt16 nWhich = 0) = 0;
 149
 150             // Set a single item, iterate over hierarchies if necessary. Default
 151             // Implementation falls back to ClearObjectItem().
 152             virtual void SetMergedItem(const SfxPoolItem& rItem);
 153
 154             // Clear a single item, iterate over hierarchies if necessary. Default
 155             // Implementation falls back to ClearObjectItem().
 156             virtual void ClearMergedItem(const sal_uInt16 nWhich);
 157
 158             // Clear single item direct. Only uses AllowItemChange() and ItemChange(),
 159             // but not PostItemChange() and ItemSetChanged() calls.
 160             // Also supports complete deletion of items when default parameter 0 is used.
 161             virtual void ClearObjectItemDirect(const sal_uInt16 nWhich) = 0;
 162
 163             // Set a new StyleSheet. Registers as listener at the StyleSheet to get knowledge
 164             // of StyleSheet changes.
 165             virtual void SetStyleSheet(SfxStyleSheet* pNewStyleSheet, bool bDontRemoveHardAttr) = 0;
 166
 167             // Get the installed StyleSheet.
 168             virtual SfxStyleSheet* GetStyleSheet() const = 0;
 169
 170             // force all attributes which come from styles to hard attributes
 171             // to be able to live without the style.
 172             virtual void ForceStyleToHardAttributes();
 173
 174             // syntactical sugar for ItemSet accesses. Broadcasts before and after the changes
 175             // to invalidate views in old and new BoundRects. As soon as the repaint mechanism
 176             // will be changed these broadcasts will no longer be needed.
 177             //void SetItemAndBroadcast(const SfxPoolItem& rItem);
 178             //void ClearItemAndBroadcast(const sal_uInt16 nWhich = 0);
 179             void SetMergedItemSetAndBroadcast(const SfxItemSet& rSet, bool bClearAllItems = false);
 180
 181             // Just a convenient shortcut for GetObjectItemSet().Get(nWhich).
 182             const SfxPoolItem& GetItem(const sal_uInt16 nWhich) const;
 183             template<class T> const T& GetItem(TypedWhichId<T> nWhich) const
 184             {
 185                 return static_cast<const T&>(GetItem(sal_uInt16(nWhich)));
 186             }
 187
 188             // support for convenient broadcasting. Used from SetMergedItemAndBroadcast(),
 189             // ClearItemAndBroadcast() and SetItemSetAndBroadcast(), see above.
 190             // But also from inside SdrObjects.
 191             void BroadcastItemChange(const ItemChangeBroadcaster& rChange);
 192
 193             // #i101556# add versioning mechanism; used from e.g. text attribute set to
 194             // allow detection of e.g. style sheet or single text attribute changes. The
 195             // default implementation returns 0 (zero)
 196             virtual sal_uInt32 getVersion() const;
 197
 198             virtual void dumpAsXml(xmlTextWriterPtr pWriter) const;
 199         };
 200
 201         // checks the FillStyle item and removes unneeded Gradient, FillBitmap and Hatch items
 202         void SVXCORE_DLLPUBLIC CleanupFillProperties( SfxItemSet& rItemSet );
 203
 204 } // end of namespace sdr::properties
 205
 206 #endif // INCLUDED_SVX_SDR_PROPERTIES_PROPERTIES_HXX
 207
 208 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */