LibreOffice Module editeng (master) 1
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
SvxBoxItem Class Referencefinal

#include <boxitem.hxx>

Inheritance diagram for SvxBoxItem:
[legend]
Collaboration diagram for SvxBoxItem:
[legend]

Public Member Functions

 SvxBoxItem (const sal_uInt16 nId)
 
 SvxBoxItem (const SvxBoxItem &rCpy)
 
virtual ~SvxBoxItem () override
 
virtual bool operator== (const SfxPoolItem &) const override
 
virtual bool QueryValue (css::uno::Any &rVal, sal_uInt8 nMemberId=0) const override
 
virtual bool PutValue (const css::uno::Any &rVal, sal_uInt8 nMemberId) override
 
virtual bool GetPresentation (SfxItemPresentation ePres, MapUnit eCoreMetric, MapUnit ePresMetric, OUString &rText, const IntlWrapper &) const override
 
virtual SvxBoxItem * Clone (SfxItemPool *pPool=nullptr) const override
 
virtual void ScaleMetrics (tools::Long nMult, tools::Long nDiv) override
 
virtual bool HasMetrics () const override
 
const editeng::SvxBorderLine * GetTop () const
 
const editeng::SvxBorderLine * GetBottom () const
 
const editeng::SvxBorderLine * GetLeft () const
 
const editeng::SvxBorderLine * GetRight () const
 
editeng::SvxBorderLine * GetTop ()
 
editeng::SvxBorderLine * GetBottom ()
 
editeng::SvxBorderLine * GetLeft ()
 
editeng::SvxBorderLine * GetRight ()
 
const editeng::SvxBorderLine * GetLine (SvxBoxItemLine nLine) const
 
void SetLine (const editeng::SvxBorderLine *pNew, SvxBoxItemLine nLine)
 
sal_Int16 GetDistance (SvxBoxItemLine nLine, bool bAllowNegative=false) const
 
sal_uInt16 GetSmallestDistance () const
 
bool IsRemoveAdjacentCellBorder () const
 
void SetDistance (sal_Int16 nNew, SvxBoxItemLine nLine)
 
void SetAllDistances (sal_Int16 nNew)
 
void SetRemoveAdjacentCellBorder (bool bSet)
 
sal_uInt16 CalcLineWidth (SvxBoxItemLine nLine) const
 
sal_Int16 CalcLineSpace (SvxBoxItemLine nLine, bool bEvenIfNoLine=false, bool bAllowNegative=false) const
 
bool HasBorder (bool bTreatPaddingAsBorder) const
 
virtual boost::property_tree::ptree dumpAsJSON () const override
 
void dumpAsXml (xmlTextWriterPtr pWriter) const override
 
- Public Member Functions inherited from SfxPoolItem
void AddRef (sal_uInt32 n=1) const
 
virtual ~SfxPoolItem ()
 
void SetWhich (sal_uInt16 nId)
 
sal_uInt16 Which () const
 
T & StaticWhichCast (TypedWhichId< T > nId)
 
const T & StaticWhichCast (TypedWhichId< T > nId) const
 
T * DynamicWhichCast (TypedWhichId< T > nId)
 
const T * DynamicWhichCast (TypedWhichId< T > nId) const
 
virtual bool operator== (const SfxPoolItem &) const=0
 
bool operator!= (const SfxPoolItem &rItem) const
 
virtual bool operator< (const SfxPoolItem &) const
 
virtual bool IsSortable () const
 
virtual bool HasLookup () const
 
virtual lookup_iterator Lookup (lookup_iterator, lookup_iterator end) const
 
virtual bool GetPresentation (SfxItemPresentation ePresentation, MapUnit eCoreMetric, MapUnit ePresentationMetric, OUString &rText, const IntlWrapper &rIntlWrapper) const
 
virtual void ScaleMetrics (tools::Long lMult, tools::Long lDiv)
 
virtual bool HasMetrics () const
 
virtual bool QueryValue (css::uno::Any &rVal, sal_uInt8 nMemberId=0) const
 
