umya-spreadsheet 3.0.0

umya-spreadsheet is a library written in pure Rust to read and write xlsx file.
Documentation 
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

use std::io::Cursor;

use quick_xml::{
    Reader,
    Writer,
    events::BytesStart,
};

use super::{
    Coordinate,
    DoubleValue,
    EnumValue,
    PaneStateValues,
    PaneValues,
};
use crate::{
    reader::driver::{
        get_attribute,
        set_string_from_xml,
    },
    writer::driver::write_start_tag,
};

#[derive(Clone, Default, Debug)]
pub struct Pane {
    horizontal_split: DoubleValue,
    vertical_split:   DoubleValue,
    top_left_cell:    Coordinate,
    active_pane:      EnumValue<PaneValues>,
    state:            EnumValue<PaneStateValues>,
}

impl Pane {
    #[inline]
    #[must_use]
    pub fn horizontal_split(&self) -> f64 {
        self.horizontal_split.value()
    }

    #[inline]
    #[must_use]
    #[deprecated(since = "3.0.0", note = "Use horizontal_split()")]
    pub fn get_horizontal_split(&self) -> f64 {
        self.horizontal_split()
    }

    #[inline]
    pub fn set_horizontal_split(&mut self, value: f64) -> &mut Self {
        self.horizontal_split.set_value(value);
        self
    }

    #[inline]
    #[must_use]
    pub fn vertical_split(&self) -> f64 {
        self.vertical_split.value()
    }

    #[inline]
    #[must_use]
    #[deprecated(since = "3.0.0", note = "Use vertical_split()")]
    pub fn get_vertical_split(&self) -> f64 {
        self.vertical_split()
    }

    #[inline]
    pub fn set_vertical_split(&mut self, value: f64) -> &mut Self {
        self.vertical_split.set_value(value);
        self
    }

    #[inline]
    #[must_use]
    pub fn top_left_cell(&self) -> &Coordinate {
        &self.top_left_cell
    }

    #[inline]
    #[must_use]
    #[deprecated(since = "3.0.0", note = "Use top_left_cell()")]
    pub fn get_top_left_cell(&self) -> &Coordinate {
        self.top_left_cell()
    }

    #[inline]
    pub fn top_left_cell_mut(&mut self) -> &mut Coordinate {
        &mut self.top_left_cell
    }

    #[inline]
    #[deprecated(since = "3.0.0", note = "Use top_left_cell_mut()")]
    pub fn get_top_left_cell_mut(&mut self) -> &mut Coordinate {
        self.top_left_cell_mut()
    }

    #[inline]
    pub fn set_top_left_cell(&mut self, value: Coordinate) -> &mut Self {
        self.top_left_cell = value;
        self
    }

    #[inline]
    #[must_use]
    pub fn active_pane(&self) -> &PaneValues {
        self.active_pane.value()
    }

    #[inline]
    #[must_use]
    #[deprecated(since = "3.0.0", note = "Use active_pane()")]
    pub fn get_active_pane(&self) -> &PaneValues {
        self.active_pane()
    }

    #[inline]
    pub fn set_active_pane(&mut self, value: PaneValues) -> &mut Self {
        self.active_pane.set_value(value);
        self
    }

    #[inline]
    #[must_use]
    pub fn state(&self) -> &PaneStateValues {
        self.state.value()
    }

    #[inline]
    #[must_use]
    #[deprecated(since = "3.0.0", note = "Use state()")]
    pub fn get_state(&self) -> &PaneStateValues {
        self.state()
    }

    #[inline]
    pub fn set_state(&mut self, value: PaneStateValues) -> &mut Self {
        self.state.set_value(value);
        self
    }

    pub(crate) fn set_attributes<R: std::io::BufRead>(
        &mut self,
        _reader: &mut Reader<R>,
        e: &BytesStart,
    ) {
        set_string_from_xml!(self, e, horizontal_split, "xSplit");
        set_string_from_xml!(self, e, vertical_split, "ySplit");
        set_string_from_xml!(self, e, active_pane, "activePane");
        set_string_from_xml!(self, e, state, "state");

        if let Some(v) = get_attribute(e, b"topLeftCell") {
            self.top_left_cell.set_coordinate(v);
        }
    }

    pub(crate) fn write_to(&self, writer: &mut Writer<Cursor<Vec<u8>>>) {
        // pane
        let mut attributes: crate::structs::AttrCollection = Vec::new();
        let coordinate = self.top_left_cell.to_string();
        let horizontal_split = self.horizontal_split.value_string();
        if self.horizontal_split.has_value() {
            attributes.push(("xSplit", &horizontal_split).into());
        }
        let vertical_split = self.vertical_split.value_string();
        if self.vertical_split.has_value() {
            attributes.push(("ySplit", &vertical_split).into());
        }
        attributes.push(("topLeftCell", &coordinate).into());
        attributes.push(("activePane", self.active_pane.value_string()).into());
        attributes.push(("state", self.state.value_string()).into());
        write_start_tag(writer, "pane", attributes, true);
    }
}