LibreOffice Module editeng (master) 1
Public Types | Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
SvxNumberFormat Class Reference

#include <numitem.hxx>

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

Public Types

enum  SvxNumPositionAndSpaceMode {
  LABEL_WIDTH_AND_POSITION ,
  LABEL_ALIGNMENT
}
 
enum  LabelFollowedBy {
  LISTTAB ,
  SPACE ,
  NOTHING ,
  NEWLINE
}
 

Public Member Functions

 SvxNumberFormat (SvxNumType nNumberingType)
 
 SvxNumberFormat (const SvxNumberFormat &rFormat)
 
 SvxNumberFormat (SvStream &rStream)
 
virtual ~SvxNumberFormat ()
 
void Store (SvStream &rStream, FontToSubsFontConverter pConverter)
 
SvxNumberFormatoperator= (const SvxNumberFormat &)
 
bool operator== (const SvxNumberFormat &) const
 
bool operator!= (const SvxNumberFormat &rFmt) const
 
void SetNumAdjust (SvxAdjust eSet)
 
SvxAdjust GetNumAdjust () const
 
void SetPrefix (const OUString &rSet)
 
const OUString & GetPrefix () const
 
void SetSuffix (const OUString &rSet)
 
const OUString & GetSuffix () const
 
void SetListFormat (const OUString &rPrefix, const OUString &rSuffix, int nLevel)
 
void SetListFormat (std::optional< OUString > oSet=std::nullopt)
 
bool HasListFormat () const
 
OUString GetListFormat (bool bIncludePrefixSuffix=true) const
 
void SetCharFormatName (const OUString &rSet)
 
virtual OUString GetCharFormatName () const
 
void SetBulletFont (const vcl::Font *pFont)
 
const std::optional< vcl::Font > & GetBulletFont () const
 
void SetBulletChar (sal_UCS4 cSet)
 
sal_UCS4 GetBulletChar () const
 
void SetBulletRelSize (sal_uInt16 nSet)
 
sal_uInt16 GetBulletRelSize () const
 
void SetBulletColor (Color nSet)
 
const ColorGetBulletColor () const
 
void SetIncludeUpperLevels (sal_uInt8 nSet)
 
sal_uInt8 GetIncludeUpperLevels () const
 
void SetStart (sal_uInt16 nSet)
 
sal_uInt16 GetStart () const
 
virtual void SetGraphicBrush (const SvxBrushItem *pBrushItem, const Size *pSize=nullptr, const sal_Int16 *pOrient=nullptr)
 
const SvxBrushItemGetBrush () const
 
void SetGraphic (const OUString &rName)
 
sal_Int16 GetVertOrient () const
 
void SetGraphicSize (const Size &rSet)
 
const SizeGetGraphicSize () const
 
SvxNumPositionAndSpaceMode GetPositionAndSpaceMode () const
 
void SetPositionAndSpaceMode (SvxNumPositionAndSpaceMode ePositionAndSpaceMode)
 
void SetAbsLSpace (sal_Int32 nSet)
 
sal_Int32 GetAbsLSpace () const
 
void SetFirstLineOffset (sal_Int32 nSet)
 
sal_Int32 GetFirstLineOffset () const
 
void SetCharTextDistance (short nSet)
 
short GetCharTextDistance () const
 
void SetLabelFollowedBy (const LabelFollowedBy eLabelFollowedBy)
 
LabelFollowedBy GetLabelFollowedBy () const
 
OUString GetLabelFollowedByAsString () const
 
void SetListtabPos (const tools::Long nListtabPos)
 
tools::Long GetListtabPos () const
 
void SetFirstLineIndent (const tools::Long nFirstLineIndent)
 
tools::Long GetFirstLineIndent () const
 
void SetIndentAt (const tools::Long nIndentAt)
 
tools::Long GetIndentAt () const
 
bool GetIsLegal () const
 
void SetIsLegal (bool val)
 
- Public Member Functions inherited from SvxNumberType
 SvxNumberType (SvxNumType nType=SVX_NUM_ARABIC)
 
 SvxNumberType (const SvxNumberType &rType)
 
 ~SvxNumberType ()
 
SvxNumberTypeoperator= (SvxNumberType const &)=default
 
OUString GetNumStr (sal_Int32 nNo) const
 
OUString GetNumStr (sal_Int32 nNo, const css::lang::Locale &rLocale, bool bIsLegal=false) const
 
void SetNumberingType (SvxNumType nSet)
 
