2 /* This file is part of
3 * ======================================================
5 * LyX, The Document Processor
7 * Copyright 1995 Matthias Ettrich
8 * Copyright 1995-2000 The LyX Team
10 * This file Copyright 1999-2000
12 *======================================================
15 #ifndef PRINTERPARAMS_H
16 #define PRINTERPARAMS_H
19 #error You must include lyxrc.h before PrinterParams.h
22 #ifdef ENABLE_ASSERTIONS
23 #include "support/LAssert.h"
27 This struct contains (or should contain) all the parameters required for
28 printing a buffer. Some work still needs to be done on this struct and
29 printing handling in general to make it nice and full-featured.
30 The main things I'd like to add now is the ability to print a read-only
31 document with different orientation, papersize or single/duplex state
32 than the document's settings. ARRae 20000423
34 struct PrinterParams {
48 /// We allow printing of even pages in a range and so on.
58 WhichPages which_pages;
59 /** Print a page range. Both from_page and to_page used to be strings
60 because they're actually easier to work with that way. I've
61 switched to_page to be an int. However, from_page will remain a
62 string because I want the from_page field to be able to be used as
63 a page range "1,3-5" and so on.
64 I've modified the invariant test to match. ARRae 20000518
75 // The settings below should allow us to print any read-only doc in
76 // whatever size/orientation we want it -- overriding the documents
78 // Override the documents orientation
80 // Print n pages per physical sheet
82 // Override document settings for duplex.
86 PrinterParams(Target const & t = PRINTER,
87 string const & pname = lyxrc.printer,
88 string const & fname = string(),
89 WhichPages const wp = ALL,
90 string const & from = string(),
92 bool const reversed = false,
93 bool const unsorted = false,
94 int const & num_copies = 1)
101 reverse_order(reversed),
102 unsorted_copies(unsorted),
103 count_copies(num_copies)
108 PrinterParams(PrinterParams const & pp)
110 printer_name(pp.printer_name),
111 file_name(pp.file_name),
112 which_pages(pp.which_pages),
113 from_page(pp.from_page),
115 reverse_order(pp.reverse_order),
116 unsorted_copies(pp.unsorted_copies),
117 count_copies(pp.count_copies)
123 // friend bool operator==(PrinterParams const &, PrinterParams const &);
124 // friend bool operator<(PrinterParams const &, PrinterParams const &);
126 /** Test that all the fields contain valid entries. It's unlikely
127 that the internal code will get this wrong (at least for the
128 xforms code anyway) however new ports and external scripts
129 might drive the wrong values in.
131 void testInvariant() const
133 #ifdef ENABLE_ASSERTIONS
134 extern bool containsOnly(string const &, char const *);
135 if (!from_page.empty()) {
136 // Assert(from_page == number or empty)
137 Assert(containsOnly(from_page, "1234567890"));
140 // Assert(to_page == empty
141 // or number iff from_page set)
142 Assert(!from_page.empty());
146 // Assert(!printer_name.empty());
149 Assert(!file_name.empty());
155 switch (which_pages) {