xlnt
Public Member Functions | List of all members
xlnt::pattern_fill Class Reference

Represents a fill which colors the cell based on a foreground and background color and a pattern. More...

#include <fill.hpp>

Public Member Functions

 pattern_fill ()
 Constructs a default pattern fill with a none pattern and no colors. More...
 
pattern_fill_type type () const
 Returns the pattern used by this fill More...
 
pattern_filltype (pattern_fill_type new_type)
 Sets the pattern of this fill and returns a reference to it. More...
 
optional< colorforeground () const
 Returns the optional foreground color of this fill More...
 
pattern_fillforeground (const color &foreground)
 Sets the foreground color and returns a reference to this pattern. More...
 
optional< colorbackground () const
 Returns the optional background color of this fill More...
 
pattern_fillbackground (const color &background)
 Sets the foreground color and returns a reference to this pattern. More...
 
bool operator== (const pattern_fill &other) const
 Returns true if this pattern fill is equivalent to other. More...
 
bool operator!= (const pattern_fill &other) const
 Returns true if this pattern fill is not equivalent to other. More...
 

Detailed Description

Represents a fill which colors the cell based on a foreground and background color and a pattern.

Constructor & Destructor Documentation

◆ pattern_fill()

xlnt::pattern_fill::pattern_fill ( )

Constructs a default pattern fill with a none pattern and no colors.

Member Function Documentation

◆ background() [1/2]

optional<color> xlnt::pattern_fill::background ( ) const

Returns the optional background color of this fill

◆ background() [2/2]

pattern_fill& xlnt::pattern_fill::background ( const color background)

Sets the foreground color and returns a reference to this pattern.

◆ foreground() [1/2]

optional<color> xlnt::pattern_fill::foreground ( ) const

Returns the optional foreground color of this fill

◆ foreground() [2/2]

pattern_fill& xlnt::pattern_fill::foreground ( const color foreground)

Sets the foreground color and returns a reference to this pattern.

◆ operator!=()

bool xlnt::pattern_fill::operator!= ( const pattern_fill other) const

Returns true if this pattern fill is not equivalent to other.

◆ operator==()

bool xlnt::pattern_fill::operator== ( const pattern_fill other) const

Returns true if this pattern fill is equivalent to other.

◆ type() [1/2]

pattern_fill_type xlnt::pattern_fill::type ( ) const

Returns the pattern used by this fill

◆ type() [2/2]

pattern_fill& xlnt::pattern_fill::type ( pattern_fill_type  new_type)

Sets the pattern of this fill and returns a reference to it.


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