SvxNumType GetNumberingType () const
 
void SetShowSymbol (bool bSet)
 
bool IsShowSymbol () const
 
bool IsTextFormat () const
 
void dumpAsXml (xmlTextWriterPtr w) const
 

Static Public Member Functions

static Size GetGraphicSizeMM100 (const Graphic *pGraphic)
 
static OUString CreateRomanString (sal_Int32 nNo, bool bUpper)
 

Private Attributes

OUString sPrefix
 
OUString sSuffix
 
std::optional< OUString > sListFormat
 
SvxAdjust eNumAdjust
 
sal_uInt8 nInclUpperLevels
 
sal_uInt16 nStart
 
sal_UCS4 cBullet
 
sal_uInt16 nBulletRelSize
 
Color nBulletColor
 
SvxNumPositionAndSpaceMode mePositionAndSpaceMode
 
sal_Int32 nFirstLineOffset
 
sal_Int32 nAbsLSpace
 
short nCharTextDistance
 
LabelFollowedBy meLabelFollowedBy
 
tools::Long mnListtabPos
 
tools::Long mnFirstLineIndent
 
tools::Long mnIndentAt
 
std::unique_ptr< SvxBrushItempGraphicBrush
 
sal_Int16 eVertOrient
 
Size aGraphicSize
 
std::optional< vcl::FontpBulletFont
 
OUString sCharStyleName
 
bool mbIsLegal = false
 

Detailed Description

Definition at line 88 of file numitem.hxx.

Member Enumeration Documentation

◆ LabelFollowedBy

Enumerator
LISTTAB 
SPACE 
NOTHING 
NEWLINE 

Definition at line 96 of file numitem.hxx.

◆ SvxNumPositionAndSpaceMode

Enumerator
LABEL_WIDTH_AND_POSITION 
LABEL_ALIGNMENT 

Definition at line 91 of file numitem.hxx.

Constructor & Destructor Documentation

◆ SvxNumberFormat() [1/3]

SvxNumberFormat::SvxNumberFormat ( SvxNumType  nNumberingType)
explicit

Definition at line 172 of file numitem.cxx.

References COL_BLACK(), eType, Left, nFirstLineOffset, NONE, and text().

◆ SvxNumberFormat() [2/3]

SvxNumberFormat::SvxNumberFormat ( const SvxNumberFormat rFormat)

Definition at line 192 of file numitem.cxx.

◆ SvxNumberFormat() [3/3]

SvxNumberFormat::SvxNumberFormat ( SvStream rStream)

◆ ~SvxNumberFormat()

SvxNumberFormat::~SvxNumberFormat ( )
virtual

Definition at line 263 of file numitem.cxx.

Member Function Documentation

◆ CreateRomanString()

OUString SvxNumberFormat::CreateRomanString ( sal_Int32  nNo,
bool  bUpper 
)
static

Definition at line 551 of file numitem.cxx.

References i, and values.

◆ GetAbsLSpace()

sal_Int32 SvxNumberFormat::GetAbsLSpace ( ) const

◆ GetBrush()

const SvxBrushItem * SvxNumberFormat::GetBrush ( ) const
inline

◆ GetBulletChar()

sal_UCS4 SvxNumberFormat::GetBulletChar ( ) const
inline

◆ GetBulletColor()

const Color & SvxNumberFormat::GetBulletColor ( ) const
inline

◆ GetBulletFont()

const std::optional< vcl::Font > & SvxNumberFormat::GetBulletFont ( ) const
inline

◆ GetBulletRelSize()

sal_uInt16 SvxNumberFormat::GetBulletRelSize ( ) const
inline

◆ GetCharFormatName()

OUString SvxNumberFormat::GetCharFormatName ( ) const
virtual

Definition at line 665 of file numitem.cxx.

References sCharStyleName.

◆ GetCharTextDistance()

short SvxNumberFormat::GetCharTextDistance ( ) const

◆ GetFirstLineIndent()

tools::Long SvxNumberFormat::GetFirstLineIndent ( ) const
inline

Definition at line 222 of file numitem.hxx.

Referenced by GetAbsLSpace(), and GetFirstLineOffset().

◆ GetFirstLineOffset()

sal_Int32 SvxNumberFormat::GetFirstLineOffset ( ) const

◆ GetGraphicSize()

const Size & SvxNumberFormat::GetGraphicSize ( ) const
inline

◆ GetGraphicSizeMM100()

Size SvxNumberFormat::GetGraphicSizeMM100 ( const Graphic pGraphic)
static

