1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
//!
//! This module contains the [`Format`] struct, which used to edit the style of the [`Cell`],
//! also defines some methods for working with [`Format`].
//!
pub use align::{FormatAlignType, FormatAlign};
pub use border::{FormatBorder, FormatBorderElement, FormatBorderType};
pub use color::FormatColor;
pub use fill::FormatFill;
pub use font::FormatFont;
use crate::Cell;
mod align;
mod color;
mod fill;
mod font;
mod border;
///
/// [`Format`] struct, which used to edit the style of the [`Cell`].
/// # Fields
/// | field | type | meaning |
/// | ------------ | ----------- | ------------------------------------------------------------ |
/// | `font` | [`FormatFont`] | The [`Cell`]'s font formats |
/// | `border` | [`FormatBorder`] | The [`Cell`]'s border formats |
/// | `fill` | [`FormatFill`] | The [`Cell`]'s fill(background) formats |
/// | `align` | [`FormatAlign`] | The [`Cell`]'s align formats |
#[derive(Default, Clone, Debug, PartialEq)]
pub struct Format {
pub font: FormatFont,
pub border: FormatBorder,
pub fill: FormatFill,
pub align: FormatAlign,
}
impl Format {
/// Checks whether the font is bold, learn more about it in [`FormatFont`].
///
/// ## Returns
///
/// Returns `true` if the font is bold, `false` otherwise.
pub fn is_bold(&self) -> bool {
self.font.bold
}
/// Checks whether the font is italic, learn more about it in [`FormatFont`].
///
/// ## Returns
///
/// Returns `true` if the font is italic, `false` otherwise.
pub fn is_italic(&self) -> bool {
self.font.italic
}
/// Checks whether the font is underline, learn more about it in [`FormatFont`].
///
/// ## Returns
///
/// Returns `true` if the font is underline, `false` otherwise.
pub fn is_underline(&self) -> bool {
self.font.underline
}
/// Retrieves the size of the font, learn more about it in [`FormatFont`].
///
/// ## Returns
///
/// Returns the pounds of the font size.
pub fn get_size(&self) -> f64 {
self.font.size
}
/// Retrieves the background(fill) of the cell.
///
/// ## Returns
///
/// Returns the [`FormatFill`] of the cell.
pub fn get_background(&self) -> &FormatFill {
&self.fill
}
/// Retrieves the borders of the cell, learn more about it in [`FormatBorder`].
///
/// ## Returns
///
/// Returns the [`FormatBorder`] of the cell.
pub fn get_borders(&self) -> &FormatBorder {
&self.border
}
/// Retrieves the color of the font, learn more about it in [`FormatFont`].
///
/// ## Returns
///
/// Returns the [`FormatColor`] of the font.
pub fn get_color(&self) -> &FormatColor {
&self.font.color
}
/// Retrieves the name of the font, learn more about it in [`FormatFont`].
///
/// ## Returns
///
/// Returns the name of the font.
pub fn get_font(&self) -> &str {
&self.font.name
}
/// Retrieves the color of the cell's background.
///
/// ## Returns
///
/// Returns the [`FormatColor`] of the cell's background.
pub fn get_background_color(&self) -> &FormatColor {
&self.fill.fg_color
}
/// Retrieves the left border of the cell, learn more about it in [`FormatBorder`].
///
/// ## Returns
///
/// Returns the [`FormatBorderElement`] of the cell's left border.
pub fn get_border_left(&self) -> &FormatBorderElement {
&self.border.left
}
/// Retrieves the right border of the cell, learn more about it in [`FormatBorder`].
///
/// ## Returns
///
/// Returns the [`FormatBorderElement`] of the cell's right border.
pub fn get_border_right(&self) -> &FormatBorderElement {
&self.border.right
}
/// Retrieves the top border of the cell, learn more about it in [`FormatBorder`].
///
/// ## Returns
///
/// Returns the [`FormatBorderElement`] of the cell's top border.
pub fn get_border_top(&self) -> &FormatBorderElement {
&self.border.top
}
/// Retrieves the bottom border of the cell, learn more about it in [`FormatBorder`].
///
/// ## Returns
///
/// Returns the [`FormatBorderElement`] of the cell's bottom border.
pub fn get_border_bottom(&self) -> &FormatBorderElement {
&self.border.bottom
}
}
impl Format {
/// Set the font to bold, learn more about it in [`FormatFont`].
///
/// ## Returns
///
/// Returns the modified format with font bold set to true.
pub fn set_bold(mut self) -> Self {
self.font.bold = true;
self
}
/// Set the font to italic, learn more about it in [`FormatFont`].
///
/// ## Returns
///
/// Returns the modified format with font italic set to true.
pub fn set_italic(mut self) -> Self {
self.font.italic = true;
self
}
/// Add an underline for the font, learn more about it in [`FormatFont`].
///
/// ## Returns
///
/// Returns the modified format with font underline set to true.
pub fn set_underline(mut self) -> Self {
self.font.underline = true;
self
}
/// Set the size of the font, learn more about it in [`FormatFont`].
///
/// ## Arguments
///
/// | arg | type | meaning |
/// |----------|------|-----------------------------------------------|
/// | size | u8 | The new size of the font. |
///
/// ## Returns
///
/// Returns the modified Format with the size set to the provided value.
pub fn set_size(mut self, size: u8) -> Self {
self.font.size = size as f64;
self
}
/// Set the size of the font, learn more about it in [`FormatFont`].
///
/// ## Arguments
///
/// | arg | type | meaning |
/// |----------|------|-----------------------------------------------|
/// | size | f64 | The new size of the font. |
///
/// ## Returns
///
/// Returns the modified Format with the size set to the provided value.
pub fn set_size_f64(mut self, size: f64) -> Self {
self.font.size = size;
self
}
/// Set the color of the font, learn more about it in [`FormatFont`].
///
/// ## Arguments
///
/// | arg | type | meaning |
/// |----------|------|-----------------------------------------------|
/// | format_color | [`FormatColor`] | The new color of the font. |
///
/// ## Returns
///
/// Returns the modified Format with the color set to the provided value.
pub fn set_color(mut self, format_color: FormatColor) -> Self {
self.font.color = format_color;
self
}
/// Set the font name, learn more about it in [`FormatFont`].
///
/// ## Arguments
///
/// | arg | type | meaning |
/// |----------|------|-----------------------------------------------|
/// | size | &str | The new font name. |
///
/// ## Returns
///
/// Returns the modified Format with the name set to the provided value.
pub fn set_font(mut self, font_name: &str) -> Self {
self.font.name = font_name.to_string();
self
}
/// Set all borders of the format, learn more about it in [`FormatBorder`].
///
/// ## Arguments
///
/// | arg | type | meaning |
/// |---------------------|-----------------------|-----------------------------------------------|
/// | format_border_type | [`FormatBorderType`] | The type of border to apply to borders of the format. |
///
/// ## Returns
///
/// Returns the modified Format with borders of the format set to the provided type.
pub fn set_border(mut self, format_border_type: FormatBorderType) -> Self {
let mut format_border = FormatBorderElement::default();
format_border.border_type = format_border_type;
self.border.left = format_border.clone();
self.border.right = format_border.clone();
self.border.top = format_border.clone();
self.border.bottom = format_border.clone();
self.border.diagonal = format_border;
self
}
/// Set the left border of the format, learn more about it in [`FormatBorder`].
///
/// ## Arguments
///
/// | arg | type | meaning |
/// |---------------------|-----------------------|-----------------------------------------------|
/// | format_border_type | [`FormatBorderType`] | The type of border to apply to the left side of the format. |
///
/// ## Returns
///
/// Returns the modified Format with the left border of the format set to the provided type.
pub fn set_border_left(mut self, format_border_type: FormatBorderType) -> Self {
let mut format_border = FormatBorderElement::default();
format_border.border_type = format_border_type;
self.border.left = format_border;
self
}
/// Set the right border of the format, learn more about it in [`FormatBorder`].
///
/// ## Arguments
///
/// | arg | type | meaning |
/// |---------------------|-----------------------|-----------------------------------------------|
/// | format_border_type | [`FormatBorderType`] | The type of border to apply to the right side of the format. |
///
/// ## Returns
///
/// Returns the modified Format with the right border of the format set to the provided type.
pub fn set_border_right(mut self, format_border_type: FormatBorderType) -> Self {
let mut format_border = FormatBorderElement::default();
format_border.border_type = format_border_type;
self.border.right = format_border;
self
}
/// Set the top border of the format, learn more about it in [`FormatBorder`].
///
/// ## Arguments
///
/// | arg | type | meaning |
/// |---------------------|-----------------------|-----------------------------------------------|
/// | format_border_type | [`FormatBorderType`] | The type of border to apply to the top side of the format. |
///
/// ## Returns
///
/// Returns the modified Format with the top border of the format set to the provided type.
pub fn set_border_top(mut self, format_border_type: FormatBorderType) -> Self {
let mut format_border = FormatBorderElement::default();
format_border.border_type = format_border_type;
self.border.top = format_border;
self
}
/// Set the bottom border of the format, learn more about it in [`FormatBorder`].
///
/// ## Arguments
///
/// | arg | type | meaning |
/// |---------------------|-----------------------|-----------------------------------------------|
/// | format_border_type | [`FormatBorderType`] | The type of border to apply to the bottom side of the format. |
///
/// ## Returns
///
/// Returns the modified Format with the bottom border of the format set to the provided type.
pub fn set_border_bottom(mut self, format_border_type: FormatBorderType) -> Self {
let mut format_border = FormatBorderElement::default();
format_border.border_type = format_border_type;
self.border.bottom = format_border;
self
}
/// Set the background color of the format.
///
/// ## Arguments
///
/// | arg | type | meaning |
/// |----------------|--------------|-----------------------------------------------|
/// | format_color | [`FormatColor`] | The color to set as the background of the format. |
///
/// ## Returns
///
/// Returns the modified Format with the background color of the format set to the provided color.
pub fn set_background_color(mut self, format_color: FormatColor) -> Self {
self.fill.pattern_type = "solid".to_string();
self.fill.fg_color = format_color;
self
}
/// Set the alignment of the format, learn more about it in [`FormatAlign`].
///
/// ## Arguments
///
/// | arg | type | meaning |
/// |----------------------|-----------------------|-----------------------------------------------|
/// | format_align_type | [`FormatAlignType`] | The type of alignment to apply to the format. |
///
/// ## Returns
///
/// Returns the modified Format with the alignment of the format set to the provided type.
pub fn set_align(mut self, format_align_type: FormatAlignType) -> Self {
match format_align_type {
FormatAlignType::Left | FormatAlignType::Center | FormatAlignType::Right =>
self.align.horizontal = Some(format_align_type),
FormatAlignType::Top | FormatAlignType::VerticalCenter | FormatAlignType::Bottom =>
self.align.vertical = Some(format_align_type),
}
self
}
/// Set the indent of the text alignment, learn more about it in [`FormatAlign`].
///
/// ## Arguments
///
/// | arg | type | meaning |
/// |----------|------|-----------------------------------------------|
/// | indent | u8 | The new reading order of the text alignment. |
///
/// ## Returns
///
/// Returns the modified Format with the reading order of the text alignment set to the provided value.
pub fn set_reading_order(mut self, reading_order: u8) -> Self {
self.align.reading_order = reading_order;
self
}
/// Set the indent of the text alignment, learn more about it in [`FormatAlign`].
///
/// ## Arguments
///
/// | arg | type | meaning |
/// |----------|------|-----------------------------------------------|
/// | indent | u8 | The new indent of the text alignment. |
///
/// ## Returns
///
/// Returns the modified Format with the indent of the text alignment set to the provided value.
pub fn set_indent(mut self, indent: u8) -> Self {
self.align.indent = indent;
self
}
}