/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef INCLUDED_SVX_SDR_PROPERTIES_PROPERTIES_HXX
#define INCLUDED_SVX_SDR_PROPERTIES_PROPERTIES_HXX
#include <sal/config.h>
#include <memory>
#include <sal/types.h>
#include <svx/svxdllapi.h>
#include <svl/typedwhich.hxx>
struct _xmlTextWriter;
typedef struct _xmlTextWriter* xmlTextWriterPtr;
class SdrObject;
class SfxItemSet;
class SfxPoolItem;
class SfxStyleSheet;
class Fraction;
class SfxItemPool;
class SdrModel;
namespace sdr::properties
{
class ItemChangeBroadcaster;
}
////////////////////////////////////////////////////////////////////////////////////////////////////
//
// BaseProperties
// DefaultProperties ->SfxItemSet
// AttributeProperties ->SfxStyleSheet
// E3dProperties
// E3dCompoundProperties
// E3dExtrudeProperties
// E3dLatheProperties
// E3dSphereProperties
// E3dSceneProperties
// TextProperties ->maVersion
// ConnectorProperties
// CustomShapeProperties
// MeasureProperties
// RectangleProperties
// CaptionProperties
// CircleProperties
// GraphicProperties
// OleProperties
// CellProperties
// TableProperties
// GroupProperties
// EmptyProperties
// PageProperties
namespace sdr::properties
{
class SVXCORE_DLLPUBLIC BaseProperties
{
private:
// the owner of this Properties. Set from constructor and not
// to be changed in any way.
SdrObject& mrObject;
protected:
// apply the correct SfyStyleSheet from SdrObject's SdrModel
virtual void applyDefaultStyleSheetFromSdrModel();
// create a new object specific itemset with object specific ranges.
virtual std::unique_ptr<SfxItemSet> CreateObjectSpecificItemSet(SfxItemPool& pPool) = 0;
// internal access to SdrObject
const SdrObject& GetSdrObject() const;
SdrObject& GetSdrObject();
// Test changeability for a single item. If an implementation wants to prevent
// changing an item it should override this method.
virtual bool AllowItemChange(const sal_uInt16 nWhich, const SfxPoolItem* pNewItem = nullptr) const = 0;
// Do the internal ItemChange. If only nWhich is given, the item needs to be cleared.
// Also needs to handle if nWhich and pNewItem is 0, which means to clear all items.
virtual void ItemChange(const sal_uInt16 nWhich, const SfxPoolItem* pNewItem = nullptr) = 0;
// Called after ItemChange() is done for all items. Allows local reactions on
// specific item changes
virtual void PostItemChange(const sal_uInt16 nWhich) = 0;
// Internally react on ItemSet changes. The given ItemSet contains all changed items, the new ones.
virtual void ItemSetChanged(const SfxItemSet& rSet) = 0;
public:
// basic constructor, used from SdrObject.
explicit BaseProperties(SdrObject& rObj);
// destructor
virtual ~BaseProperties();
// Clone() operator, normally just calls the local copy constructor,
// see above.
virtual std::unique_ptr<BaseProperties> Clone(SdrObject& rObj) const = 0;
// Get the local ItemSet. This directly returns the local ItemSet of the object. No
// merging of ItemSets is done for e.g. Group objects.
virtual const SfxItemSet& GetObjectItemSet() const = 0;
// get merged ItemSet. Normally, this maps directly to GetObjectItemSet(), but may
// be overridden e.g for group objects to return a merged ItemSet of the object.
// When using this method the returned ItemSet may contain items in the state
// SfxItemState::DONTCARE which means there were several such items with different
// values.
virtual const SfxItemSet& GetMergedItemSet() const;
// Sets all items which are on state SfxItemState::SET in rSet at the local ItemSet.
// Uses AllowItemChange(), ItemChange(), PostItemChange() and ItemSetChanged() calls.
virtual void SetObjectItemSet(const SfxItemSet& rSet) = 0;
// Set merged ItemSet. Normally, this maps to SetObjectItemSet().
virtual void SetMergedItemSet(const SfxItemSet& rSet, bool bClearAllItems = false);
// Set single item at the local ItemSet. Uses AllowItemChange(),
// ItemChange(), PostItemChange() and ItemSetChanged() calls.
virtual void SetObjectItem(const SfxPoolItem& rItem) = 0;
// Set a single item direct. Only uses AllowItemChange() and ItemChange(),
// but not PostItemChange() and ItemSetChanged() calls.
virtual void SetObjectItemDirect(const SfxPoolItem& rItem) = 0;
// Clear a single local item. Uses AllowItemChange(),
// ItemChange(), PostItemChange() and ItemSetChanged() calls.
virtual void ClearObjectItem(const sal_uInt16 nWhich = 0) = 0;
// Set a single item, iterate over hierarchies if necessary. Default
// Implementation falls back to ClearObjectItem().
virtual void SetMergedItem(const SfxPoolItem& rItem);
// Clear a single item, iterate over hierarchies if necessary. Default
// Implementation falls back to ClearObjectItem().
virtual void ClearMergedItem(const sal_uInt16 nWhich);
// Clear single item direct. Only uses AllowItemChange() and ItemChange(),
// but not PostItemChange() and ItemSetChanged() calls.
// Also supports complete deletion of items when default parameter 0 is used.
virtual void ClearObjectItemDirect(const sal_uInt16 nWhich) = 0;
// Set a new StyleSheet. Registers as listener at the StyleSheet to get knowledge
// of StyleSheet changes.
virtual void SetStyleSheet(SfxStyleSheet* pNewStyleSheet, bool bDontRemoveHardAttr) = 0;
// Get the installed StyleSheet.
virtual SfxStyleSheet* GetStyleSheet() const = 0;
// force all attributes which come from styles to hard attributes
// to be able to live without the style.
virtual void ForceStyleToHardAttributes();
// syntactical sugar for ItemSet accesses. Broadcasts before and after the changes
// to invalidate views in old and new BoundRects. As soon as the repaint mechanism
// will be changed these broadcasts will no longer be needed.
//void SetItemAndBroadcast(const SfxPoolItem& rItem);
//void ClearItemAndBroadcast(const sal_uInt16 nWhich = 0);
void SetMergedItemSetAndBroadcast(const SfxItemSet& rSet, bool bClearAllItems = false);
// Just a convenient shortcut for GetObjectItemSet().Get(nWhich).
const SfxPoolItem& GetItem(const sal_uInt16 nWhich) const;
template<class T> const T& GetItem(TypedWhichId<T> nWhich) const
{
return static_cast<const T&>(GetItem(sal_uInt16(nWhich)));
}
// support for convenient broadcasting. Used from SetMergedItemAndBroadcast(),
// ClearItemAndBroadcast() and SetItemSetAndBroadcast(), see above.
// But also from inside SdrObjects.
void BroadcastItemChange(const ItemChangeBroadcaster& rChange);
// #i101556# add versioning mechanism; used from e.g. text attribute set to
// allow detection of e.g. style sheet or single text attribute changes. The
// default implementation returns 0 (zero)
virtual sal_uInt32 getVersion() const;
virtual void dumpAsXml(xmlTextWriterPtr pWriter) const;
};
// checks the FillStyle item and removes unneeded Gradient, FillBitmap and Hatch items
void SVXCORE_DLLPUBLIC CleanupFillProperties( SfxItemSet& rItemSet );
} // end of namespace sdr::properties
#endif // INCLUDED_SVX_SDR_PROPERTIES_PROPERTIES_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */