xlnt
Classes | Public Member Functions | Static Public Member Functions | List of all members
xlnt::border Class Reference

Describes the border style of a particular cell. More...

#include <border.hpp>

Classes

class  border_property
 Each side of a cell can have a border_property applied to it to change how it is displayed. More...
 

Public Member Functions

 border ()
 Constructs a default border. More...
 
optional< border_propertyside (border_side s) const
 Returns the border properties of the given side. More...
 
borderside (border_side s, const border_property &prop)
 Sets the border properties of the side s to prop. More...
 
optional< diagonal_directiondiagonal () const
 Returns the diagonal direction of this border. More...
 
borderdiagonal (diagonal_direction dir)
 Sets the diagonal direction of this border to dir. More...
 
bool operator== (const border &right) const
 Returns true if left is exactly equal to right. More...
 
bool operator!= (const border &right) const
 Returns true if left is not exactly equal to right. More...
 

Static Public Member Functions

static const std::vector< border_side > & all_sides ()
 Returns a vector containing all of the border sides to be used for iteration. More...
 

Detailed Description

Describes the border style of a particular cell.

Constructor & Destructor Documentation

◆ border()

xlnt::border::border ( )

Constructs a default border.

Member Function Documentation

◆ all_sides()

static const std::vector<border_side>& xlnt::border::all_sides ( )
static

Returns a vector containing all of the border sides to be used for iteration.

◆ diagonal() [1/2]

optional<diagonal_direction> xlnt::border::diagonal ( ) const

Returns the diagonal direction of this border.

◆ diagonal() [2/2]

border& xlnt::border::diagonal ( diagonal_direction  dir)

Sets the diagonal direction of this border to dir.

◆ operator!=()

bool xlnt::border::operator!= ( const border right) const

Returns true if left is not exactly equal to right.

◆ operator==()

bool xlnt::border::operator== ( const border right) const

Returns true if left is exactly equal to right.

◆ side() [1/2]

optional<border_property> xlnt::border::side ( border_side  s) const

Returns the border properties of the given side.

◆ side() [2/2]

border& xlnt::border::side ( border_side  s,
const border_property prop 
)

Sets the border properties of the side s to prop.


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