virtual bool PutValue (const css::uno::Any &rVal, sal_uInt8 nMemberId)
 
virtual SfxPoolItem * Clone (SfxItemPool *pPool=nullptr) const=0
 
std::unique_ptr< SfxPoolItem > CloneSetWhich (sal_uInt16 nNewWhich) const
 
std::unique_ptr< T > CloneSetWhich (TypedWhichId< T > nId) const
 
sal_uInt32 GetRefCount () const
 
SfxItemKind GetKind () const
 
virtual void dumpAsXml (xmlTextWriterPtr pWriter) const
 
virtual boost::property_tree::ptree dumpAsJSON () const
 
virtual bool IsVoidItem () const
 

Static Public Member Functions

static SfxPoolItem * CreateDefault ()
 
static css::table::BorderLine2 SvxLineToLine (const editeng::SvxBorderLine *pLine, bool bConvert)
 
static bool LineToSvxLine (const css::table::BorderLine &rLine, editeng::SvxBorderLine &rSvxLine, bool bConvert)
 
static bool LineToSvxLine (const css::table::BorderLine2 &rLine, editeng::SvxBorderLine &rSvxLine, bool bConvert)
 

Private Member Functions

void tryMigrateComplexColor (SvxBoxItemLine eLine)
 

Private Attributes

std::unique_ptr< editeng::SvxBorderLine > mpTopBorderLine
 
std::unique_ptr< editeng::SvxBorderLine > mpBottomBorderLine
 
std::unique_ptr< editeng::SvxBorderLine > mpLeftBorderLine
 
std::unique_ptr< editeng::SvxBorderLine > mpRightBorderLine
 
sal_Int16 mnTopDistance = 0
 
sal_Int16 mnBottomDistance = 0
 
sal_Int16 mnLeftDistance = 0
 
sal_Int16 mnRightDistance = 0
 
std::array< model::ComplexColor, 4 > maTempComplexColors
 
bool mbRemoveAdjCellBorder = false
 

Additional Inherited Members

- Public Types inherited from SfxPoolItem
typedef std::vector< SfxPoolItem * >::const_iterator lookup_iterator
 
- Protected Member Functions inherited from SfxPoolItem
 SfxPoolItem (sal_uInt16 nWhich=0)
 
 SfxPoolItem (const SfxPoolItem &rCopy)
 

Detailed Description

Definition at line 57 of file boxitem.hxx.

Constructor & Destructor Documentation

◆ SvxBoxItem() [1/2]

SvxBoxItem::SvxBoxItem ( const sal_uInt16  nId)
explicit

Definition at line 2310 of file frmitems.cxx.

References nId.

Referenced by Clone(), and CreateDefault().

◆ SvxBoxItem() [2/2]

SvxBoxItem::SvxBoxItem ( const SvxBoxItem &  rCpy)

Definition at line 2294 of file frmitems.cxx.

◆ ~SvxBoxItem()

SvxBoxItem::~SvxBoxItem ( )
overridevirtual

Definition at line 2316 of file frmitems.cxx.

Member Function Documentation

◆ CalcLineSpace()

sal_Int16 SvxBoxItem::CalcLineSpace ( SvxBoxItemLine  nLine,
bool  bEvenIfNoLine = false,
bool  bAllowNegative = false 
) const

Definition at line 3178 of file frmitems.cxx.

References BOTTOM, LEFT, mnBottomDistance, mnLeftDistance, mnRightDistance, mnTopDistance, mpBottomBorderLine, mpLeftBorderLine, mpRightBorderLine, mpTopBorderLine, RIGHT, and TOP.

Referenced by HasBorder().

◆ CalcLineWidth()

sal_uInt16 SvxBoxItem::CalcLineWidth ( SvxBoxItemLine  nLine) const

Definition at line 3150 of file frmitems.cxx.

References BOTTOM, LEFT, mpBottomBorderLine, mpLeftBorderLine, mpRightBorderLine, mpTopBorderLine, RIGHT, and TOP.

◆ Clone()

SvxBoxItem * SvxBoxItem::Clone ( SfxItemPool *  pPool = nullptr) const
overridevirtual

Implements SfxPoolItem.

Definition at line 2875 of file frmitems.cxx.

References SvxBoxItem().

◆ CreateDefault()

SfxPoolItem * SvxBoxItem::CreateDefault ( )
static

Definition at line 96 of file frmitems.cxx.

References SvxBoxItem().

◆ dumpAsJSON()

boost::property_tree::ptree SvxBoxItem::dumpAsJSON ( ) const
overridevirtual

Reimplemented from SfxPoolItem.

Definition at line 2335 of file frmitems.cxx.

References GetBottom(), GetLeft(), GetRight(), and GetTop().

◆ dumpAsXml()

void SvxBoxItem::dumpAsXml ( xmlTextWriterPtr  pWriter) const
overridevirtual

Reimplemented from SfxPoolItem.

Definition at line 2320 of file frmitems.cxx.

References SfxPoolItem::dumpAsXml(), mnBottomDistance, mnLeftDistance, mnRightDistance, and mnTopDistance.

◆ GetBottom() [1/2]

editeng::SvxBorderLine * SvxBoxItem::GetBottom ( )
inline

Definition at line 119 of file boxitem.hxx.

◆ GetBottom() [2/2]

const editeng::SvxBorderLine * SvxBoxItem::GetBottom ( ) const
inline

Definition at line 102 of file boxitem.hxx.

Referenced by dumpAsJSON(), operator==(), QueryValue(), and legacy::SvxBox::Store().

◆ GetDistance()

sal_Int16 SvxBoxItem::GetDistance ( SvxBoxItemLine  nLine,
bool  bAllowNegative = false 
) const

Definition at line 3100 of file frmitems.cxx.

References BOTTOM, LEFT, mnBottomDistance, mnLeftDistance, mnRightDistance, mnTopDistance, RIGHT, and TOP.

Referenced by editeng::BorderDistancesToWord(), and legacy::SvxBox::Store().

◆ GetLeft() [1/2]

editeng::SvxBorderLine * SvxBoxItem::GetLeft ( )
inline

Definition at line 123 of file boxitem.hxx.

◆ GetLeft() [2/2]

const editeng::SvxBorderLine * SvxBoxItem::GetLeft ( ) const
inline

Definition at line 106 of file boxitem.hxx.

Referenced by dumpAsJSON(), operator==(), QueryValue(), and legacy::SvxBox::Store().

◆ GetLine()

const SvxBorderLine * SvxBoxItem::GetLine ( SvxBoxItemLine  nLine) const

Definition at line 3034 of file frmitems.cxx.

References BOTTOM, LEFT, mpBottomBorderLine, mpLeftBorderLine, mpRightBorderLine, mpTopBorderLine, RIGHT, and TOP.

Referenced by editeng::BorderDistancesToWord(), PutValue(), and tryMigrateComplexColor().

◆ GetPresentation()

bool SvxBoxItem::GetPresentation ( SfxItemPresentation  ePres,
MapUnit  eCoreMetric,
MapUnit  ePresMetric,
OUString &  rText,
const IntlWrapper &  rIntl 
) const
overridevirtual

Reimplemented from SfxPoolItem.

Definition at line 2880 of file frmitems.cxx.

References cpDelim, EditResId(), GetMetricId(), GetMetricText(), mnBottomDistance, mnLeftDistance, mnRightDistance, mnTopDistance, mpBottomBorderLine, mpLeftBorderLine, mpRightBorderLine, and mpTopBorderLine.

◆ GetRight() [1/2]

editeng::SvxBorderLine * SvxBoxItem::GetRight ( )
inline

Definition at line 127 of file boxitem.hxx.

◆ GetRight() [2/2]

const editeng::SvxBorderLine * SvxBoxItem::GetRight ( ) const
inline

Definition at line 110 of file boxitem.hxx.

Referenced by dumpAsJSON(), operator==(), QueryValue(), and legacy::SvxBox::Store().