◆ GetIncludeUpperLevels()

sal_uInt8 SvxNumberFormat::GetIncludeUpperLevels ( ) const
inline

Definition at line 195 of file numitem.hxx.

Referenced by SvxNumRule::MakeNumString().

◆ GetIndentAt()

tools::Long SvxNumberFormat::GetIndentAt ( ) const
inline

Definition at line 224 of file numitem.hxx.

Referenced by GetAbsLSpace().

◆ GetIsLegal()

bool SvxNumberFormat::GetIsLegal ( ) const
inline

Definition at line 229 of file numitem.hxx.

Referenced by SvxNumRule::MakeNumString().

◆ GetLabelFollowedBy()

LabelFollowedBy SvxNumberFormat::GetLabelFollowedBy ( ) const
inline

Definition at line 217 of file numitem.hxx.

◆ GetLabelFollowedByAsString()

OUString SvxNumberFormat::GetLabelFollowedByAsString ( ) const

Definition at line 500 of file numitem.cxx.

References LISTTAB, meLabelFollowedBy, NEWLINE, NOTHING, SAL_WARN, and SPACE.

◆ GetListFormat()

OUString SvxNumberFormat::GetListFormat ( bool  bIncludePrefixSuffix = true) const

Definition at line 654 of file numitem.cxx.

References sListFormat, sPrefix, and sSuffix.

◆ GetListtabPos()

tools::Long SvxNumberFormat::GetListtabPos ( ) const
inline

Definition at line 220 of file numitem.hxx.

◆ GetNumAdjust()

SvxAdjust SvxNumberFormat::GetNumAdjust ( ) const
inline

◆ GetPositionAndSpaceMode()

SvxNumPositionAndSpaceMode SvxNumberFormat::GetPositionAndSpaceMode ( ) const
inline

Definition at line 206 of file numitem.hxx.

◆ GetPrefix()

const OUString & SvxNumberFormat::GetPrefix ( ) const
inline

◆ GetStart()

sal_uInt16 SvxNumberFormat::GetStart ( ) const
inline

◆ GetSuffix()

const OUString & SvxNumberFormat::GetSuffix ( ) const
inline

◆ GetVertOrient()

sal_Int16 SvxNumberFormat::GetVertOrient ( ) const

Definition at line 460 of file numitem.cxx.

References eVertOrient.

Referenced by SvxNumRule::UnLinkGraphics().

◆ HasListFormat()

bool SvxNumberFormat::HasListFormat ( ) const
inline

Definition at line 179 of file numitem.hxx.

◆ operator!=()

bool SvxNumberFormat::operator!= ( const SvxNumberFormat rFmt) const
inline

Definition at line 168 of file numitem.hxx.

◆ operator=()

SvxNumberFormat & SvxNumberFormat::operator= ( const SvxNumberFormat rFormat)

◆ operator==()

bool SvxNumberFormat::operator== ( const SvxNumberFormat rFormat) const

◆ SetAbsLSpace()

void SvxNumberFormat::SetAbsLSpace ( sal_Int32  nSet)
inline

◆ SetBulletChar()

void SvxNumberFormat::SetBulletChar ( sal_UCS4  cSet)
inline

Definition at line 187 of file numitem.hxx.

Referenced by SvxUnoNumberingRules::setNumberingRuleByIndex().

◆ SetBulletColor()

void SvxNumberFormat::SetBulletColor ( Color  nSet)
inline

Definition at line 191 of file numitem.hxx.

Referenced by SvxUnoNumberingRules::setNumberingRuleByIndex().

◆ SetBulletFont()

void SvxNumberFormat::SetBulletFont ( const vcl::Font pFont)

Definition at line 465 of file numitem.cxx.

References pBulletFont.

Referenced by SvxUnoNumberingRules::setNumberingRuleByIndex().

◆ SetBulletRelSize()

void SvxNumberFormat::SetBulletRelSize ( sal_uInt16  nSet)
inline

Definition at line 189 of file numitem.hxx.

References SVX_NUM_REL_SIZE_MIN.

Referenced by SvxUnoNumberingRules::setNumberingRuleByIndex().

◆ SetCharFormatName()

void SvxNumberFormat::SetCharFormatName ( const OUString &  rSet)
inline

Definition at line 182 of file numitem.hxx.

References rSet, and sCharStyleName.

◆ SetCharTextDistance()

void SvxNumberFormat::SetCharTextDistance ( short  nSet)
inline

