WPSBorder Struct Reference

a border list More...

#include <libwps_internal.h>

Public Types

enum  Style {
  None , Simple , Dot , LargeDot ,
  Dash
}
 the line style More...
 
enum  Type { Single , Double , Triple }
 the line repetition More...
 
enum  Pos { Left = 0 , Right = 1 , Top = 2 , Bottom = 3 }
 
enum  { LeftBit = 0x01 , RightBit = 0x02 , TopBit =0x4 , BottomBit = 0x08 }
 

Public Member Functions

 WPSBorder ()
 constructor
 
 WPSBorder (WPSBorder const &)=default
 
 WPSBorder (WPSBorder &&)=default
 
WPSBorderoperator= (WPSBorder const &)=default
 
WPSBorderoperator= (WPSBorder &&)=default
 
bool addTo (librevenge::RVNGPropertyList &propList, std::string which="") const
 add the border property to proplist (if needed )
 
bool isEmpty () const
 returns true if the border is empty
 
bool operator== (WPSBorder const &orig) const
 operator==
 
bool operator!= (WPSBorder const &orig) const
 operator!=
 
int compare (WPSBorder const &orig) const
 compare two cell
 

Public Attributes

Style m_style
 the border style
 
Type m_type
 the border repetition
 
int m_width
 the border width
 
std::vector< double > m_widthsList
 the different length used for each line/sep (if defined)
 
WPSColor m_color
 the border color
 
std::string m_extra
 extra data ( if needed)
 

Friends

std::ostream & operator<< (std::ostream &o, WPSBorder const &border)
 operator<<
 
std::ostream & operator<< (std::ostream &o, WPSBorder::Style const &style)
 operator<<: prints data in form "none|dot|..."
 

Detailed Description

a border list

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
LeftBit 
RightBit 
TopBit 
BottomBit 

◆ Pos

Enumerator
Left 
Right 
Top 
Bottom 

◆ Style

the line style

Enumerator
None 
Simple 
Dot 
LargeDot 
Dash 

◆ Type

the line repetition

Enumerator
Single 
Double 
Triple 

Constructor & Destructor Documentation

◆ WPSBorder() [1/3]

WPSBorder::WPSBorder ( )
inline

constructor

◆ WPSBorder() [2/3]

WPSBorder::WPSBorder ( WPSBorder const &  )
default

◆ WPSBorder() [3/3]

WPSBorder::WPSBorder ( WPSBorder &&  )
default

Member Function Documentation

◆ addTo()

bool WPSBorder::addTo ( librevenge::RVNGPropertyList &  propList,
std::string  which = "" 
) const

add the border property to proplist (if needed )

\note if set which must be equal to "left", "top", ... 

Referenced by WPSParagraph::addTo().

◆ compare()

int WPSBorder::compare ( WPSBorder const &  orig) const

compare two cell

◆ isEmpty()

bool WPSBorder::isEmpty ( ) const
inline

returns true if the border is empty

◆ operator!=()

bool WPSBorder::operator!= ( WPSBorder const &  orig) const
inline

operator!=

◆ operator=() [1/2]

WPSBorder & WPSBorder::operator= ( WPSBorder &&  )
default

◆ operator=() [2/2]

WPSBorder & WPSBorder::operator= ( WPSBorder const &  )
default

◆ operator==()

bool WPSBorder::operator== ( WPSBorder const &  orig) const
inline

operator==

Referenced by operator!=().

Friends And Related Symbol Documentation

◆ operator<< [1/2]

std::ostream & operator<< ( std::ostream &  o,
WPSBorder const &  border 
)
friend

operator<<

◆ operator<< [2/2]

std::ostream & operator<< ( std::ostream &  o,
WPSBorder::Style const &  style 
)
friend

operator<<: prints data in form "none|dot|..."

Member Data Documentation

◆ m_color

◆ m_extra

std::string WPSBorder::m_extra

extra data ( if needed)

◆ m_style

◆ m_type

◆ m_width

◆ m_widthsList

std::vector<double> WPSBorder::m_widthsList

the different length used for each line/sep (if defined)

\note when defined, the size of this list must be equal to 2*Type-1

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


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

Generated on Thu Jul 20 2023 00:00:00 for libwps by doxygen 1.9.7