◆ GetSmallestDistance()

sal_uInt16 SvxBoxItem::GetSmallestDistance ( ) const

Definition at line 3085 of file frmitems.cxx.

References mnBottomDistance, mnLeftDistance, mnRightDistance, and mnTopDistance.

Referenced by QueryValue(), and legacy::SvxBox::Store().

◆ GetTop() [1/2]

editeng::SvxBorderLine * SvxBoxItem::GetTop ( )
inline

Definition at line 115 of file boxitem.hxx.

◆ GetTop() [2/2]

const editeng::SvxBorderLine * SvxBoxItem::GetTop ( ) const
inline

Definition at line 98 of file boxitem.hxx.

Referenced by dumpAsJSON(), operator==(), QueryValue(), and legacy::SvxBox::Store().

◆ HasBorder()

bool SvxBoxItem::HasBorder ( bool  bTreatPaddingAsBorder) const

Definition at line 3248 of file frmitems.cxx.

References BOTTOM, CalcLineSpace(), LEFT, RIGHT, and TOP.

◆ HasMetrics()

bool SvxBoxItem::HasMetrics ( ) const
overridevirtual

Reimplemented from SfxPoolItem.

Definition at line 3028 of file frmitems.cxx.

◆ IsRemoveAdjacentCellBorder()

bool SvxBoxItem::IsRemoveAdjacentCellBorder ( ) const
inline

Definition at line 140 of file boxitem.hxx.

◆ LineToSvxLine() [1/2]

static bool SvxBoxItem::LineToSvxLine ( const css::table::BorderLine &  rLine,
editeng::SvxBorderLine &  rSvxLine,
bool  bConvert 
)
static

Referenced by PutValue(), SvxBoxInfoItem::PutValue(), and SvxLineItem::PutValue().

◆ LineToSvxLine() [2/2]

static bool SvxBoxItem::LineToSvxLine ( const css::table::BorderLine2 &  rLine,
editeng::SvxBorderLine &  rSvxLine,
bool  bConvert 
)
static

◆ operator==()

bool SvxBoxItem::operator== ( const SfxPoolItem &  rAttr) const
overridevirtual

Implements SfxPoolItem.

Definition at line 2362 of file frmitems.cxx.

References CompareBorderLine(), GetBottom(), GetLeft(), GetRight(), GetTop(), maTempComplexColors, mbRemoveAdjCellBorder, mnBottomDistance, mnLeftDistance, mnRightDistance, mnTopDistance, mpBottomBorderLine, mpLeftBorderLine, mpRightBorderLine, mpTopBorderLine, and rBoxItem.

◆ PutValue()

bool SvxBoxItem::PutValue ( const css::uno::Any &  rVal,
sal_uInt8  nMemberId 
)
overridevirtual

Reimplemented from SfxPoolItem.

Definition at line 2618 of file frmitems.cxx.

References aSeq, BORDER_DISTANCE, BOTTOM, BOTTOM_BORDER, BOTTOM_BORDER_DISTANCE, CONVERT_TWIPS, DASHED, model::color::getFromXComplexColor(), GetLine(), uno::Any::hasValue(), LEFT, LEFT_BORDER, LEFT_BORDER_DISTANCE, LINE_STYLE, LINE_WIDTH, LineToSvxLine(), maTempComplexColors, MID_BORDER_BOTTOM_COLOR, MID_BORDER_LEFT_COLOR, MID_BORDER_RIGHT_COLOR, MID_BORDER_TOP_COLOR, MID_BOTTOM_BORDER, MID_LEFT_BORDER, MID_RIGHT_BORDER, MID_TOP_BORDER, o3tl::mm100, mpBottomBorderLine, mpLeftBorderLine, mpRightBorderLine, mpTopBorderLine, n, NONE, RIGHT, RIGHT_BORDER, RIGHT_BORDER_DISTANCE, SetAllDistances(), editeng::SvxBorderLine::SetBorderLineStyle(), SetDistance(), SetLine(), editeng::SvxBorderLine::SetWidth(), SOLID, TOP, TOP_BORDER, TOP_BORDER_DISTANCE, o3tl::toTwips(), tryMigrateComplexColor(), and xConverter.