Definition at line 213 of file numitem.hxx.

Referenced by SvxUnoNumberingRules::setNumberingRuleByIndex().

◆ SetFirstLineIndent()

void SvxNumberFormat::SetFirstLineIndent ( const tools::Long  nFirstLineIndent)

Definition at line 524 of file numitem.cxx.

References mnFirstLineIndent.

◆ SetFirstLineOffset()

void SvxNumberFormat::SetFirstLineOffset ( sal_Int32  nSet)
inline

◆ SetGraphic()

void SvxNumberFormat::SetGraphic ( const OUString &  rName)

◆ SetGraphicBrush()

void SvxNumberFormat::SetGraphicBrush ( const SvxBrushItem pBrushItem,
const Size pSize = nullptr,
const sal_Int16 *  pOrient = nullptr 
)
virtual

◆ SetGraphicSize()

void SvxNumberFormat::SetGraphicSize ( const Size rSet)
inline

Definition at line 203 of file numitem.hxx.

References rSet.

Referenced by SvxUnoNumberingRules::setNumberingRuleByIndex().

◆ SetIncludeUpperLevels()

void SvxNumberFormat::SetIncludeUpperLevels ( sal_uInt8  nSet)
inline

Definition at line 194 of file numitem.hxx.

◆ SetIndentAt()

void SvxNumberFormat::SetIndentAt ( const tools::Long  nIndentAt)

Definition at line 528 of file numitem.cxx.

References mnIndentAt.

◆ SetIsLegal()

void SvxNumberFormat::SetIsLegal ( bool  val)
inline

Definition at line 230 of file numitem.hxx.

◆ SetLabelFollowedBy()

void SvxNumberFormat::SetLabelFollowedBy ( const LabelFollowedBy  eLabelFollowedBy)

Definition at line 495 of file numitem.cxx.

References meLabelFollowedBy.

◆ SetListFormat() [1/2]

void SvxNumberFormat::SetListFormat ( const OUString &  rPrefix,
const OUString &  rSuffix,
int  nLevel 
)

Definition at line 589 of file numitem.cxx.

References i, nInclUpperLevels, sListFormat, sPrefix, and sSuffix.

◆ SetListFormat() [2/2]

void SvxNumberFormat::SetListFormat ( std::optional< OUString >  oSet = std::nullopt)

Definition at line 614 of file numitem.cxx.

References getLength(), i, nInclUpperLevels, sListFormat, sPrefix, and sSuffix.

◆ SetListtabPos()

void SvxNumberFormat::SetListtabPos ( const tools::Long  nListtabPos)

Definition at line 520 of file numitem.cxx.

References mnListtabPos.

◆ SetNumAdjust()

void SvxNumberFormat::SetNumAdjust ( SvxAdjust  eSet)
inline

Definition at line 170 of file numitem.hxx.

Referenced by SvxUnoNumberingRules::setNumberingRuleByIndex().

◆ SetPositionAndSpaceMode()

void SvxNumberFormat::SetPositionAndSpaceMode ( SvxNumPositionAndSpaceMode  ePositionAndSpaceMode)

Definition at line 473 of file numitem.cxx.

References mePositionAndSpaceMode.

◆ SetPrefix()

void SvxNumberFormat::SetPrefix ( const OUString &  rSet)

Definition at line 571 of file numitem.cxx.

References rSet, sListFormat, and sPrefix.

Referenced by SvxUnoNumberingRules::setNumberingRuleByIndex().

◆ SetStart()

void SvxNumberFormat::SetStart ( sal_uInt16  nSet)
inline

Definition at line 196 of file numitem.hxx.

Referenced by SvxUnoNumberingRules::setNumberingRuleByIndex().

◆ SetSuffix()

void SvxNumberFormat::SetSuffix ( const OUString &  rSet)

Definition at line 580 of file numitem.cxx.

References rSet, sListFormat, and sSuffix.

Referenced by SvxUnoNumberingRules::setNumberingRuleByIndex().

◆ Store()

void SvxNumberFormat::Store ( SvStream rStream,
FontToSubsFontConverter  pConverter 
)

Member Data Documentation

◆ aGraphicSize

Size SvxNumberFormat::aGraphicSize
private

Definition at line 149 of file numitem.hxx.

Referenced by operator=(), operator==(), SetGraphic(), SetGraphicBrush(), Store(), and SvxNumberFormat().

◆ cBullet

sal_UCS4 SvxNumberFormat::cBullet
private

Definition at line 116 of file numitem.hxx.

