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

use std::io::Cursor;

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

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

#[derive(Clone, Default, Debug)]
pub struct Selection {
    pane:                   EnumValue<PaneValues>,
    active_cell:            Option<Coordinate>,
    sequence_of_references: SequenceOfReferences,
}

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

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

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

    #[inline]
    #[must_use]
    pub fn active_cell(&self) -> Option<&Coordinate> {
        self.active_cell.as_ref()
    }

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

    #[inline]
    pub fn active_cell_mut(&mut self) -> Option<&mut Coordinate> {
        self.active_cell.as_mut()
    }

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

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

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

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

    #[inline]
    pub fn sequence_of_references_mut(&mut self) -> &mut SequenceOfReferences {
        &mut self.sequence_of_references
    }

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

    #[inline]
    pub fn set_sequence_of_references(&mut self, value: SequenceOfReferences) -> &mut Self {
        self.sequence_of_references = 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, pane, "pane");

        if let Some(v) = get_attribute(e, b"activeCell") {
            let mut obj = Coordinate::default();
            obj.set_coordinate(v);
            self.set_active_cell(obj);
        }

        if let Some(v) = get_attribute(e, b"sqref") {
            self.sequence_of_references.set_sqref(v);
        }
    }

    pub(crate) fn write_to(&self, writer: &mut Writer<Cursor<Vec<u8>>>) {
        // selection
        let mut attributes: crate::structs::AttrCollection = Vec::new();

        let mut active_cell_id = 0;
        if let Some(active_cell) = &self.active_cell {
            for range in self.sequence_of_references.range_collection() {
                let range_str = range.range();
                if range_str.contains(&active_cell.to_string()) {
                    break;
                }
                active_cell_id += 1;
            }
        }

        if self.pane.has_value() {
            attributes.push(("pane", self.pane.value_string()).into());
        }

        let active_cell_str = match &self.active_cell {
            Some(active_cell) => active_cell.to_string(),
            None => String::new(),
        };
        if !active_cell_str.is_empty() {
            attributes.push(("activeCell", &active_cell_str).into());
        }

        let active_cell_id_str = active_cell_id.to_string();
        if active_cell_id > 0 {
            attributes.push(("activeCellId", &active_cell_id_str).into());
        }

        let sqref = self.sequence_of_references.get_sqref();
        if !sqref.is_empty() {
            attributes.push(("sqref", &sqref).into());
        }

        write_start_tag(writer, "selection", attributes, true);
    }
}