◆ QueryValue()

bool SvxBoxItem::QueryValue ( css::uno::Any &  rVal,
sal_uInt8  nMemberId = 0 
) const
overridevirtual

Reimplemented from SfxPoolItem.

Definition at line 2401 of file frmitems.cxx.

References aSeq, BORDER_DISTANCE, BOTTOM, BOTTOM_BORDER, BOTTOM_BORDER_DISTANCE, CONVERT_TWIPS, convertTwipToMm100(), model::color::createXComplexColor(), GetBottom(), GetLeft(), GetRight(), GetSmallestDistance(), GetTop(), getType(), LEFT, LEFT_BORDER, LEFT_BORDER_DISTANCE, LINE_STYLE, LINE_WIDTH, maTempComplexColors, MID_BORDER_BOTTOM_COLOR, MID_BORDER_LEFT_COLOR, MID_BORDER_RIGHT_COLOR, MID_BORDER_TOP_COLOR, MID_BOTTOM_BORDER, MID_LEFT_BORDER, MID_RIGHT_BORDER, MID_TOP_BORDER, mnBottomDistance, mnLeftDistance, mnRightDistance, mnTopDistance, mpBottomBorderLine, mpLeftBorderLine, mpRightBorderLine, mpTopBorderLine, RIGHT, RIGHT_BORDER, RIGHT_BORDER_DISTANCE, SvxLineToLine(), TOP, TOP_BORDER, TOP_BORDER_DISTANCE, and model::Unused.

◆ ScaleMetrics()

void SvxBoxItem::ScaleMetrics ( tools::Long  nMult,
tools::Long  nDiv 
)
overridevirtual

Reimplemented from SfxPoolItem.

Definition at line 3010 of file frmitems.cxx.

References mnBottomDistance, mnLeftDistance, mnRightDistance, mnTopDistance, mpBottomBorderLine, mpLeftBorderLine, mpRightBorderLine, mpTopBorderLine, and BigInt::Scale().

◆ SetAllDistances()

void SvxBoxItem::SetAllDistances ( sal_Int16  nNew)
inline

Definition at line 143 of file boxitem.hxx.

Referenced by legacy::SvxBox::Create(), and PutValue().

◆ SetDistance()

void SvxBoxItem::SetDistance ( sal_Int16  nNew,
SvxBoxItemLine  nLine 
)

Definition at line 3129 of file frmitems.cxx.

References BOTTOM, LEFT, mnBottomDistance, mnLeftDistance, mnRightDistance, mnTopDistance, RIGHT, and TOP.

Referenced by legacy::SvxBox::Create(), and PutValue().

◆ SetLine()

void SvxBoxItem::SetLine ( const editeng::SvxBorderLine *  pNew,
SvxBoxItemLine  nLine 
)

Definition at line 3061 of file frmitems.cxx.

References BOTTOM, LEFT, mpBottomBorderLine, mpLeftBorderLine, mpRightBorderLine, mpTopBorderLine, RIGHT, and TOP.

Referenced by legacy::SvxBox::Create(), PutValue(), and SetBorderLine().

◆ SetRemoveAdjacentCellBorder()

void SvxBoxItem::SetRemoveAdjacentCellBorder ( bool  bSet)
inline

Definition at line 148 of file boxitem.hxx.

◆ SvxLineToLine()

table::BorderLine2 SvxBoxItem::SvxLineToLine ( const editeng::SvxBorderLine *  pLine,
bool  bConvert 
)
static

Definition at line 2381 of file frmitems.cxx.

References convertTwipToMm100().

Referenced by QueryValue(), SvxBoxInfoItem::QueryValue(), and SvxLineItem::QueryValue().

◆ tryMigrateComplexColor()

void SvxBoxItem::tryMigrateComplexColor ( SvxBoxItemLine  eLine)
private

Definition at line 3219 of file frmitems.cxx.

References BOTTOM, GetLine(), getType(), LEFT, maTempComplexColors, mpBottomBorderLine, mpLeftBorderLine, mpRightBorderLine, mpTopBorderLine, nIndex, RIGHT, TOP, and model::Unused.

Referenced by PutValue().

Member Data Documentation

◆ maTempComplexColors

std::array<model::ComplexColor, 4> SvxBoxItem::maTempComplexColors
private

Definition at line 70 of file boxitem.hxx.

Referenced by operator==(), PutValue(), QueryValue(), and tryMigrateComplexColor().

◆ mbRemoveAdjCellBorder

bool SvxBoxItem::mbRemoveAdjCellBorder = false
private

Definition at line 72 of file boxitem.hxx.

Referenced by operator==().

◆ mnBottomDistance

sal_Int16 SvxBoxItem::mnBottomDistance = 0
private

Definition at line 65 of file boxitem.hxx.

Referenced by CalcLineSpace(), dumpAsXml(), GetDistance(), GetPresentation(), GetSmallestDistance(), operator==(), QueryValue(), ScaleMetrics(), and SetDistance().

◆ mnLeftDistance

sal_Int16 SvxBoxItem::mnLeftDistance = 0
private

Definition at line 66 of file boxitem.hxx.

Referenced by CalcLineSpace(), dumpAsXml(), GetDistance(), GetPresentation(), GetSmallestDistance(), operator==(), QueryValue(), ScaleMetrics(), and SetDistance().

◆ mnRightDistance

sal_Int16 SvxBoxItem::mnRightDistance = 0
private

Definition at line 67 of file boxitem.hxx.

Referenced by CalcLineSpace(), dumpAsXml(), GetDistance(), GetPresentation(), GetSmallestDistance(), operator==(), QueryValue(), ScaleMetrics(), and SetDistance().

◆ mnTopDistance

sal_Int16 SvxBoxItem::mnTopDistance = 0
private

Definition at line 64 of file boxitem.hxx.

Referenced by CalcLineSpace(), dumpAsXml(), GetDistance(), GetPresentation(), GetSmallestDistance(), operator==(), QueryValue(), ScaleMetrics(), and SetDistance().

◆ mpBottomBorderLine

std::unique_ptr<editeng::SvxBorderLine> SvxBoxItem::mpBottomBorderLine
private

Definition at line 60 of file boxitem.hxx.

Referenced by CalcLineSpace(), CalcLineWidth(), GetLine(), GetPresentation(), operator==(), PutValue(), QueryValue(), ScaleMetrics(), SetLine(), and tryMigrateComplexColor().

◆ mpLeftBorderLine

std::unique_ptr<editeng::SvxBorderLine> SvxBoxItem::mpLeftBorderLine
private

Definition at line 61 of file boxitem.hxx.

Referenced by CalcLineSpace(), CalcLineWidth(), GetLine(), GetPresentation(), operator==(), PutValue(), QueryValue(), ScaleMetrics(), SetLine(), and tryMigrateComplexColor().

◆ mpRightBorderLine

std::unique_ptr<editeng::SvxBorderLine> SvxBoxItem::mpRightBorderLine
private

Definition at line 62 of file boxitem.hxx.

Referenced by CalcLineSpace(), CalcLineWidth(), GetLine(), GetPresentation(), operator==(), PutValue(), QueryValue(), ScaleMetrics(), SetLine(), and tryMigrateComplexColor().

◆ mpTopBorderLine

std::unique_ptr<editeng::SvxBorderLine> SvxBoxItem::mpTopBorderLine
private

Definition at line 59 of file boxitem.hxx.

Referenced by CalcLineSpace(), CalcLineWidth(), GetLine(), GetPresentation(), operator==(), PutValue(), QueryValue(), ScaleMetrics(), SetLine(), and tryMigrateComplexColor().

The documentation for this class was generated from the following files:
Generated on Sun Jul 30 2023 04:34:06 for LibreOffice Module editeng (master) by doxygen 1.9.3