Referenced by operator=(), operator==(), Store(), and SvxNumberFormat().

◆ eNumAdjust

SvxAdjust SvxNumberFormat::eNumAdjust
private

Definition at line 111 of file numitem.hxx.

Referenced by operator=(), operator==(), Store(), and SvxNumberFormat().

◆ eVertOrient

sal_Int16 SvxNumberFormat::eVertOrient
private

◆ mbIsLegal

bool SvxNumberFormat::mbIsLegal = false
private

Definition at line 155 of file numitem.hxx.

Referenced by operator=(), and operator==().

◆ meLabelFollowedBy

LabelFollowedBy SvxNumberFormat::meLabelFollowedBy
private

◆ mePositionAndSpaceMode

SvxNumPositionAndSpaceMode SvxNumberFormat::mePositionAndSpaceMode
private

◆ mnFirstLineIndent

tools::Long SvxNumberFormat::mnFirstLineIndent
private

Definition at line 141 of file numitem.hxx.

Referenced by operator=(), operator==(), SetFirstLineIndent(), Store(), and SvxNumberFormat().

◆ mnIndentAt

tools::Long SvxNumberFormat::mnIndentAt
private

Definition at line 143 of file numitem.hxx.

Referenced by operator=(), operator==(), SetIndentAt(), Store(), and SvxNumberFormat().

◆ mnListtabPos

tools::Long SvxNumberFormat::mnListtabPos
private

Definition at line 139 of file numitem.hxx.

Referenced by operator=(), operator==(), SetListtabPos(), Store(), and SvxNumberFormat().

◆ nAbsLSpace

sal_Int32 SvxNumberFormat::nAbsLSpace
private

Definition at line 132 of file numitem.hxx.

Referenced by GetAbsLSpace(), operator=(), operator==(), Store(), and SvxNumberFormat().

◆ nBulletColor

Color SvxNumberFormat::nBulletColor
private

Definition at line 118 of file numitem.hxx.

Referenced by operator=(), operator==(), Store(), and SvxNumberFormat().

◆ nBulletRelSize

sal_uInt16 SvxNumberFormat::nBulletRelSize
private

Definition at line 117 of file numitem.hxx.

Referenced by operator=(), operator==(), Store(), and SvxNumberFormat().

◆ nCharTextDistance

short SvxNumberFormat::nCharTextDistance
private

Definition at line 133 of file numitem.hxx.

Referenced by GetCharTextDistance(), operator=(), operator==(), Store(), and SvxNumberFormat().

◆ nFirstLineOffset

sal_Int32 SvxNumberFormat::nFirstLineOffset
private

Definition at line 131 of file numitem.hxx.

Referenced by GetFirstLineOffset(), operator=(), operator==(), Store(), and SvxNumberFormat().

◆ nInclUpperLevels

sal_uInt8 SvxNumberFormat::nInclUpperLevels
private

Definition at line 113 of file numitem.hxx.

Referenced by operator=(), operator==(), SetListFormat(), Store(), and SvxNumberFormat().

◆ nStart

sal_uInt16 SvxNumberFormat::nStart
private

Definition at line 114 of file numitem.hxx.

Referenced by operator=(), operator==(), Store(), and SvxNumberFormat().

◆ pBulletFont

std::optional<vcl::Font> SvxNumberFormat::pBulletFont
private

Definition at line 151 of file numitem.hxx.

Referenced by operator=(), operator==(), SetBulletFont(), Store(), and SvxNumberFormat().

◆ pGraphicBrush

std::unique_ptr<SvxBrushItem> SvxNumberFormat::pGraphicBrush
private

Definition at line 146 of file numitem.hxx.

Referenced by operator=(), operator==(), SetGraphic(), SetGraphicBrush(), Store(), and SvxNumberFormat().

◆ sCharStyleName

OUString SvxNumberFormat::sCharStyleName
private

Definition at line 153 of file numitem.hxx.

Referenced by GetCharFormatName(), operator=(), operator==(), Store(), and SvxNumberFormat().

◆ sListFormat

std::optional<OUString> SvxNumberFormat::sListFormat
private

Definition at line 107 of file numitem.hxx.

Referenced by GetListFormat(), operator=(), operator==(), SetListFormat(), SetPrefix(), and SetSuffix().

◆ sPrefix

OUString SvxNumberFormat::sPrefix
private

◆ sSuffix

OUString SvxNumberFormat::sSuffix
private

The documentation for this class was generated from the following files: