/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* 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.
*
************************************************************************/
#ifndef _TXATBASE_HXX
#define _TXATBASE_HXX
#include <tools/solar.h>
#include <svl/poolitem.hxx>
#include <hintids.hxx>
#include <boost/utility.hpp>
class SfxItemPool;
class SvXMLAttrContainerItem;
class SwFmtRuby;
class SwFmtCharFmt;
class SwFmtAutoFmt;
class SwFmtINetFmt;
class SwFmtFld;
class SwFmtFtn;
class SwFmtFlyCnt;
class SwTOXMark;
class SwFmtRefMark;
class SwFmtMeta;
class SwTxtAttr : private boost::noncopyable
{
private:
SfxPoolItem * const m_pAttr;
xub_StrLen m_nStart;
bool m_bDontExpand : 1;
bool m_bLockExpandFlag : 1;
bool m_bDontMoveAttr : 1; // refmarks, toxmarks
bool m_bCharFmtAttr : 1; // charfmt, inet
bool m_bOverlapAllowedAttr : 1; // refmarks, toxmarks
bool m_bPriorityAttr : 1; // attribute has priority (redlining)
bool m_bDontExpandStart : 1; // don't expand start at paragraph start (ruby)
bool m_bNesting : 1; // SwTxtAttrNesting
bool m_bHasDummyChar : 1; // without end + meta
protected:
SwTxtAttr( SfxPoolItem& rAttr, xub_StrLen nStart );
virtual ~SwTxtAttr();
void SetLockExpandFlag( bool bFlag ) { m_bLockExpandFlag = bFlag; }
void SetDontMoveAttr( bool bFlag ) { m_bDontMoveAttr = bFlag; }
void SetCharFmtAttr( bool bFlag ) { m_bCharFmtAttr = bFlag; }
void SetOverlapAllowedAttr( bool bFlag ){ m_bOverlapAllowedAttr = bFlag; }
void SetDontExpandStartAttr(bool bFlag) { m_bDontExpandStart = bFlag; }
void SetNesting(const bool bFlag) { m_bNesting = bFlag; }
void SetHasDummyChar(const bool bFlag) { m_bHasDummyChar = bFlag; }
public:
/// destroy instance
static void Destroy( SwTxtAttr * pToDestroy, SfxItemPool& rPool );
/// start position
xub_StrLen* GetStart() { return & m_nStart; }
const xub_StrLen* GetStart() const { return & m_nStart; }
/// end position
virtual xub_StrLen* GetEnd();
inline const xub_StrLen* GetEnd() const;
/// end (if available), else start
inline const xub_StrLen* GetAnyEnd() const;
inline void SetDontExpand( bool bDontExpand );
bool DontExpand() const { return m_bDontExpand; }
bool IsLockExpandFlag() const { return m_bLockExpandFlag; }
bool IsDontMoveAttr() const { return m_bDontMoveAttr; }
bool IsCharFmtAttr() const { return m_bCharFmtAttr; }
bool IsOverlapAllowedAttr() const { return m_bOverlapAllowedAttr; }
bool IsPriorityAttr() const { return m_bPriorityAttr; }
void SetPriorityAttr( bool bFlag ) { m_bPriorityAttr = bFlag; }
bool IsDontExpandStartAttr() const { return m_bDontExpandStart; }
bool IsNesting() const { return m_bNesting; }
bool HasDummyChar() const { return m_bHasDummyChar; }
inline const SfxPoolItem& GetAttr() const;
inline SfxPoolItem& GetAttr();
inline sal_uInt16 Which() const { return GetAttr().Which(); }
virtual int operator==( const SwTxtAttr& ) const;
inline const SwFmtCharFmt &GetCharFmt() const;
inline const SwFmtAutoFmt &GetAutoFmt() const;
inline const SwFmtFld &GetFld() const;
inline const SwFmtFtn &GetFtn() const;
inline const SwFmtFlyCnt &GetFlyCnt() const;
inline const SwTOXMark &GetTOXMark() const;
inline const SwFmtRefMark &GetRefMark() const;
inline const SwFmtINetFmt &GetINetFmt() const;
inline const SwFmtRuby &GetRuby() const;
inline const SwFmtMeta &GetMeta() const;
};
class SwTxtAttrEnd : public SwTxtAttr
{
protected:
xub_StrLen m_nEnd;
public:
SwTxtAttrEnd( SfxPoolItem& rAttr, sal_uInt16 nStart, sal_uInt16 nEnd );
using SwTxtAttr::GetEnd;
virtual xub_StrLen* GetEnd();
};
// --------------- Inline Implementations ------------------------
inline const xub_StrLen* SwTxtAttr::GetEnd() const
{
return const_cast<SwTxtAttr * >(this)->GetEnd();
}
inline const xub_StrLen* SwTxtAttr::GetAnyEnd() const
{
const xub_StrLen* pEnd = GetEnd();
return pEnd ? pEnd : GetStart();
}
inline const SfxPoolItem& SwTxtAttr::GetAttr() const
{
OSL_ENSURE( m_pAttr, "SwTxtAttr: where is my attribute?" );
return *m_pAttr;
}
inline SfxPoolItem& SwTxtAttr::GetAttr()
{
return const_cast<SfxPoolItem&>(
const_cast<const SwTxtAttr*>(this)->GetAttr());
}
inline void SwTxtAttr::SetDontExpand( bool bDontExpand )
{
if ( !m_bLockExpandFlag )
{
m_bDontExpand = bDontExpand;
}
}
//------------------------------------------------------------------------
inline const SwFmtCharFmt& SwTxtAttr::GetCharFmt() const
{
OSL_ENSURE( m_pAttr && m_pAttr->Which() == RES_TXTATR_CHARFMT,
"Wrong attribute" );
return (const SwFmtCharFmt&)(*m_pAttr);
}
inline const SwFmtAutoFmt& SwTxtAttr::GetAutoFmt() const
{
OSL_ENSURE( m_pAttr && m_pAttr->Which() == RES_TXTATR_AUTOFMT,
"Wrong attribute" );
return (const SwFmtAutoFmt&)(*m_pAttr);
}
inline const SwFmtFld& SwTxtAttr::GetFld() const
{
OSL_ENSURE( m_pAttr && m_pAttr->Which() == RES_TXTATR_FIELD,
"Wrong attribute" );
return (const SwFmtFld&)(*m_pAttr);
}
inline const SwFmtFtn& SwTxtAttr::GetFtn() const
{
OSL_ENSURE( m_pAttr && m_pAttr->Which() == RES_TXTATR_FTN, "Wrong attribute" );
return (const SwFmtFtn&)(*m_pAttr);
}
inline const SwFmtFlyCnt& SwTxtAttr::GetFlyCnt() const
{
OSL_ENSURE( m_pAttr && m_pAttr->Which() == RES_TXTATR_FLYCNT,
"Wrong attribute" );
return (const SwFmtFlyCnt&)(*m_pAttr);
}
inline const SwTOXMark& SwTxtAttr::GetTOXMark() const
{
OSL_ENSURE( m_pAttr && m_pAttr->Which() == RES_TXTATR_TOXMARK,
"Wrong attribute" );
return (const SwTOXMark&)(*m_pAttr);
}
inline const SwFmtRefMark& SwTxtAttr::GetRefMark() const
{
OSL_ENSURE( m_pAttr && m_pAttr->Which() == RES_TXTATR_REFMARK,
"Wrong attribute" );
return (const SwFmtRefMark&)(*m_pAttr);
}
inline const SwFmtINetFmt& SwTxtAttr::GetINetFmt() const
{
OSL_ENSURE( m_pAttr && m_pAttr->Which() == RES_TXTATR_INETFMT,
"Wrong attribute" );
return (const SwFmtINetFmt&)(*m_pAttr);
}
inline const SwFmtRuby& SwTxtAttr::GetRuby() const
{
OSL_ENSURE( m_pAttr && m_pAttr->Which() == RES_TXTATR_CJK_RUBY,
"Wrong attribute" );
return (const SwFmtRuby&)(*m_pAttr);
}
inline const SwFmtMeta& SwTxtAttr::GetMeta() const
{
OSL_ENSURE( m_pAttr && (m_pAttr->Which() == RES_TXTATR_META ||
m_pAttr->Which() == RES_TXTATR_METAFIELD),
"Wrong attribute" );
return (const SwFmtMeta&)(*m_pAttr);
}
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */