umya_spreadsheet/structs/
sheet_view.rs

1// sheetView
2use super::BooleanValue;
3use super::EnumValue;
4use super::Pane;
5use super::Selection;
6use super::SheetViewValues;
7use super::StringValue;
8use super::UInt32Value;
9use crate::reader::driver::*;
10use crate::writer::driver::*;
11use quick_xml::events::{BytesStart, Event};
12use quick_xml::Reader;
13use quick_xml::Writer;
14use std::io::Cursor;
15use thin_vec::ThinVec;
16
17#[derive(Clone, Default, Debug)]
18pub struct SheetView {
19    show_grid_lines: BooleanValue,
20    tab_selected: BooleanValue,
21    workbook_view_id: UInt32Value,
22    pane: Option<Box<Pane>>,
23    view: EnumValue<SheetViewValues>,
24    zoom_scale: UInt32Value,
25    zoom_scale_normal: UInt32Value,
26    zoom_scale_page_layout_view: UInt32Value,
27    zoom_scale_sheet_layout_view: UInt32Value,
28    top_left_cell: StringValue,
29    selection: ThinVec<Selection>,
30}
31
32impl SheetView {
33    #[inline]
34    pub fn get_show_grid_lines(&self) -> &bool {
35        self.show_grid_lines.get_value()
36    }
37
38    #[inline]
39    pub fn set_show_grid_lines(&mut self, value: bool) -> &mut Self {
40        self.show_grid_lines.set_value(value);
41        self
42    }
43
44    #[inline]
45    pub fn get_tab_selected(&self) -> &bool {
46        self.tab_selected.get_value()
47    }
48
49    #[inline]
50    pub fn set_tab_selected(&mut self, value: bool) -> &mut Self {
51        self.tab_selected.set_value(value);
52        self
53    }
54
55    #[inline]
56    pub fn get_workbook_view_id(&self) -> &u32 {
57        self.workbook_view_id.get_value()
58    }
59
60    #[inline]
61    pub fn set_workbook_view_id(&mut self, value: u32) -> &mut Self {
62        self.workbook_view_id.set_value(value);
63        self
64    }
65
66    #[inline]
67    pub fn get_pane(&self) -> Option<&Pane> {
68        self.pane.as_deref()
69    }
70
71    #[inline]
72    pub fn get_pane_mut(&mut self) -> Option<&mut Pane> {
73        self.pane.as_deref_mut()
74    }
75
76    #[inline]
77    pub fn set_pane(&mut self, value: Pane) -> &mut Self {
78        self.pane = Some(Box::new(value));
79        self
80    }
81
82    #[inline]
83    pub fn get_view(&self) -> &SheetViewValues {
84        self.view.get_value()
85    }
86
87    #[inline]
88    pub fn set_view(&mut self, value: SheetViewValues) -> &mut Self {
89        self.view.set_value(value);
90        self
91    }
92
93    #[inline]
94    pub fn get_zoom_scale(&self) -> &u32 {
95        self.zoom_scale.get_value()
96    }
97
98    #[inline]
99    pub fn set_zoom_scale(&mut self, value: u32) -> &mut Self {
100        self.zoom_scale.set_value(value);
101        self
102    }
103
104    #[inline]
105    pub fn get_zoom_scale_normal(&self) -> &u32 {
106        self.zoom_scale_normal.get_value()
107    }
108
109    #[inline]
110    pub fn set_zoom_scale_normal(&mut self, value: u32) -> &mut Self {
111        self.zoom_scale_normal.set_value(value);
112        self
113    }
114
115    #[inline]
116    pub fn get_zoom_scale_page_layout_view(&self) -> &u32 {
117        self.zoom_scale_page_layout_view.get_value()
118    }
119
120    #[inline]
121    pub fn set_zoom_scale_page_layout_view(&mut self, value: u32) -> &mut Self {
122        self.zoom_scale_page_layout_view.set_value(value);
123        self
124    }
125
126    #[inline]
127    pub fn get_zoom_scale_sheet_layout_view(&self) -> &u32 {
128        self.zoom_scale_sheet_layout_view.get_value()
129    }
130
131    #[inline]
132    pub fn set_zoom_scale_sheet_layout_view(&mut self, value: u32) -> &mut Self {
133        self.zoom_scale_sheet_layout_view.set_value(value);
134        self
135    }
136
137    #[inline]
138    pub fn get_top_left_cell(&self) -> &str {
139        self.top_left_cell.get_value_str()
140    }
141
142    #[inline]
143    pub fn set_top_left_cell<S: Into<String>>(&mut self, value: S) -> &mut Self {
144        self.top_left_cell.set_value(value);
145        self
146    }
147
148    #[inline]
149    pub fn get_selection(&self) -> &[Selection] {
150        &self.selection
151    }
152
153    #[inline]
154    pub fn get_selection_mut(&mut self) -> &mut ThinVec<Selection> {
155        &mut self.selection
156    }
157
158    #[inline]
159    pub fn set_selection(&mut self, value: Selection) -> &mut Self {
160        self.selection.push(value);
161        self
162    }
163
164    pub(crate) fn set_attributes<R: std::io::BufRead>(
165        &mut self,
166        reader: &mut Reader<R>,
167        e: &BytesStart,
168        empty_flag: bool,
169    ) {
170        set_string_from_xml!(self, e, show_grid_lines, "showGridLines");
171        set_string_from_xml!(self, e, tab_selected, "tabSelected");
172        set_string_from_xml!(self, e, workbook_view_id, "workbookViewId");
173        set_string_from_xml!(self, e, view, "view");
174        set_string_from_xml!(self, e, zoom_scale, "zoomScale");
175        set_string_from_xml!(self, e, zoom_scale_normal, "zoomScaleNormal");
176        set_string_from_xml!(
177            self,
178            e,
179            zoom_scale_page_layout_view,
180            "zoomScalePageLayoutView"
181        );
182        set_string_from_xml!(
183            self,
184            e,
185            zoom_scale_sheet_layout_view,
186            "zoomScaleSheetLayoutView"
187        );
188        set_string_from_xml!(self, e, top_left_cell, "topLeftCell");
189
190        if empty_flag {
191            return;
192        }
193
194        xml_read_loop!(
195            reader,
196            Event::Empty(ref e) => {
197                match e.name().into_inner() {
198                    b"pane" => {
199                        let mut obj = Pane::default();
200                        obj.set_attributes(reader, e);
201                        self.set_pane(obj);
202                    }
203                    b"selection" => {
204                        let mut obj = Selection::default();
205                        obj.set_attributes(reader, e);
206                        self.set_selection(obj);
207                    }
208                    _ => (),
209                }
210            },
211            Event::End(ref e) => {
212                if e.name().into_inner() == b"sheetView" {
213                    return
214                }
215            },
216            Event::Eof => panic!("Error: Could not find {} end element", "sheetView")
217        );
218    }
219
220    pub(crate) fn write_to(&self, writer: &mut Writer<Cursor<Vec<u8>>>) {
221        let empty_flag = self.pane.is_none() && self.selection.is_empty();
222
223        // sheetView
224        let mut attributes: Vec<(&str, &str)> = Vec::new();
225        if self.show_grid_lines.has_value() {
226            attributes.push(("showGridLines", self.show_grid_lines.get_value_string()));
227        }
228        if *self.tab_selected.get_value() {
229            attributes.push(("tabSelected", self.tab_selected.get_value_string()));
230        }
231        if self.view.has_value() {
232            attributes.push(("view", self.view.get_value_string()));
233        }
234        let zoom_scale = self.zoom_scale.get_value_string();
235        if self.zoom_scale.has_value() {
236            attributes.push(("zoomScale", &zoom_scale));
237        }
238        let zoom_scale_normal = self.zoom_scale_normal.get_value_string();
239        if self.zoom_scale_normal.has_value() {
240            attributes.push(("zoomScaleNormal", &zoom_scale_normal));
241        }
242        let zoom_scale_page_layout_view = self.zoom_scale_page_layout_view.get_value_string();
243        if self.zoom_scale_page_layout_view.has_value() {
244            attributes.push(("zoomScalePageLayoutView", &zoom_scale_page_layout_view));
245        }
246        let zoom_scale_sheet_layout_view = self.zoom_scale_sheet_layout_view.get_value_string();
247        if self.zoom_scale_sheet_layout_view.has_value() {
248            attributes.push(("zoomScaleSheetLayoutView", &zoom_scale_sheet_layout_view));
249        }
250        let top_left_cell = self.top_left_cell.get_value_str();
251        if self.top_left_cell.has_value() {
252            attributes.push(("topLeftCell", &top_left_cell));
253        }
254        let workbook_view_id = self.workbook_view_id.get_value_string();
255        attributes.push(("workbookViewId", &workbook_view_id));
256
257        write_start_tag(writer, "sheetView", attributes, empty_flag);
258
259        if empty_flag {
260            return;
261        }
262        // pane
263        if let Some(v) = &self.pane {
264            v.write_to(writer)
265        }
266        // selection
267        for obj in &self.selection {
268            obj.write_to(writer);
269        }
270        write_end_tag(writer, "sheetView");
271    }
272}
umya_spreadsheet/structs/sheet_view.rs

umya_spreadsheet/structs/
sheet_view.rs
