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
use crate::style::pagestyle::PageStyleRef;
use crate::style::AnyStyleRef;
use crate::text::TextTag;
use get_size::GetSize;
use get_size_derive::GetSize;
use std::borrow::Borrow;
style_ref2!(MasterPageRef);
/// Defines the structure and content for a page.
/// Refers to a PageStyle for layout information.
/// It must be attached to a Sheet to be used.
///
/// ```
/// use spreadsheet_ods::{pt, Length, WorkBook, Sheet};
/// use spreadsheet_ods::style::{PageStyle, MasterPage, TableStyle};
/// use spreadsheet_ods::style::units::Border;
/// use spreadsheet_ods::xmltree::XmlVec;
/// use spreadsheet_ods::color::Rgb;
/// use icu_locid::locale;
///
/// let mut wb = WorkBook::new(locale!("en_US"));
///
/// let mut ps = PageStyle::new("ps1");
/// ps.set_border(pt!(0.5), Border::Groove, Rgb::new(128,128,128));
/// ps.headerstyle_mut().set_background_color(Rgb::new(92,92,92));
/// let ps_ref = wb.add_pagestyle(ps);
///
/// let mut mp1 = MasterPage::new("mp1");
/// mp1.set_pagestyle(&ps_ref);
/// mp1.header_mut().center_mut().add_text("center");
/// mp1.footer_mut().right_mut().add_text("right");
/// let mp1_ref = wb.add_masterpage(mp1);
///
/// let mut ts = TableStyle::new("ts1");
/// ts.set_master_page(&mp1_ref);
/// let ts_ref = wb.add_tablestyle(ts);
///
/// let mut sheet = Sheet::new("sheet 1");
/// sheet.set_style(&ts_ref);
/// ```
#[derive(Clone, Debug, Default, GetSize)]
pub struct MasterPage {
name: String,
display_name: String,
pagestyle: Option<PageStyleRef>,
next_style_name: Option<MasterPageRef>,
header: HeaderFooter,
header_first: HeaderFooter,
header_left: HeaderFooter,
footer: HeaderFooter,
footer_first: HeaderFooter,
footer_left: HeaderFooter,
}
impl MasterPage {
/// Empty.
pub fn new_empty() -> Self {
Self {
name: Default::default(),
display_name: Default::default(),
pagestyle: Default::default(),
next_style_name: Default::default(),
header: Default::default(),
header_first: Default::default(),
header_left: Default::default(),
footer: Default::default(),
footer_first: Default::default(),
footer_left: Default::default(),
}
}
/// New MasterPage
pub fn new<S: AsRef<str>>(name: S) -> Self {
Self {
name: name.as_ref().to_string(),
display_name: Default::default(),
pagestyle: Default::default(),
next_style_name: Default::default(),
header: Default::default(),
header_first: Default::default(),
header_left: Default::default(),
footer: Default::default(),
footer_first: Default::default(),
footer_left: Default::default(),
}
}
/// Style reference.
pub fn masterpage_ref(&self) -> MasterPageRef {
MasterPageRef::from(self.name())
}
/// Name.
pub fn set_name(&mut self, name: String) {
self.name = name;
}
/// Name.
pub fn name(&self) -> &String {
&self.name
}
/// Name.
pub fn set_display_name(&mut self, display_name: String) {
self.display_name = display_name;
}
/// Name.
pub fn display_name(&self) -> &String {
&self.display_name
}
/// Reference to a page-style.
pub fn set_pagestyle(&mut self, name: &PageStyleRef) {
self.pagestyle = Some(name.clone());
}
/// Reference to a page-style.
pub fn pagestyle(&self) -> Option<&PageStyleRef> {
self.pagestyle.as_ref()
}
/// The style:next-style-name attribute specifies the name of the master page that is used for
/// the next page if the current page is entirely filled. If the next style name is not specified, the
/// current master page is used for the next page. The value of this attribute shall be the name of a
/// <style:master-page> element.
pub fn set_next_masterpage(&mut self, master: &MasterPageRef) {
self.next_style_name = Some(master.clone());
}
///
pub fn next_masterpage(&self) -> Option<&MasterPageRef> {
self.next_style_name.as_ref()
}
/// Left side header.
pub fn set_header(&mut self, header: HeaderFooter) {
self.header = header;
}
/// Left side header.
pub fn header(&self) -> &HeaderFooter {
&self.header
}
/// Header.
pub fn header_mut(&mut self) -> &mut HeaderFooter {
&mut self.header
}
/// First page header.
pub fn set_header_first(&mut self, header: HeaderFooter) {
self.header_first = header;
}
/// First page header.
pub fn header_first(&self) -> &HeaderFooter {
&self.header_first
}
/// First page header.
pub fn header_first_mut(&mut self) -> &mut HeaderFooter {
&mut self.header_first
}
/// Left side header.
pub fn set_header_left(&mut self, header: HeaderFooter) {
self.header_left = header;
}
/// Left side header.
pub fn header_left(&self) -> &HeaderFooter {
&self.header_left
}
/// Left side header.
pub fn header_left_mut(&mut self) -> &mut HeaderFooter {
&mut self.header_left
}
/// Footer.
pub fn set_footer(&mut self, footer: HeaderFooter) {
self.footer = footer;
}
/// Footer.
pub fn footer(&self) -> &HeaderFooter {
&self.footer
}
/// Footer.
pub fn footer_mut(&mut self) -> &mut HeaderFooter {
&mut self.footer
}
/// First page footer.
pub fn set_footer_first(&mut self, footer: HeaderFooter) {
self.footer_first = footer;
}
/// First page footer.
pub fn footer_first(&self) -> &HeaderFooter {
&self.footer_first
}
/// First page footer.
pub fn footer_first_mut(&mut self) -> &mut HeaderFooter {
&mut self.footer_first
}
/// Left side footer.
pub fn set_footer_left(&mut self, footer: HeaderFooter) {
self.footer_left = footer;
}
/// Left side footer.
pub fn footer_left(&self) -> &HeaderFooter {
&self.footer_left
}
/// Left side footer.
pub fn footer_left_mut(&mut self) -> &mut HeaderFooter {
&mut self.footer_left
}
}
/// Header/Footer data.
/// Can be seen as three regions left/center/right or as one region.
/// In the first case region* contains the data, in the second it's content.
/// Each is a TextTag of parsed XML-tags.
#[derive(Clone, Debug, Default, GetSize)]
pub struct HeaderFooter {
display: bool,
region_left: Vec<TextTag>,
region_center: Vec<TextTag>,
region_right: Vec<TextTag>,
content: Vec<TextTag>,
}
impl HeaderFooter {
/// Create
pub fn new() -> Self {
Self {
display: true,
region_left: Default::default(),
region_center: Default::default(),
region_right: Default::default(),
content: Default::default(),
}
}
/// Is the header displayed. Used to deactivate left side headers.
pub fn set_display(&mut self, display: bool) {
self.display = display;
}
/// Display
pub fn display(&self) -> bool {
self.display
}
/// true if all regions of the header/footer are empty.
pub fn is_empty(&self) -> bool {
self.region_left.is_empty()
&& self.region_center.is_empty()
&& self.region_right.is_empty()
&& self.content.is_empty()
}
/// Set the content of the left region of the header.
///
/// Attention:
/// This tag must be a text:p otherwise its ignored.
pub fn set_left(&mut self, txt: Vec<TextTag>) {
self.region_left = txt;
}
/// Adds to the content of the left region of the header.
///
/// Attention:
/// This tag must be a text:p otherwise its ignored.
pub fn add_left(&mut self, txt: TextTag) {
self.region_left.push(txt);
}
/// Clear left region.
pub fn clear_left(&mut self) {
self.region_left = Vec::new();
}
/// Left region.
pub fn left(&self) -> &Vec<TextTag> {
self.region_left.as_ref()
}
/// Left region.
pub fn left_mut(&mut self) -> &mut Vec<TextTag> {
self.region_left.as_mut()
}
/// Set the content of the center region of the header.
///
/// Attention:
/// This tag must be a text:p otherwise its ignored.
pub fn set_center(&mut self, txt: Vec<TextTag>) {
self.region_center = txt;
}
/// Adds to the content of the center region of the header.
///
/// Attention:
/// This tag must be a text:p otherwise its ignored.
pub fn add_center(&mut self, txt: TextTag) {
self.region_center.push(txt);
}
/// Center region.
pub fn clear_center(&mut self) {
self.region_center = Vec::new();
}
/// Center region.
pub fn center(&self) -> &Vec<TextTag> {
self.region_center.as_ref()
}
/// Center region.
pub fn center_mut(&mut self) -> &mut Vec<TextTag> {
self.region_center.as_mut()
}
/// Set the content of the right region of the header.
///
/// Attention:
/// This tag must be a text:p otherwise its ignored.
pub fn set_right(&mut self, txt: Vec<TextTag>) {
self.region_right = txt;
}
/// Adds to the content of the right region of the header.
///
/// Attention:
/// This tag must be a text:p otherwise its ignored.
pub fn add_right(&mut self, txt: TextTag) {
self.region_right.push(txt);
}
/// Right region.
pub fn clear_right(&mut self) {
self.region_right = Vec::new();
}
/// Right region.
pub fn right(&self) -> &Vec<TextTag> {
self.region_right.as_ref()
}
/// Right region.
pub fn right_mut(&mut self) -> &mut Vec<TextTag> {
self.region_right.as_mut()
}
/// Header content, if there are no regions.
pub fn set_content(&mut self, txt: Vec<TextTag>) {
self.content = txt;
}
/// Adds header content, if there are no regions.
pub fn add_content(&mut self, txt: TextTag) {
self.content.push(txt);
}
/// Header content, if there are no regions.
pub fn content(&self) -> &Vec<TextTag> {
&self.content
}
/// Header content, if there are no regions.
pub fn content_mut(&mut self) -> &mut Vec<TextTag> {
&mut self.content
}
}