Describes a conditional format that will be applied to all cells in the associated range that satisfy the condition. This can only be constructed using methods on worksheet or range. More...

#include <conditional_format.hpp>

Public Member Functions
	conditional_format ()=delete
	Delete zero-argument constructor More...

	conditional_format (const conditional_format &other)=default
	Default copy constructor. Constructs a format using the same PIMPL as other. More...

bool	has_border () const
	Returns true if a border has been set for this conditional format. More...

class border	border () const
	Returns a copy of the border of this conditional format. If no border has been set (has_border() returns false), a default-constructed border will be returned. More...

conditional_format	border (const xlnt::border &new_border)
	Sets the border of this conditional format to new_border. Returns a wrapper pointing to this conditional format. More...

bool	has_fill () const
	Returns true if a fill has been set for this conditional format. More...

class fill	fill () const
	Returns a copy of the fill of this conditional format. If no fill has been set (has_fill() returns false), a default-constructed fill will be returned. More...

conditional_format	fill (const xlnt::fill &new_fill)
	Sets the fill of this conditional format to new_fill. Returns a wrapper pointing to this conditional format. More...

bool	has_font () const
	Returns true if a font has been set for this conditional format. More...

class font	font () const
	Returns a copy of the font of this conditional format. If no font has been set (has_font() returns false), a default-constructed font will be returned. More...

conditional_format	font (const xlnt::font &new_font)
	Sets the font of this conditional format to new_font. Returns a wrapper pointing to this conditional format. More...

bool	operator== (const conditional_format &other) const
	Returns true if this format is equivalent to other. More...

bool	operator!= (const conditional_format &other) const
	Returns true if this format is not equivalent to other. More...

Friends
struct	detail::stylesheet

class	detail::xlsx_consumer

Detailed Description

Describes a conditional format that will be applied to all cells in the associated range that satisfy the condition. This can only be constructed using methods on worksheet or range.

Constructor & Destructor Documentation

◆ conditional_format() [1/2]

xlnt::conditional_format::conditional_format ( )

delete

Delete zero-argument constructor

◆ conditional_format() [2/2]

xlnt::conditional_format::conditional_format ( const conditional_format & other )

default

Default copy constructor. Constructs a format using the same PIMPL as other.

Member Function Documentation

◆ border() [1/2]

class border xlnt::conditional_format::border ( ) const

Returns a copy of the border of this conditional format. If no border has been set (has_border() returns false), a default-constructed border will be returned.

◆ border() [2/2]

conditional_format xlnt::conditional_format::border ( const xlnt::border & new_border )

Sets the border of this conditional format to new_border. Returns a wrapper pointing to this conditional format.

◆ fill() [1/2]

class fill xlnt::conditional_format::fill ( ) const

Returns a copy of the fill of this conditional format. If no fill has been set (has_fill() returns false), a default-constructed fill will be returned.

◆ fill() [2/2]

conditional_format xlnt::conditional_format::fill ( const xlnt::fill & new_fill )

Sets the fill of this conditional format to new_fill. Returns a wrapper pointing to this conditional format.

◆ font() [1/2]

class font xlnt::conditional_format::font ( ) const

Returns a copy of the font of this conditional format. If no font has been set (has_font() returns false), a default-constructed font will be returned.

◆ font() [2/2]

conditional_format xlnt::conditional_format::font ( const xlnt::font & new_font )

Sets the font of this conditional format to new_font. Returns a wrapper pointing to this conditional format.

◆ has_border()

bool xlnt::conditional_format::has_border ( ) const

Returns true if a border has been set for this conditional format.

◆ has_fill()

bool xlnt::conditional_format::has_fill ( ) const

Returns true if a fill has been set for this conditional format.

◆ has_font()

bool xlnt::conditional_format::has_font ( ) const

Returns true if a font has been set for this conditional format.

◆ operator!=()

bool xlnt::conditional_format::operator!= ( const conditional_format & other ) const

Returns true if this format is not equivalent to other.

◆ operator==()

bool xlnt::conditional_format::operator== ( const conditional_format & other ) const

Returns true if this format is equivalent to other.

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

xlnt/styles/conditional_format.hpp

Public Member Functions

Friends