197 lines
8.7 KiB
C++
197 lines
8.7 KiB
C++
/* -*- 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:
|
|
// internal access to SdrObject
|
|
const SdrObject& GetSdrObject() const;
|
|
|
|
SdrObject& GetSdrObject();
|
|
|
|
public:
|
|
// basic constructor, used from SdrObject.
|
|
explicit BaseProperties(SdrObject& rObj);
|
|
|
|
// destructor
|
|
virtual ~BaseProperties();
|
|
|
|
virtual SfxItemSet CreateObjectSpecificItemSet(SfxItemPool& pPool) = 0;
|
|
|
|
// 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::INVALID 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.
|
|
// @param bAdjustTextFrameWidthAndHeight pass false if you know it is safe to avoid the cost of doing
|
|
// text layout right now.
|
|
virtual void SetObjectItemSet(const SfxItemSet& rSet, bool bAdjustTextFrameWidthAndHeight = true) = 0;
|
|
|
|
// Set merged ItemSet. Normally, this maps to SetObjectItemSet().
|
|
// @param bAdjustTextFrameWidthAndHeight pass false if you know it is safe to avoid the cost of doing
|
|
// text layout right now.
|
|
virtual void SetMergedItemSet(const SfxItemSet& rSet, bool bClearAllItems = false,
|
|
bool bAdjustTextFrameWidthAndHeight = true);
|
|
|
|
// 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.
|
|
// @param bAdjustTextFrameWidthAndHeight pass false if you know it is safe to avoid the cost of doing
|
|
// text layout right now.
|
|
virtual void SetStyleSheet(SfxStyleSheet* pNewStyleSheet, bool bDontRemoveHardAttr,
|
|
bool bBroadcast, bool bAdjustTextFrameWidthAndHeight = true) = 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: */
|