xref: /aoo41x/main/svx/source/sdr/attribute/sdrtextattribute.cxx (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/

#include "precompiled_svx.hxx"

#include <svx/sdr/attribute/sdrtextattribute.hxx>
#include <svx/sdr/attribute/sdrformtextattribute.hxx>
#include <svx/svdotext.hxx>
#include <editeng/outlobj.hxx>
#include <editeng/editobj.hxx>
#include <editeng/flditem.hxx>
#include <svx/sdr/properties/properties.hxx>

//////////////////////////////////////////////////////////////////////////////

namespace drawinglayer
{
	namespace attribute
	{
		class ImpSdrTextAttribute
		{
		public:
			// refcounter
			sal_uInt32							mnRefCount;

            // all-text attributes. The SdrText itself and a copy
            // of te OPO
			const SdrText*						mpSdrText;
			const OutlinerParaObject*			mpOutlinerParaObject;

            // Set when it's a FormText; contains all FormText attributes
            SdrFormTextAttribute                maSdrFormTextAttribute;

            // text distances
			sal_Int32							maTextLeftDistance;
			sal_Int32							maTextUpperDistance;
			sal_Int32							maTextRightDistance;
			sal_Int32							maTextLowerDistance;

            // #i101556# use versioning from text attributes to detect changes
            sal_uInt32                          maPropertiesVersion;

            // text alignments
            SdrTextHorzAdjust                   maSdrTextHorzAdjust;
            SdrTextVertAdjust                   maSdrTextVertAdjust;

			// bitfield
			unsigned							mbContour : 1;
			unsigned							mbFitToSize : 1;
			unsigned							mbHideContour : 1;
			unsigned							mbBlink : 1;
			unsigned							mbScroll : 1;
			unsigned							mbInEditMode : 1;
			unsigned							mbFixedCellHeight : 1;
			unsigned							mbWrongSpell : 1;

		public:
			ImpSdrTextAttribute(
				const SdrText* pSdrText,
                const OutlinerParaObject& rOutlinerParaObject,
				XFormTextStyle eFormTextStyle,
				sal_Int32 aTextLeftDistance,
				sal_Int32 aTextUpperDistance,
				sal_Int32 aTextRightDistance,
				sal_Int32 aTextLowerDistance,
                SdrTextHorzAdjust aSdrTextHorzAdjust,
                SdrTextVertAdjust aSdrTextVertAdjust,
				bool bContour,
                bool bFitToSize,
				bool bHideContour,
                bool bBlink,
				bool bScroll,
                bool bInEditMode,
                bool bFixedCellHeight,
				bool bWrongSpell)
			:	mnRefCount(0),
				mpSdrText(pSdrText),
				mpOutlinerParaObject(new OutlinerParaObject(rOutlinerParaObject)),
				maSdrFormTextAttribute(),
				maTextLeftDistance(aTextLeftDistance),
				maTextUpperDistance(aTextUpperDistance),
				maTextRightDistance(aTextRightDistance),
				maTextLowerDistance(aTextLowerDistance),
				maPropertiesVersion(0),
				maSdrTextHorzAdjust(aSdrTextHorzAdjust),
				maSdrTextVertAdjust(aSdrTextVertAdjust),
				mbContour(bContour),
				mbFitToSize(bFitToSize),
				mbHideContour(bHideContour),
				mbBlink(bBlink),
				mbScroll(bScroll),
				mbInEditMode(bInEditMode),
				mbFixedCellHeight(bFixedCellHeight),
				mbWrongSpell(bWrongSpell)
			{
				if(pSdrText)
				{
					if(XFT_NONE != eFormTextStyle)
					{
						// text on path. Create FormText attribute
        				const SfxItemSet& rSet = pSdrText->GetItemSet();
						maSdrFormTextAttribute = SdrFormTextAttribute(rSet);
					}

					// #i101556# init with version number to detect changes of single text
					// attribute and/or style sheets in primitive data without having to
					// copy that data locally (which would be better from principle)
					maPropertiesVersion = pSdrText->GetObject().GetProperties().getVersion();
				}
			}

			ImpSdrTextAttribute()
			:	mnRefCount(0),
				mpSdrText(0),
				mpOutlinerParaObject(0),
				maSdrFormTextAttribute(),
				maTextLeftDistance(0),
				maTextUpperDistance(0),
				maTextRightDistance(0),
				maTextLowerDistance(0),
				maPropertiesVersion(0),
				maSdrTextHorzAdjust(SDRTEXTHORZADJUST_LEFT),
				maSdrTextVertAdjust(SDRTEXTVERTADJUST_TOP),
				mbContour(false),
				mbFitToSize(false),
				mbHideContour(false),
				mbBlink(false),
				mbScroll(false),
				mbInEditMode(false),
				mbFixedCellHeight(false),
				mbWrongSpell(false)
			{
			}

			~ImpSdrTextAttribute()
			{
				if(mpOutlinerParaObject)
				{
					delete mpOutlinerParaObject;
				}
			}

			// data read access
			const SdrText& getSdrText() const
			{
				OSL_ENSURE(mpSdrText, "Access to text of default version of ImpSdrTextAttribute (!)");
				return *mpSdrText;
			}
            const OutlinerParaObject& getOutlinerParaObject() const
			{
				OSL_ENSURE(mpOutlinerParaObject, "Access to OutlinerParaObject of default version of ImpSdrTextAttribute (!)");
				return *mpOutlinerParaObject;
			}
			bool isContour() const { return mbContour; }
			bool isFitToSize() const { return mbFitToSize; }
			bool isHideContour() const { return mbHideContour; }
			bool isBlink() const { return mbBlink; }
			bool isScroll() const { return mbScroll; }
            bool isInEditMode() const { return mbInEditMode; }
            bool isFixedCellHeight() const { return mbFixedCellHeight; }
			bool isWrongSpell() const { return mbWrongSpell; }
            const SdrFormTextAttribute& getSdrFormTextAttribute() const { return maSdrFormTextAttribute; }
			sal_Int32 getTextLeftDistance() const { return maTextLeftDistance; }
			sal_Int32 getTextUpperDistance() const { return maTextUpperDistance; }
			sal_Int32 getTextRightDistance() const { return maTextRightDistance; }
			sal_Int32 getTextLowerDistance() const { return maTextLowerDistance; }
            sal_uInt32 getPropertiesVersion() const { return maPropertiesVersion; }
            SdrTextHorzAdjust getSdrTextHorzAdjust() const { return maSdrTextHorzAdjust; }
            SdrTextVertAdjust getSdrTextVertAdjust() const { return maSdrTextVertAdjust; }

			// compare operator
			bool operator==(const ImpSdrTextAttribute& rCandidate) const
			{
				if(mpOutlinerParaObject != rCandidate.mpOutlinerParaObject)
				{
					if(mpOutlinerParaObject && rCandidate.mpOutlinerParaObject)
					{
						// compares OPO and it's contents, but traditionally not the RedLining
						// which is not seen as model, but as temporary information
						if(!(getOutlinerParaObject() == rCandidate.getOutlinerParaObject()))
						{
							return false;
						}

						// #i102062# for primitive visualisation, the WrongList (SpellChecking)
						// is important, too, so use isWrongListEqual since there is no WrongList
						// comparison in the regular OutlinerParaObject compare (since it's
						// not-persistent data)
						if(!(getOutlinerParaObject().isWrongListEqual(rCandidate.getOutlinerParaObject())))
						{
							return false;
						}
					}
					else
					{
						// only one is zero; not equal
						return false;
					}
				}

				return (
					   getSdrFormTextAttribute() == rCandidate.getSdrFormTextAttribute()
					&& getTextLeftDistance() == rCandidate.getTextLeftDistance()
					&& getTextUpperDistance() == rCandidate.getTextUpperDistance()
					&& getTextRightDistance() == rCandidate.getTextRightDistance()
					&& getTextLowerDistance() == rCandidate.getTextLowerDistance()
					&& getPropertiesVersion() == rCandidate.getPropertiesVersion()

					&& getSdrTextHorzAdjust() == rCandidate.getSdrTextHorzAdjust()
					&& getSdrTextVertAdjust() == rCandidate.getSdrTextVertAdjust()

					&& isContour() == rCandidate.isContour()
					&& isFitToSize() == rCandidate.isFitToSize()
					&& isHideContour() == rCandidate.isHideContour()
					&& isBlink() == rCandidate.isBlink()
					&& isScroll() == rCandidate.isScroll()
					&& isInEditMode() == rCandidate.isInEditMode()
					&& isFixedCellHeight() == rCandidate.isFixedCellHeight()
					&& isWrongSpell() == rCandidate.isWrongSpell());
			}

			static ImpSdrTextAttribute* get_global_default()
            {
                static ImpSdrTextAttribute* pDefault = 0;

                if(!pDefault)
                {
					// use default constructor
                    pDefault = new ImpSdrTextAttribute();

                    // never delete; start with RefCount 1, not 0
    			    pDefault->mnRefCount++;
                }

                return pDefault;
            }
		};

        SdrTextAttribute::SdrTextAttribute(
			const SdrText& rSdrText,
            const OutlinerParaObject& rOutlinerParaObject,
			XFormTextStyle eFormTextStyle,
			sal_Int32 aTextLeftDistance,
			sal_Int32 aTextUpperDistance,
			sal_Int32 aTextRightDistance,
			sal_Int32 aTextLowerDistance,
            SdrTextHorzAdjust aSdrTextHorzAdjust,
            SdrTextVertAdjust aSdrTextVertAdjust,
			bool bContour,
            bool bFitToSize,
			bool bHideContour,
            bool bBlink,
			bool bScroll,
            bool bInEditMode,
            bool bFixedCellHeight,
			bool bWrongSpell)
		:	mpSdrTextAttribute(new ImpSdrTextAttribute(
				&rSdrText, rOutlinerParaObject, eFormTextStyle, aTextLeftDistance, aTextUpperDistance,
				aTextRightDistance, aTextLowerDistance, aSdrTextHorzAdjust, aSdrTextVertAdjust, bContour,
				bFitToSize, bHideContour, bBlink, bScroll, bInEditMode, bFixedCellHeight, bWrongSpell))
		{
		}

		SdrTextAttribute::SdrTextAttribute()
        :	mpSdrTextAttribute(ImpSdrTextAttribute::get_global_default())
		{
			mpSdrTextAttribute->mnRefCount++;
		}

        SdrTextAttribute::SdrTextAttribute(const SdrTextAttribute& rCandidate)
		:	mpSdrTextAttribute(rCandidate.mpSdrTextAttribute)
		{
			mpSdrTextAttribute->mnRefCount++;
		}

		SdrTextAttribute::~SdrTextAttribute()
		{
			if(mpSdrTextAttribute->mnRefCount)
			{
				mpSdrTextAttribute->mnRefCount--;
			}
			else
			{
				delete mpSdrTextAttribute;
			}
		}

        bool SdrTextAttribute::isDefault() const
        {
            return mpSdrTextAttribute == ImpSdrTextAttribute::get_global_default();
        }

        SdrTextAttribute& SdrTextAttribute::operator=(const SdrTextAttribute& rCandidate)
		{
			if(rCandidate.mpSdrTextAttribute != mpSdrTextAttribute)
			{
				if(mpSdrTextAttribute->mnRefCount)
				{
					mpSdrTextAttribute->mnRefCount--;
				}
				else
				{
					delete mpSdrTextAttribute;
				}

				mpSdrTextAttribute = rCandidate.mpSdrTextAttribute;
				mpSdrTextAttribute->mnRefCount++;
			}

			return *this;
		}

		bool SdrTextAttribute::operator==(const SdrTextAttribute& rCandidate) const
		{
			if(rCandidate.mpSdrTextAttribute == mpSdrTextAttribute)
			{
				return true;
			}

			if(rCandidate.isDefault() != isDefault())
			{
				return false;
			}

			return (*rCandidate.mpSdrTextAttribute == *mpSdrTextAttribute);
		}

		const SdrText& SdrTextAttribute::getSdrText() const
		{
			return mpSdrTextAttribute->getSdrText();
		}

		const OutlinerParaObject& SdrTextAttribute::getOutlinerParaObject() const
		{
			return mpSdrTextAttribute->getOutlinerParaObject();
		}

		bool SdrTextAttribute::isContour() const
		{
			return mpSdrTextAttribute->isContour();
		}

		bool SdrTextAttribute::isFitToSize() const
		{
			return mpSdrTextAttribute->isFitToSize();
		}

		bool SdrTextAttribute::isHideContour() const
		{
			return mpSdrTextAttribute->isHideContour();
		}

		bool SdrTextAttribute::isBlink() const
		{
			return mpSdrTextAttribute->isBlink();
		}

		bool SdrTextAttribute::isScroll() const
		{
			return mpSdrTextAttribute->isScroll();
		}

		bool SdrTextAttribute::isInEditMode() const
		{
			return mpSdrTextAttribute->isInEditMode();
		}

		bool SdrTextAttribute::isFixedCellHeight() const
		{
			return mpSdrTextAttribute->isFixedCellHeight();
		}

		bool SdrTextAttribute::isWrongSpell() const
		{
			return mpSdrTextAttribute->isWrongSpell();
		}

		const SdrFormTextAttribute& SdrTextAttribute::getSdrFormTextAttribute() const
		{
			return mpSdrTextAttribute->getSdrFormTextAttribute();
		}

		sal_Int32 SdrTextAttribute::getTextLeftDistance() const
		{
			return mpSdrTextAttribute->getTextLeftDistance();
		}

		sal_Int32 SdrTextAttribute::getTextUpperDistance() const
		{
			return mpSdrTextAttribute->getTextUpperDistance();
		}

		sal_Int32 SdrTextAttribute::getTextRightDistance() const
		{
			return mpSdrTextAttribute->getTextRightDistance();
		}

		sal_Int32 SdrTextAttribute::getTextLowerDistance() const
		{
			return mpSdrTextAttribute->getTextLowerDistance();
		}

		sal_uInt32 SdrTextAttribute::getPropertiesVersion() const
		{
			return mpSdrTextAttribute->getPropertiesVersion();
		}

		SdrTextHorzAdjust SdrTextAttribute::getSdrTextHorzAdjust() const
		{
			return mpSdrTextAttribute->getSdrTextHorzAdjust();
		}

		SdrTextVertAdjust SdrTextAttribute::getSdrTextVertAdjust() const
		{
			return mpSdrTextAttribute->getSdrTextVertAdjust();
		}

		void SdrTextAttribute::getBlinkTextTiming(drawinglayer::animation::AnimationEntryList& rAnimList) const
		{
			if(isBlink())
			{
				getSdrText().GetObject().impGetBlinkTextTiming(rAnimList);
			}
		}

		void SdrTextAttribute::getScrollTextTiming(drawinglayer::animation::AnimationEntryList& rAnimList, double fFrameLength, double fTextLength) const
		{
			if(isScroll())
			{
				getSdrText().GetObject().impGetScrollTextTiming(rAnimList, fFrameLength, fTextLength);
			}
		}
	} // end of namespace attribute
} // end of namespace drawinglayer

//////////////////////////////////////////////////////////////////////////////
// eof