diff --git a/alignment_8hpp_source.html b/alignment_8hpp_source.html
new file mode 100644
index 00000000..e69be2be
--- /dev/null
+++ b/alignment_8hpp_source.html
@@ -0,0 +1,85 @@
+
+
+
+xlnt: xlnt/styles/alignment.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
27 #include <xlnt/xlnt_config.hpp> 28 #include <xlnt/utils/optional.hpp> 140 bool shrink_to_fit_ =
false ;
145 bool wrap_text_ =
false ;
horizontal_alignment
Text can be aligned horizontally within a cell in these enumerated ways.
Definition: alignment.hpp:35
+
vertical_alignment
Text can be aligned vertically within a cell in these enumerated ways.
Definition: alignment.hpp:50
+
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
Describes the fill style of a particular cell.
Definition: fill.hpp:298
+
bool operator==(std::nullptr_t, const cell &cell)
Returns true if this cell is uninitialized.
+
+
Alignment options that determine how text should be displayed within a cell.
Definition: alignment.hpp:62
+
bool operator!=(const std::string &reference_string, const range_reference &ref)
Returns true if the string representation of the range is not equivalent to ref.
+
xlnt: Class List
+
+
+
+
+
+
+
+
+
+
+
Here are the classes, structs, unions and interfaces with brief descriptions:
+
[detail level 1 2 3 ]
+ ▼ N std C hash< xlnt::cell_reference > C hash< xlnt::column_t > Template specialization to allow xlnt::column_t to be used as a key in a std container. C hash< xlnt::path > Template specialization to allow xlnt:path to be used as a key in a std container. ▼ N xlnt Enumerates the possible types a cell can be determined by it's current value. ▼ N detail C number_serialiser ▼ N drawing C spreadsheet_drawing The spreadsheet_drawing class encapsulates the information captured from objects within the spreadsheetDrawing schema. C alignment Alignment options that determine how text should be displayed within a cell. ▼ C border Describes the border style of a particular cell. C border_property Each side of a cell can have a border_property applied to it to change how it is displayed. C calculation_properties Workbook file properties relating to calculations. C cell Describes a unit of data in a worksheet at a specific coordinate and its associated properties. C cell_iterator A cell iterator iterates over a 1D range by row or by column. C cell_reference An object used to refer to a cell. References have two parts, the column and the row. In Excel, the reference string A1 refers to the top-left-most cell. A cell_reference can be initialized from a string of this form or a 1-indexed ordered pair of the form column, row. C cell_reference_hash Functor for hashing a cell reference. Allows for use of std::unordered_set<cell_reference, cel_reference_hash> and similar. C cell_vector A cell vector is a linear (1D) range of cells, either vertical or horizontal depending on the major order specified in the constructor. C color Colors can be applied to many parts of a cell's style. C column_hash Functor for hashing a column. Allows for use of std::unordered_set<column_t, column_hash> and similar. C column_properties Properties applied to a column in a worksheet. Columns can have a size and a style. C column_t Columns can be referred to as a string A,B,...Z,AA,AB,..,ZZ,AAA,...,ZZZ or as a 1-indexed index. This class encapsulates both of these forms of column referencing and allows for conversions between them. C comment A comment can be applied to a cell to provide extra information about its contents. C condition C conditional_format Describes a conditional format that will be applied to all cells in the associated range that satisfy the condition. This can only be constructed using methods on worksheet or range. C const_cell_iterator A cell iterator iterates over a 1D range by row or by column. C const_range_iterator A const version of range_iterator which does not allow modification to the dereferenced cell_vector . C const_worksheet_iterator An iterator which is used to iterate over the worksheets in a const workbook. C date A date is a specific day specified in terms of a year, month, and day. It can also be initialized as a number of days since a base date using date::from_number . C datetime A datetime is a combination of a date and a time. ▼ C document_security Properties governing how the data in a workbook should be protected. These values can be ignored by consumers. C lock_verifier Holds data describing the verifier that locks revisions or a workbook. C exception Parent type of all custom exceptions thrown in this library. ▼ C ext_list A list of xml extensions that may or may not be understood by the parser preservation is required for round-tripping even if extension is not understood [serialised: extLst] C ext C external_book A reference to an external workbook for use in formulae. C fill Describes the fill style of a particular cell. C font Describes the font style of a particular cell. C format Describes the formatting of a particular cell. C gradient_fill Encapsulates a fill which transitions between colors at particular "stops". C header_footer Represents the header and footer of a sheet in a workbook. C hyperlink Describes a hyperlink pointing from a cell to another cell or a URL. C illegal_character The data submitted which cannot be used directly in Excel files. It must be removed or escaped. C indexed_color An indexed color encapsulates a simple index to a color in the indexedColors of the stylesheet. C invalid_attribute Exception when setting a class's attribute to an invalid value C invalid_cell_reference Exception for converting between numeric and A1-style cell references. C invalid_column_index Exception for bad column indices in A1-style cell references. C invalid_data_type Exception for any data type inconsistencies. C invalid_file Exception for trying to open a non-XLSX file. C invalid_parameter Exception for a bad parameter value C invalid_sheet_title Exception for bad sheet names. C key_not_found Exception for a key that doesn't exist in a container C manifest The manifest keeps track of all files in the OOXML package and their type and relationships. C named_range A 2D range of cells in a worksheet that is referred to by name. ws->range("A1:B2") could be replaced by ws->range("range1") C no_visible_worksheets Exception for a workbook with no visible worksheets C number_format Describes the number formatting applied to text and numbers within a certain cell. C optional Many settings in xlnt are allowed to not have a value set. This class encapsulates a value which may or may not be set. Memory is allocated within the optional class. C page_margins Describes the margins around a worksheet for printing. C page_setup Describes how a worksheet will be converted into a page during printing. C pane A fixed portion of a worksheet. C path Encapsulates a path that points to location in a filesystem. C pattern_fill Represents a fill which colors the cell based on a foreground and background color and a pattern. C phonetic_pr Phonetic properties Element provides a collection of properties that affect display of East Asian Languages [Serialised phoneticPr] C phonetic_run Encapsulates a run of text that C print_options C protection Describes the protection style of a particular cell. C range A range is a 2D collection of cells with defined extens that can be iterated upon. C range_iterator An iterator used by worksheet and range for traversing a 2D grid of cells by row/column then across that row/column. C range_reference A range_reference describes a rectangular area of a worksheet with positive width and height defined by a top-left and bottom-right corner. C relationship Represents an association between a source Package or part, and a target object which can be a part or external resource. C rgb_color An RGB color describes a color in terms of its red, green, blue, and alpha components. C rich_text Encapsulates zero or more formatted text runs where a text run is a string of text with the same defined formatting. C rich_text_hash C rich_text_run Typedef a rich_text_run as a pair of string and optional font. C row_properties The properties of a row in a worksheet. C scoped_enum_hash Allows a scoped enum (aka "enum class") to be used as a key in a std::unordered_map. C selection The selected area of a worksheet. C sheet_format_properties General worksheet formatting properties. C sheet_pr C sheet_protection Protection applied to a particular worksheet to prevent it from being modified. C sheet_view Describes a view of a worksheet. Worksheets can have multiple views which show the data differently. C streaming_workbook_reader workbook is the container for all other parts of the document. C streaming_workbook_writer workbook is the container for all other parts of the document. C style Describes a style which has a name and can be applied to multiple individual formats. In Excel this is a "Cell Style". C theme A theme is a combination of fonts, colors, and effects. This isn't really supported yet. C theme_color A theme color encapsulates a color derived from the theme. C time A time is a specific time of the day specified in terms of an hour, minute, second, and microsecond (0-999999). It can also be initialized as a fraction of a day using time::from_number . C timedelta Represents a span of time between two datetimes. This is not fully supported yet throughout the library. C unhandled_switch_case Debug exception for a switch that fell through to the default case C unsupported Exception for attempting to use a feature which is not supported C uri Encapsulates a uniform resource identifier (URI) as described by RFC 3986. C variant Represents an object that can have variable type. C workbook workbook is the container for all other parts of the document. C workbook_view A workbook can be opened in multiple windows with different views. This class represents a particular view used by one window. C worksheet A worksheet is a 2D array of cells starting with cell A1 in the top-left corner and extending indefinitely down and right as needed. C worksheet_iterator An iterator which is used to iterate over the worksheets in a workbook.
+
+
xlnt: xlnt/styles/border.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
29 #include <unordered_map> 32 #include <xlnt/xlnt_config.hpp> 33 #include <xlnt/styles/color.hpp> 34 #include <xlnt/utils/optional.hpp> 148 static const std::vector<border_side> &all_sides();
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
Colors can be applied to many parts of a cell's style.
Definition: color.hpp:164
+
border_side
Enumerates the sides of a cell to which a border style can be applied.
Definition: border.hpp:41
+
Describes the border style of a particular cell.
Definition: border.hpp:93
+
bool operator==(std::nullptr_t, const cell &cell)
Returns true if this cell is uninitialized.
+
Each side of a cell can have a border_property applied to it to change how it is displayed.
Definition: border.hpp:100
+
diagonal_direction
Cells can have borders that go from the top-left to bottom-right or from the top-right to bottom-left...
Definition: border.hpp:78
+
border_style
Enumerates the pattern of the border lines on a particular side.
Definition: border.hpp:55
+
Many settings in xlnt are allowed to not have a value set. This class encapsulates a value which may ...
Definition: format.hpp:43
+
bool operator!=(const std::string &reference_string, const range_reference &ref)
Returns true if the string representation of the range is not equivalent to ref.
+
Describes a style which has a name and can be applied to multiple individual formats. In Excel this is a "Cell Style".
Definition: style.hpp:55
+
xlnt: xlnt/workbook/calculation_properties.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
26 #include <xlnt/xlnt_config.hpp> 41 std::size_t calc_id = 0;
46 bool concurrent_calc =
false ;
std::size_t calc_id
The version of calculation engine used to calculate cell formula values. If this is older than the ve...
Definition: calculation_properties.hpp:41
+
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
bool operator==(std::nullptr_t, const cell &cell)
Returns true if this cell is uninitialized.
+
bool concurrent_calc
If this is true, concurrent calculation will be enabled for the workbook.
Definition: calculation_properties.hpp:46
+
Workbook file properties relating to calculations.
Definition: calculation_properties.hpp:33
+
xlnt: xlnt/utils/calendar.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
26 #include <xlnt/xlnt_config.hpp> Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
calendar
An enumeration of possible base dates. Dates in Excel are stored as days since this base date...
Definition: calendar.hpp:34
+
xlnt: xlnt/cell/cell.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
29 #include <unordered_map> 31 #include <xlnt/xlnt_config.hpp> 32 #include <xlnt/cell/cell_type.hpp> 33 #include <xlnt/cell/index_types.hpp> 34 #include <xlnt/cell/rich_text.hpp> 94 static const std::unordered_map<std::string, int> &error_codes();
106 bool has_value()
const ;
113 template <
typename T>
125 void value(std::nullptr_t);
130 void value(
bool boolean_value);
135 void value(
int int_value);
140 void value(
unsigned int int_value);
145 void value(
long long int int_value);
150 void value(
unsigned long long int int_value);
155 void value(
float float_value);
160 void value(
double float_value);
165 void value(
const date &date_value);
170 void value(
const time &time_value);
175 void value(
const datetime &datetime_value);
180 void value(
const timedelta &timedelta_value);
185 void value(
const std::string &string_value);
190 void value(
const char *string_value);
200 void value(
const cell other_cell);
206 void value(
const std::string &string_value,
bool infer_type);
211 type data_type()
const ;
217 void data_type(
type t);
225 bool garbage_collectible()
const ;
230 bool is_date()
const ;
257 std::pair<int, int> anchor()
const ;
270 void hyperlink (
const std::string &url,
const std::string &display =
"" );
285 bool has_hyperlink()
const ;
294 class alignment computed_alignment() const;
301 class border computed_border() const;
308 class fill computed_fill() const;
315 class font computed_font() const;
336 bool has_format()
const ;
427 bool has_style()
const ;
450 void style (
const std::string &style_name);
464 std::string formula()
const ;
470 void formula(
const std::string &formula);
475 void clear_formula();
480 bool has_formula()
const ;
488 std::string to_string()
const ;
496 bool is_merged()
const ;
503 void merged(
bool merged);
510 bool phonetics_visible()
const ;
515 void show_phonetics(
bool phonetics);
520 std::string
error ()
const ;
531 cell offset(
int column,
int row);
561 std::string check_string(
const std::string &to_check);
573 void clear_comment();
584 void comment (
const std::string &text,
585 const std::string &author =
"Microsoft Office User" );
591 void comment (
const std::string &comment_text,
592 const class font &comment_font,
593 const std::string &author =
"Microsoft Office User" );
603 double width()
const ;
608 double height()
const ;
631 friend class detail::xlsx_consumer;
632 friend class detail::xlsx_producer;
633 friend struct detail::cell_impl;
639 class format modifiable_format();
649 cell (detail::cell_impl *d);
654 detail::cell_impl *d_;
674 bool cell::value<bool>()
const ;
677 int cell::value<int>()
const ;
680 unsigned int cell::value<unsigned int>()
const ;
683 long long int cell::value<long long int>()
const ;
686 unsigned long long cell::value<unsigned long long int>()
const ;
689 float cell::value<float>()
const ;
692 double cell::value<double>()
const ;
695 date cell::value<date>()
const ;
698 time cell::value<time>()
const ;
701 datetime cell::value<datetime>()
const ;
704 timedelta cell::value<timedelta>()
const ;
707 std::string cell::value<std::string>()
const ;
710 rich_text cell::value<rich_text>()
const ;
+
A range is a 2D collection of cells with defined extens that can be iterated upon.
Definition: range.hpp:54
+
Represents an association between a source Package or part, and a target object which can be a part o...
Definition: relationship.hpp:102
+
std::uint32_t index_t
Alias declaration for the internal numeric type of this column.
Definition: index_types.hpp:53
+
std::uint32_t row_t
All rows should be referred to by an instance of this type.
Definition: index_types.hpp:40
+
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
Describes the font style of a particular cell.
Definition: font.hpp:40
+
value is a known error code such as #VALUE!
+
A time is a specific time of the day specified in terms of an hour, minute, second, and microsecond (0-999999). It can also be initialized as a fraction of a day using time::from_number.
Definition: time.hpp:37
+
Describes the fill style of a particular cell.
Definition: fill.hpp:298
+
A worksheet is a 2D array of cells starting with cell A1 in the top-left corner and extending indefin...
Definition: worksheet.hpp:76
+
Represents a span of time between two datetimes. This is not fully supported yet throughout the libra...
Definition: timedelta.hpp:36
+
Describes the border style of a particular cell.
Definition: border.hpp:93
+
bool operator==(std::nullptr_t, const cell &cell)
Returns true if this cell is uninitialized.
+
An object used to refer to a cell. References have two parts, the column and the row. In Excel, the reference string A1 refers to the top-left-most cell. A cell_reference can be initialized from a string of this form or a 1-indexed ordered pair of the form column, row.
Definition: cell_reference.hpp:59
+
Describes a unit of data in a worksheet at a specific coordinate and its associated properties...
Definition: cell.hpp:83
+
Describes a hyperlink pointing from a cell to another cell or a URL.
Definition: hyperlink.hpp:42
+
Encapsulates zero or more formatted text runs where a text run is a string of text with the same defi...
Definition: rich_text.hpp:40
+
A datetime is a combination of a date and a time.
Definition: datetime.hpp:39
+
+
std::ostream & operator<<(std::ostream &stream, const xlnt::cell &cell)
Convenience function for writing cell to an ostream. Uses cell::to_string() internally.
+
+
Alignment options that determine how text should be displayed within a cell.
Definition: alignment.hpp:62
+
Columns can be referred to as a string A,B,...Z,AA,AB,..,ZZ,AAA,...,ZZZ or as a 1-indexed index...
Definition: index_types.hpp:47
+
cell_type
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell_type.hpp:38
+
bool operator!=(const std::string &reference_string, const range_reference &ref)
Returns true if the string representation of the range is not equivalent to ref.
+
Describes the protection style of a particular cell.
Definition: protection.hpp:37
+
Describes a style which has a name and can be applied to multiple individual formats. In Excel this is a "Cell Style".
Definition: style.hpp:55
+
A date is a specific day specified in terms of a year, month, and day. It can also be initialized as ...
Definition: date.hpp:38
+
workbook is the container for all other parts of the document.
Definition: workbook.hpp:91
+
calendar
An enumeration of possible base dates. Dates in Excel are stored as days since this base date...
Definition: calendar.hpp:34
+
Phonetic properties Element provides a collection of properties that affect display of East Asian Lan...
Definition: phonetic_pr.hpp:38
+
xlnt: xlnt/worksheet/cell_iterator.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
30 #include <xlnt/xlnt_config.hpp> 31 #include <xlnt/cell/cell_reference.hpp> 32 #include <xlnt/worksheet/major_order.hpp> 33 #include <xlnt/worksheet/range_reference.hpp> 34 #include <xlnt/worksheet/worksheet.hpp> 42 class range_reference;
55 using difference_type = std::ptrdiff_t;
144 bool has_value()
const ;
150 bool skip_null_ =
false ;
194 using difference_type = std::ptrdiff_t;
278 bool has_value()
const ;
284 bool skip_null_ =
false ;
A cell iterator iterates over a 1D range by row or by column.
Definition: cell_iterator.hpp:186
+
std::bidirectional_iterator_tag iterator_category
iterator tags required for use with standard algorithms and adapters
Definition: cell_iterator.hpp:192
+
std::bidirectional_iterator_tag iterator_category
iterator tags required for use with standard algorithms and adapters
Definition: cell_iterator.hpp:53
+
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
A worksheet is a 2D array of cells starting with cell A1 in the top-left corner and extending indefin...
Definition: worksheet.hpp:76
+
major_order
Defines whether iterating a range returns columns or rows sequentially.
Definition: major_order.hpp:33
+
bool operator==(std::nullptr_t, const cell &cell)
Returns true if this cell is uninitialized.
+
An object used to refer to a cell. References have two parts, the column and the row. In Excel, the reference string A1 refers to the top-left-most cell. A cell_reference can be initialized from a string of this form or a 1-indexed ordered pair of the form column, row.
Definition: cell_reference.hpp:59
+
Describes a unit of data in a worksheet at a specific coordinate and its associated properties...
Definition: cell.hpp:83
+
A cell iterator iterates over a 1D range by row or by column.
Definition: cell_iterator.hpp:47
+
bool operator!=(const std::string &reference_string, const range_reference &ref)
Returns true if the string representation of the range is not equivalent to ref.
+
A range_reference describes a rectangular area of a worksheet with positive width and height defined ...
Definition: range_reference.hpp:35
+
xlnt: xlnt/cell/cell_reference.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
26 #include <xlnt/xlnt_config.hpp> 27 #include <xlnt/cell/index_types.hpp> 38 class range_reference;
65 static std::pair<std::string, row_t> split_reference(
const std::string &reference_string);
73 static std::pair<std::string, row_t> split_reference(
74 const std::string &reference_string,
bool &absolute_column,
bool &absolute_row);
115 cell_reference &make_absolute(
bool absolute_column =
true ,
bool absolute_row =
true );
120 bool column_absolute()
const ;
126 void column_absolute(
bool absolute_column);
131 bool row_absolute()
const ;
137 void row_absolute(
bool absolute_row);
150 void column(
const std::string &column_string);
178 cell_reference make_offset(
int column_offset,
int row_offset)
const ;
183 std::string to_string()
const ;
209 bool operator== (
const std::string &reference_string)
const ;
215 bool operator== (
const char *reference_string)
const ;
227 bool operator!= (
const std::string &reference_string)
const ;
233 bool operator!= (
const char *reference_string)
const ;
256 bool absolute_column_;
263 struct hash<
xlnt ::cell_reference>
267 static_assert(std::is_same<decltype(x.
row ()), std::uint32_t>::value,
"this hash function expects both row and column to be 32-bit numbers" );
268 static_assert(std::is_same<decltype(x.
column_index ()), std::uint32_t>::value,
"this hash function expects both row and column to be 32-bit numbers" );
269 return hash<std::uint64_t>{}(x.
row () |
static_cast< std::uint64_t
> (x.
column_index ()) << 32);
std::uint32_t index_t
Alias declaration for the internal numeric type of this column.
Definition: index_types.hpp:53
+
std::uint32_t row_t
All rows should be referred to by an instance of this type.
Definition: index_types.hpp:40
+
Definition: cell_reference.hpp:261
+
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
Functor for hashing a cell reference. Allows for use of std::unordered_set<cell_reference, cel_reference_hash> and similar.
Definition: cell_reference.hpp:44
+
bool operator==(std::nullptr_t, const cell &cell)
Returns true if this cell is uninitialized.
+
An object used to refer to a cell. References have two parts, the column and the row. In Excel, the reference string A1 refers to the top-left-most cell. A cell_reference can be initialized from a string of this form or a 1-indexed ordered pair of the form column, row.
Definition: cell_reference.hpp:59
+
column_t::index_t column_index() const
Returns a 1-indexed numeric index of the column of this reference.
+
Columns can be referred to as a string A,B,...Z,AA,AB,..,ZZ,AAA,...,ZZZ or as a 1-indexed index...
Definition: index_types.hpp:47
+
bool operator!=(const std::string &reference_string, const range_reference &ref)
Returns true if the string representation of the range is not equivalent to ref.
+
A range_reference describes a rectangular area of a worksheet with positive width and height defined ...
Definition: range_reference.hpp:35
+
row_t row() const
Returns a 1-indexed numeric index of the row of this reference.
+
xlnt: xlnt/cell/cell_type.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
27 #include <xlnt/xlnt_config.hpp> value is a string stored in the cell
+
value is the string result of a formula
+
+
value is a string shared with other cells to save space
+
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
value is a known error code such as #VALUE!
+
value is an ISO 8601 formatted date
+
+
cell_type
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell_type.hpp:38
+
+
xlnt: xlnt/worksheet/cell_vector.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
28 #include <xlnt/xlnt_config.hpp> 29 #include <xlnt/cell/cell_reference.hpp> 30 #include <xlnt/worksheet/cell_iterator.hpp> 31 #include <xlnt/worksheet/major_order.hpp> 32 #include <xlnt/worksheet/range_reference.hpp> 33 #include <xlnt/worksheet/worksheet.hpp> 39 class const_cell_iterator;
40 class range_reference;
92 const cell front()
const ;
102 const cell back()
const ;
107 std::size_t length()
const ;
172 cell operator[](std::size_t column_index);
177 const cell operator[](std::size_t column_index)
const ;
A cell iterator iterates over a 1D range by row or by column.
Definition: cell_iterator.hpp:186
+
std::reverse_iterator< iterator > reverse_iterator
Iterate over cells in a cell_vector in reverse oreder with an iterator of this type.
Definition: cell_vector.hpp:63
+
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
A worksheet is a 2D array of cells starting with cell A1 in the top-left corner and extending indefin...
Definition: worksheet.hpp:76
+
major_order
Defines whether iterating a range returns columns or rows sequentially.
Definition: major_order.hpp:33
+
An object used to refer to a cell. References have two parts, the column and the row. In Excel, the reference string A1 refers to the top-left-most cell. A cell_reference can be initialized from a string of this form or a 1-indexed ordered pair of the form column, row.
Definition: cell_reference.hpp:59
+
Describes a unit of data in a worksheet at a specific coordinate and its associated properties...
Definition: cell.hpp:83
+
A cell iterator iterates over a 1D range by row or by column.
Definition: cell_iterator.hpp:47
+
A cell vector is a linear (1D) range of cells, either vertical or horizontal depending on the major o...
Definition: cell_vector.hpp:46
+
+
A range_reference describes a rectangular area of a worksheet with positive width and height defined ...
Definition: range_reference.hpp:35
+
std::reverse_iterator< const_iterator > const_reverse_iterator
Iterate over const cells in a const cell_vector in reverse order with an iterator of this type...
Definition: cell_vector.hpp:69
+
xlnt: Class Index
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/classxlnt_1_1alignment-members.html b/classxlnt_1_1alignment-members.html
new file mode 100644
index 00000000..3abe756a
--- /dev/null
+++ b/classxlnt_1_1alignment-members.html
@@ -0,0 +1,94 @@
+
+
+
+xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::alignment , including all inherited members.
+
xlnt: xlnt::alignment Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Alignment options that determine how text should be displayed within a cell.
+ More...
+
+
#include <alignment.hpp >
+
+
+
Alignment options that determine how text should be displayed within a cell.
+
+
+
◆ [1/2]
+
+
+
+
+
Returns the optional horizontal alignment.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Sets the horizontal alignment.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ optional <int> xlnt::alignment::indent (
+ )
+ const
+
+
+
+
+
Returns the optional value of indentation width in number of spaces.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ alignment & xlnt::alignment::indent (
+ int
+ indent_size )
+
+
+
+
+
Sets the indent size in number of spaces from the side of the cell. This will only take effect when left or right horizontal alignment has also been set.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::alignment::operator!=
+ (
+ const alignment &
+ other )
+ const
+
+
+
+
+
Returns true if this alignment is not equivalent to other.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::alignment::operator==
+ (
+ const alignment &
+ other )
+ const
+
+
+
+
+
Returns true if this alignment is equivalent to other.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ optional <int> xlnt::alignment::rotation (
+ )
+ const
+
+
+
+
+
Returns the optional value of rotation for text in the cell in degrees.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ alignment & xlnt::alignment::rotation (
+ int
+ text_rotation )
+
+
+
+
+
Sets the rotation for text in the cell in degrees.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ bool xlnt::alignment::shrink
+ (
+ )
+ const
+
+
+
+
+
Returns true if shrink-to-fit has been enabled.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ alignment & xlnt::alignment::shrink (
+ bool
+ shrink_to_fit )
+
+
+
+
+
Sets whether the font size should be reduced until all of the text fits in a cell without wrapping.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Returns the optional vertical alignment.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Sets the vertical alignment.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ bool xlnt::alignment::wrap
+ (
+ )
+ const
+
+
+
+
+
Returns true if text-wrapping has been enabled.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ alignment & xlnt::alignment::wrap (
+ bool
+ wrap_text )
+
+
+
+
+
Sets whether text in a cell should continue to multiple lines if it doesn't fit in one line.
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::border , including all inherited members.
+
xlnt: xlnt::border Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Describes the border style of a particular cell.
+ More...
+
+
#include <border.hpp >
+
+static const std::vector< border_side > & all_sides () Returns a vector containing all of the border sides to be used for iteration. More...
+
+
Describes the border style of a particular cell.
+
+
+
◆
+
+
+
+
+
+ xlnt::border::border
+ (
+ )
+
+
+
+
+
Constructs a default border.
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static const std::vector<border_side >& xlnt::border::all_sides
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Returns a vector containing all of the border sides to be used for iteration.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Returns the diagonal direction of this border.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Sets the diagonal direction of this border to dir.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::border::operator!=
+ (
+ const border &
+ right )
+ const
+
+
+
+
+
Returns true if left is not exactly equal to right.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::border::operator==
+ (
+ const border &
+ right )
+ const
+
+
+
+
+
Returns true if left is exactly equal to right.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Returns the border properties of the given side.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Sets the border properties of the side s to prop.
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::border::border_property , including all inherited members.
+
xlnt: xlnt::border::border_property Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Each side of a cell can have a border_property applied to it to change how it is displayed.
+ More...
+
+
#include <border.hpp >
+
+
+
Each side of a cell can have a border_property applied to it to change how it is displayed.
+
+
+
◆ [1/2]
+
+
+
+
+
+ optional <class color > xlnt::border::border_property::color (
+ )
+ const
+
+
+
+
+
Returns the color of the side.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Sets the color of the side and returns a reference to the side properties.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::border::border_property::operator!=
+ (
+ const border_property &
+ right )
+ const
+
+
+
+
+
Returns true if left is not exactly equal to right.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::border::border_property::operator==
+ (
+ const border_property &
+ right )
+ const
+
+
+
+
+
Returns true if left is exactly equal to right.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Returns the style of the side.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Sets the style of the side and returns a reference to the side properties.
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::calculation_properties , including all inherited members.
+
xlnt: xlnt::calculation_properties Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Workbook file properties relating to calculations.
+ More...
+
+
#include <calculation_properties.hpp >
+
+std::size_t calc_id = 0 The version of calculation engine used to calculate cell formula values. If this is older than the version of the Excel calculation engine opening the workbook, cell values will be recalculated. More... bool concurrent_calc = false If this is true, concurrent calculation will be enabled for the workbook. More...
+
+
Workbook file properties relating to calculations.
+
+
+
◆
+
+
+
+
+
+ std::size_t xlnt::calculation_properties::calc_id = 0
+
+
+
+
+
The version of calculation engine used to calculate cell formula values. If this is older than the version of the Excel calculation engine opening the workbook, cell values will be recalculated.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::calculation_properties::concurrent_calc = false
+
+
+
+
+
If this is true, concurrent calculation will be enabled for the workbook.
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::cell , including all inherited members.
+
xlnt: xlnt::cell Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Describes a unit of data in a worksheet at a specific coordinate and its associated properties.
+ More...
+
+
#include <cell.hpp >
+
+ cell (const cell &)=default Default copy constructor. More... bool has_value () const Returns true if value has been set and has not been cleared using cell::clear_value() . More... template<typename T > T value () const Returns the value of this cell as an instance of type T. Overloads exist for most C++ fundamental types like bool, int, etc. as well as for std::string and xlnt datetime types: date, time, datetime, and timedelta. More... void clear_value () Makes this cell have a value of type null. All other cell attributes are retained. More... void value (std::nullptr_t) Sets the type of this cell to null. More... void value (bool boolean_value) Sets the value of this cell to the given boolean value. More... void value (int int_value) Sets the value of this cell to the given value. More... void value (unsigned int int_value) Sets the value of this cell to the given value. More... void value (long long int int_value) Sets the value of this cell to the given value. More... void value (unsigned long long int int_value) Sets the value of this cell to the given value. More... void value (float float_value) Sets the value of this cell to the given value. More... void value (double float_value) Sets the value of this cell to the given value. More... void value (const date &date_value) Sets the value of this cell to the given value. More... void value (const time &time_value) Sets the value of this cell to the given value. More... void value (const datetime &datetime_value) Sets the value of this cell to the given value. More... void value (const timedelta &timedelta_value) Sets the value of this cell to the given value. More... void value (const std::string &string_value) Sets the value of this cell to the given value. More... void value (const char *string_value) Sets the value of this cell to the given value. More... void value (const rich_text &text_value) Sets the value of this cell to the given value. More... void value (const cell other_cell) Sets the value and formatting of this cell to that of other_cell. More... void value (const std::string &string_value, bool infer_type) Analyzes string_value to determine its type, convert it to that type, and set the value of this cell to that converted value. More... type data_type () const Returns the type of this cell. More... void data_type (type t) Sets the type of this cell. This should usually be done indirectly by setting the value of the cell to a value of that type. More... bool garbage_collectible () const There's no reason to keep a cell which has no value and is not a placeholder. Returns true if this cell has no value, style, isn't merged, etc. More... bool is_date () const Returns true iff this cell's number format matches a date format. More... cell_reference reference () const Returns a cell_reference that points to the location of this cell. More... column_t column () const Returns the column of this cell. More... column_t::index_t column_index () const Returns the numeric index (A == 1) of the column of this cell. More... row_t row () const Returns the row of this cell. More... std::pair< int, int > anchor () const Returns the location of this cell as an ordered pair (left, top). More... class hyperlink hyperlink () const Returns the relationship of this cell's hyperlink. More... void hyperlink (const std::string &url, const std::string &display="") Adds a hyperlink to this cell pointing to the URI of the given value and sets the text value of the cell to the given parameter. More... void hyperlink (xlnt::cell target, const std::string &display="") Adds an internal hyperlink to this cell pointing to the given cell. More... void hyperlink (xlnt::range target, const std::string &display="") Adds an internal hyperlink to this cell pointing to the given range. More... bool has_hyperlink () const Returns true if this cell has a hyperlink set. More... class alignment computed_alignment () const Returns the alignment that should be used when displaying this cell graphically based on the workbook default, the cell-level format, and the named style applied to the cell in that order. More... class border computed_border () const Returns the border that should be used when displaying this cell graphically based on the workbook default, the cell-level format, and the named style applied to the cell in that order. More... class fill computed_fill () const Returns the fill that should be used when displaying this cell graphically based on the workbook default, the cell-level format, and the named style applied to the cell in that order. More... class font computed_font () const Returns the font that should be used when displaying this cell graphically based on the workbook default, the cell-level format, and the named style applied to the cell in that order. More... class number_format computed_number_format () const Returns the number format that should be used when displaying this cell graphically based on the workbook default, the cell-level format, and the named style applied to the cell in that order. More... class protection computed_protection () const Returns the protection that should be used when displaying this cell graphically based on the workbook default, the cell-level format, and the named style applied to the cell in that order. More... bool has_format () const Returns true if this cell has had a format applied to it. More... const class format format () const Returns the format applied to this cell. If this cell has no format, an invalid_attribute exception will be thrown. More... void format (const class format new_format) Applies the cell-level formatting of new_format to this cell. More... void clear_format () Removes the cell-level formatting from this cell. This doesn't affect the style that may also be applied to the cell. Throws an invalid_attribute exception if no format is applied. More... class number_format number_format () const Returns the number format of this cell. More... void number_format (const class number_format &format ) Creates a new format in the workbook, sets its number_format to the given format, and applies the format to this cell. More... class font font () const Returns the font applied to the text in this cell. More... void font (const class font &font_) Creates a new format in the workbook, sets its font to the given font, and applies the format to this cell. More... class fill fill () const Returns the fill applied to this cell. More... void fill (const class fill &fill_) Creates a new format in the workbook, sets its fill to the given fill, and applies the format to this cell. More... class border border () const Returns the border of this cell. More... void border (const class border &border_) Creates a new format in the workbook, sets its border to the given border, and applies the format to this cell. More... class alignment alignment () const Returns the alignment of the text in this cell. More... void alignment (const class alignment &alignment_) Creates a new format in the workbook, sets its alignment to the given alignment, and applies the format to this cell. More... class protection protection () const Returns the protection of this cell. More... void protection (const class protection &protection_) Creates a new format in the workbook, sets its protection to the given protection, and applies the format to this cell. More... bool has_style () const Returns true if this cell has had a style applied to it. More... class style style () Returns a wrapper pointing to the named style applied to this cell. More... const class style style () const Returns a wrapper pointing to the named style applied to this cell. More... void style (const class style &new_style) Sets the named style applied to this cell to a style named style_name. Equivalent to style(new_style.name()). More... void style (const std::string &style_name) Sets the named style applied to this cell to a style named style_name. If this style has not been previously created in the workbook, a key_not_found exception will be thrown. More... void clear_style () Removes the named style from this cell. An invalid_attribute exception will be thrown if this cell has no style. This will not affect the cell format of the cell. More... std::string formula () const Returns the string representation of the formula applied to this cell. More... void formula (const std::string &formula) Sets the formula of this cell to the given value. This formula string should begin with '='. More... void clear_formula () Removes the formula from this cell. After this is called, has_formula() will return false. More... bool has_formula () const Returns true if this cell has had a formula applied to it. More... std::string to_string () const Returns a string representing the value of this cell. If the data type is not a string, it will be converted according to the number format. More... bool is_merged () const Returns true iff this cell has been merged with one or more surrounding cells. More... void merged (bool merged) Makes this a merged cell iff merged is true. Generally, this shouldn't be called directly. Instead, use worksheet::merge_cells on its parent worksheet. More... bool phonetics_visible () const Returns true if this cell is set to show phonetic information. More... void show_phonetics (bool phonetics) Enables the display of phonetic information on this cell. More... std::string error () const Returns the error string that is stored in this cell. More... void error (const std::string &error) Directly assigns the value of this cell to be the given error. More... cell offset (int column , int row ) Returns a cell from this cell's parent workbook at a relative offset given by the parameters. More... class worksheet worksheet () Returns the worksheet that owns this cell. More... const class worksheet worksheet () const Returns the worksheet that owns this cell. More... class workbook & workbook () Returns the workbook of the worksheet that owns this cell. More... const class workbook & workbook () const Returns the workbook of the worksheet that owns this cell. More... calendar base_date () const Returns the base date of the parent workbook. More... std::string check_string (const std::string &to_check) Returns to_check after verifying and fixing encoding, size, and illegal characters. More... bool has_comment () Returns true if this cell has a comment applied. More... void clear_comment () Deletes the comment applied to this cell if it exists. More... class comment comment () Gets the comment applied to this cell. More... void comment (const std::string &text, const std::string &author="Microsoft Office User") Creates a new comment with the given text and optional author and applies it to the cell. More... void comment (const std::string &comment_text, const class font &comment_font, const std::string &author="Microsoft Office User") Creates a new comment with the given text, formatting, and optional author and applies it to the cell. More... void comment (const class comment &new_comment) Apply the comment provided as the only argument to the cell. More... double width () const Returns the width of this cell in pixels. More... double height () const Returns the height of this cell in pixels. More... cell & operator= (const cell &rhs) Makes this cell interally point to rhs. The cell data originally pointed to by this cell will be unchanged. More... bool operator== (const cell &comparand) const Returns true if this cell the same cell as comparand (compared by reference). More... bool operator!= (const cell &comparand) const Returns false if this cell the same cell as comparand (compared by reference). More... bool value () const int value () const unsigned int value () const long long int value () const unsigned long long value () const float value () const double value () const date value () const time value () const datetime value () const timedelta value () const rich_text value () const
+static const std::unordered_map< std::string, int > & error_codes () Returns a map of error strings such as #DIV/0! and their associated indices. More...
+style worksheet detail::xlsx_consumer detail::xlsx_producer detail::cell_impl
+
+
Describes a unit of data in a worksheet at a specific coordinate and its associated properties.
+
Properties of interest include style, type, value, and address. The Cell class is required to know its value and type, display options, and any other features of an Excel cell.Utilities for referencing cells using Excel's 'A1' column/row nomenclature are also provided.
+
+
+
◆
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ xlnt::cell::cell
+ (
+ const cell &
+ )
+
+
+
+
+default
+
+
+
+
+
Default copy constructor.
+
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ class alignment xlnt::cell::alignment
+ (
+ )
+ const
+
+
+
+
+
Returns the alignment of the text in this cell.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::cell::alignment
+ (
+ const class alignment &
+ alignment_ )
+
+
+
+
+
Creates a new format in the workbook, sets its alignment to the given alignment, and applies the format to this cell.
+
+
+
+
+
◆
+
+
+
+
+
+ std::pair<int, int> xlnt::cell::anchor
+ (
+ )
+ const
+
+
+
+
+
Returns the location of this cell as an ordered pair (left, top).
+
+
+
+
+
◆
+
+
+
+
+
+ calendar xlnt::cell::base_date (
+ )
+ const
+
+
+
+
+
Returns the base date of the parent workbook.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ class border xlnt::cell::border
+ (
+ )
+ const
+
+
+
+
+
Returns the border of this cell.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::cell::border
+ (
+ const class border &
+ border_ )
+
+
+
+
+
Creates a new format in the workbook, sets its border to the given border, and applies the format to this cell.
+
+
+
+
+
◆
+
+
+
+
+
+ std::string xlnt::cell::check_string
+ (
+ const std::string &
+ to_check )
+
+
+
+
+
Returns to_check after verifying and fixing encoding, size, and illegal characters.
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::cell::clear_comment
+ (
+ )
+
+
+
+
+
Deletes the comment applied to this cell if it exists.
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::cell::clear_format
+ (
+ )
+
+
+
+
+
Removes the cell-level formatting from this cell. This doesn't affect the style that may also be applied to the cell. Throws an invalid_attribute exception if no format is applied.
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::cell::clear_formula
+ (
+ )
+
+
+
+
+
Removes the formula from this cell. After this is called, has_formula() will return false.
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::cell::clear_style
+ (
+ )
+
+
+
+
+
Removes the named style from this cell. An invalid_attribute exception will be thrown if this cell has no style. This will not affect the cell format of the cell.
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::cell::clear_value
+ (
+ )
+
+
+
+
+
Makes this cell have a value of type null. All other cell attributes are retained.
+
+
+
+
+
◆
+
+
+
+
+
+ column_t xlnt::cell::column (
+ )
+ const
+
+
+
+
+
Returns the column of this cell.
+
+
+
+
+
◆
+
+
+
+
+
Returns the numeric index (A == 1) of the column of this cell.
+
+
+
+
+
◆ [1/4]
+
+
+
+
+
+ class comment xlnt::cell::comment
+ (
+ )
+
+
+
+
+
Gets the comment applied to this cell.
+
+
+
+
+
◆ [2/4]
+
+
+
+
+
+ void xlnt::cell::comment
+ (
+ const std::string &
+ text ,
+
+ const std::string &
+ author = "Microsoft Office User"
+
+ )
+
+
+
+
+
Creates a new comment with the given text and optional author and applies it to the cell.
+
+
+
+
+
◆ [3/4]
+
+
+
+
+
+ void xlnt::cell::comment
+ (
+ const std::string &
+ comment_text ,
+
+ const class font &
+ comment_font ,
+
+ const std::string &
+ author = "Microsoft Office User"
+
+ )
+
+
+
+
+
Creates a new comment with the given text, formatting, and optional author and applies it to the cell.
+
+
+
+
+
◆ [4/4]
+
+
+
+
+
+ void xlnt::cell::comment
+ (
+ const class comment &
+ new_comment )
+
+
+
+
+
Apply the comment provided as the only argument to the cell.
+
+
+
+
+
◆
+
+
+
+
+
+ class alignment xlnt::cell::computed_alignment
+ (
+ )
+ const
+
+
+
+
+
Returns the alignment that should be used when displaying this cell graphically based on the workbook default, the cell-level format, and the named style applied to the cell in that order.
+
+
+
+
+
◆
+
+
+
+
+
+ class border xlnt::cell::computed_border
+ (
+ )
+ const
+
+
+
+
+
Returns the border that should be used when displaying this cell graphically based on the workbook default, the cell-level format, and the named style applied to the cell in that order.
+
+
+
+
+
◆
+
+
+
+
+
+ class fill xlnt::cell::computed_fill
+ (
+ )
+ const
+
+
+
+
+
Returns the fill that should be used when displaying this cell graphically based on the workbook default, the cell-level format, and the named style applied to the cell in that order.
+
+
+
+
+
◆
+
+
+
+
+
+ class font xlnt::cell::computed_font
+ (
+ )
+ const
+
+
+
+
+
Returns the font that should be used when displaying this cell graphically based on the workbook default, the cell-level format, and the named style applied to the cell in that order.
+
+
+
+
+
◆
+
+
+
+
+
+ class number_format xlnt::cell::computed_number_format
+ (
+ )
+ const
+
+
+
+
+
Returns the number format that should be used when displaying this cell graphically based on the workbook default, the cell-level format, and the named style applied to the cell in that order.
+
+
+
+
+
◆
+
+
+
+
+
+ class protection xlnt::cell::computed_protection
+ (
+ )
+ const
+
+
+
+
+
Returns the protection that should be used when displaying this cell graphically based on the workbook default, the cell-level format, and the named style applied to the cell in that order.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ type xlnt::cell::data_type (
+ )
+ const
+
+
+
+
+
Returns the type of this cell.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::cell::data_type
+ (
+ type t )
+
+
+
+
+
Sets the type of this cell. This should usually be done indirectly by setting the value of the cell to a value of that type.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ std::string xlnt::cell::error
+ (
+ )
+ const
+
+
+
+
+
Returns the error string that is stored in this cell.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::cell::error
+ (
+ const std::string &
+ error )
+
+
+
+
+
Directly assigns the value of this cell to be the given error.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static const std::unordered_map<std::string, int>& xlnt::cell::error_codes
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Returns a map of error strings such as #DIV/0! and their associated indices.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ class fill xlnt::cell::fill
+ (
+ )
+ const
+
+
+
+
+
Returns the fill applied to this cell.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::cell::fill
+ (
+ const class fill &
+ fill_ )
+
+
+
+
+
Creates a new format in the workbook, sets its fill to the given fill, and applies the format to this cell.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ class font xlnt::cell::font
+ (
+ )
+ const
+
+
+
+
+
Returns the font applied to the text in this cell.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::cell::font
+ (
+ const class font &
+ font_ )
+
+
+
+
+
Creates a new format in the workbook, sets its font to the given font, and applies the format to this cell.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ const class format xlnt::cell::format
+ (
+ )
+ const
+
+
+
+
+
Returns the format applied to this cell. If this cell has no format, an invalid_attribute exception will be thrown.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::cell::format
+ (
+ const class format
+ new_format )
+
+
+
+
+
Applies the cell-level formatting of new_format to this cell.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ std::string xlnt::cell::formula
+ (
+ )
+ const
+
+
+
+
+
Returns the string representation of the formula applied to this cell.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::cell::formula
+ (
+ const std::string &
+ formula )
+
+
+
+
+
Sets the formula of this cell to the given value. This formula string should begin with '='.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::cell::garbage_collectible
+ (
+ )
+ const
+
+
+
+
+
There's no reason to keep a cell which has no value and is not a placeholder. Returns true if this cell has no value, style, isn't merged, etc.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::cell::has_comment
+ (
+ )
+
+
+
+
+
Returns true if this cell has a comment applied.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::cell::has_format
+ (
+ )
+ const
+
+
+
+
+
Returns true if this cell has had a format applied to it.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::cell::has_formula
+ (
+ )
+ const
+
+
+
+
+
Returns true if this cell has had a formula applied to it.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::cell::has_hyperlink
+ (
+ )
+ const
+
+
+
+
+
Returns true if this cell has a hyperlink set.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::cell::has_style
+ (
+ )
+ const
+
+
+
+
+
Returns true if this cell has had a style applied to it.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::cell::has_value
+ (
+ )
+ const
+
+
+
+
+
+
◆
+
+
+
+
+
+ double xlnt::cell::height
+ (
+ )
+ const
+
+
+
+
+
Returns the height of this cell in pixels.
+
+
+
+
+
◆ [1/4]
+
+
+
+
+
+ class hyperlink xlnt::cell::hyperlink
+ (
+ )
+ const
+
+
+
+
+
Returns the relationship of this cell's hyperlink.
+
+
+
+
+
◆ [2/4]
+
+
+
+
+
+ void xlnt::cell::hyperlink
+ (
+ const std::string &
+ url ,
+
+ const std::string &
+ display = ""
+
+ )
+
+
+
+
+
Adds a hyperlink to this cell pointing to the URI of the given value and sets the text value of the cell to the given parameter.
+
+
+
+
+
◆ [3/4]
+
+
+
+
+
+ void xlnt::cell::hyperlink
+ (
+ xlnt::cell target ,
+
+ const std::string &
+ display = ""
+
+ )
+
+
+
+
+
Adds an internal hyperlink to this cell pointing to the given cell.
+
+
+
+
+
◆ [4/4]
+
+
+
+
+
+ void xlnt::cell::hyperlink
+ (
+ xlnt::range target ,
+
+ const std::string &
+ display = ""
+
+ )
+
+
+
+
+
Adds an internal hyperlink to this cell pointing to the given range.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::cell::is_date
+ (
+ )
+ const
+
+
+
+
+
Returns true iff this cell's number format matches a date format.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::cell::is_merged
+ (
+ )
+ const
+
+
+
+
+
Returns true iff this cell has been merged with one or more surrounding cells.
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::cell::merged
+ (
+ bool
+ merged )
+
+
+
+
+
Makes this a merged cell iff merged is true. Generally, this shouldn't be called directly. Instead, use worksheet::merge_cells on its parent worksheet.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ class number_format xlnt::cell::number_format
+ (
+ )
+ const
+
+
+
+
+
Returns the number format of this cell.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::cell::number_format
+ (
+ const class number_format &
+ format )
+
+
+
+
+
Creates a new format in the workbook, sets its number_format to the given format, and applies the format to this cell.
+
+
+
+
+
◆
+
+
+
+
+
+ cell xlnt::cell::offset (
+ int
+ column ,
+
+ int
+ row
+
+ )
+
+
+
+
+
Returns a cell from this cell's parent workbook at a relative offset given by the parameters.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::cell::operator!=
+ (
+ const cell &
+ comparand )
+ const
+
+
+
+
+
Returns false if this cell the same cell as comparand (compared by reference).
+
+
+
+
+
◆
+
+
+
+
+
+ cell & xlnt::cell::operator= (
+ const cell &
+ rhs )
+
+
+
+
+
Makes this cell interally point to rhs. The cell data originally pointed to by this cell will be unchanged.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::cell::operator==
+ (
+ const cell &
+ comparand )
+ const
+
+
+
+
+
Returns true if this cell the same cell as comparand (compared by reference).
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::cell::phonetics_visible
+ (
+ )
+ const
+
+
+
+
+
Returns true if this cell is set to show phonetic information.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ class protection xlnt::cell::protection
+ (
+ )
+ const
+
+
+
+
+
Returns the protection of this cell.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::cell::protection
+ (
+ const class protection &
+ protection_ )
+
+
+
+
+
Creates a new format in the workbook, sets its protection to the given protection, and applies the format to this cell.
+
+
+
+
+
◆
+
+
+
+
+
Returns a cell_reference that points to the location of this cell.
+
+
+
+
+
◆
+
+
+
+
+
+ row_t xlnt::cell::row (
+ )
+ const
+
+
+
+
+
Returns the row of this cell.
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::cell::show_phonetics
+ (
+ bool
+ phonetics )
+
+
+
+
+
Enables the display of phonetic information on this cell.
+
+
+
+
+
◆ [1/4]
+
+
+
+
+
+ class style xlnt::cell::style
+ (
+ )
+
+
+
+
+
Returns a wrapper pointing to the named style applied to this cell.
+
+
+
+
+
◆ [2/4]
+
+
+
+
+
+ const class style xlnt::cell::style
+ (
+ )
+ const
+
+
+
+
+
Returns a wrapper pointing to the named style applied to this cell.
+
+
+
+
+
◆ [3/4]
+
+
+
+
+
+ void xlnt::cell::style
+ (
+ const class style &
+ new_style )
+
+
+
+
+
Sets the named style applied to this cell to a style named style_name. Equivalent to style(new_style.name()).
+
+
+
+
+
◆ [4/4]
+
+
+
+
+
+ void xlnt::cell::style
+ (
+ const std::string &
+ style_name )
+
+
+
+
+
Sets the named style applied to this cell to a style named style_name. If this style has not been previously created in the workbook, a key_not_found exception will be thrown.
+
+
+
+
+
◆
+
+
+
+
+
+ std::string xlnt::cell::to_string
+ (
+ )
+ const
+
+
+
+
+
Returns a string representing the value of this cell. If the data type is not a string, it will be converted according to the number format.
+
+
+
+
+
◆ [1/18]
+
+
+
+
+template<typename T >
+
+
+ T xlnt::cell::value
+ (
+ )
+ const
+
+
+
+
+
Returns the value of this cell as an instance of type T. Overloads exist for most C++ fundamental types like bool, int, etc. as well as for std::string and xlnt datetime types: date, time, datetime, and timedelta.
+
+
+
+
+
◆ [2/18]
+
+
+
+
+
+ void xlnt::cell::value
+ (
+ std::nullptr_t
+ )
+
+
+
+
+
Sets the type of this cell to null.
+
+
+
+
+
◆ [3/18]
+
+
+
+
+
+ void xlnt::cell::value
+ (
+ bool
+ boolean_value )
+
+
+
+
+
Sets the value of this cell to the given boolean value.
+
+
+
+
+
◆ [4/18]
+
+
+
+
+
+ void xlnt::cell::value
+ (
+ int
+ int_value )
+
+
+
+
+
Sets the value of this cell to the given value.
+
+
+
+
+
◆ [5/18]
+
+
+
+
+
+ void xlnt::cell::value
+ (
+ unsigned int
+ int_value )
+
+
+
+
+
Sets the value of this cell to the given value.
+
+
+
+
+
◆ [6/18]
+
+
+
+
+
+ void xlnt::cell::value
+ (
+ long long int
+ int_value )
+
+
+
+
+
Sets the value of this cell to the given value.
+
+
+
+
+
◆ [7/18]
+
+
+
+
+
+ void xlnt::cell::value
+ (
+ unsigned long long int
+ int_value )
+
+
+
+
+
Sets the value of this cell to the given value.
+
+
+
+
+
◆ [8/18]
+
+
+
+
+
+ void xlnt::cell::value
+ (
+ float
+ float_value )
+
+
+
+
+
Sets the value of this cell to the given value.
+
+
+
+
+
◆ [9/18]
+
+
+
+
+
+ void xlnt::cell::value
+ (
+ double
+ float_value )
+
+
+
+
+
Sets the value of this cell to the given value.
+
+
+
+
+
◆ [10/18]
+
+
+
+
+
+ void xlnt::cell::value
+ (
+ const date &
+ date_value )
+
+
+
+
+
Sets the value of this cell to the given value.
+
+
+
+
+
◆ [11/18]
+
+
+
+
+
+ void xlnt::cell::value
+ (
+ const time &
+ time_value )
+
+
+
+
+
Sets the value of this cell to the given value.
+
+
+
+
+
◆ [12/18]
+
+
+
+
+
+ void xlnt::cell::value
+ (
+ const datetime &
+ datetime_value )
+
+
+
+
+
Sets the value of this cell to the given value.
+
+
+
+
+
◆ [13/18]
+
+
+
+
+
+ void xlnt::cell::value
+ (
+ const timedelta &
+ timedelta_value )
+
+
+
+
+
Sets the value of this cell to the given value.
+
+
+
+
+
◆ [14/18]
+
+
+
+
+
+ void xlnt::cell::value
+ (
+ const std::string &
+ string_value )
+
+
+
+
+
Sets the value of this cell to the given value.
+
+
+
+
+
◆ [15/18]
+
+
+
+
+
+ void xlnt::cell::value
+ (
+ const char *
+ string_value )
+
+
+
+
+
Sets the value of this cell to the given value.
+
+
+
+
+
◆ [16/18]
+
+
+
+
+
+ void xlnt::cell::value
+ (
+ const rich_text &
+ text_value )
+
+
+
+
+
Sets the value of this cell to the given value.
+
+
+
+
+
◆ [17/18]
+
+
+
+
+
+ void xlnt::cell::value
+ (
+ const cell
+ other_cell )
+
+
+
+
+
Sets the value and formatting of this cell to that of other_cell.
+
+
+
+
+
◆ [18/18]
+
+
+
+
+
+ void xlnt::cell::value
+ (
+ const std::string &
+ string_value ,
+
+ bool
+ infer_type
+
+ )
+
+
+
+
+
Analyzes string_value to determine its type, convert it to that type, and set the value of this cell to that converted value.
+
+
+
+
+
◆
+
+
+
+
+
+ double xlnt::cell::width
+ (
+ )
+ const
+
+
+
+
+
Returns the width of this cell in pixels.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ class workbook & xlnt::cell::workbook
+ (
+ )
+
+
+
+
+
Returns the workbook of the worksheet that owns this cell.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ const class workbook & xlnt::cell::workbook
+ (
+ )
+ const
+
+
+
+
+
Returns the workbook of the worksheet that owns this cell.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ const class worksheet xlnt::cell::worksheet
+ (
+ )
+ const
+
+
+
+
+
Returns the worksheet that owns this cell.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ class worksheet xlnt::cell::worksheet
+ (
+ )
+
+
+
+
+
Returns the worksheet that owns this cell.
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::cell_iterator , including all inherited members.
+
xlnt: xlnt::cell_iterator Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
A cell iterator iterates over a 1D range by row or by column.
+ More...
+
+
#include <cell_iterator.hpp >
+
+using iterator_category = std::bidirectional_iterator_tag iterator tags required for use with standard algorithms and adapters More... value_type = cell difference_type = std::ptrdiff_t pointer = cell * reference = cell
+
+
A cell iterator iterates over a 1D range by row or by column.
+
+
+
◆
+
+
+
+
+
iterator tags required for use with standard algorithms and adapters
+
+
+
+
+
+
◆ [1/4]
+
+
+
+
+
+
+
+
+ xlnt::cell_iterator::cell_iterator
+ (
+ )
+
+
+
+
+default
+
+
+
+
+
+
◆ [2/4]
+
+
+
+
+
+ xlnt::cell_iterator::cell_iterator
+ (
+ worksheet ws ,
+
+ const cell_reference &
+ start_cell ,
+
+ const range_reference &
+ limits ,
+
+ major_order order ,
+
+ bool
+ skip_null ,
+
+ bool
+ wrap
+
+ )
+
+
+
+
+
Constructs a cell_iterator from a worksheet, range, and iteration settings.
+
+
+
+
+
◆ [3/4]
+
+
+
+
+
+
+
+
+ xlnt::cell_iterator::cell_iterator
+ (
+ const cell_iterator &
+ )
+
+
+
+
+default
+
+
+
+
+
+
◆ [4/4]
+
+
+
+
+
+
+
+
+ xlnt::cell_iterator::cell_iterator
+ (
+ cell_iterator && )
+
+
+
+
+default
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ xlnt::cell_iterator::~cell_iterator
+ (
+ )
+
+
+
+
+default
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::cell_iterator::has_value
+ (
+ )
+ const
+
+
+
+
+
When iterating over a range that doesn't ignore null cells, operator*() will throw when trying to access the cells that are null. This method checks the existence of a cell.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::cell_iterator::operator!=
+ (
+ const cell_iterator &
+ other )
+ const
+
+
+
+
+
Returns true if this iterator isn't equivalent to other.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ reference xlnt::cell_iterator::operator* (
+ )
+
+
+
+
+
Dereferences this iterator to return the cell it points to.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ const reference xlnt::cell_iterator::operator*
+ (
+ )
+ const
+
+
+
+
+
Dereferences this iterator to return the cell it points to.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Pre-increments the iterator to point to the previous cell and returns a reference to the iterator.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ cell_iterator xlnt::cell_iterator::operator++ (
+ int
+ )
+
+
+
+
+
Post-increments the iterator to point to the previous cell and return a copy of the iterator before the decrement.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Pre-decrements the iterator to point to the previous cell and returns a reference to the iterator.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ cell_iterator xlnt::cell_iterator::operator-- (
+ int
+ )
+
+
+
+
+
Post-decrements the iterator to point to the previous cell and return a copy of the iterator before the decrement.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Assigns this iterator to match the data in rhs.
+
+
+
+
+
◆ [2/2]
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::cell_iterator::operator==
+ (
+ const cell_iterator &
+ other )
+ const
+
+
+
+
+
Returns true if this iterator is equivalent to other.
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::cell_reference , including all inherited members.
+
xlnt: xlnt::cell_reference Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
An object used to refer to a cell. References have two parts, the column and the row. In Excel, the reference string A1 refers to the top-left-most cell. A cell_reference can be initialized from a string of this form or a 1-indexed ordered pair of the form column, row.
+ More...
+
+
#include <cell_reference.hpp >
+
+ cell_reference () Default constructor makes a reference to the top-left-most cell, "A1". More... cell_reference (const char *reference_string) Constructs a cell_reference from a string reprenting a cell coordinate (e.g. $B14). More... cell_reference (const std::string &reference_string) Constructs a cell_reference from a string reprenting a cell coordinate (e.g. $B14). More... cell_reference (column_t column , row_t row ) Constructs a cell_reference from a 1-indexed column index and row index. More... cell_reference & make_absolute (bool absolute_column=true, bool absolute_row=true) Converts a coordinate to an absolute coordinate string (e.g. B12 -> $B$12) Defaulting to true, absolute_column and absolute_row can optionally control whether the resulting cell_reference has an absolute column (e.g. B12 -> $B12) and absolute row (e.g. B12 -> B$12) respectively. More... bool column_absolute () const Returns true if the reference refers to an absolute column, otherwise false. More... void column_absolute (bool absolute_column) Makes this reference have an absolute column if absolute_column is true, otherwise not absolute. More... bool row_absolute () const Returns true if the reference refers to an absolute row, otherwise false. More... void row_absolute (bool absolute_row) Makes this reference have an absolute row if absolute_row is true, otherwise not absolute. More... column_t column () const Returns a string that identifies the column of this reference (e.g. second column from left is "B") More... void column (const std::string &column_string) Sets the column of this reference from a string that identifies a particular column. More... column_t::index_t column_index () const Returns a 1-indexed numeric index of the column of this reference. More... void column_index (column_t column ) Sets the column of this reference from a 1-indexed number that identifies a particular column. More... row_t row () const Returns a 1-indexed numeric index of the row of this reference. More... void row (row_t row) Sets the row of this reference from a 1-indexed number that identifies a particular row. More... cell_reference make_offset (int column_offset, int row_offset) const Returns a cell_reference offset from this cell_reference by the number of columns and rows specified by the parameters. A negative value for column_offset or row_offset results in a reference above or left of this cell_reference , respectively. More... std::string to_string () const Returns a string like "A1" for cell_reference(1, 1). More... range_reference to_range () const Returns a 1x1 range_reference containing only this cell_reference . More... range_reference operator, (const cell_reference &other) const I've always wanted to overload the comma operator. cell_reference ("A", 1), cell_reference ("B", 1) will return range_reference (cell_reference ("A", 1), cell_reference ("B", 1)) More... bool operator== (const cell_reference &comparand) const Returns true if this reference is identical to comparand including in absoluteness of column and row. More... bool operator== (const std::string &reference_string) const Constructs a cell_reference from reference_string and return the result of their comparison. More... bool operator== (const char *reference_string) const Constructs a cell_reference from reference_string and return the result of their comparison. More... bool operator!= (const cell_reference &comparand) const Returns true if this reference is not identical to comparand including in absoluteness of column and row. More... bool operator!= (const std::string &reference_string) const Constructs a cell_reference from reference_string and return the result of their comparison. More... bool operator!= (const char *reference_string) const Constructs a cell_reference from reference_string and return the result of their comparison. More...
+static std::pair< std::string, row_t > split_reference (const std::string &reference_string) Splits a coordinate string like "A1" into an equivalent pair like {"A", 1}. More... static std::pair< std::string, row_t > split_reference (const std::string &reference_string, bool &absolute_column, bool &absolute_row) Splits a coordinate string like "A1" into an equivalent pair like {"A", 1}. Reference parameters absolute_column and absolute_row will be set to true if column part or row part are prefixed by a dollar-sign indicating they are absolute, otherwise false. More...
+
+
An object used to refer to a cell. References have two parts, the column and the row. In Excel, the reference string A1 refers to the top-left-most cell. A cell_reference can be initialized from a string of this form or a 1-indexed ordered pair of the form column, row.
+
+
+
◆ [1/4]
+
+
+
+
+
+ xlnt::cell_reference::cell_reference
+ (
+ )
+
+
+
+
+
Default constructor makes a reference to the top-left-most cell, "A1".
+
+
+
+
+
◆ [2/4]
+
+
+
+
+
+ xlnt::cell_reference::cell_reference
+ (
+ const char *
+ reference_string )
+
+
+
+
+
Constructs a cell_reference from a string reprenting a cell coordinate (e.g. $B14).
+
+
+
+
+
◆ [3/4]
+
+
+
+
+
+ xlnt::cell_reference::cell_reference
+ (
+ const std::string &
+ reference_string )
+
+
+
+
+
Constructs a cell_reference from a string reprenting a cell coordinate (e.g. $B14).
+
+
+
+
+
◆ [4/4]
+
+
+
+
+
+ xlnt::cell_reference::cell_reference
+ (
+ column_t column ,
+
+ row_t row
+
+ )
+
+
+
+
+
Constructs a cell_reference from a 1-indexed column index and row index.
+
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ column_t xlnt::cell_reference::column (
+ )
+ const
+
+
+
+
+
Returns a string that identifies the column of this reference (e.g. second column from left is "B")
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::cell_reference::column
+ (
+ const std::string &
+ column_string )
+
+
+
+
+
Sets the column of this reference from a string that identifies a particular column.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ bool xlnt::cell_reference::column_absolute
+ (
+ )
+ const
+
+
+
+
+
Returns true if the reference refers to an absolute column, otherwise false.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::cell_reference::column_absolute
+ (
+ bool
+ absolute_column )
+
+
+
+
+
Makes this reference have an absolute column if absolute_column is true, otherwise not absolute.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Returns a 1-indexed numeric index of the column of this reference.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::cell_reference::column_index
+ (
+ column_t column )
+
+
+
+
+
Sets the column of this reference from a 1-indexed number that identifies a particular column.
+
+
+
+
+
◆
+
+
+
+
+
+ cell_reference & xlnt::cell_reference::make_absolute (
+ bool
+ absolute_column = true,
+
+ bool
+ absolute_row = true
+
+ )
+
+
+
+
+
Converts a coordinate to an absolute coordinate string (e.g. B12 -> $B$12) Defaulting to true, absolute_column and absolute_row can optionally control whether the resulting cell_reference has an absolute column (e.g. B12 -> $B12) and absolute row (e.g. B12 -> B$12) respectively.
+
This is functionally equivalent to: cell_reference copy(*this); copy.column_absolute(absolute_column); copy.row_absolute(absolute_row); return copy;
+
+
+
+
+
◆
+
+
+
+
+
+ cell_reference xlnt::cell_reference::make_offset (
+ int
+ column_offset ,
+
+ int
+ row_offset
+
+ )
+ const
+
+
+
+
+
Returns a cell_reference offset from this cell_reference by the number of columns and rows specified by the parameters. A negative value for column_offset or row_offset results in a reference above or left of this cell_reference , respectively.
+
+
+
+
+
◆ [1/3]
+
+
+
+
+
+ bool xlnt::cell_reference::operator!=
+ (
+ const cell_reference &
+ comparand )
+ const
+
+
+
+
+
Returns true if this reference is not identical to comparand including in absoluteness of column and row.
+
+
+
+
+
◆ [2/3]
+
+
+
+
+
+ bool xlnt::cell_reference::operator!=
+ (
+ const std::string &
+ reference_string )
+ const
+
+
+
+
+
Constructs a cell_reference from reference_string and return the result of their comparison.
+
+
+
+
+
◆ [3/3]
+
+
+
+
+
+ bool xlnt::cell_reference::operator!=
+ (
+ const char *
+ reference_string )
+ const
+
+
+
+
+
Constructs a cell_reference from reference_string and return the result of their comparison.
+
+
+
+
+
◆
+
+
+
+
◆ [1/3]
+
+
+
+
+
+ bool xlnt::cell_reference::operator==
+ (
+ const cell_reference &
+ comparand )
+ const
+
+
+
+
+
Returns true if this reference is identical to comparand including in absoluteness of column and row.
+
+
+
+
+
◆ [2/3]
+
+
+
+
+
+ bool xlnt::cell_reference::operator==
+ (
+ const std::string &
+ reference_string )
+ const
+
+
+
+
+
Constructs a cell_reference from reference_string and return the result of their comparison.
+
+
+
+
+
◆ [3/3]
+
+
+
+
+
+ bool xlnt::cell_reference::operator==
+ (
+ const char *
+ reference_string )
+ const
+
+
+
+
+
Constructs a cell_reference from reference_string and return the result of their comparison.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ row_t xlnt::cell_reference::row (
+ )
+ const
+
+
+
+
+
Returns a 1-indexed numeric index of the row of this reference.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::cell_reference::row
+ (
+ row_t row )
+
+
+
+
+
Sets the row of this reference from a 1-indexed number that identifies a particular row.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ bool xlnt::cell_reference::row_absolute
+ (
+ )
+ const
+
+
+
+
+
Returns true if the reference refers to an absolute row, otherwise false.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::cell_reference::row_absolute
+ (
+ bool
+ absolute_row )
+
+
+
+
+
Makes this reference have an absolute row if absolute_row is true, otherwise not absolute.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ static std::pair<std::string, row_t > xlnt::cell_reference::split_reference
+ (
+ const std::string &
+ reference_string )
+
+
+
+
+static
+
+
+
+
+
Splits a coordinate string like "A1" into an equivalent pair like {"A", 1}.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ static std::pair<std::string, row_t > xlnt::cell_reference::split_reference
+ (
+ const std::string &
+ reference_string ,
+
+ bool &
+ absolute_column ,
+
+ bool &
+ absolute_row
+
+ )
+
+
+
+
+static
+
+
+
+
+
Splits a coordinate string like "A1" into an equivalent pair like {"A", 1}. Reference parameters absolute_column and absolute_row will be set to true if column part or row part are prefixed by a dollar-sign indicating they are absolute, otherwise false.
+
+
+
+
+
◆
+
+
+
+
◆
+
+
+
+
+
+ std::string xlnt::cell_reference::to_string
+ (
+ )
+ const
+
+
+
+
+
Returns a string like "A1" for cell_reference(1, 1).
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::cell_vector , including all inherited members.
+
xlnt: xlnt::cell_vector Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
A cell vector is a linear (1D) range of cells, either vertical or horizontal depending on the major order specified in the constructor.
+ More...
+
+
#include <cell_vector.hpp >
+
+
+
A cell vector is a linear (1D) range of cells, either vertical or horizontal depending on the major order specified in the constructor.
+
+
+
◆
+
+
+
+
+
Iterate over const cells in a const cell_vector with an iterator of this type.
+
+
+
+
+
◆
+
+
+
+
+
Iterate over const cells in a const cell_vector in reverse order with an iterator of this type.
+
+
+
+
+
◆
+
+
+
+
+
Iterate over cells in a cell_vector with an iterator of this type.
+
+
+
+
+
◆
+
+
+
+
+
Iterate over cells in a cell_vector in reverse oreder with an iterator of this type.
+
+
+
+
+
+
◆
+
+
+
+
+
Constructs a cell vector pointing to a given range in a given worksheet. order determines whether this vector is a row or a column. If skip_null is true, iterating over this vector will skip empty cells.
+
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ cell xlnt::cell_vector::back (
+ )
+
+
+
+
+
Returns the last cell in this vector.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ const cell xlnt::cell_vector::back
+ (
+ )
+ const
+
+
+
+
+
Returns the last cell in this vector.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ iterator xlnt::cell_vector::begin (
+ )
+
+
+
+
+
Returns an iterator to the first cell in this vector.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Returns an iterator to the first cell in this vector.
+
+
+
+
+
◆
+
+
+
+
+
Returns an iterator to the first cell in this vector.
+
+
+
+
+
◆
+
+
+
+
+
Returns an iterator to a cell one-past-the-end of this vector.
+
+
+
+
+
◆
+
+
+
+
+
Returns a reverse iterator to the first cell of this reversed vector.
+
+
+
+
+
◆
+
+
+
+
+
Returns a reverse iterator to to a cell one-past-the-end of this reversed vector.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::cell_vector::empty
+ (
+ )
+ const
+
+
+
+
+
Returns true if every cell in this vector is null (i.e. the cell doesn't exist in the worksheet).
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ iterator xlnt::cell_vector::end (
+ )
+
+
+
+
+
Returns an iterator to a cell one-past-the-end of this vector.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Returns an iterator to a cell one-past-the-end of this vector.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ cell xlnt::cell_vector::front (
+ )
+
+
+
+
+
Returns the first cell in this vector.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ const cell xlnt::cell_vector::front
+ (
+ )
+ const
+
+
+
+
+
Returns the first cell in this vector.
+
+
+
+
+
◆
+
+
+
+
+
+ std::size_t xlnt::cell_vector::length
+ (
+ )
+ const
+
+
+
+
+
Returns the distance between the first and last cells in this vector.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ cell xlnt::cell_vector::operator[] (
+ std::size_t
+ column_index )
+
+
+
+
+
Returns the cell column_index distance away from the first cell in this vector.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ const cell xlnt::cell_vector::operator[]
+ (
+ std::size_t
+ column_index )
+ const
+
+
+
+
+
Returns the cell column_index distance away from the first cell in this vector.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Returns a reverse iterator to the first cell of this reversed vector.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Returns a reverse iterator to the first cell of this reversed vector.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Returns a reverse iterator to to a cell one-past-the-end of this reversed vector.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Returns a reverse iterator to to a cell one-past-the-end of this reversed vector.
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::color , including all inherited members.
+
xlnt: xlnt::color Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Colors can be applied to many parts of a cell's style.
+ More...
+
+
#include <color.hpp >
+
+
+
Colors can be applied to many parts of a cell's style.
+
+
+
◆ [1/4]
+
+
+
+
+
+ xlnt::color::color
+ (
+ )
+
+
+
+
+
Constructs a default color
+
+
+
+
+
◆ [2/4]
+
+
+
+
+
+ xlnt::color::color
+ (
+ const rgb_color &
+ rgb )
+
+
+
+
+
Constructs a color from a given RGB color
+
+
+
+
+
◆ [3/4]
+
+
+
+
+
+ xlnt::color::color
+ (
+ const indexed_color &
+ indexed )
+
+
+
+
+
Constructs a color from a given indexed color
+
+
+
+
+
◆ [4/4]
+
+
+
+
+
+ xlnt::color::color
+ (
+ const theme_color &
+ theme )
+
+
+
+
+
Constructs a color from a given theme color
+
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ bool xlnt::color::auto_
+ (
+ )
+ const
+
+
+
+
+
Returns true if this color has been set to auto
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::color::auto_
+ (
+ bool
+ value )
+
+
+
+
+
Sets the auto property of this color to value
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static const color xlnt::color::black
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Returns the color #000000
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static const color xlnt::color::blue
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Returns the color #00ff00
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static const color xlnt::color::darkblue
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Returns the color #008b00
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static const color xlnt::color::darkgreen
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Returns the color #00008b
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static const color xlnt::color::darkred
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Returns the color #8b0000
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static const color xlnt::color::darkyellow
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Returns the color #cccc00
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static const color xlnt::color::green
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Returns the color #0000ff
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::color::has_tint
+ (
+ )
+ const
+
+
+
+
+
Returns true if tint is set
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ const indexed_color & xlnt::color::indexed
+ (
+ )
+ const
+
+
+
+
+
Returns the internal indexed color representing this color. If this is not an indexed color, an invalid_attribute exception will be thrown.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Returns the internal indexed color representing this color. If this is not an indexed color, an invalid_attribute exception will be thrown.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::color::operator!=
+ (
+ const color &
+ other )
+ const
+
+
+
+
+
Returns true if this color is not equivalent to other
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::color::operator==
+ (
+ const color &
+ other )
+ const
+
+
+
+
+
Returns true if this color is equivalent to other
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static const color xlnt::color::red
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Returns the color #ff0000
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ const rgb_color & xlnt::color::rgb
+ (
+ )
+ const
+
+
+
+
+
Returns the internal indexed color representing this color. If this is not an RGB color, an invalid_attribute exception will be thrown.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ rgb_color & xlnt::color::rgb (
+ )
+
+
+
+
+
Returns the internal indexed color representing this color. If this is not an RGB color, an invalid_attribute exception will be thrown.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ const theme_color & xlnt::color::theme
+ (
+ )
+ const
+
+
+
+
+
Returns the internal indexed color representing this color. If this is not a theme color, an invalid_attribute exception will be thrown.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Returns the internal indexed color representing this color. If this is not a theme color, an invalid_attribute exception will be thrown.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ double xlnt::color::tint
+ (
+ )
+ const
+
+
+
+
+
Returns the tint of this color.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::color::tint
+ (
+ double
+ tint )
+
+
+
+
+
Sets the tint of this color to tint. Tints lighten or darken an existing color by multiplying the color with the tint.
+
+
+
+
+
◆
+
+
+
+
+
+ color_type xlnt::color::type (
+ )
+ const
+
+
+
+
+
Returns the type of this color
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static const color xlnt::color::white
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Returns the color #ffffff
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static const color xlnt::color::yellow
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Returns the color #ffff00
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::column_properties , including all inherited members.
+
xlnt: xlnt::column_properties Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Properties applied to a column in a worksheet. Columns can have a size and a style.
+ More...
+
+
#include <column_properties.hpp >
+
+optional < double > width The optional width of the column More... bool custom_width = false If true, this is a custom width More... optional < std::size_t > style The style index of this column. This shouldn't be used since style indices aren't supposed to be used directly in xlnt. (TODO) More... bool best_fit = false Is this column sized to fit its content as best it can serialise if true More... bool hidden = false If true, this column will be hidden More...
+
+
Properties applied to a column in a worksheet. Columns can have a size and a style.
+
+
+
◆
+
+
+
+
+
+ bool xlnt::column_properties::best_fit = false
+
+
+
+
+
Is this column sized to fit its content as best it can serialise if true
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::column_properties::custom_width = false
+
+
+
+
+
If true, this is a custom width
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::column_properties::hidden = false
+
+
+
+
+
If true, this column will be hidden
+
+
+
+
+
◆
+
+
+
+
+
+ optional <std::size_t> xlnt::column_properties::style
+
+
+
+
The style index of this column. This shouldn't be used since style indices aren't supposed to be used directly in xlnt. (TODO)
+
+
+
+
+
◆
+
+
+
+
+
+ optional <double> xlnt::column_properties::width
+
+
+
+
The optional width of the column
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::column_t , including all inherited members.
+
xlnt: xlnt::column_t Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Columns can be referred to as a string A,B,...Z,AA,AB,..,ZZ,AAA,...,ZZZ or as a 1-indexed index. This class encapsulates both of these forms of column referencing and allows for conversions between them.
+ More...
+
+
#include <index_types.hpp >
+
+using index_t = std::uint32_t Alias declaration for the internal numeric type of this column. More...
+
+
Columns can be referred to as a string A,B,...Z,AA,AB,..,ZZ,AAA,...,ZZZ or as a 1-indexed index. This class encapsulates both of these forms of column referencing and allows for conversions between them.
+
+
+
◆
+
+
+
+
+
Alias declaration for the internal numeric type of this column.
+
+
+
+
+
+
◆ [1/4]
+
+
+
+
+
+ xlnt::column_t::column_t
+ (
+ )
+
+
+
+
+
Default constructor. The column points to the "A" column.
+
+
+
+
+
◆ [2/4]
+
+
+
+
+
+ xlnt::column_t::column_t
+ (
+ index_t column_index )
+
+
+
+
+
Constructs a column from a number.
+
+
+
+
+
◆ [3/4]
+
+
+
+
+
+ xlnt::column_t::column_t
+ (
+ const std::string &
+ column_string )
+
+
+
+
+
Constructs a column from a string.
+
+
+
+
+
◆ [4/4]
+
+
+
+
+
+ xlnt::column_t::column_t
+ (
+ const char *
+ column_string )
+
+
+
+
+
Constructs a column from a string.
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static index_t xlnt::column_t::column_index_from_string
+ (
+ const std::string &
+ column_string )
+
+
+
+
+static
+
+
+
+
+
Convert a column letter into a column number (e.g. B -> 2)
+
Excel only supports 1 - 3 letter column names from A->ZZZ, so we restrict our column names to 1 - 3 characters, each in the range A - Z. Strings outside this range and malformed strings will throw column_string_index_exception.
+
+
+
+
+
◆
+
+
+
+
+
+ std::string xlnt::column_t::column_string
+ (
+ )
+ const
+
+
+
+
+
Returns a string representation of this column index.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static std::string xlnt::column_t::column_string_from_index
+ (
+ index_t column_index )
+
+
+
+
+static
+
+
+
+
+
Convert a column number into a column letter (3 -> 'C')
+
Right shift the column, column_index, by 26 to find column letters in reverse order. These indices are 1-based, and can be converted to ASCII ordinals by adding 64.
+
+
+
+
+
◆ [1/5]
+
+
+
+
+
+ bool xlnt::column_t::operator!=
+ (
+ const column_t &
+ other )
+ const
+
+
+
+
+
Returns true if this column doesn't refer to the same column as other.
+
+
+
+
+
◆ [2/5]
+
+
+
+
+
+ bool xlnt::column_t::operator!=
+ (
+ int
+ other )
+ const
+
+
+
+
+
Returns true if this column doesn't refer to the same column as other.
+
+
+
+
+
◆ [3/5]
+
+
+
+
+
+ bool xlnt::column_t::operator!=
+ (
+ index_t other )
+ const
+
+
+
+
+
Returns true if this column doesn't refer to the same column as other.
+
+
+
+
+
◆ [4/5]
+
+
+
+
+
+ bool xlnt::column_t::operator!=
+ (
+ const std::string &
+ other )
+ const
+
+
+
+
+
Returns true if this column doesn't refer to the same column as other.
+
+
+
+
+
◆ [5/5]
+
+
+
+
+
+ bool xlnt::column_t::operator!=
+ (
+ const char *
+ other )
+ const
+
+
+
+
+
Returns true if this column doesn't refer to the same column as other.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ column_t & xlnt::column_t::operator++ (
+ )
+
+
+
+
+
Pre-increments this column, making it point to the column one to the right and returning a reference to it.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ column_t xlnt::column_t::operator++ (
+ int
+ )
+
+
+
+
+
Post-increments this column, making it point to the column one to the right and returning the old column.
+
+
+
+
+
◆
+
+
+
+
+
Adds rhs to this column and returns a reference to this column.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ column_t & xlnt::column_t::operator-- (
+ )
+
+
+
+
+
Pre-deccrements this column, making it point to the column one to the left and returning a reference to it.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ column_t xlnt::column_t::operator-- (
+ int
+ )
+
+
+
+
+
Post-decrements this column, making it point to the column one to the left and returning the old column.
+
+
+
+
+
◆
+
+
+
+
+
Subtracts rhs from this column and returns a reference to this column.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ bool xlnt::column_t::operator<
+ (
+ const column_t &
+ other )
+ const
+
+
+
+
+
Returns true if other is to the left of this column.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ bool xlnt::column_t::operator<
+ (
+ const column_t::index_t &
+ other )
+ const
+
+
+
+
+
Returns true if other is to the left of this column.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ bool xlnt::column_t::operator<=
+ (
+ const column_t &
+ other )
+ const
+
+
+
+
+
Returns true if other is to the left of or equal to this column.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ bool xlnt::column_t::operator<=
+ (
+ const column_t::index_t &
+ other )
+ const
+
+
+
+
+
Returns true if other is to the left of or equal to this column.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ column_t & xlnt::column_t::operator= (
+ const std::string &
+ rhs )
+
+
+
+
+
Sets this column to be equal to rhs and return reference to self.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ column_t & xlnt::column_t::operator= (
+ const char *
+ rhs )
+
+
+
+
+
Sets this column to be equal to rhs and return reference to self.
+
+
+
+
+
◆ [1/5]
+
+
+
+
+
+ bool xlnt::column_t::operator==
+ (
+ const column_t &
+ other )
+ const
+
+
+
+
+
Returns true if this column refers to the same column as other.
+
+
+
+
+
◆ [2/5]
+
+
+
+
+
+ bool xlnt::column_t::operator==
+ (
+ int
+ other )
+ const
+
+
+
+
+
Returns true if this column refers to the same column as other.
+
+
+
+
+
◆ [3/5]
+
+
+
+
+
+ bool xlnt::column_t::operator==
+ (
+ index_t other )
+ const
+
+
+
+
+
Returns true if this column refers to the same column as other.
+
+
+
+
+
◆ [4/5]
+
+
+
+
+
+ bool xlnt::column_t::operator==
+ (
+ const std::string &
+ other )
+ const
+
+
+
+
+
Returns true if this column refers to the same column as other.
+
+
+
+
+
◆ [5/5]
+
+
+
+
+
+ bool xlnt::column_t::operator==
+ (
+ const char *
+ other )
+ const
+
+
+
+
+
Returns true if this column refers to the same column as other.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ bool xlnt::column_t::operator>
+ (
+ const column_t &
+ other )
+ const
+
+
+
+
+
Returns true if other is to the right of this column.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ bool xlnt::column_t::operator>
+ (
+ const column_t::index_t &
+ other )
+ const
+
+
+
+
+
Returns true if other is to the right of this column.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ bool xlnt::column_t::operator>=
+ (
+ const column_t &
+ other )
+ const
+
+
+
+
+
Returns true if other is to the right of or equal to this column.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ bool xlnt::column_t::operator>=
+ (
+ const column_t::index_t &
+ other )
+ const
+
+
+
+
+
Returns true if other is to the right of or equal to this column.
+
+
+
+
+
+
◆
+
+
+
+
+
Returns the result of adding rhs to this column.
+
+
+
+
+
◆
+
+
+
+
+
Returns the result of subtracing lhs by rhs column.
+
+
+
+
+
◆
+
+
+
+
+
Returns true if other is to the left of this column.
+
+
+
+
+
◆
+
+
+
+
+
Returns true if other is to the left of or equal to this column.
+
+
+
+
+
◆
+
+
+
+
+
Returns true if other is to the right of this column.
+
+
+
+
+
◆
+
+
+
+
+
Returns true if other is to the right of or equal to this column.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void swap
+ (
+ column_t & left ,
+
+ column_t & right
+
+ )
+
+
+
+
+friend
+
+
+
+
+
Swaps the columns that left and right refer to.
+
+
+
+
+
+
◆
+
+
+
+
+
+ index_t xlnt::column_t::index
+
+
+
+
Internal numeric value of this column index.
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::comment , including all inherited members.
+
xlnt: xlnt::comment Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
A comment can be applied to a cell to provide extra information about its contents.
+ More...
+
+
#include <comment.hpp >
+
+ comment () Constructs a new blank comment. More... comment (const rich_text &text , const std::string &author ) Constructs a new comment with the given text and author. More... comment (const std::string &text , const std::string &author ) Constructs a new comment with the given unformatted text and author. More... rich_text text () const Returns the text that will be displayed for this comment. More... std::string plain_text () const Returns the plain text that will be displayed for this comment without formatting information. More... std::string author () const Returns the author of this comment. More... void hide () Makes this comment only visible when the associated cell is hovered. More... void show () Makes this comment always visible. More... bool visible () const Returns true if this comment is not hidden. More... void position (int left , int top ) Sets the absolute position of this cell to the given coordinates. More... int left () const Returns the distance from the left side of the sheet to the left side of the comment. More... int top () const Returns the distance from the top of the sheet to the top of the comment. More... void size (int width , int height ) Sets the size of the comment. More... int width () const Returns the width of this comment. More... int height () const Returns the height of this comment. More... bool operator== (const comment &other) const Return true if this comment is equivalent to other. More... bool operator!= (const comment &other) const Returns true if this comment is not equivalent to other. More...
+
+
A comment can be applied to a cell to provide extra information about its contents.
+
+
+
◆ [1/3]
+
+
+
+
+
+ xlnt::comment::comment
+ (
+ )
+
+
+
+
+
Constructs a new blank comment.
+
+
+
+
+
◆ [2/3]
+
+
+
+
+
+ xlnt::comment::comment
+ (
+ const rich_text &
+ text ,
+
+ const std::string &
+ author
+
+ )
+
+
+
+
+
Constructs a new comment with the given text and author.
+
+
+
+
+
◆ [3/3]
+
+
+
+
+
+ xlnt::comment::comment
+ (
+ const std::string &
+ text ,
+
+ const std::string &
+ author
+
+ )
+
+
+
+
+
Constructs a new comment with the given unformatted text and author.
+
+
+
+
+
+
◆
+
+
+
+
+
+ std::string xlnt::comment::author
+ (
+ )
+ const
+
+
+
+
+
Returns the author of this comment.
+
+
+
+
+
◆
+
+
+
+
+
+ int xlnt::comment::height
+ (
+ )
+ const
+
+
+
+
+
Returns the height of this comment.
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::comment::hide
+ (
+ )
+
+
+
+
+
Makes this comment only visible when the associated cell is hovered.
+
+
+
+
+
◆
+
+
+
+
+
+ int xlnt::comment::left
+ (
+ )
+ const
+
+
+
+
+
Returns the distance from the left side of the sheet to the left side of the comment.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::comment::operator!=
+ (
+ const comment &
+ other )
+ const
+
+
+
+
+
Returns true if this comment is not equivalent to other.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::comment::operator==
+ (
+ const comment &
+ other )
+ const
+
+
+
+
+
Return true if this comment is equivalent to other.
+
+
+
+
+
◆
+
+
+
+
+
+ std::string xlnt::comment::plain_text
+ (
+ )
+ const
+
+
+
+
+
Returns the plain text that will be displayed for this comment without formatting information.
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::comment::position
+ (
+ int
+ left ,
+
+ int
+ top
+
+ )
+
+
+
+
+
Sets the absolute position of this cell to the given coordinates.
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::comment::show
+ (
+ )
+
+
+
+
+
Makes this comment always visible.
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::comment::size
+ (
+ int
+ width ,
+
+ int
+ height
+
+ )
+
+
+
+
+
Sets the size of the comment.
+
+
+
+
+
◆
+
+
+
+
+
+ rich_text xlnt::comment::text (
+ )
+ const
+
+
+
+
+
Returns the text that will be displayed for this comment.
+
+
+
+
+
◆
+
+
+
+
+
+ int xlnt::comment::top
+ (
+ )
+ const
+
+
+
+
+
Returns the distance from the top of the sheet to the top of the comment.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::comment::visible
+ (
+ )
+ const
+
+
+
+
+
Returns true if this comment is not hidden.
+
+
+
+
+
◆
+
+
+
+
+
+ int xlnt::comment::width
+ (
+ )
+ const
+
+
+
+
+
Returns the width of this comment.
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::condition , including all inherited members.
+
xlnt: xlnt::condition Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+operator== (const condition &rhs) const
+condition text_starts_with (const std::string &start) condition text_ends_with (const std::string &end) condition text_contains (const std::string &start) condition text_does_not_contain (const std::string &start)
+detail::xlsx_producer
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::conditional_format , including all inherited members.
+
xlnt: xlnt::conditional_format Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Describes a conditional format that will be applied to all cells in the associated range that satisfy the condition. This can only be constructed using methods on worksheet or range.
+ More...
+
+
#include <conditional_format.hpp >
+
+detail::stylesheet detail::xlsx_consumer
+
+
Describes a conditional format that will be applied to all cells in the associated range that satisfy the condition. This can only be constructed using methods on worksheet or range.
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ xlnt::conditional_format::conditional_format
+ (
+ )
+
+
+
+
+delete
+
+
+
+
+
Delete zero-argument constructor
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ xlnt::conditional_format::conditional_format
+ (
+ const conditional_format &
+ other )
+
+
+
+
+default
+
+
+
+
+
Default copy constructor. Constructs a format using the same PIMPL as other.
+
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ class border xlnt::conditional_format::border
+ (
+ )
+ const
+
+
+
+
+
+
◆ [2/2]
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ class fill xlnt::conditional_format::fill
+ (
+ )
+ const
+
+
+
+
+
+
◆ [2/2]
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ class font xlnt::conditional_format::font
+ (
+ )
+ const
+
+
+
+
+
+
◆ [2/2]
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::conditional_format::has_border
+ (
+ )
+ const
+
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::conditional_format::has_fill
+ (
+ )
+ const
+
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::conditional_format::has_font
+ (
+ )
+ const
+
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::conditional_format::operator!=
+ (
+ const conditional_format &
+ other )
+ const
+
+
+
+
+
Returns true if this format is not equivalent to other.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::conditional_format::operator==
+ (
+ const conditional_format &
+ other )
+ const
+
+
+
+
+
Returns true if this format is equivalent to other.
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::const_cell_iterator , including all inherited members.
+
xlnt: xlnt::const_cell_iterator Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
A cell iterator iterates over a 1D range by row or by column.
+ More...
+
+
#include <cell_iterator.hpp >
+
+using iterator_category = std::bidirectional_iterator_tag iterator tags required for use with standard algorithms and adapters More... value_type = const cell difference_type = std::ptrdiff_t pointer = const cell * reference = const cell
+
+
A cell iterator iterates over a 1D range by row or by column.
+
+
+
◆
+
+
+
+
+
iterator tags required for use with standard algorithms and adapters
+
+
+
+
+
+
◆ [1/4]
+
+
+
+
+
+
+
+
+ xlnt::const_cell_iterator::const_cell_iterator
+ (
+ )
+
+
+
+
+default
+
+
+
+
+
+
◆ [2/4]
+
+
+
+
+
+ xlnt::const_cell_iterator::const_cell_iterator
+ (
+ worksheet ws ,
+
+ const cell_reference &
+ start_cell ,
+
+ const range_reference &
+ limits ,
+
+ major_order order ,
+
+ bool
+ skip_null ,
+
+ bool
+ wrap
+
+ )
+
+
+
+
+
Constructs a cell_iterator from a worksheet, range, and iteration settings.
+
+
+
+
+
◆ [3/4]
+
+
+
+
◆ [4/4]
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ xlnt::const_cell_iterator::~const_cell_iterator
+ (
+ )
+
+
+
+
+default
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::const_cell_iterator::has_value
+ (
+ )
+ const
+
+
+
+
+
When iterating over a range that doesn't ignore null cells, operator*() will throw when trying to access the cells that are null. This method checks the existence of a cell.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::const_cell_iterator::operator!=
+ (
+ const const_cell_iterator &
+ other )
+ const
+
+
+
+
+
Returns true if this iterator isn't equivalent to other.
+
+
+
+
+
◆
+
+
+
+
+
+ const reference xlnt::const_cell_iterator::operator*
+ (
+ )
+ const
+
+
+
+
+
Dereferences this iterator to return the cell it points to.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Pre-increments the iterator to point to the previous cell and returns a reference to the iterator.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Post-increments the iterator to point to the previous cell and return a copy of the iterator before the decrement.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Pre-decrements the iterator to point to the previous cell and returns a reference to the iterator.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Post-decrements the iterator to point to the previous cell and return a copy of the iterator before the decrement.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Assigns this iterator to match the data in rhs.
+
+
+
+
+
◆ [2/2]
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::const_cell_iterator::operator==
+ (
+ const const_cell_iterator &
+ other )
+ const
+
+
+
+
+
Returns true if this iterator is equivalent to other.
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::const_range_iterator , including all inherited members.
+
xlnt: xlnt::const_range_iterator Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
A const version of range_iterator which does not allow modification to the dereferenced cell_vector .
+ More...
+
+
#include <range_iterator.hpp >
+
+using iterator_category = std::bidirectional_iterator_tag this iterator meets the interface requirements of bidirection_iterator More... value_type = const cell_vector difference_type = std::ptrdiff_t pointer = const cell_vector * reference = const cell_vector
+
+
A const version of range_iterator which does not allow modification to the dereferenced cell_vector .
+
+
+
◆
+
+
+
+
+
this iterator meets the interface requirements of bidirection_iterator
+
+
+
+
+
+
◆ [1/4]
+
+
+
+
+
+
+
+
+ xlnt::const_range_iterator::const_range_iterator
+ (
+ )
+
+
+
+
+default
+
+
+
+
+
Default constructs a range iterator
+
+
+
+
+
◆ [2/4]
+
+
+
+
+
Constructs a range iterator on a worksheet, cell pointing to the current row or column, range bounds, an order, and whether or not to skip null column/rows.
+
+
+
+
+
◆ [3/4]
+
+
+
+
+
Default copy constructor.
+
+
+
+
+
◆ [4/4]
+
+
+
+
+
Default move constructor.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ xlnt::const_range_iterator::~const_range_iterator
+ (
+ )
+
+
+
+
+default
+
+
+
+
+
Default destructor
+
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::const_range_iterator::operator!=
+ (
+ const const_range_iterator &
+ other )
+ const
+
+
+
+
+
Returns true if this iterator is not equivalent to other.
+
+
+
+
+
◆
+
+
+
+
+
+ const reference xlnt::const_range_iterator::operator*
+ (
+ )
+ const
+
+
+
+
+
Dereferennce the iterator to return the current column/row.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Pre-increment the iterator to point to the next row/column.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Post-increment the iterator to point to the next row/column.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Pre-decrement the iterator to point to the next row/column.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Post-decrement the iterator to point to the next row/column.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Default assignment operator.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Default move assignment operator.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::const_range_iterator::operator==
+ (
+ const const_range_iterator &
+ other )
+ const
+
+
+
+
+
Returns true if this iterator is equivalent to other.
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::const_worksheet_iterator , including all inherited members.
+
xlnt: xlnt::const_worksheet_iterator Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
An iterator which is used to iterate over the worksheets in a const workbook.
+ More...
+
+
#include <worksheet_iterator.hpp >
+
+using iterator_category = std::bidirectional_iterator_tag iterator tags required for use with standard algorithms and adapters More... value_type = const worksheet difference_type = std::ptrdiff_t pointer = const worksheet * reference = const worksheet
+
+
An iterator which is used to iterate over the worksheets in a const workbook.
+
+
+
◆
+
+
+
+
+
iterator tags required for use with standard algorithms and adapters
+
+
+
+
+
+
◆ [1/4]
+
+
+
+
+
+
+
+
+ xlnt::const_worksheet_iterator::const_worksheet_iterator
+ (
+ )
+
+
+
+
+default
+
+
+
+
+
Default Constructs a worksheet iterator
+
+
+
+
+
◆ [2/4]
+
+
+
+
+
+ xlnt::const_worksheet_iterator::const_worksheet_iterator
+ (
+ const workbook &
+ wb ,
+
+ std::size_t
+ index
+
+ )
+
+
+
+
+
Constructs a worksheet iterator from a workbook and sheet index.
+
+
+
+
+
◆ [3/4]
+
+
+
+
+
Copy constructs a worksheet iterator from another iterator.
+
+
+
+
+
◆ [4/4]
+
+
+
+
+
Move constructs a worksheet iterator from a temporary iterator.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ xlnt::const_worksheet_iterator::~const_worksheet_iterator
+ (
+ )
+
+
+
+
+default
+
+
+
+
+
Default destructor
+
+
+
+
+
+
◆
+
+
+
+
+
Returns true if this iterator doesn't point to the same worksheet as comparand.
+
+
+
+
+
◆
+
+
+
+
+
+ const reference xlnt::const_worksheet_iterator::operator*
+ (
+ )
+ const
+
+
+
+
+
Dereferences the iterator to return the worksheet it is pointing to. If the iterator points to one-past-the-end of the workbook, an invalid_parameter exception will be thrown.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Post-increment the iterator's internal workseet index. Returns a copy of the iterator as it was before being incremented.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Pre-increment the iterator's internal workseet index. Returns a refernce to the same iterator.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Post-decrement the iterator's internal workseet index. Returns a copy of the iterator as it was before being incremented.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Pre-decrement the iterator's internal workseet index. Returns a refernce to the same iterator.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Copy assigns the iterator so that it points to the same worksheet in the same workbook.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Move assigns the iterator from a temporary iterator
+
+
+
+
+
◆
+
+
+
+
+
Returns true if this iterator points to the same worksheet as comparand.
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::detail::number_serialiser , including all inherited members.
+
xlnt: xlnt::detail::number_serialiser Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+serialise (double d) const serialise_short (double d) const deserialise (const std::string &s, ptrdiff_t *len_converted) const deserialise (const std::string &s) const
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::document_security , including all inherited members.
+
xlnt: xlnt::document_security Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Properties governing how the data in a workbook should be protected. These values can be ignored by consumers.
+ More...
+
+
#include <document_security.hpp >
+
+struct lock_verifier Holds data describing the verifier that locks revisions or a workbook. More...
+
+
Properties governing how the data in a workbook should be protected. These values can be ignored by consumers.
+
+
+
◆
+
+
+
+
+
+
+
+
+ xlnt::document_security::document_security
+ (
+ )
+
+
+
+
+default
+
+
+
+
+
Constructs a new document security object with default values.
+
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::document_security::lock_revision = false
+
+
+
+
+
If true, the workbook is locked for revisions.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::document_security::lock_structure = false
+
+
+
+
+
If true, worksheets can't be moved, renamed, (un)hidden, inserted, or deleted.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::document_security::lock_windows = false
+
+
+
+
+
If true, workbook windows will be opened at the same position with the same size every time they are loaded.
+
+
+
+
+
◆
+
+
+
+
+
The settings to allow the revision lock to be removed.
+
+
+
+
+
◆
+
+
+
+
+
The settings to allow the structure and windows lock to be removed.
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::drawing::spreadsheet_drawing , including all inherited members.
+
xlnt: xlnt::drawing::spreadsheet_drawing Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
The spreadsheet_drawing class encapsulates the information captured from objects within the spreadsheetDrawing schema.
+ More...
+
+
#include <spreadsheet_drawing.hpp >
+
+spreadsheet_drawing (xml::parser &parser) serialize (xml::serializer &serializer) get_embed_ids ()
+
+
The spreadsheet_drawing class encapsulates the information captured from objects within the spreadsheetDrawing schema.
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::exception , including all inherited members.
+
xlnt: xlnt::exception Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Parent type of all custom exceptions thrown in this library.
+ More...
+
+
#include <exceptions.hpp >
+
+
+
+
+
+
+
+
+ exception (const std::string &message ) Constructs an exception with a message. This message will be returned by std::exception::what(), an inherited member of this class. More... exception (const exception &)=default Default copy constructor. More... ~exception () override Destructor More... void message (const std::string &message) Sets the message after the xlnt::exception is constructed. This can show more specific information than std::exception::what(). More... std::string message () Gets the message containing extra information. More...
+
+
Parent type of all custom exceptions thrown in this library.
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ xlnt::exception::exception
+ (
+ const std::string &
+ message )
+
+
+
+
+explicit
+
+
+
+
+
Constructs an exception with a message. This message will be returned by std::exception::what(), an inherited member of this class.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ xlnt::exception::exception
+ (
+ const exception &
+ )
+
+
+
+
+default
+
+
+
+
+
Default copy constructor.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ xlnt::exception::~exception
+ (
+ )
+
+
+
+
+override
+
+
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ void xlnt::exception::message
+ (
+ const std::string &
+ message )
+
+
+
+
+
Sets the message after the xlnt::exception is constructed. This can show more specific information than std::exception::what().
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ std::string xlnt::exception::message
+ (
+ )
+
+
+
+
+
Gets the message containing extra information.
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::ext_list , including all inherited members.
+
xlnt: xlnt::ext_list Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
A list of xml extensions that may or may not be understood by the parser preservation is required for round-tripping even if extension is not understood [serialised: extLst]
+ More...
+
+
#include <ext_list.hpp >
+
+ext_list (xml::parser &parser, const std::string &ns) serialize (xml::serializer &serialiser, const std::string &ns) add_extension (const uri &ID, const std::string &element) has_extension (const uri &extension_uri) const ext & extension (const uri &extension_uri) const ext > & extensions () const operator== (const ext_list &rhs) const
+
+
A list of xml extensions that may or may not be understood by the parser preservation is required for round-tripping even if extension is not understood [serialised: extLst]
+
The documentation for this class was generated from the following file:
+
xlnt: xlnt::external_book Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
A reference to an external workbook for use in formulae.
+ More...
+
+
#include <external_book.hpp >
+
+
A reference to an external workbook for use in formulae.
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::fill , including all inherited members.
+
xlnt: xlnt::fill Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Describes the fill style of a particular cell.
+ More...
+
+
#include <fill.hpp >
+
+static fill solid (const color &fill_color) Helper method for the most common use case, setting the fill color of a cell to a single solid color. The foreground and background colors of a fill are not the same as the foreground and background colors of a cell. When setting a fill color in Excel, a new fill is created with the given color as the fill's fgColor and index color number 64 as the bgColor. This method creates a fill in the same way. More...
+
+
Describes the fill style of a particular cell.
+
+
+
◆ [1/3]
+
+
+
+
+
+ xlnt::fill::fill
+ (
+ )
+
+
+
+
+
Constructs a fill initialized as a none-type pattern fill with no foreground or background colors.
+
+
+
+
+
◆ [2/3]
+
+
+
+
+
+ xlnt::fill::fill
+ (
+ const pattern_fill &
+ pattern )
+
+
+
+
+
Constructs a fill initialized as a pattern fill based on the given pattern.
+
+
+
+
+
◆ [3/3]
+
+
+
+
+
+ xlnt::fill::fill
+ (
+ const gradient_fill &
+ gradient )
+
+
+
+
+
Constructs a fill initialized as a gradient fill based on the given gradient.
+
+
+
+
+
+
◆
+
+
+
+
+
+ class gradient_fill xlnt::fill::gradient_fill
+ (
+ )
+ const
+
+
+
+
+
Returns the gradient fill represented by this fill. Throws an invalid_attribute exception if this is not a gradient fill.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::fill::operator!=
+ (
+ const fill &
+ other )
+ const
+
+
+
+
+
Returns true if left is not exactly equal to right.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::fill::operator==
+ (
+ const fill &
+ other )
+ const
+
+
+
+
+
Returns true if left is exactly equal to right.
+
+
+
+
+
◆
+
+
+
+
+
+ class pattern_fill xlnt::fill::pattern_fill
+ (
+ )
+ const
+
+
+
+
+
Returns the pattern fill represented by this fill. Throws an invalid_attribute exception if this is not a pattern fill.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static fill xlnt::fill::solid
+ (
+ const color &
+ fill_color )
+
+
+
+
+static
+
+
+
+
+
Helper method for the most common use case, setting the fill color of a cell to a single solid color. The foreground and background colors of a fill are not the same as the foreground and background colors of a cell. When setting a fill color in Excel, a new fill is created with the given color as the fill's fgColor and index color number 64 as the bgColor. This method creates a fill in the same way.
+
+
+
+
+
◆
+
+
+
+
+
+ fill_type xlnt::fill::type (
+ )
+ const
+
+
+
+
+
Returns the fill_type of this fill depending on how it was constructed.
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::font , including all inherited members.
+
xlnt: xlnt::font Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Describes the font style of a particular cell.
+ More...
+
+
#include <font.hpp >
+
+enum underline_style { none ,
+double_ ,
+double_accounting ,
+single ,
+single_accounting
+ Text can be underlined in the enumerated ways More...
+ font () Constructs a default font. Calibri, size 12 More... font & bold (bool bold) Sets the bold state of the font to bold and returns a reference to the font. More... bool bold () const Returns the bold state of the font. More... font & subscript (bool value) Sets the vertical alignment of the font to subscript and returns a reference to the font. More... bool subscript () const Returns true if this font has a vertical alignment of subscript. More... font & superscript (bool value) Sets the vertical alignment of the font to superscript and returns a reference to the font. More... bool superscript () const Returns true if this font has a vertical alignment of superscript. More... font & italic (bool italic) Sets the bold state of the font to bold and returns a reference to the font. More... bool italic () const Returns true if this font has italics applied. More... font & strikethrough (bool strikethrough) Sets the bold state of the font to bold and returns a reference to the font. More... bool strikethrough () const Returns true if this font has a strikethrough applied. More... font & outline (bool outline) Sets the bold state of the font to bold and returns a reference to the font. More... bool outline () const Returns true if this font has an outline applied. More... font & shadow (bool shadow) Sets the shadow state of the font to shadow and returns a reference to the font. More... bool shadow () const Returns true if this font has a shadow applied. More... font & underline (underline_style new_underline) Sets the underline state of the font to new_underline and returns a reference to the font. More... bool underlined () const Returns true if this font has any type of underline applied. More... underline_style underline () const Returns the particular style of underline this font has applied. More... bool has_size () const Returns true if this font has a defined size. More... font & size (double size) Sets the size of the font to size and returns a reference to the font. More... double size () const Returns the size of the font. More... bool has_name () const Returns true if this font has a particular face applied (e.g. "Comic Sans"). More... font & name (const std::string &name) Sets the font face to name and returns a reference to the font. More... const std::string & name () const Returns the name of the font face. More... bool has_color () const Returns true if this font has a color applied. More... font & color (const color &c) Sets the color of the font to c and returns a reference to the font. More... xlnt::color color () const Returns the color that this font is using. More... bool has_family () const Returns true if this font has a family defined. More... font & family (std::size_t family) Sets the family index of the font to family and returns a reference to the font. More... std::size_t family () const Returns the family index for the font. More... bool has_charset () const Returns true if this font has a charset defined. More... font & charset (std::size_t charset) Sets the charset of the font to charset and returns a reference to the font. More... std::size_t charset () const Returns the charset of the font. More... bool has_scheme () const Returns true if this font has a scheme. More... font & scheme (const std::string &scheme) Sets the scheme of the font to scheme and returns a reference to the font. More... const std::string & scheme () const Returns the scheme of this font. More... bool operator== (const font &other) const Returns true if left is exactly equal to right. More... bool operator!= (const font &other) const Returns true if left is not exactly equal to right. More...
+
+
Describes the font style of a particular cell.
+
+
+
◆
+
+
+
+
+
Text can be underlined in the enumerated ways
+
+
+
+
+
+
◆
+
+
+
+
+
+ xlnt::font::font
+ (
+ )
+
+
+
+
+
Constructs a default font. Calibri, size 12
+
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ font & xlnt::font::bold (
+ bool
+ bold )
+
+
+
+
+
Sets the bold state of the font to bold and returns a reference to the font.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ bool xlnt::font::bold
+ (
+ )
+ const
+
+
+
+
+
Returns the bold state of the font.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ font & xlnt::font::charset (
+ std::size_t
+ charset )
+
+
+
+
+
Sets the charset of the font to charset and returns a reference to the font.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ std::size_t xlnt::font::charset
+ (
+ )
+ const
+
+
+
+
+
Returns the charset of the font.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ font & xlnt::font::color (
+ const color &
+ c )
+
+
+
+
+
Sets the color of the font to c and returns a reference to the font.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Returns the color that this font is using.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ font & xlnt::font::family (
+ std::size_t
+ family )
+
+
+
+
+
Sets the family index of the font to family and returns a reference to the font.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ std::size_t xlnt::font::family
+ (
+ )
+ const
+
+
+
+
+
Returns the family index for the font.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::font::has_charset
+ (
+ )
+ const
+
+
+
+
+
Returns true if this font has a charset defined.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::font::has_color
+ (
+ )
+ const
+
+
+
+
+
Returns true if this font has a color applied.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::font::has_family
+ (
+ )
+ const
+
+
+
+
+
Returns true if this font has a family defined.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::font::has_name
+ (
+ )
+ const
+
+
+
+
+
Returns true if this font has a particular face applied (e.g. "Comic Sans").
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::font::has_scheme
+ (
+ )
+ const
+
+
+
+
+
Returns true if this font has a scheme.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::font::has_size
+ (
+ )
+ const
+
+
+
+
+
Returns true if this font has a defined size.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ font & xlnt::font::italic (
+ bool
+ italic )
+
+
+
+
+
Sets the bold state of the font to bold and returns a reference to the font.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ bool xlnt::font::italic
+ (
+ )
+ const
+
+
+
+
+
Returns true if this font has italics applied.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ font & xlnt::font::name (
+ const std::string &
+ name )
+
+
+
+
+
Sets the font face to name and returns a reference to the font.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ const std::string& xlnt::font::name
+ (
+ )
+ const
+
+
+
+
+
Returns the name of the font face.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ bool xlnt::font::operator!=
+ (
+ const font &
+ other )
+ const
+
+
+
+
+inline
+
+
+
+
+
Returns true if left is not exactly equal to right.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::font::operator==
+ (
+ const font &
+ other )
+ const
+
+
+
+
+
Returns true if left is exactly equal to right.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ font & xlnt::font::outline (
+ bool
+ outline )
+
+
+
+
+
Sets the bold state of the font to bold and returns a reference to the font.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ bool xlnt::font::outline
+ (
+ )
+ const
+
+
+
+
+
Returns true if this font has an outline applied.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ font & xlnt::font::scheme (
+ const std::string &
+ scheme )
+
+
+
+
+
Sets the scheme of the font to scheme and returns a reference to the font.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ const std::string& xlnt::font::scheme
+ (
+ )
+ const
+
+
+
+
+
Returns the scheme of this font.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ font & xlnt::font::shadow (
+ bool
+ shadow )
+
+
+
+
+
Sets the shadow state of the font to shadow and returns a reference to the font.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ bool xlnt::font::shadow
+ (
+ )
+ const
+
+
+
+
+
Returns true if this font has a shadow applied.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ font & xlnt::font::size (
+ double
+ size )
+
+
+
+
+
Sets the size of the font to size and returns a reference to the font.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ double xlnt::font::size
+ (
+ )
+ const
+
+
+
+
+
Returns the size of the font.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ font & xlnt::font::strikethrough (
+ bool
+ strikethrough )
+
+
+
+
+
Sets the bold state of the font to bold and returns a reference to the font.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ bool xlnt::font::strikethrough
+ (
+ )
+ const
+
+
+
+
+
Returns true if this font has a strikethrough applied.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ font & xlnt::font::subscript (
+ bool
+ value )
+
+
+
+
+
Sets the vertical alignment of the font to subscript and returns a reference to the font.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ bool xlnt::font::subscript
+ (
+ )
+ const
+
+
+
+
+
Returns true if this font has a vertical alignment of subscript.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ font & xlnt::font::superscript (
+ bool
+ value )
+
+
+
+
+
Sets the vertical alignment of the font to superscript and returns a reference to the font.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ bool xlnt::font::superscript
+ (
+ )
+ const
+
+
+
+
+
Returns true if this font has a vertical alignment of superscript.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Sets the underline state of the font to new_underline and returns a reference to the font.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Returns the particular style of underline this font has applied.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::font::underlined
+ (
+ )
+ const
+
+
+
+
+
Returns true if this font has any type of underline applied.
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::format , including all inherited members.
+
xlnt: xlnt::format Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Describes the formatting of a particular cell.
+ More...
+
+
#include <format.hpp >
+
+class alignment alignment () const Returns the alignment of this format. More... format alignment (const xlnt::alignment &new_alignment, xlnt::optional < bool > applied={}) Sets the alignment of this format to new_alignment. Applied, which defaults to true, determines whether the alignment should be enabled for cells using this format. More... bool alignment_applied () const Returns true if the alignment of this format should be applied to cells using it. More... class border border () const Returns the border of this format. More... format border (const xlnt::border &new_border, xlnt::optional < bool > applied={}) Sets the border of this format to new_border. Applied, which defaults to true, determines whether the border should be enabled for cells using this format. More... bool border_applied () const Returns true if the border set for this format should be applied to cells using the format. More... class fill fill () const Returns the fill of this format. More... format fill (const xlnt::fill &new_fill, xlnt::optional < bool > applied={}) Sets the fill of this format to new_fill. Applied, which defaults to true, determines whether the border should be enabled for cells using this format. More... bool fill_applied () const Returns true if the fill set for this format should be applied to cells using the format. More... class font font () const Returns the font of this format. More... format font (const xlnt::font &new_font, xlnt::optional < bool > applied={}) Sets the font of this format to new_font. Applied, which defaults to true, determines whether the font should be enabled for cells using this format. More... bool font_applied () const Returns true if the font set for this format should be applied to cells using the format. More... class number_format number_format () const Returns the number format of this format. More... format number_format (const xlnt::number_format &new_number_format, xlnt::optional < bool > applied={}) Sets the number format of this format to new_number_format. Applied, which defaults to true, determines whether the number format should be enabled for cells using this format. More... bool number_format_applied () const Returns true if the number_format set for this format should be applied to cells using the format. More... class protection protection () const Returns the protection of this format. More... bool protection_applied () const Returns true if the protection set for this format should be applied to cells using the format. More... format protection (const xlnt::protection &new_protection, xlnt::optional < bool > applied={}) Sets the protection of this format to new_protection. Applied, which defaults to true, determines whether the protection should be enabled for cells using this format. More... bool pivot_button () const Returns true if the pivot table interface is enabled for this format. More... void pivot_button (bool show) If show is true, a pivot table interface will be displayed for cells using this format. More... bool quote_prefix () const Returns true if this format should add a single-quote prefix for all text values. More... void quote_prefix (bool quote) If quote is true, enables a single-quote prefix for all text values in cells using this format (e.g. "abc" will appear as "'abc"). The text will also not be stored in sharedStrings when this is enabled. More... bool has_style () const Returns true if this format has a corresponding style applied. More... void clear_style () Removes the style from this format if it exists. More... format style (const std::string &name) Sets the style of this format to a style with the given name. More... format style (const class style &new_style) Sets the style of this format to new_style. More... class style style () Returns the style of this format. If it has no style, an invalid_parameter exception will be thrown. More... const class style style () const Returns the style of this format. If it has no style, an invalid_parameters exception will be thrown. More...
+detail::stylesheet detail::xlsx_producer detail::xlsx_consumer cell
+
+
Describes the formatting of a particular cell.
+
+
+
◆ [1/2]
+
+
+
+
+
Sets the alignment of this format to new_alignment. Applied, which defaults to true, determines whether the alignment should be enabled for cells using this format.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ class alignment xlnt::format::alignment
+ (
+ )
+ const
+
+
+
+
+
Returns the alignment of this format.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::format::alignment_applied
+ (
+ )
+ const
+
+
+
+
+
Returns true if the alignment of this format should be applied to cells using it.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ class border xlnt::format::border
+ (
+ )
+ const
+
+
+
+
+
Returns the border of this format.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Sets the border of this format to new_border. Applied, which defaults to true, determines whether the border should be enabled for cells using this format.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::format::border_applied
+ (
+ )
+ const
+
+
+
+
+
Returns true if the border set for this format should be applied to cells using the format.
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::format::clear_style
+ (
+ )
+
+
+
+
+
Removes the style from this format if it exists.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ class fill xlnt::format::fill
+ (
+ )
+ const
+
+
+
+
+
Returns the fill of this format.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Sets the fill of this format to new_fill. Applied, which defaults to true, determines whether the border should be enabled for cells using this format.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::format::fill_applied
+ (
+ )
+ const
+
+
+
+
+
Returns true if the fill set for this format should be applied to cells using the format.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ class font xlnt::format::font
+ (
+ )
+ const
+
+
+
+
+
Returns the font of this format.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Sets the font of this format to new_font. Applied, which defaults to true, determines whether the font should be enabled for cells using this format.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::format::font_applied
+ (
+ )
+ const
+
+
+
+
+
Returns true if the font set for this format should be applied to cells using the format.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::format::has_style
+ (
+ )
+ const
+
+
+
+
+
Returns true if this format has a corresponding style applied.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ class number_format xlnt::format::number_format
+ (
+ )
+ const
+
+
+
+
+
Returns the number format of this format.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Sets the number format of this format to new_number_format. Applied, which defaults to true, determines whether the number format should be enabled for cells using this format.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::format::number_format_applied
+ (
+ )
+ const
+
+
+
+
+
Returns true if the number_format set for this format should be applied to cells using the format.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ bool xlnt::format::pivot_button
+ (
+ )
+ const
+
+
+
+
+
Returns true if the pivot table interface is enabled for this format.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::format::pivot_button
+ (
+ bool
+ show )
+
+
+
+
+
If show is true, a pivot table interface will be displayed for cells using this format.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ class protection xlnt::format::protection
+ (
+ )
+ const
+
+
+
+
+
Returns the protection of this format.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Sets the protection of this format to new_protection. Applied, which defaults to true, determines whether the protection should be enabled for cells using this format.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::format::protection_applied
+ (
+ )
+ const
+
+
+
+
+
Returns true if the protection set for this format should be applied to cells using the format.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ bool xlnt::format::quote_prefix
+ (
+ )
+ const
+
+
+
+
+
Returns true if this format should add a single-quote prefix for all text values.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::format::quote_prefix
+ (
+ bool
+ quote )
+
+
+
+
+
If quote is true, enables a single-quote prefix for all text values in cells using this format (e.g. "abc" will appear as "'abc"). The text will also not be stored in sharedStrings when this is enabled.
+
+
+
+
+
◆ [1/4]
+
+
+
+
+
+ format xlnt::format::style (
+ const std::string &
+ name )
+
+
+
+
+
Sets the style of this format to a style with the given name.
+
+
+
+
+
◆ [2/4]
+
+
+
+
+
+ format xlnt::format::style (
+ const class style &
+ new_style )
+
+
+
+
+
Sets the style of this format to new_style.
+
+
+
+
+
◆ [3/4]
+
+
+
+
+
+ const class style xlnt::format::style
+ (
+ )
+ const
+
+
+
+
+
Returns the style of this format. If it has no style, an invalid_parameters exception will be thrown.
+
+
+
+
+
◆ [4/4]
+
+
+
+
+
+ class style xlnt::format::style
+ (
+ )
+
+
+
+
+
Returns the style of this format. If it has no style, an invalid_parameter exception will be thrown.
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::gradient_fill , including all inherited members.
+
xlnt: xlnt::gradient_fill Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Encapsulates a fill which transitions between colors at particular "stops".
+ More...
+
+
#include <fill.hpp >
+
+
+
Encapsulates a fill which transitions between colors at particular "stops".
+
+
+
◆
+
+
+
+
+
+ xlnt::gradient_fill::gradient_fill
+ (
+ )
+
+
+
+
+
Constructs a default linear fill
+
+
+
+
+
+
◆
+
+
+
+
+
+ gradient_fill & xlnt::gradient_fill::add_stop (
+ double
+ position ,
+
+ color stop_color
+
+ )
+
+
+
+
+
Adds a gradient stop at position with the given color.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ double xlnt::gradient_fill::bottom
+ (
+ )
+ const
+
+
+
+
+
Returns the distance from the bottom where the gradient starts.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ gradient_fill & xlnt::gradient_fill::bottom (
+ double
+ value )
+
+
+
+
+
Sets the distance from the bottom where the gradient starts.
+
+
+
+
+
◆
+
+
+
+
+
+ gradient_fill & xlnt::gradient_fill::clear_stops (
+ )
+
+
+
+
+
Deletes all stops from the gradient.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ gradient_fill & xlnt::gradient_fill::degree (
+ double
+ degree )
+
+
+
+
+
Sets the angle of the gradient in degrees
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ double xlnt::gradient_fill::degree
+ (
+ )
+ const
+
+
+
+
+
Returns the angle of the gradient
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ double xlnt::gradient_fill::left
+ (
+ )
+ const
+
+
+
+
+
Returns the distance from the left where the gradient starts.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ gradient_fill & xlnt::gradient_fill::left (
+ double
+ value )
+
+
+
+
+
Sets the distance from the left where the gradient starts.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::gradient_fill::operator!=
+ (
+ const gradient_fill &
+ right )
+ const
+
+
+
+
+
Returns true if the gradient is not equivalent to other.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::gradient_fill::operator==
+ (
+ const gradient_fill &
+ other )
+ const
+
+
+
+
+
Returns true if the gradient is equivalent to other.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ double xlnt::gradient_fill::right
+ (
+ )
+ const
+
+
+
+
+
Returns the distance from the right where the gradient starts.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ gradient_fill & xlnt::gradient_fill::right (
+ double
+ value )
+
+
+
+
+
Sets the distance from the right where the gradient starts.
+
+
+
+
+
◆
+
+
+
+
+
+ std::unordered_map<double, color > xlnt::gradient_fill::stops
+ (
+ )
+ const
+
+
+
+
+
Returns all of the gradient stops.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ double xlnt::gradient_fill::top
+ (
+ )
+ const
+
+
+
+
+
Returns the distance from the top where the gradient starts.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ gradient_fill & xlnt::gradient_fill::top (
+ double
+ value )
+
+
+
+
+
Sets the distance from the top where the gradient starts.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Returns the type of this gradient fill
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Sets the type of this gradient fill
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::header_footer , including all inherited members.
+
+ align_with_margins () constxlnt::header_footer align_with_margins (bool align)xlnt::header_footer clear_first_page_footer ()xlnt::header_footer clear_first_page_footer (location where)xlnt::header_footer clear_first_page_header ()xlnt::header_footer clear_first_page_header (location where)xlnt::header_footer clear_footer ()xlnt::header_footer clear_footer (location where)xlnt::header_footer clear_header ()xlnt::header_footer clear_header (location where)xlnt::header_footer clear_odd_even_footer ()xlnt::header_footer clear_odd_even_footer (location where)xlnt::header_footer clear_odd_even_header ()xlnt::header_footer clear_odd_even_header (location where)xlnt::header_footer different_first () constxlnt::header_footer different_odd_even () constxlnt::header_footer even_footer (location where) constxlnt::header_footer even_header (location where) constxlnt::header_footer first_page_footer (location where, const rich_text &text)xlnt::header_footer first_page_footer (location where) constxlnt::header_footer first_page_header (location where, const rich_text &text)xlnt::header_footer first_page_header (location where) constxlnt::header_footer footer (location where, const std::string &text)xlnt::header_footer footer (location where, const rich_text &text)xlnt::header_footer footer (location where) constxlnt::header_footer has_first_page_footer () constxlnt::header_footer has_first_page_footer (location where) constxlnt::header_footer has_first_page_header () constxlnt::header_footer has_first_page_header (location where) constxlnt::header_footer has_footer () constxlnt::header_footer has_footer (location where) constxlnt::header_footer has_header () constxlnt::header_footer has_header (location where) constxlnt::header_footer has_odd_even_footer () constxlnt::header_footer has_odd_even_footer (location where) constxlnt::header_footer has_odd_even_header () constxlnt::header_footer has_odd_even_header (location where) constxlnt::header_footer header (location where, const std::string &text)xlnt::header_footer header (location where, const rich_text &text)xlnt::header_footer header (location where) constxlnt::header_footer location enum namexlnt::header_footer odd_even_footer (location where, const rich_text &odd, const rich_text &even)xlnt::header_footer odd_even_header (location where, const rich_text &odd, const rich_text &even)xlnt::header_footer odd_footer (location where) constxlnt::header_footer odd_header (location where) constxlnt::header_footer operator== (const header_footer &rhs) const (defined in xlnt::header_footer )xlnt::header_footer scale_with_doc () constxlnt::header_footer scale_with_doc (bool scale)xlnt::header_footer
xlnt: xlnt::header_footer Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Represents the header and footer of a sheet in a workbook.
+ More...
+
+
#include <header_footer.hpp >
+
+enum location { left ,
+center ,
+right
+ } Enumerates the three possible locations of a header or footer. More...
+bool has_header () const True if any text has been added for a header at any location on any page. More... bool has_footer () const True if any text has been added for a footer at any location on any page. More... bool align_with_margins () const True if headers and footers should align to the page margins. More... header_footer & align_with_margins (bool align) Set to true if headers and footers should align to the page margins. Set to false if headers and footers should align to the edge of the page. More... bool different_odd_even () const True if headers and footers differ based on page number. More... bool different_first () const True if headers and footers are different on the first page. More... bool scale_with_doc () const True if headers and footers should scale to match the worksheet. More... header_footer & scale_with_doc (bool scale) Set to true if headers and footers should scale to match the worksheet. More... bool has_header (location where) const True if any text has been added at the given location on any page. More... void clear_header () Remove all headers from all pages. More... void clear_header (location where) Remove header at the given location on any page. More... header_footer & header (location where, const std::string &text) Add a header at the given location with the given text. More... header_footer & header (location where, const rich_text &text) Add a header at the given location with the given text. More... rich_text header (location where) const Get the text of the header at the given location. If headers are different on odd and even pages, the odd header will be returned. More... bool has_first_page_header () const True if a header has been set for the first page at any location. More... bool has_first_page_header (location where) const True if a header has been set for the first page at the given location. More... void clear_first_page_header () Remove all headers from the first page. More... void clear_first_page_header (location where) Remove header from the first page at the given location. More... header_footer & first_page_header (location where, const rich_text &text) Add a header on the first page at the given location with the given text. More... rich_text first_page_header (location where) const Get the text of the first page header at the given location. If no first page header has been set, the general header for that location will be returned. More... bool has_odd_even_header () const True if different headers have been set for odd and even pages. More... bool has_odd_even_header (location where) const True if different headers have been set for odd and even pages at the given location. More... void clear_odd_even_header () Remove odd/even headers at all locations. More... void clear_odd_even_header (location where) Remove odd/even headers at the given location. More... header_footer & odd_even_header (location where, const rich_text &odd, const rich_text &even) Add a header for odd pages at the given location with the given text. More... rich_text odd_header (location where) const Get the text of the odd page header at the given location. If no odd page header has been set, the general header for that location will be returned. More... rich_text even_header (location where) const Get the text of the even page header at the given location. If no even page header has been set, the general header for that location will be returned. More... bool has_footer (location where) const True if any text has been added at the given location on any page. More... void clear_footer () Remove all footers from all pages. More... void clear_footer (location where) Remove footer at the given location on any page. More... header_footer & footer (location where, const std::string &text) Add a footer at the given location with the given text. More... header_footer & footer (location where, const rich_text &text) Add a footer at the given location with the given text. More... rich_text footer (location where) const Get the text of the footer at the given location. If footers are different on odd and even pages, the odd footer will be returned. More... bool has_first_page_footer () const True if a footer has been set for the first page at any location. More... bool has_first_page_footer (location where) const True if a footer has been set for the first page at the given location. More... void clear_first_page_footer () Remove all footers from the first page. More... void clear_first_page_footer (location where) Remove footer from the first page at the given location. More... header_footer & first_page_footer (location where, const rich_text &text) Add a footer on the first page at the given location with the given text. More... rich_text first_page_footer (location where) const Get the text of the first page footer at the given location. If no first page footer has been set, the general footer for that location will be returned. More... bool has_odd_even_footer () const True if different footers have been set for odd and even pages. More... bool has_odd_even_footer (location where) const True if different footers have been set for odd and even pages at the given location. More... void clear_odd_even_footer () Remove odd/even footers at all locations. More... void clear_odd_even_footer (location where) Remove odd/even footers at the given location. More... header_footer & odd_even_footer (location where, const rich_text &odd, const rich_text &even) Add a footer for odd pages at the given location with the given text. More... rich_text odd_footer (location where) const Get the text of the odd page footer at the given location. If no odd page footer has been set, the general footer for that location will be returned. More... rich_text even_footer (location where) const Get the text of the even page footer at the given location. If no even page footer has been set, the general footer for that location will be returned. More... operator== (const header_footer &rhs) const
+
+
Represents the header and footer of a sheet in a workbook.
+
+
+
◆
+
+
+
+
+
Enumerates the three possible locations of a header or footer.
+
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ bool xlnt::header_footer::align_with_margins
+ (
+ )
+ const
+
+
+
+
+
True if headers and footers should align to the page margins.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ header_footer & xlnt::header_footer::align_with_margins (
+ bool
+ align )
+
+
+
+
+
Set to true if headers and footers should align to the page margins. Set to false if headers and footers should align to the edge of the page.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ void xlnt::header_footer::clear_first_page_footer
+ (
+ )
+
+
+
+
+
Remove all footers from the first page.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::header_footer::clear_first_page_footer
+ (
+ location where )
+
+
+
+
+
Remove footer from the first page at the given location.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ void xlnt::header_footer::clear_first_page_header
+ (
+ )
+
+
+
+
+
Remove all headers from the first page.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::header_footer::clear_first_page_header
+ (
+ location where )
+
+
+
+
+
Remove header from the first page at the given location.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ void xlnt::header_footer::clear_footer
+ (
+ )
+
+
+
+
+
Remove all footers from all pages.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::header_footer::clear_footer
+ (
+ location where )
+
+
+
+
+
Remove footer at the given location on any page.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ void xlnt::header_footer::clear_header
+ (
+ )
+
+
+
+
+
Remove all headers from all pages.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::header_footer::clear_header
+ (
+ location where )
+
+
+
+
+
Remove header at the given location on any page.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ void xlnt::header_footer::clear_odd_even_footer
+ (
+ )
+
+
+
+
+
Remove odd/even footers at all locations.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::header_footer::clear_odd_even_footer
+ (
+ location where )
+
+
+
+
+
Remove odd/even footers at the given location.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ void xlnt::header_footer::clear_odd_even_header
+ (
+ )
+
+
+
+
+
Remove odd/even headers at all locations.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::header_footer::clear_odd_even_header
+ (
+ location where )
+
+
+
+
+
Remove odd/even headers at the given location.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::header_footer::different_first
+ (
+ )
+ const
+
+
+
+
+
True if headers and footers are different on the first page.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::header_footer::different_odd_even
+ (
+ )
+ const
+
+
+
+
+
True if headers and footers differ based on page number.
+
+
+
+
+
◆
+
+
+
+
+
Get the text of the even page footer at the given location. If no even page footer has been set, the general footer for that location will be returned.
+
+
+
+
+
◆
+
+
+
+
+
Get the text of the even page header at the given location. If no even page header has been set, the general header for that location will be returned.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Add a footer on the first page at the given location with the given text.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ rich_text xlnt::header_footer::first_page_footer (
+ location where )
+ const
+
+
+
+
+
Get the text of the first page footer at the given location. If no first page footer has been set, the general footer for that location will be returned.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Add a header on the first page at the given location with the given text.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ rich_text xlnt::header_footer::first_page_header (
+ location where )
+ const
+
+
+
+
+
Get the text of the first page header at the given location. If no first page header has been set, the general header for that location will be returned.
+
+
+
+
+
◆ [1/3]
+
+
+
+
+
+ header_footer & xlnt::header_footer::footer (
+ location where ,
+
+ const std::string &
+ text
+
+ )
+
+
+
+
+
Add a footer at the given location with the given text.
+
+
+
+
+
◆ [2/3]
+
+
+
+
+
Add a footer at the given location with the given text.
+
+
+
+
+
◆ [3/3]
+
+
+
+
+
Get the text of the footer at the given location. If footers are different on odd and even pages, the odd footer will be returned.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ bool xlnt::header_footer::has_first_page_footer
+ (
+ )
+ const
+
+
+
+
+
True if a footer has been set for the first page at any location.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ bool xlnt::header_footer::has_first_page_footer
+ (
+ location where )
+ const
+
+
+
+
+
True if a footer has been set for the first page at the given location.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ bool xlnt::header_footer::has_first_page_header
+ (
+ )
+ const
+
+
+
+
+
True if a header has been set for the first page at any location.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ bool xlnt::header_footer::has_first_page_header
+ (
+ location where )
+ const
+
+
+
+
+
True if a header has been set for the first page at the given location.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ bool xlnt::header_footer::has_footer
+ (
+ )
+ const
+
+
+
+
+
True if any text has been added for a footer at any location on any page.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ bool xlnt::header_footer::has_footer
+ (
+ location where )
+ const
+
+
+
+
+
True if any text has been added at the given location on any page.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ bool xlnt::header_footer::has_header
+ (
+ )
+ const
+
+
+
+
+
True if any text has been added for a header at any location on any page.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ bool xlnt::header_footer::has_header
+ (
+ location where )
+ const
+
+
+
+
+
True if any text has been added at the given location on any page.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ bool xlnt::header_footer::has_odd_even_footer
+ (
+ )
+ const
+
+
+
+
+
True if different footers have been set for odd and even pages.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ bool xlnt::header_footer::has_odd_even_footer
+ (
+ location where )
+ const
+
+
+
+
+
True if different footers have been set for odd and even pages at the given location.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ bool xlnt::header_footer::has_odd_even_header
+ (
+ )
+ const
+
+
+
+
+
True if different headers have been set for odd and even pages.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ bool xlnt::header_footer::has_odd_even_header
+ (
+ location where )
+ const
+
+
+
+
+
True if different headers have been set for odd and even pages at the given location.
+
+
+
+
+
◆ [1/3]
+
+
+
+
+
+ header_footer & xlnt::header_footer::header (
+ location where ,
+
+ const std::string &
+ text
+
+ )
+
+
+
+
+
Add a header at the given location with the given text.
+
+
+
+
+
◆ [2/3]
+
+
+
+
+
Add a header at the given location with the given text.
+
+
+
+
+
◆ [3/3]
+
+
+
+
+
Get the text of the header at the given location. If headers are different on odd and even pages, the odd header will be returned.
+
+
+
+
+
◆
+
+
+
+
+
Add a footer for odd pages at the given location with the given text.
+
+
+
+
+
◆
+
+
+
+
+
Add a header for odd pages at the given location with the given text.
+
+
+
+
+
◆
+
+
+
+
+
Get the text of the odd page footer at the given location. If no odd page footer has been set, the general footer for that location will be returned.
+
+
+
+
+
◆
+
+
+
+
+
Get the text of the odd page header at the given location. If no odd page header has been set, the general header for that location will be returned.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ bool xlnt::header_footer::scale_with_doc
+ (
+ )
+ const
+
+
+
+
+
True if headers and footers should scale to match the worksheet.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ header_footer & xlnt::header_footer::scale_with_doc (
+ bool
+ scale )
+
+
+
+
+
Set to true if headers and footers should scale to match the worksheet.
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::hyperlink , including all inherited members.
+
xlnt: xlnt::hyperlink Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Describes a hyperlink pointing from a cell to another cell or a URL.
+ More...
+
+
#include <hyperlink.hpp >
+
+external () const relationship relationship () const url () const target_range () const has_display () const display (const std::string &value) display () const has_tooltip () const tooltip (const std::string &value) tooltip () const has_location () const location (const std::string &value) location () const
+
+
Describes a hyperlink pointing from a cell to another cell or a URL.
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::illegal_character , including all inherited members.
+
xlnt: xlnt::illegal_character Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
The data submitted which cannot be used directly in Excel files. It must be removed or escaped.
+ More...
+
+
#include <exceptions.hpp >
+
+
+
+
+
+
+
+
+
+
The data submitted which cannot be used directly in Excel files. It must be removed or escaped.
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ xlnt::illegal_character::illegal_character
+ (
+ char
+ c )
+
+
+
+
+explicit
+
+
+
+
+
Constructs an illegal_character exception thrown as a result of the given character.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ xlnt::illegal_character::illegal_character
+ (
+ const illegal_character &
+ )
+
+
+
+
+default
+
+
+
+
+
Default copy constructor.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ xlnt::illegal_character::~illegal_character
+ (
+ )
+
+
+
+
+override
+
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::indexed_color , including all inherited members.
+
xlnt: xlnt::indexed_color Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
An indexed color encapsulates a simple index to a color in the indexedColors of the stylesheet.
+ More...
+
+
#include <color.hpp >
+
+
+
An indexed color encapsulates a simple index to a color in the indexedColors of the stylesheet.
+
+
+
◆
+
+
+
+
+
+ xlnt::indexed_color::indexed_color
+ (
+ std::size_t
+ index )
+
+
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ std::size_t xlnt::indexed_color::index
+ (
+ )
+ const
+
+
+
+
+
Returns the index this color points to.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::indexed_color::index
+ (
+ std::size_t
+ index )
+
+
+
+
+
Sets the index to index.
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::invalid_attribute , including all inherited members.
+
xlnt: xlnt::invalid_attribute Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Exception when setting a class's attribute to an invalid value
+ More...
+
+
#include <exceptions.hpp >
+
+
+
+
+
+
+
+
+
+
Exception when setting a class's attribute to an invalid value
+
+
+
◆ [1/2]
+
+
+
+
+
+ xlnt::invalid_attribute::invalid_attribute
+ (
+ )
+
+
+
+
+
Default constructor.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ xlnt::invalid_attribute::invalid_attribute
+ (
+ const invalid_attribute &
+ )
+
+
+
+
+default
+
+
+
+
+
Default copy constructor.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ xlnt::invalid_attribute::~invalid_attribute
+ (
+ )
+
+
+
+
+override
+
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::invalid_cell_reference , including all inherited members.
+
xlnt: xlnt::invalid_cell_reference Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Exception for converting between numeric and A1-style cell references.
+ More...
+
+
#include <exceptions.hpp >
+
+
+
+
+
+
+
+
+
+
Exception for converting between numeric and A1-style cell references.
+
+
+
◆ [1/3]
+
+
+
+
+
+ xlnt::invalid_cell_reference::invalid_cell_reference
+ (
+ column_t column ,
+
+ row_t row
+
+ )
+
+
+
+
+
+
◆ [2/3]
+
+
+
+
+
+
+
+
+ xlnt::invalid_cell_reference::invalid_cell_reference
+ (
+ const std::string &
+ reference_string )
+
+
+
+
+explicit
+
+
+
+
+
+
◆ [3/3]
+
+
+
+
+
Default copy constructor.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ xlnt::invalid_cell_reference::~invalid_cell_reference
+ (
+ )
+
+
+
+
+override
+
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::invalid_column_index , including all inherited members.
+
xlnt: xlnt::invalid_column_index Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Exception for bad column indices in A1-style cell references.
+ More...
+
+
#include <exceptions.hpp >
+
+
+
+
+
+
+
+
+
+
Exception for bad column indices in A1-style cell references.
+
+
+
◆ [1/2]
+
+
+
+
+
+ xlnt::invalid_column_index::invalid_column_index
+ (
+ )
+
+
+
+
+
Default constructor.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Default copy constructor.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ xlnt::invalid_column_index::~invalid_column_index
+ (
+ )
+
+
+
+
+override
+
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::invalid_data_type , including all inherited members.
+
xlnt: xlnt::invalid_data_type Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Exception for any data type inconsistencies.
+ More...
+
+
#include <exceptions.hpp >
+
+
+
+
+
+
+
+
+
+
Exception for any data type inconsistencies.
+
+
+
◆ [1/2]
+
+
+
+
+
+ xlnt::invalid_data_type::invalid_data_type
+ (
+ )
+
+
+
+
+
Default constructor.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ xlnt::invalid_data_type::invalid_data_type
+ (
+ const invalid_data_type &
+ )
+
+
+
+
+default
+
+
+
+
+
Default copy constructor.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ xlnt::invalid_data_type::~invalid_data_type
+ (
+ )
+
+
+
+
+override
+
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::invalid_file , including all inherited members.
+
xlnt: xlnt::invalid_file Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Exception for trying to open a non-XLSX file.
+ More...
+
+
#include <exceptions.hpp >
+
+
+
+
+
+
+
+
+
+
Exception for trying to open a non-XLSX file.
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ xlnt::invalid_file::invalid_file
+ (
+ const std::string &
+ filename )
+
+
+
+
+explicit
+
+
+
+
+
Constructs an invalid_file exception thrown when attempt to access the given filename.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ xlnt::invalid_file::invalid_file
+ (
+ const invalid_file &
+ )
+
+
+
+
+default
+
+
+
+
+
Default copy constructor.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ xlnt::invalid_file::~invalid_file
+ (
+ )
+
+
+
+
+override
+
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::invalid_parameter , including all inherited members.
+
xlnt: xlnt::invalid_parameter Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Exception for a bad parameter value
+ More...
+
+
#include <exceptions.hpp >
+
+
+
+
+
+
+
+
+
+
Exception for a bad parameter value
+
+
+
◆ [1/2]
+
+
+
+
+
+ xlnt::invalid_parameter::invalid_parameter
+ (
+ )
+
+
+
+
+
Default constructor.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ xlnt::invalid_parameter::invalid_parameter
+ (
+ const invalid_parameter &
+ )
+
+
+
+
+default
+
+
+
+
+
Default copy constructor.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ xlnt::invalid_parameter::~invalid_parameter
+ (
+ )
+
+
+
+
+override
+
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::invalid_sheet_title , including all inherited members.
+
xlnt: xlnt::invalid_sheet_title Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Exception for bad sheet names.
+ More...
+
+
#include <exceptions.hpp >
+
+
+
+
+
+
+
+
+
+
Exception for bad sheet names.
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ xlnt::invalid_sheet_title::invalid_sheet_title
+ (
+ const std::string &
+ title )
+
+
+
+
+explicit
+
+
+
+
+
Default constructor.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Default copy constructor.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ xlnt::invalid_sheet_title::~invalid_sheet_title
+ (
+ )
+
+
+
+
+override
+
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::key_not_found , including all inherited members.
+
xlnt: xlnt::key_not_found Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Exception for a key that doesn't exist in a container
+ More...
+
+
#include <exceptions.hpp >
+
+
+
+
+
+
+
+
+
+
Exception for a key that doesn't exist in a container
+
+
+
◆ [1/2]
+
+
+
+
+
+ xlnt::key_not_found::key_not_found
+ (
+ )
+
+
+
+
+
Default constructor.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ xlnt::key_not_found::key_not_found
+ (
+ const key_not_found &
+ )
+
+
+
+
+default
+
+
+
+
+
Default copy constructor.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ xlnt::key_not_found::~key_not_found
+ (
+ )
+
+
+
+
+override
+
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::manifest , including all inherited members.
+
+ canonicalize (const std::vector< xlnt::relationship > &rels) constxlnt::manifest clear ()xlnt::manifest content_type (const path &part) constxlnt::manifest default_type (const std::string &extension) constxlnt::manifest extensions_with_default_types () constxlnt::manifest has_default_type (const std::string &extension) constxlnt::manifest has_override_type (const path &part) constxlnt::manifest has_relationship (const path &source, relationship_type type) constxlnt::manifest has_relationship (const path &source, const std::string &rel_id) constxlnt::manifest operator== (const manifest &other) const (defined in xlnt::manifest )xlnt::manifest override_type (const path &part) constxlnt::manifest parts () constxlnt::manifest parts_with_overriden_types () constxlnt::manifest register_default_type (const std::string &extension, const std::string &type)xlnt::manifest register_override_type (const path &part, const std::string &type)xlnt::manifest register_relationship (const uri &source, relationship_type type, const uri &target, target_mode mode)xlnt::manifest register_relationship (const class relationship &rel)xlnt::manifest relationship (const path &source, relationship_type type) constxlnt::manifest relationship (const path &source, const std::string &rel_id) constxlnt::manifest relationships (const path &source) constxlnt::manifest relationships (const path &source, relationship_type type) constxlnt::manifest unregister_default_type (const std::string &extension)xlnt::manifest unregister_override_type (const path &part)xlnt::manifest unregister_relationship (const uri &source, const std::string &rel_id)xlnt::manifest
xlnt: xlnt::manifest Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
The manifest keeps track of all files in the OOXML package and their type and relationships.
+ More...
+
+
#include <manifest.hpp >
+
+void clear () Unregisters all default and override type and all relationships and known parts. More... std::vector< path > parts () const Returns the path to all internal package parts registered as a source or target of a relationship. More... bool has_relationship (const path &source, relationship_type type) const Returns true if the manifest contains a relationship with the given type with part as the source. More... bool has_relationship (const path &source, const std::string &rel_id) const Returns true if the manifest contains a relationship with the given type with part as the source. More... class relationship relationship (const path &source, relationship_type type) const Returns the relationship with "source" as the source and with a type of "type". Throws a key_not_found exception if no such relationship is found. More... class relationship relationship (const path &source, const std::string &rel_id) const Returns the relationship with "source" as the source and with an ID of "rel_id". Throws a key_not_found exception if no such relationship is found. More... std::vector< xlnt::relationship > relationships (const path &source) const Returns all relationship with "source" as the source. More... std::vector< xlnt::relationship > relationships (const path &source, relationship_type type) const Returns all relationships with "source" as the source and with a type of "type". More... path canonicalize (const std::vector< xlnt::relationship > &rels) const Returns the canonical path of the chain of relationships by traversing through rels and forming the absolute combined path. More... std::string register_relationship (const uri &source, relationship_type type, const uri &target, target_mode mode) Registers a new relationship by specifying all of the relationship properties explicitly. More... std::string register_relationship (const class relationship &rel) Registers a new relationship already constructed elsewhere. More... std::unordered_map< std::string, std::string > unregister_relationship (const uri &source, const std::string &rel_id) Delete the relationship with the given id from source part. Returns a mapping of relationship IDs since IDs are shifted down. For example, if there are three relationships for part a.xml like [rId1, rId2, rId3] and rId2 is deleted, the resulting map would look like [rId3->rId2]. More... std::string content_type (const path &part) const Given the path to a part, returns the content type of the part as a string. More... bool has_default_type (const std::string &extension) const Returns true if a default content type for the extension has been registered. More... std::vector< std::string > extensions_with_default_types () const Returns a vector of all extensions with registered default content types. More... std::string default_type (const std::string &extension) const Returns the registered default content type for parts of the given extension. More... void register_default_type (const std::string &extension, const std::string &type) Associates the given extension with the given content type. More... void unregister_default_type (const std::string &extension) Unregisters the default content type for the given extension. More... bool has_override_type (const path &part) const Returns true if a content type overriding the default content type has been registered for the given part. More... std::string override_type (const path &part) const Returns the override content type registered for the given part. Throws key_not_found exception if no override type was found. More... std::vector< path > parts_with_overriden_types () const Returns the path of every part in this manifest with an overriden content type. More... void register_override_type (const path &part, const std::string &type) Overrides any default type registered for the part's extension with the given content type. More... void unregister_override_type (const path &part) Unregisters the overriding content type of the given part. More... operator== (const manifest &other) const
+
+
The manifest keeps track of all files in the OOXML package and their type and relationships.
+
+
+
◆
+
+
+
+
+
Returns the canonical path of the chain of relationships by traversing through rels and forming the absolute combined path.
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::manifest::clear
+ (
+ )
+
+
+
+
+
Unregisters all default and override type and all relationships and known parts.
+
+
+
+
+
◆
+
+
+
+
+
+ std::string xlnt::manifest::content_type
+ (
+ const path &
+ part )
+ const
+
+
+
+
+
Given the path to a part, returns the content type of the part as a string.
+
+
+
+
+
◆
+
+
+
+
+
+ std::string xlnt::manifest::default_type
+ (
+ const std::string &
+ extension )
+ const
+
+
+
+
+
Returns the registered default content type for parts of the given extension.
+
+
+
+
+
◆
+
+
+
+
+
+ std::vector<std::string> xlnt::manifest::extensions_with_default_types
+ (
+ )
+ const
+
+
+
+
+
Returns a vector of all extensions with registered default content types.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::manifest::has_default_type
+ (
+ const std::string &
+ extension )
+ const
+
+
+
+
+
Returns true if a default content type for the extension has been registered.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::manifest::has_override_type
+ (
+ const path &
+ part )
+ const
+
+
+
+
+
Returns true if a content type overriding the default content type has been registered for the given part.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ bool xlnt::manifest::has_relationship
+ (
+ const path &
+ source ,
+
+ relationship_type type
+
+ )
+ const
+
+
+
+
+
Returns true if the manifest contains a relationship with the given type with part as the source.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ bool xlnt::manifest::has_relationship
+ (
+ const path &
+ source ,
+
+ const std::string &
+ rel_id
+
+ )
+ const
+
+
+
+
+
Returns true if the manifest contains a relationship with the given type with part as the source.
+
+
+
+
+
◆
+
+
+
+
+
+ std::string xlnt::manifest::override_type
+ (
+ const path &
+ part )
+ const
+
+
+
+
+
Returns the override content type registered for the given part. Throws key_not_found exception if no override type was found.
+
+
+
+
+
◆
+
+
+
+
+
+ std::vector<path > xlnt::manifest::parts
+ (
+ )
+ const
+
+
+
+
+
Returns the path to all internal package parts registered as a source or target of a relationship.
+
+
+
+
+
◆
+
+
+
+
+
+ std::vector<path > xlnt::manifest::parts_with_overriden_types
+ (
+ )
+ const
+
+
+
+
+
Returns the path of every part in this manifest with an overriden content type.
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::manifest::register_default_type
+ (
+ const std::string &
+ extension ,
+
+ const std::string &
+ type
+
+ )
+
+
+
+
+
Associates the given extension with the given content type.
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::manifest::register_override_type
+ (
+ const path &
+ part ,
+
+ const std::string &
+ type
+
+ )
+
+
+
+
+
Overrides any default type registered for the part's extension with the given content type.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ std::string xlnt::manifest::register_relationship
+ (
+ const uri &
+ source ,
+
+ relationship_type type ,
+
+ const uri &
+ target ,
+
+ target_mode mode
+
+ )
+
+
+
+
+
Registers a new relationship by specifying all of the relationship properties explicitly.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ std::string xlnt::manifest::register_relationship
+ (
+ const class relationship &
+ rel )
+
+
+
+
+
Registers a new relationship already constructed elsewhere.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ class relationship xlnt::manifest::relationship
+ (
+ const path &
+ source ,
+
+ const std::string &
+ rel_id
+
+ )
+ const
+
+
+
+
+
Returns the relationship with "source" as the source and with an ID of "rel_id". Throws a key_not_found exception if no such relationship is found.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Returns the relationship with "source" as the source and with a type of "type". Throws a key_not_found exception if no such relationship is found.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Returns all relationship with "source" as the source.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Returns all relationships with "source" as the source and with a type of "type".
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::manifest::unregister_default_type
+ (
+ const std::string &
+ extension )
+
+
+
+
+
Unregisters the default content type for the given extension.
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::manifest::unregister_override_type
+ (
+ const path &
+ part )
+
+
+
+
+
Unregisters the overriding content type of the given part.
+
+
+
+
+
◆
+
+
+
+
+
+ std::unordered_map<std::string, std::string> xlnt::manifest::unregister_relationship
+ (
+ const uri &
+ source ,
+
+ const std::string &
+ rel_id
+
+ )
+
+
+
+
+
Delete the relationship with the given id from source part. Returns a mapping of relationship IDs since IDs are shifted down. For example, if there are three relationships for part a.xml like [rId1, rId2, rId3] and rId2 is deleted, the resulting map would look like [rId3->rId2].
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::named_range , including all inherited members.
+
xlnt: xlnt::named_range Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
A 2D range of cells in a worksheet that is referred to by name. ws->range("A1:B2") could be replaced by ws->range("range1")
+ More...
+
+
#include <named_range.hpp >
+
+
+
A 2D range of cells in a worksheet that is referred to by name. ws->range("A1:B2") could be replaced by ws->range("range1")
+
+
+
◆
+
+
+
+
+
Type alias for the combination of sheet and range this named_range points to.
+
+
+
+
+
+
◆ [1/3]
+
+
+
+
+
+ xlnt::named_range::named_range
+ (
+ )
+
+
+
+
+
Constructs a named range that has no name and has no targets.
+
+
+
+
+
◆ [2/3]
+
+
+
+
+
+ xlnt::named_range::named_range
+ (
+ const named_range &
+ other )
+
+
+
+
+
Constructs a named range by copying its name and targets from other.
+
+
+
+
+
◆ [3/3]
+
+
+
+
+
+ xlnt::named_range::named_range
+ (
+ const std::string &
+ name ,
+
+ const std::vector< target > &
+ targets
+
+ )
+
+
+
+
+
Constructs a named range with the given name and targets.
+
+
+
+
+
+
◆
+
+
+
+
+
+ std::string xlnt::named_range::name
+ (
+ )
+ const
+
+
+
+
+
Returns the name of this range.
+
+
+
+
+
◆
+
+
+
+
+
Assigns the name and targets of this named_range to that of other.
+
+
+
+
+
◆
+
+
+
+
+
+ const std::vector<target >& xlnt::named_range::targets
+ (
+ )
+ const
+
+
+
+
+
Returns the set of targets of this named range as a vector.
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::no_visible_worksheets , including all inherited members.
+
xlnt: xlnt::no_visible_worksheets Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Exception for a workbook with no visible worksheets
+ More...
+
+
#include <exceptions.hpp >
+
+
+
+
+
+
+
+
+
+
Exception for a workbook with no visible worksheets
+
+
+
◆ [1/2]
+
+
+
+
+
+ xlnt::no_visible_worksheets::no_visible_worksheets
+ (
+ )
+
+
+
+
+
Default constructor.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Default copy constructor.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ xlnt::no_visible_worksheets::~no_visible_worksheets
+ (
+ )
+
+
+
+
+override
+
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::number_format , including all inherited members.
+
xlnt: xlnt::number_format Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Describes the number formatting applied to text and numbers within a certain cell.
+ More...
+
+
#include <number_format.hpp >
+
+ number_format () Constructs a default number_format equivalent to "General" More... number_format (std::size_t builtin_id) Constructs a number format equivalent to that returned from number_format::from_builtin_id(builtin_id). More... number_format (const std::string &code) Constructs a number format from a code string. If the string matches a builtin ID, its ID will also be set to match the builtin ID. More... number_format (const std::string &code, std::size_t custom_id) Constructs a number format from a code string and custom ID. Custom ID should generally be >= 164. More... void format_string (const std::string &format_code) Sets the format code of this number format to format_code. More... void format_string (const std::string &format_code, std::size_t custom_id) Sets the format code of this number format to format_code and the ID to custom_id. More... std::string format_string () const Returns the format code this number format uses. More... bool has_id () const Returns true if this number format has an ID. More... void id (std::size_t id) Sets the ID of this number format to id. More... std::size_t id () const Returns the ID of this format. More... std::string format (const std::string &text ) const Returns text formatted according to this number format's format code. More... std::string format (double number , calendar base_date) const Returns number formatted according to this number format's format code with the given base date. More... bool is_date_format () const Returns true if this format code returns a number formatted as a date. More... bool operator== (const number_format &other) const Returns true if this format is equivalent to other. More... bool operator!= (const number_format &other) const Returns true if this format is not equivalent to other. More...
+
+
Describes the number formatting applied to text and numbers within a certain cell.
+
+
+
◆ [1/4]
+
+
+
+
+
+ xlnt::number_format::number_format
+ (
+ )
+
+
+
+
+
Constructs a default number_format equivalent to "General"
+
+
+
+
+
◆ [2/4]
+
+
+
+
+
+ xlnt::number_format::number_format
+ (
+ std::size_t
+ builtin_id )
+
+
+
+
+
Constructs a number format equivalent to that returned from number_format::from_builtin_id(builtin_id).
+
+
+
+
+
◆ [3/4]
+
+
+
+
+
+ xlnt::number_format::number_format
+ (
+ const std::string &
+ code )
+
+
+
+
+
Constructs a number format from a code string. If the string matches a builtin ID, its ID will also be set to match the builtin ID.
+
+
+
+
+
◆ [4/4]
+
+
+
+
+
+ xlnt::number_format::number_format
+ (
+ const std::string &
+ code ,
+
+ std::size_t
+ custom_id
+
+ )
+
+
+
+
+
Constructs a number format from a code string and custom ID. Custom ID should generally be >= 164.
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static const number_format xlnt::number_format::date_datetime
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Number format "yyyy-mm-dd h:mm:ss"
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static const number_format xlnt::number_format::date_ddmmyyyy
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Number format "dd/mm/yy"
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static const number_format xlnt::number_format::date_dmminus
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Number format "d-m"
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static const number_format xlnt::number_format::date_dmyminus
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Number format "d-m-yy"
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static const number_format xlnt::number_format::date_dmyslash
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Number format "d/m/yy"
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static const number_format xlnt::number_format::date_myminus
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Number format "m-yy"
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static const number_format xlnt::number_format::date_time1
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Number format "h:mm AM/PM"
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static const number_format xlnt::number_format::date_time2
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Number format "h:mm:ss AM/PM"
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static const number_format xlnt::number_format::date_time3
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Number format "h:mm"
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static const number_format xlnt::number_format::date_time4
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Number format "h:mm:ss"
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static const number_format xlnt::number_format::date_time5
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Number format "mm:ss"
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static const number_format xlnt::number_format::date_time6
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Number format "h:mm:ss"
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static const number_format xlnt::number_format::date_xlsx14
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Number format "mm-dd-yy"
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static const number_format xlnt::number_format::date_xlsx15
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Number format "d-mmm-yy"
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static const number_format xlnt::number_format::date_xlsx16
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Number format "d-mmm"
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static const number_format xlnt::number_format::date_xlsx17
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Number format "mmm-yy"
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static const number_format xlnt::number_format::date_xlsx22
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Number format "m/d/yy h:mm"
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static const number_format xlnt::number_format::date_yymmdd
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Number format "yy-mm-dd"
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static const number_format xlnt::number_format::date_yyyymmdd2
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Number format "yyyy-mm-dd"
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ std::string xlnt::number_format::format
+ (
+ const std::string &
+ text )
+ const
+
+
+
+
+
Returns text formatted according to this number format's format code.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ std::string xlnt::number_format::format
+ (
+ double
+ number ,
+
+ calendar base_date
+
+ )
+ const
+
+
+
+
+
Returns number formatted according to this number format's format code with the given base date.
+
+
+
+
+
◆ [1/3]
+
+
+
+
+
+ void xlnt::number_format::format_string
+ (
+ const std::string &
+ format_code )
+
+
+
+
+
Sets the format code of this number format to format_code.
+
+
+
+
+
◆ [2/3]
+
+
+
+
+
+ void xlnt::number_format::format_string
+ (
+ const std::string &
+ format_code ,
+
+ std::size_t
+ custom_id
+
+ )
+
+
+
+
+
Sets the format code of this number format to format_code and the ID to custom_id.
+
+
+
+
+
◆ [3/3]
+
+
+
+
+
+ std::string xlnt::number_format::format_string
+ (
+ )
+ const
+
+
+
+
+
Returns the format code this number format uses.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static const number_format & xlnt::number_format::from_builtin_id
+ (
+ std::size_t
+ builtin_id )
+
+
+
+
+static
+
+
+
+
+
Returns the format with the given ID. Thows an invalid_parameter exception if builtin_id is not a valid ID.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static const number_format xlnt::number_format::general
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Number format "General"
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::number_format::has_id
+ (
+ )
+ const
+
+
+
+
+
Returns true if this number format has an ID.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ void xlnt::number_format::id
+ (
+ std::size_t
+ id )
+
+
+
+
+
Sets the ID of this number format to id.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ std::size_t xlnt::number_format::id
+ (
+ )
+ const
+
+
+
+
+
Returns the ID of this format.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static bool xlnt::number_format::is_builtin_format
+ (
+ std::size_t
+ builtin_id )
+
+
+
+
+static
+
+
+
+
+
Returns true if the given format ID corresponds to a known builtin format.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::number_format::is_date_format
+ (
+ )
+ const
+
+
+
+
+
Returns true if this format code returns a number formatted as a date.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static const number_format xlnt::number_format::number
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static const number_format xlnt::number_format::number_00
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Number format "00"
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static const number_format xlnt::number_format::number_comma_separated1
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Number format "#,##0.00"
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::number_format::operator!=
+ (
+ const number_format &
+ other )
+ const
+
+
+
+
+
Returns true if this format is not equivalent to other.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::number_format::operator==
+ (
+ const number_format &
+ other )
+ const
+
+
+
+
+
Returns true if this format is equivalent to other.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static const number_format xlnt::number_format::percentage
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Number format "0%"
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static const number_format xlnt::number_format::percentage_00
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Number format "0.00%"
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static const number_format xlnt::number_format::text
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::optional< T > , including all inherited members.
+
xlnt: xlnt::optional< T > Class Template Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Many settings in xlnt are allowed to not have a value set. This class encapsulates a value which may or may not be set. Memory is allocated within the optional class.
+ More...
+
+
#include <optional.hpp >
+
+ optional () noexcept Default contructor. is_set() will be false initially. More... optional (const T &value) noexcept(XLNT_NOEXCEPT_VALUE_COMPAT(ctor_copy_T_noexcept{})) Constructs this optional with a value. noexcept if T copy ctor is noexcept More... optional (T &&value) noexcept(XLNT_NOEXCEPT_VALUE_COMPAT(ctor_move_T_noexcept{})) Constructs this optional with a value. noexcept if T move ctor is noexcept More... optional (const optional &other) noexcept(XLNT_NOEXCEPT_VALUE_COMPAT(copy_ctor_noexcept{})) Copy constructs this optional from other noexcept if T copy ctor is noexcept More... optional (optional &&other) noexcept(XLNT_NOEXCEPT_VALUE_COMPAT(move_ctor_noexcept{})) Move constructs this optional from other. Clears the value from other if set noexcept if T move ctor is noexcept More... optional & operator= (const optional &other) noexcept(XLNT_NOEXCEPT_VALUE_COMPAT(set_copy_noexcept_t{} &&clear_noexcept_t{})) Copy assignment of this optional from other noexcept if set and clear are noexcept for T& More... optional & operator= (optional &&other) noexcept(XLNT_NOEXCEPT_VALUE_COMPAT(set_move_noexcept_t{} &&clear_noexcept_t{})) Move assignment of this optional from other noexcept if set and clear are noexcept for T&& More... ~optional () noexcept Destructor cleans up the T instance if set More... bool is_set () const noexcept Returns true if this object currently has a value set. This should be called before accessing the value with optional::get() . More... void set (const T &value) noexcept(XLNT_NOEXCEPT_VALUE_COMPAT(set_copy_noexcept_t{})) Copies the value into the stored value More... void set (T &&value) noexcept(XLNT_NOEXCEPT_VALUE_COMPAT(set_move_noexcept_t{})) Moves the value into the stored value More... optional & operator= (const T &rhs) noexcept(XLNT_NOEXCEPT_VALUE_COMPAT(set_copy_noexcept_t{})) Assignment operator overload. Equivalent to setting the value using optional::set . More... optional & operator= (T &&rhs) noexcept(XLNT_NOEXCEPT_VALUE_COMPAT(set_move_noexcept_t{})) Assignment operator overload. Equivalent to setting the value using optional::set . More... void clear () noexcept(XLNT_NOEXCEPT_VALUE_COMPAT(clear_noexcept_t{})) After this is called, is_set() will return false until a new value is provided. More... T & get () Gets the value. If no value has been initialized in this object, an xlnt::invalid_attribute exception will be thrown. More... const T & get () const Gets the value. If no value has been initialized in this object, an xlnt::invalid_attribute exception will be thrown. More... bool operator== (const optional < T > &other) const noexcept Returns true if neither this nor other have a value or both have a value and those values are equal according to their equality operator. More... bool operator!= (const optional < T > &other) const noexcept Returns false if neither this nor other have a value or both have a value and those values are equal according to their equality operator. More...
+
+
template<typename T>
+
+
Many settings in xlnt are allowed to not have a value set. This class encapsulates a value which may or may not be set. Memory is allocated within the optional class.
+
+
+
◆ [1/5]
+
+
+
+
+template<typename T>
+
+
+
+
+
+
+inline noexcept
+
+
+
+
+
Default contructor. is_set() will be false initially.
+
+
+
+
+
◆ [2/5]
+
+
+
+
+template<typename T>
+
+
+
+
+
+
+inline noexcept
+
+
+
+
+
Constructs this optional with a value. noexcept if T copy ctor is noexcept
+
+
+
+
+
◆ [3/5]
+
+
+
+
+template<typename T>
+
+
+
+
+
+
+inline noexcept
+
+
+
+
+
Constructs this optional with a value. noexcept if T move ctor is noexcept
+
+
+
+
+
◆ [4/5]
+
+
+
+
+template<typename T>
+
+
+
+
+
+
+inline noexcept
+
+
+
+
+
Copy constructs this optional from other noexcept if T copy ctor is noexcept
+
+
+
+
+
◆ [5/5]
+
+
+
+
+template<typename T>
+
+
+
+
+
+
+inline noexcept
+
+
+
+
+
Move constructs this optional from other. Clears the value from other if set noexcept if T move ctor is noexcept
+
+
+
+
+
◆
+
+
+
+
+template<typename T>
+
+
+
+
+
+
+inline noexcept
+
+
+
+
+
Destructor cleans up the T instance if set
+
+
+
+
+
+
◆
+
+
+
+
+template<typename T>
+
+
+
+
+
+
+inline noexcept
+
+
+
+
+
After this is called, is_set() will return false until a new value is provided.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+template<typename T>
+
+
+
+
Gets the value. If no value has been initialized in this object, an xlnt::invalid_attribute exception will be thrown.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+template<typename T>
+
+
+
+
Gets the value. If no value has been initialized in this object, an xlnt::invalid_attribute exception will be thrown.
+
+
+
+
+
◆
+
+
+
+
+template<typename T>
+
+
+
+
+
+
+inline noexcept
+
+
+
+
+
Returns true if this object currently has a value set. This should be called before accessing the value with optional::get() .
+
+
+
+
+
◆
+
+
+
+
+template<typename T>
+
+
+
+
+
+
+inline noexcept
+
+
+
+
+
Returns false if neither this nor other have a value or both have a value and those values are equal according to their equality operator.
+
+
+
+
+
◆ [1/4]
+
+
+
+
+template<typename T>
+
+
+
+
+
+
+inline noexcept
+
+
+
+
+
Copy assignment of this optional from other noexcept if set and clear are noexcept for T&
+
+
+
+
+
◆ [2/4]
+
+
+
+
+template<typename T>
+
+
+
+
+
+
+inline noexcept
+
+
+
+
+
Move assignment of this optional from other noexcept if set and clear are noexcept for T&&
+
+
+
+
+
◆ [3/4]
+
+
+
+
+template<typename T>
+
+
+
+
+
+
+inline noexcept
+
+
+
+
+
Assignment operator overload. Equivalent to setting the value using optional::set .
+
+
+
+
+
◆ [4/4]
+
+
+
+
+template<typename T>
+
+
+
+
+
+
+inline noexcept
+
+
+
+
+
Assignment operator overload. Equivalent to setting the value using optional::set .
+
+
+
+
+
◆
+
+
+
+
+template<typename T>
+
+
+
+
+
+
+inline noexcept
+
+
+
+
+
Returns true if neither this nor other have a value or both have a value and those values are equal according to their equality operator.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+template<typename T>
+
+
+
+
+
+
+inline noexcept
+
+
+
+
+
Copies the value into the stored value
+
+
+
+
+
◆ [2/2]
+
+
+
+
+template<typename T>
+
+
+
+
+
+
+inline noexcept
+
+
+
+
+
Moves the value into the stored value
+
+
+
+
The documentation for this class was generated from the following files:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::page_margins , including all inherited members.
+
xlnt: xlnt::page_margins Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Describes the margins around a worksheet for printing.
+ More...
+
+
#include <page_margins.hpp >
+
+ page_margins () Constructs a page margins objects with Excel-default margins. More... double top () const Returns the top margin More... void top (double top) Sets the top margin to top More... double left () const Returns the left margin More... void left (double left) Sets the left margin to left More... double bottom () const Returns the bottom margin More... void bottom (double bottom) Sets the bottom margin to bottom More... double right () const Returns the right margin More... void right (double right) Sets the right margin to right More... double header () const Returns the header margin More... void header (double header) Sets the header margin to header More... double footer () const Returns the footer margin More... void footer (double footer) Sets the footer margin to footer More... operator== (const page_margins &rhs) const
+
+
Describes the margins around a worksheet for printing.
+
+
+
◆
+
+
+
+
+
+ xlnt::page_margins::page_margins
+ (
+ )
+
+
+
+
+
Constructs a page margins objects with Excel-default margins.
+
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ double xlnt::page_margins::bottom
+ (
+ )
+ const
+
+
+
+
+
Returns the bottom margin
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::page_margins::bottom
+ (
+ double
+ bottom )
+
+
+
+
+
Sets the bottom margin to bottom
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ double xlnt::page_margins::footer
+ (
+ )
+ const
+
+
+
+
+
Returns the footer margin
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::page_margins::footer
+ (
+ double
+ footer )
+
+
+
+
+
Sets the footer margin to footer
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ double xlnt::page_margins::header
+ (
+ )
+ const
+
+
+
+
+
Returns the header margin
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::page_margins::header
+ (
+ double
+ header )
+
+
+
+
+
Sets the header margin to header
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ double xlnt::page_margins::left
+ (
+ )
+ const
+
+
+
+
+
Returns the left margin
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::page_margins::left
+ (
+ double
+ left )
+
+
+
+
+
Sets the left margin to left
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ double xlnt::page_margins::right
+ (
+ )
+ const
+
+
+
+
+
Returns the right margin
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::page_margins::right
+ (
+ double
+ right )
+
+
+
+
+
Sets the right margin to right
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ double xlnt::page_margins::top
+ (
+ )
+ const
+
+
+
+
+
Returns the top margin
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::page_margins::top
+ (
+ double
+ top )
+
+
+
+
+
Sets the top margin to top
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::path , including all inherited members.
+
xlnt: xlnt::path Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Encapsulates a path that points to location in a filesystem.
+ More...
+
+
#include <path.hpp >
+
+ path () Construct an empty path. More... path (const std::string &path_string) Counstruct a path from a string representing the path. More... path (const std::string &path_string, char sep) Construct a path from a string with an explicit directory seprator. More... bool is_relative () const Return true iff this path doesn't begin with / (or a drive letter on Windows). More... bool is_absolute () const Return true iff path::is_relative() is false. More... bool is_root () const Return true iff this path is the root directory. More... path parent () const Return a new path that points to the directory containing the current path Return the path unchanged if this path is the absolute or relative root. More... std::string filename () const Return the last component of this path. More... std::string extension () const Return the part of the path following the last dot in the filename. More... std::pair< std::string, std::string > split_extension () const Return a pair of strings resulting from splitting the filename on the last dot. More... std::vector< std::string > split () const Create a string representing this path separated by the provided separator or the system-default separator if not provided. More... const std::string & string () const Create a string representing this path separated by the provided separator or the system-default separator if not provided. More... path resolve (const path &base_path) const If this path is relative, append each component of this path to base_path and return the resulting absolute path. Otherwise, the the current path will be returned and base_path will be ignored. More... path relative_to (const path &base_path) const The inverse of path::resolve . Creates a relative path from an absolute path by removing the common root between base_path and this path. If the current path is already relative, return it unchanged. More... bool exists () const Return true iff the file or directory pointed to by this path exists on the filesystem. More... bool is_directory () const Return true if the file or directory pointed to by this path is a directory. More... bool is_file () const Return true if the file or directory pointed to by this path is a regular file. More... std::string read_contents () const Open the file pointed to by this path and return a string containing the files contents. More... path append (const std::string &to_append) const Append the provided part to this path and return the result. More... path append (const path &to_append) const Append the provided part to this path and return the result. More... bool operator== (const path &other) const Returns true if left path is equal to right path. More... bool operator!= (const path &other) const Returns true if left path is equal to right path. More...
+
+
Encapsulates a path that points to location in a filesystem.
+
+
+
◆ [1/3]
+
+
+
+
+
+ xlnt::path::path
+ (
+ )
+
+
+
+
+
Construct an empty path.
+
+
+
+
+
◆ [2/3]
+
+
+
+
+
+
+
+
+ xlnt::path::path
+ (
+ const std::string &
+ path_string )
+
+
+
+
+explicit
+
+
+
+
+
Counstruct a path from a string representing the path.
+
+
+
+
+
◆ [3/3]
+
+
+
+
+
+ xlnt::path::path
+ (
+ const std::string &
+ path_string ,
+
+ char
+ sep
+
+ )
+
+
+
+
+
Construct a path from a string with an explicit directory seprator.
+
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ path xlnt::path::append (
+ const std::string &
+ to_append )
+ const
+
+
+
+
+
Append the provided part to this path and return the result.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ path xlnt::path::append (
+ const path &
+ to_append )
+ const
+
+
+
+
+
Append the provided part to this path and return the result.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::path::exists
+ (
+ )
+ const
+
+
+
+
+
Return true iff the file or directory pointed to by this path exists on the filesystem.
+
+
+
+
+
◆
+
+
+
+
+
+ std::string xlnt::path::extension
+ (
+ )
+ const
+
+
+
+
+
Return the part of the path following the last dot in the filename.
+
+
+
+
+
◆
+
+
+
+
+
+ std::string xlnt::path::filename
+ (
+ )
+ const
+
+
+
+
+
Return the last component of this path.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::path::is_absolute
+ (
+ )
+ const
+
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::path::is_directory
+ (
+ )
+ const
+
+
+
+
+
Return true if the file or directory pointed to by this path is a directory.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::path::is_file
+ (
+ )
+ const
+
+
+
+
+
Return true if the file or directory pointed to by this path is a regular file.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::path::is_relative
+ (
+ )
+ const
+
+
+
+
+
Return true iff this path doesn't begin with / (or a drive letter on Windows).
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::path::is_root
+ (
+ )
+ const
+
+
+
+
+
Return true iff this path is the root directory.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::path::operator!=
+ (
+ const path &
+ other )
+ const
+
+
+
+
+
Returns true if left path is equal to right path.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::path::operator==
+ (
+ const path &
+ other )
+ const
+
+
+
+
+
Returns true if left path is equal to right path.
+
+
+
+
+
◆
+
+
+
+
+
+ path xlnt::path::parent (
+ )
+ const
+
+
+
+
+
Return a new path that points to the directory containing the current path Return the path unchanged if this path is the absolute or relative root.
+
+
+
+
+
◆
+
+
+
+
+
+ std::string xlnt::path::read_contents
+ (
+ )
+ const
+
+
+
+
+
Open the file pointed to by this path and return a string containing the files contents.
+
+
+
+
+
◆
+
+
+
+
+
+ path xlnt::path::relative_to (
+ const path &
+ base_path )
+ const
+
+
+
+
+
The inverse of path::resolve . Creates a relative path from an absolute path by removing the common root between base_path and this path. If the current path is already relative, return it unchanged.
+
+
+
+
+
◆
+
+
+
+
+
+ path xlnt::path::resolve (
+ const path &
+ base_path )
+ const
+
+
+
+
+
If this path is relative, append each component of this path to base_path and return the resulting absolute path. Otherwise, the the current path will be returned and base_path will be ignored.
+
+
+
+
+
◆
+
+
+
+
+
+ std::vector<std::string> xlnt::path::split
+ (
+ )
+ const
+
+
+
+
+
Create a string representing this path separated by the provided separator or the system-default separator if not provided.
+
+
+
+
+
◆
+
+
+
+
+
+ std::pair<std::string, std::string> xlnt::path::split_extension
+ (
+ )
+ const
+
+
+
+
+
Return a pair of strings resulting from splitting the filename on the last dot.
+
+
+
+
+
◆
+
+
+
+
+
+ const std::string& xlnt::path::string
+ (
+ )
+ const
+
+
+
+
+
Create a string representing this path separated by the provided separator or the system-default separator if not provided.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static char xlnt::path::system_separator
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
The system-specific path separator character (e.g. '/' or '\').
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::pattern_fill , including all inherited members.
+
xlnt: xlnt::pattern_fill Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Represents a fill which colors the cell based on a foreground and background color and a pattern.
+ More...
+
+
#include <fill.hpp >
+
+
+
Represents a fill which colors the cell based on a foreground and background color and a pattern.
+
+
+
◆
+
+
+
+
+
+ xlnt::pattern_fill::pattern_fill
+ (
+ )
+
+
+
+
+
Constructs a default pattern fill with a none pattern and no colors.
+
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ optional <color > xlnt::pattern_fill::background (
+ )
+ const
+
+
+
+
+
Returns the optional background color of this fill
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ pattern_fill & xlnt::pattern_fill::background (
+ const color &
+ background )
+
+
+
+
+
Sets the foreground color and returns a reference to this pattern.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ optional <color > xlnt::pattern_fill::foreground (
+ )
+ const
+
+
+
+
+
Returns the optional foreground color of this fill
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ pattern_fill & xlnt::pattern_fill::foreground (
+ const color &
+ foreground )
+
+
+
+
+
Sets the foreground color and returns a reference to this pattern.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::pattern_fill::operator!=
+ (
+ const pattern_fill &
+ other )
+ const
+
+
+
+
+
Returns true if this pattern fill is not equivalent to other.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::pattern_fill::operator==
+ (
+ const pattern_fill &
+ other )
+ const
+
+
+
+
+
Returns true if this pattern fill is equivalent to other.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Returns the pattern used by this fill
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Sets the pattern of this fill and returns a reference to it.
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::phonetic_pr , including all inherited members.
+
xlnt: xlnt::phonetic_pr Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Phonetic properties Element provides a collection of properties that affect display of East Asian Languages [Serialised phoneticPr]
+ More...
+
+
#include <phonetic_pr.hpp >
+
+enum align { center ,
+distributed ,
+left ,
+no_control
+ } possible values for alignment property More... enum phonetic_type { full_width_katakana ,
+half_width_katakana ,
+hiragana ,
+no_conversion
+ } possible values for type property More... using font_id_t = std::uint32_t FontID represented by an unsigned 32-bit integer More...
+
+
Phonetic properties Element provides a collection of properties that affect display of East Asian Languages [Serialised phoneticPr]
+
+
+
◆
+
+
+
+
+
FontID represented by an unsigned 32-bit integer
+
+
+
+
+
+
◆
+
+
+
+
+
possible values for alignment property
+
+
+
+
+
◆
+
+
+
+
+
possible values for type property
+
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ xlnt::phonetic_pr::phonetic_pr
+ (
+ )
+
+
+
+
+default
+
+
+
+
+
Default ctor for phonetic properties
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ xlnt::phonetic_pr::phonetic_pr
+ (
+ font_id_t font )
+
+
+
+
+explicit
+
+
+
+
+
FontID ctor for phonetic properties
+
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ align xlnt::phonetic_pr::alignment (
+ )
+ const
+
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::phonetic_pr::alignment
+ (
+ align align )
+
+
+
+
+
+
◆
+
+
+
+
+
string form of alignment enum
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static align xlnt::phonetic_pr::alignment_from_string
+ (
+ const std::string &
+ str )
+
+
+
+
+static
+
+
+
+
+
alignment enum from string
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ font_id_t xlnt::phonetic_pr::font_id (
+ )
+ const
+
+
+
+
+
get the font index
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::phonetic_pr::font_id
+ (
+ font_id_t font )
+
+
+
+
+
set the font index
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::phonetic_pr::has_alignment
+ (
+ )
+ const
+
+
+
+
+
is the alignment set
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::phonetic_pr::has_type
+ (
+ )
+ const
+
+
+
+
+
is the phonetic type set
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::phonetic_pr::serialise
+ (
+ std::ostream &
+ output_stream )
+ const
+
+
+
+
+
adds the xml serialised representation of this element to the stream
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
returns the phonetic type
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::phonetic_pr::type
+ (
+ phonetic_type type )
+
+
+
+
+
sets the phonetic type
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static const std::string& xlnt::phonetic_pr::type_as_string
+ (
+ phonetic_type type )
+
+
+
+
+static
+
+
+
+
+
string form of the type enum
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static phonetic_type xlnt::phonetic_pr::type_from_string
+ (
+ const std::string &
+ str )
+
+
+
+
+static
+
+
+
+
+
type enum from string
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::protection , including all inherited members.
+
xlnt: xlnt::protection Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Describes the protection style of a particular cell.
+ More...
+
+
#include <protection.hpp >
+
+ protection () Constructs a default unlocked unhidden protection object. More... bool locked () const Returns true if cells using this protection should be locked. More... protection & locked (bool locked) Sets the locked state of the protection to locked and returns a reference to the protection. More... bool hidden () const Returns true if cells using this protection should be hidden. More... protection & hidden (bool hidden) Sets the hidden state of the protection to hidden and returns a reference to the protection. More... bool operator== (const protection &other) const Returns true if this protections is equivalent to right. More... bool operator!= (const protection &other) const Returns true if this protection is not equivalent to right. More...
+
+
Describes the protection style of a particular cell.
+
+
+
◆
+
+
+
+
+
+ xlnt::protection::protection
+ (
+ )
+
+
+
+
+
Constructs a default unlocked unhidden protection object.
+
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ bool xlnt::protection::hidden
+ (
+ )
+ const
+
+
+
+
+
Returns true if cells using this protection should be hidden.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ protection & xlnt::protection::hidden (
+ bool
+ hidden )
+
+
+
+
+
Sets the hidden state of the protection to hidden and returns a reference to the protection.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ bool xlnt::protection::locked
+ (
+ )
+ const
+
+
+
+
+
Returns true if cells using this protection should be locked.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ protection & xlnt::protection::locked (
+ bool
+ locked )
+
+
+
+
+
Sets the locked state of the protection to locked and returns a reference to the protection.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static protection xlnt::protection::locked_and_hidden
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Returns a locked and hidden protection object.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static protection xlnt::protection::locked_and_visible
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Returns a locked and unhidden protection object.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::protection::operator!=
+ (
+ const protection &
+ other )
+ const
+
+
+
+
+
Returns true if this protection is not equivalent to right.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::protection::operator==
+ (
+ const protection &
+ other )
+ const
+
+
+
+
+
Returns true if this protections is equivalent to right.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static protection xlnt::protection::unlocked_and_hidden
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Returns an unlocked and hidden protection object.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static protection xlnt::protection::unlocked_and_visible
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Returns an unlocked and unhidden protection object.
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::range , including all inherited members.
+
xlnt: xlnt::range Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
A range is a 2D collection of cells with defined extens that can be iterated upon.
+ More...
+
+
#include <range.hpp >
+
+
+
A range is a 2D collection of cells with defined extens that can be iterated upon.
+
+
+
◆
+
+
+
+
+
Alias for the const iterator type
+
+
+
+
+
◆
+
+
+
+
+
Alias for the const reverse iterator type
+
+
+
+
+
◆
+
+
+
+
+
Alias for the iterator type
+
+
+
+
+
◆
+
+
+
+
+
Alias for the reverse iterator type
+
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ xlnt::range::range
+ (
+ worksheet ws ,
+
+ const range_reference &
+ reference ,
+
+ major_order order = major_order::row,
+
+ bool
+ skip_null = false
+
+ )
+
+
+
+
+
Constructs a range on the given worksheet.
+
+
+
+
+
◆
+
+
+
+
+
+ xlnt::range::~range
+ (
+ )
+
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ xlnt::range::range
+ (
+ const range &
+ )
+
+
+
+
+default
+
+
+
+
+
Default copy constructor.
+
+
+
+
+
+
◆
+
+
+
+
+
Sets the alignment of all cells in the range to new_alignment and returns the range.
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::range::apply
+ (
+ std::function< void(class cell )>
+ f )
+
+
+
+
+
Applies function f to all cells in the range
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Returns the last row or column in this range.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ const cell_vector xlnt::range::back
+ (
+ )
+ const
+
+
+
+
+
Returns the last row or column in this range.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ iterator xlnt::range::begin (
+ )
+
+
+
+
+
Returns an iterator to the first row or column in this range.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Returns an iterator to the first row or column in this range.
+
+
+
+
+
◆
+
+
+
+
+
Sets the border of all cells in the range to new_border and returns the range.
+
+
+
+
+
◆
+
+
+
+
+
Returns an iterator to the first row or column in this range.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Returns a cell in the range relative to its top left cell.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Returns a cell in the range relative to its top left cell.
+
+
+
+
+
◆
+
+
+
+
+
Returns an iterator to one past the last row or column in this range.
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::range::clear_cells
+ (
+ )
+
+
+
+
+
Erases all cell data from the worksheet for cells within this range.
+
+
+
+
+
◆
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::range::contains
+ (
+ const cell_reference &
+ ref )
+
+
+
+
+
Returns true if the given cell exists in the parent worksheet of this range.
+
+
+
+
+
◆
+
+
+
+
+
Returns a reverse iterator to the first row or column in this range.
+
+
+
+
+
◆
+
+
+
+
+
Returns a reverse iterator to one past the last row or column in this range.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ iterator xlnt::range::end (
+ )
+
+
+
+
+
Returns an iterator to one past the last row or column in this range.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Returns an iterator to one past the last row or column in this range.
+
+
+
+
+
◆
+
+
+
+
+
Sets the fill of all cells in the range to new_fill and returns the range.
+
+
+
+
+
◆
+
+
+
+
+
Sets the font of all cells in the range to new_font and returns the range.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Returns the first row or column in this range.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ const cell_vector xlnt::range::front
+ (
+ )
+ const
+
+
+
+
+
Returns the first row or column in this range.
+
+
+
+
+
◆
+
+
+
+
+
+ std::size_t xlnt::range::length
+ (
+ )
+ const
+
+
+
+
+
Returns the number of rows or columns in this range (depending on major order).
+
+
+
+
+
◆
+
+
+
+
+
Sets the number format of all cells in the range to new_number_format and returns the range.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::range::operator!=
+ (
+ const range &
+ comparand )
+ const
+
+
+
+
+
Returns true if this range is not equivalent to comparand.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::range::operator==
+ (
+ const range &
+ comparand )
+ const
+
+
+
+
+
Returns true if this range is equivalent to comparand.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ cell_vector xlnt::range::operator[] (
+ std::size_t
+ n )
+
+
+
+
+
Returns the n-th row or column in this range.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ const cell_vector xlnt::range::operator[]
+ (
+ std::size_t
+ n )
+ const
+
+
+
+
+
Returns the n-th row or column in this range.
+
+
+
+
+
◆
+
+
+
+
+
Sets the protection of all cells in the range to new_protection and returns the range.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Returns a reverse iterator to the first row or column in this range.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Returns a reverse iterator to the first row or column in this range.
+
+
+
+
+
◆
+
+
+
+
+
Returns the reference defining the bounds of this range.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Returns a reverse iterator to one past the last row or column in this range.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Returns a reverse iterator to one past the last row or column in this range.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ range xlnt::range::style (
+ const class style &
+ new_style )
+
+
+
+
+
Sets the named style applied to all cells in this range to a style named style_name.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ range xlnt::range::style (
+ const std::string &
+ style_name )
+
+
+
+
+
Sets the named style applied to all cells in this range to a style named style_name. If this style has not been previously created in the workbook, a key_not_found exception will be thrown.
+
+
+
+
+
◆
+
+
+
+
+
+ const worksheet & xlnt::range::target_worksheet
+ (
+ )
+ const
+
+
+
+
+
The worksheet this range targets
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ cell_vector xlnt::range::vector (
+ std::size_t
+ n )
+
+
+
+
+
Returns a vector pointing to the n-th row or column in this range (depending on major order).
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ const cell_vector xlnt::range::vector
+ (
+ std::size_t
+ n )
+ const
+
+
+
+
+
Returns a vector pointing to the n-th row or column in this range (depending on major order).
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::range_iterator , including all inherited members.
+
xlnt: xlnt::range_iterator Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
An iterator used by worksheet and range for traversing a 2D grid of cells by row/column then across that row/column.
+ More...
+
+
#include <range_iterator.hpp >
+
+using iterator_category = std::bidirectional_iterator_tag iterator tags required for use with standard algorithms and adapters More... value_type = cell_vector difference_type = std::ptrdiff_t pointer = cell_vector * reference = cell_vector
+
+
An iterator used by worksheet and range for traversing a 2D grid of cells by row/column then across that row/column.
+
+
+
◆
+
+
+
+
+
iterator tags required for use with standard algorithms and adapters
+
+
+
+
+
+
◆ [1/4]
+
+
+
+
+
+
+
+
+ xlnt::range_iterator::range_iterator
+ (
+ )
+
+
+
+
+default
+
+
+
+
+
Default constructs a range iterator
+
+
+
+
+
◆ [2/4]
+
+
+
+
+
Constructs a range iterator on a worksheet, cell pointing to the current row or column, range bounds, an order, and whether or not to skip null column/rows.
+
+
+
+
+
◆ [3/4]
+
+
+
+
+
+
+
+
+ xlnt::range_iterator::range_iterator
+ (
+ const range_iterator &
+ )
+
+
+
+
+default
+
+
+
+
+
Default copy constructor.
+
+
+
+
+
◆ [4/4]
+
+
+
+
+
+
+
+
+ xlnt::range_iterator::range_iterator
+ (
+ range_iterator && )
+
+
+
+
+default
+
+
+
+
+
Default move constructor.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ xlnt::range_iterator::~range_iterator
+ (
+ )
+
+
+
+
+default
+
+
+
+
+
Default destructor
+
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::range_iterator::operator!=
+ (
+ const range_iterator &
+ other )
+ const
+
+
+
+
+
Returns true if this iterator is not equivalent to other.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ reference xlnt::range_iterator::operator* (
+ )
+
+
+
+
+
Dereference the iterator to return a column or row.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ const reference xlnt::range_iterator::operator*
+ (
+ )
+ const
+
+
+
+
+
Dereference the iterator to return a column or row.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Pre-increment the iterator to point to the next row/column.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ range_iterator xlnt::range_iterator::operator++ (
+ int
+ )
+
+
+
+
+
Post-increment the iterator to point to the next row/column.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Pre-decrement the iterator to point to the previous row/column.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ range_iterator xlnt::range_iterator::operator-- (
+ int
+ )
+
+
+
+
+
Post-decrement the iterator to point to the previous row/column.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Default assignment operator.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Default move assignment operator.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::range_iterator::operator==
+ (
+ const range_iterator &
+ other )
+ const
+
+
+
+
+
Returns true if this iterator is equivalent to other.
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::range_reference , including all inherited members.
+
xlnt: xlnt::range_reference Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
A range_reference describes a rectangular area of a worksheet with positive width and height defined by a top-left and bottom-right corner.
+ More...
+
+
#include <range_reference.hpp >
+
+ range_reference () Constructs a range reference equal to A1:A1 More... range_reference (const std::string &range_string) Constructs a range reference equivalent to the provided range_string in the form top_left:bottom_right. More... range_reference (const char *range_string) Constructs a range reference equivalent to the provided range_string in the form top_left:bottom_right. More... range_reference (const cell_reference &start, const cell_reference &end) Constructs a range reference from cell references indicating top left and bottom right coordinates of the range. More... range_reference (column_t column_index_start, row_t row_index_start, column_t column_index_end, row_t row_index_end) Constructs a range reference from column and row indices. More... bool is_single_cell () const Returns true if the range has a width and height of 1 cell. More... std::size_t width () const Returns the number of columns encompassed by this range. More... std::size_t height () const Returns the number of rows encompassed by this range. More... cell_reference top_left () const Returns the coordinate of the top left cell of this range. More... cell_reference top_right () const Returns the coordinate of the top right cell of this range. More... cell_reference bottom_left () const Returns the coordinate of the bottom left cell of this range. More... cell_reference bottom_right () const Returns the coordinate of the bottom right cell of this range. More... range_reference make_offset (int column_offset, int row_offset) const Returns a new range reference with the same width and height as this range but shifted by the given number of columns and rows. More... std::string to_string () const Returns a string representation of this range. More... bool contains (const cell_reference &ref) const Returns true if the given cell reference is within the bounds of this range reference. More... bool operator== (const range_reference &comparand) const Returns true if this range is equivalent to the other range. More... bool operator== (const std::string &reference_string) const Returns true if this range is equivalent to the string representation of the other range. More... bool operator== (const char *reference_string) const Returns true if this range is equivalent to the string representation of the other range. More... bool operator!= (const range_reference &comparand) const Returns true if this range is not equivalent to the other range. More... bool operator!= (const std::string &reference_string) const Returns true if this range is not equivalent to the string representation of the other range. More... bool operator!= (const char *reference_string) const Returns true if this range is not equivalent to the string representation of the other range. More...
+
+
A range_reference describes a rectangular area of a worksheet with positive width and height defined by a top-left and bottom-right corner.
+
+
+
◆ [1/5]
+
+
+
+
+
+ xlnt::range_reference::range_reference
+ (
+ )
+
+
+
+
+
Constructs a range reference equal to A1:A1
+
+
+
+
+
◆ [2/5]
+
+
+
+
+
+
+
+
+ xlnt::range_reference::range_reference
+ (
+ const std::string &
+ range_string )
+
+
+
+
+explicit
+
+
+
+
+
Constructs a range reference equivalent to the provided range_string in the form top_left:bottom_right.
+
+
+
+
+
◆ [3/5]
+
+
+
+
+
+
+
+
+ xlnt::range_reference::range_reference
+ (
+ const char *
+ range_string )
+
+
+
+
+explicit
+
+
+
+
+
Constructs a range reference equivalent to the provided range_string in the form top_left:bottom_right.
+
+
+
+
+
◆ [4/5]
+
+
+
+
+
Constructs a range reference from cell references indicating top left and bottom right coordinates of the range.
+
+
+
+
+
◆ [5/5]
+
+
+
+
+
+ xlnt::range_reference::range_reference
+ (
+ column_t column_index_start ,
+
+ row_t row_index_start ,
+
+ column_t column_index_end ,
+
+ row_t row_index_end
+
+ )
+
+
+
+
+
Constructs a range reference from column and row indices.
+
+
+
+
+
+
◆
+
+
+
+
+
+ cell_reference xlnt::range_reference::bottom_left (
+ )
+ const
+
+
+
+
+
Returns the coordinate of the bottom left cell of this range.
+
+
+
+
+
◆
+
+
+
+
+
+ cell_reference xlnt::range_reference::bottom_right (
+ )
+ const
+
+
+
+
+
Returns the coordinate of the bottom right cell of this range.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::range_reference::contains
+ (
+ const cell_reference &
+ ref )
+ const
+
+
+
+
+
Returns true if the given cell reference is within the bounds of this range reference.
+
+
+
+
+
◆
+
+
+
+
+
+ std::size_t xlnt::range_reference::height
+ (
+ )
+ const
+
+
+
+
+
Returns the number of rows encompassed by this range.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::range_reference::is_single_cell
+ (
+ )
+ const
+
+
+
+
+
Returns true if the range has a width and height of 1 cell.
+
+
+
+
+
◆
+
+
+
+
+
Converts relative reference coordinates to absolute coordinates (B12 -> $B$12)
+
+
+
+
+
◆
+
+
+
+
+
+ range_reference xlnt::range_reference::make_offset (
+ int
+ column_offset ,
+
+ int
+ row_offset
+
+ )
+ const
+
+
+
+
+
Returns a new range reference with the same width and height as this range but shifted by the given number of columns and rows.
+
+
+
+
+
◆ [1/3]
+
+
+
+
+
+ bool xlnt::range_reference::operator!=
+ (
+ const range_reference &
+ comparand )
+ const
+
+
+
+
+
Returns true if this range is not equivalent to the other range.
+
+
+
+
+
◆ [2/3]
+
+
+
+
+
+ bool xlnt::range_reference::operator!=
+ (
+ const std::string &
+ reference_string )
+ const
+
+
+
+
+
Returns true if this range is not equivalent to the string representation of the other range.
+
+
+
+
+
◆ [3/3]
+
+
+
+
+
+ bool xlnt::range_reference::operator!=
+ (
+ const char *
+ reference_string )
+ const
+
+
+
+
+
Returns true if this range is not equivalent to the string representation of the other range.
+
+
+
+
+
◆ [1/3]
+
+
+
+
+
+ bool xlnt::range_reference::operator==
+ (
+ const range_reference &
+ comparand )
+ const
+
+
+
+
+
Returns true if this range is equivalent to the other range.
+
+
+
+
+
◆ [2/3]
+
+
+
+
+
+ bool xlnt::range_reference::operator==
+ (
+ const std::string &
+ reference_string )
+ const
+
+
+
+
+
Returns true if this range is equivalent to the string representation of the other range.
+
+
+
+
+
◆ [3/3]
+
+
+
+
+
+ bool xlnt::range_reference::operator==
+ (
+ const char *
+ reference_string )
+ const
+
+
+
+
+
Returns true if this range is equivalent to the string representation of the other range.
+
+
+
+
+
◆
+
+
+
+
+
+ std::string xlnt::range_reference::to_string
+ (
+ )
+ const
+
+
+
+
+
Returns a string representation of this range.
+
+
+
+
+
◆
+
+
+
+
+
+ cell_reference xlnt::range_reference::top_left (
+ )
+ const
+
+
+
+
+
Returns the coordinate of the top left cell of this range.
+
+
+
+
+
◆
+
+
+
+
+
+ cell_reference xlnt::range_reference::top_right (
+ )
+ const
+
+
+
+
+
Returns the coordinate of the top right cell of this range.
+
+
+
+
+
◆
+
+
+
+
+
+ std::size_t xlnt::range_reference::width
+ (
+ )
+ const
+
+
+
+
+
Returns the number of columns encompassed by this range.
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::relationship , including all inherited members.
+
xlnt: xlnt::relationship Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Represents an association between a source Package or part, and a target object which can be a part or external resource.
+ More...
+
+
#include <relationship.hpp >
+
+
+
Represents an association between a source Package or part, and a target object which can be a part or external resource.
+
+
+
◆ [1/2]
+
+
+
+
+
+ xlnt::relationship::relationship
+ (
+ )
+
+
+
+
+
Constructs a new empty relationship.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ xlnt::relationship::relationship
+ (
+ const std::string &
+ id ,
+
+ relationship_type t ,
+
+ const uri &
+ source ,
+
+ const uri &
+ target ,
+
+ xlnt::target_mode mode
+
+ )
+
+
+
+
+
Constructs a new relationship by specifying all of its properties.
+
+
+
+
+
+
◆
+
+
+
+
+
+ const std::string& xlnt::relationship::id
+ (
+ )
+ const
+
+
+
+
+
Returns a string of the form rId# that identifies the relationship.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::relationship::operator!=
+ (
+ const relationship &
+ rhs )
+ const
+
+
+
+
+
Returns true if and only if rhs is not equal to this relationship.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::relationship::operator==
+ (
+ const relationship &
+ rhs )
+ const
+
+
+
+
+
Returns true if and only if rhs is equal to this relationship.
+
+
+
+
+
◆
+
+
+
+
+
+ const uri & xlnt::relationship::source
+ (
+ )
+ const
+
+
+
+
+
Returns the URI of the package part this relationship points to.
+
+
+
+
+
◆
+
+
+
+
+
+ const uri & xlnt::relationship::target
+ (
+ )
+ const
+
+
+
+
+
Returns the URI of the package part this relationship points to.
+
+
+
+
+
◆
+
+
+
+
+
Returns whether the target of the relationship is internal or external to the package.
+
+
+
+
+
◆
+
+
+
+
+
Returns the type of this relationship.
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::rgb_color , including all inherited members.
+
xlnt: xlnt::rgb_color Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
An RGB color describes a color in terms of its red, green, blue, and alpha components.
+ More...
+
+
#include <color.hpp >
+
+ rgb_color (const std::string &hex_string ) Constructs an RGB color from a string in the form #[aa]rrggbb More... rgb_color (std::uint8_t r, std::uint8_t g, std::uint8_t b, std::uint8_t a=255) Constructs an RGB color from red, green, and blue values in the range 0 to 255 plus an optional alpha which defaults to fully opaque. More... std::string hex_string () const Returns a string representation of this color in the form #aarrggbb More... std::uint8_t red () const Returns a byte representing the red component of this color More... std::uint8_t green () const Returns a byte representing the red component of this color More... std::uint8_t blue () const Returns a byte representing the blue component of this color More... std::uint8_t alpha () const Returns a byte representing the alpha component of this color More... std::array< std::uint8_t, 3 > rgb () const Returns the red, green, and blue components of this color separately in an array in that order. More... std::array< std::uint8_t, 4 > rgba () const Returns the red, green, blue, and alpha components of this color separately in an array in that order. More...
+
+
An RGB color describes a color in terms of its red, green, blue, and alpha components.
+
+
+
◆ [1/2]
+
+
+
+
+
+ xlnt::rgb_color::rgb_color
+ (
+ const std::string &
+ hex_string )
+
+
+
+
+
Constructs an RGB color from a string in the form #[aa]rrggbb
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ xlnt::rgb_color::rgb_color
+ (
+ std::uint8_t
+ r ,
+
+ std::uint8_t
+ g ,
+
+ std::uint8_t
+ b ,
+
+ std::uint8_t
+ a = 255
+
+ )
+
+
+
+
+
Constructs an RGB color from red, green, and blue values in the range 0 to 255 plus an optional alpha which defaults to fully opaque.
+
+
+
+
+
+
◆
+
+
+
+
+
+ std::uint8_t xlnt::rgb_color::alpha
+ (
+ )
+ const
+
+
+
+
+
Returns a byte representing the alpha component of this color
+
+
+
+
+
◆
+
+
+
+
+
+ std::uint8_t xlnt::rgb_color::blue
+ (
+ )
+ const
+
+
+
+
+
Returns a byte representing the blue component of this color
+
+
+
+
+
◆
+
+
+
+
+
+ std::uint8_t xlnt::rgb_color::green
+ (
+ )
+ const
+
+
+
+
+
Returns a byte representing the red component of this color
+
+
+
+
+
◆
+
+
+
+
+
+ std::string xlnt::rgb_color::hex_string
+ (
+ )
+ const
+
+
+
+
+
Returns a string representation of this color in the form #aarrggbb
+
+
+
+
+
◆
+
+
+
+
+
+ std::uint8_t xlnt::rgb_color::red
+ (
+ )
+ const
+
+
+
+
+
Returns a byte representing the red component of this color
+
+
+
+
+
◆
+
+
+
+
+
+ std::array<std::uint8_t, 3> xlnt::rgb_color::rgb
+ (
+ )
+ const
+
+
+
+
+
Returns the red, green, and blue components of this color separately in an array in that order.
+
+
+
+
+
◆
+
+
+
+
+
+ std::array<std::uint8_t, 4> xlnt::rgb_color::rgba
+ (
+ )
+ const
+
+
+
+
+
Returns the red, green, blue, and alpha components of this color separately in an array in that order.
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::rich_text , including all inherited members.
+
xlnt: xlnt::rich_text Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Encapsulates zero or more formatted text runs where a text run is a string of text with the same defined formatting.
+ More...
+
+
#include <rich_text.hpp >
+
+
+
Encapsulates zero or more formatted text runs where a text run is a string of text with the same defined formatting.
+
+
+
◆ [1/5]
+
+
+
+
+
+
+
+
+ xlnt::rich_text::rich_text
+ (
+ )
+
+
+
+
+default
+
+
+
+
+
Constructs an empty rich text object with no font and empty text.
+
+
+
+
+
◆ [2/5]
+
+
+
+
+
+ xlnt::rich_text::rich_text
+ (
+ const std::string &
+ plain_text )
+
+
+
+
+
Constructs a rich text object with the given text and no font.
+
+
+
+
+
◆ [3/5]
+
+
+
+
+
+ xlnt::rich_text::rich_text
+ (
+ const rich_text &
+ other )
+
+
+
+
+
Constructs a rich text object from other
+
+
+
+
+
◆ [4/5]
+
+
+
+
+
+ xlnt::rich_text::rich_text
+ (
+ const std::string &
+ plain_text ,
+
+ const class font &
+ text_font
+
+ )
+
+
+
+
+
Constructs a rich text object with the given text and font.
+
+
+
+
+
◆ [5/5]
+
+
+
+
+
+ xlnt::rich_text::rich_text
+ (
+ const rich_text_run &
+ single_run )
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::rich_text::add_phonetic_run
+ (
+ const phonetic_run &
+ t )
+
+
+
+
+
Adds a new run to the end of the set of runs.
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::rich_text::add_run
+ (
+ const rich_text_run &
+ t )
+
+
+
+
+
Adds a new run to the end of the set of runs.
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::rich_text::clear
+ (
+ )
+
+
+
+
+
Removes all text runs from this text.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::rich_text::has_phonetic_properties
+ (
+ )
+ const
+
+
+
+
+
Returns true if this text has phonetic properties
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ bool xlnt::rich_text::operator!=
+ (
+ const rich_text &
+ rhs )
+ const
+
+
+
+
+
Returns true if the runs that make up this text are identical to those in rhs.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ bool xlnt::rich_text::operator!=
+ (
+ const std::string &
+ rhs )
+ const
+
+
+
+
+
Returns true if this text has a single unformatted run with text equal to rhs.
+
+
+
+
+
◆
+
+
+
+
+
Copies rich text object from other
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ bool xlnt::rich_text::operator==
+ (
+ const rich_text &
+ rhs )
+ const
+
+
+
+
+
Returns true if the runs that make up this text are identical to those in rhs.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ bool xlnt::rich_text::operator==
+ (
+ const std::string &
+ rhs )
+ const
+
+
+
+
+
Returns true if this text has a single unformatted run with text equal to rhs.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ const phonetic_pr & xlnt::rich_text::phonetic_properties
+ (
+ )
+ const
+
+
+
+
+
Returns the phonetic properties of this text.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::rich_text::phonetic_properties
+ (
+ const phonetic_pr &
+ phonetic_props )
+
+
+
+
+
Sets the phonetic properties of this text to phonetic_props
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ std::vector<phonetic_run > xlnt::rich_text::phonetic_runs
+ (
+ )
+ const
+
+
+
+
+
Returns a copy of the individual runs that comprise this text.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::rich_text::phonetic_runs
+ (
+ const std::vector< phonetic_run > &
+ new_phonetic_runs )
+
+
+
+
+
Sets the runs of this text all at once.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ void xlnt::rich_text::plain_text
+ (
+ const std::string &
+ s ,
+
+ bool
+ preserve_space
+
+ )
+
+
+
+
+
Clears any runs in this text and adds a single run with default formatting and the given string as its textual content.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ std::string xlnt::rich_text::plain_text
+ (
+ )
+ const
+
+
+
+
+
Combines the textual content of each text run in order and returns the result.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ std::vector<rich_text_run > xlnt::rich_text::runs
+ (
+ )
+ const
+
+
+
+
+
Returns a copy of the individual runs that comprise this text.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::rich_text::runs
+ (
+ const std::vector< rich_text_run > &
+ new_runs )
+
+
+
+
+
Sets the runs of this text all at once.
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::rich_text_hash , including all inherited members.
+
xlnt: xlnt::rich_text_hash Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+operator() (const rich_text &k) const
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::row_properties , including all inherited members.
+
xlnt: xlnt::row_properties Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
The properties of a row in a worksheet.
+ More...
+
+
#include <row_properties.hpp >
+
+optional < double > height Row height More... optional < double > dy_descent Distance in pixels from the bottom of the cell to the baseline of the cell content More... bool custom_height = false Whether or not the height is different from the default More... bool hidden = false Whether or not the row should be hidden More... optional < bool > custom_format True if row style should be applied More... optional < std::size_t > style The index to the style used by all cells in this row More... optional < std::string > spans The row column span, used as part of the row block optimisation. This used for loading this attribute from existing excel files mainly for inspecting and not used when saving, it is calculated in the xlsx_producer. More...
+
+
The properties of a row in a worksheet.
+
+
+
◆
+
+
+
+
+
+ optional <bool> xlnt::row_properties::custom_format
+
+
+
+
True if row style should be applied
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::row_properties::custom_height = false
+
+
+
+
+
Whether or not the height is different from the default
+
+
+
+
+
◆
+
+
+
+
+
+ optional <double> xlnt::row_properties::dy_descent
+
+
+
+
Distance in pixels from the bottom of the cell to the baseline of the cell content
+
+
+
+
+
◆
+
+
+
+
+
+ optional <double> xlnt::row_properties::height
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::row_properties::hidden = false
+
+
+
+
+
Whether or not the row should be hidden
+
+
+
+
+
◆
+
+
+
+
+
+ optional <std::string> xlnt::row_properties::spans
+
+
+
+
The row column span, used as part of the row block optimisation. This used for loading this attribute from existing excel files mainly for inspecting and not used when saving, it is calculated in the xlsx_producer.
+
+
+
+
+
◆
+
+
+
+
+
+ optional <std::size_t> xlnt::row_properties::style
+
+
+
+
The index to the style used by all cells in this row
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::selection , including all inherited members.
+
xlnt: xlnt::selection Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
The selected area of a worksheet.
+ More...
+
+
#include <selection.hpp >
+
+
+
The selected area of a worksheet.
+
+
+
◆ [1/3]
+
+
+
+
+
+
+
+
+ xlnt::selection::selection
+ (
+ )
+
+
+
+
+explicit default
+
+
+
+
+
+
◆ [2/3]
+
+
+
+
+
+
+
+
+
+inline explicit
+
+
+
+
+
ctor when no range selected sqref == active_cell
+
+
+
+
+
◆ [3/3]
+
+
+
+
+
+
+
+
+
+inline explicit
+
+
+
+
+
ctor with selected range sqref must contain active_cell
+
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Returns the cell reference of the active cell.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ void xlnt::selection::active_cell
+ (
+ const cell_reference &
+ ref )
+
+
+
+
+inline
+
+
+
+
+
Sets the active cell to that pointed to by ref.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ bool xlnt::selection::has_active_cell
+ (
+ )
+ const
+
+
+
+
+inline
+
+
+
+
+
Returns true if this selection has a defined active cell.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ bool xlnt::selection::has_sqref
+ (
+ )
+ const
+
+
+
+
+inline
+
+
+
+
+
Returns true if this selection has a defined sqref.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ bool xlnt::selection::operator==
+ (
+ const selection &
+ rhs )
+ const
+
+
+
+
+inline
+
+
+
+
+
Returns true if this selection is equal to rhs based on its active cell, sqref, and pane.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ pane_corner xlnt::selection::pane (
+ )
+ const
+
+
+
+
+inline
+
+
+
+
+
Returns the sheet quadrant of this selection.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ void xlnt::selection::pane
+ (
+ pane_corner corner )
+
+
+
+
+inline
+
+
+
+
+
Sets the sheet quadrant of this selection to corner.
+
+
+
+
+
◆ [1/3]
+
+
+
+
+
Returns the range encompassed by this selection.
+
+
+
+
+
◆ [2/3]
+
+
+
+
+
Sets the range encompassed by this selection.
+
+
+
+
+
◆ [3/3]
+
+
+
+
+
+
+
+
+ void xlnt::selection::sqref
+ (
+ const std::string &
+ ref )
+
+
+
+
+inline
+
+
+
+
+
Sets the range encompassed by this selection.
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::sheet_format_properties , including all inherited members.
+
xlnt: xlnt::sheet_format_properties Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
General worksheet formatting properties.
+ More...
+
+
#include <sheet_format_properties.hpp >
+
+
+
General worksheet formatting properties.
+
+
+
◆
+
+
+
+
+
+ optional <double> xlnt::sheet_format_properties::base_col_width
+
+
+
+
The base column width
+
+
+
+
+
◆
+
+
+
+
+
+ optional <double> xlnt::sheet_format_properties::default_column_width
+
+
+
+
The default column width
+
+
+
+
+
◆
+
+
+
+
+
+ double xlnt::sheet_format_properties::default_row_height = 15.0
+
+
+
+
+
The default row height is required
+
+
+
+
+
◆
+
+
+
+
+
+ optional <double> xlnt::sheet_format_properties::dy_descent
+
+
+
+
x14ac extension, dyDescent property
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::sheet_protection , including all inherited members.
+
xlnt: xlnt::sheet_protection Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Protection applied to a particular worksheet to prevent it from being modified.
+ More...
+
+
#include <sheet_protection.hpp >
+
+void password (const std::string &password) Sets the protection password to password. More... std::string hashed_password () const Returns the hash of the password set for this sheet protection. More...
+static std::string hash_password (const std::string &password ) Calculates and returns the hash of the given protection password. More...
+
+
Protection applied to a particular worksheet to prevent it from being modified.
+
+
+
◆
+
+
+
+
+
+
+
+
+ static std::string xlnt::sheet_protection::hash_password
+ (
+ const std::string &
+ password )
+
+
+
+
+static
+
+
+
+
+
Calculates and returns the hash of the given protection password.
+
+
+
+
+
◆
+
+
+
+
+
+ std::string xlnt::sheet_protection::hashed_password
+ (
+ )
+ const
+
+
+
+
+
Returns the hash of the password set for this sheet protection.
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::sheet_protection::password
+ (
+ const std::string &
+ password )
+
+
+
+
+
Sets the protection password to password.
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::sheet_view , including all inherited members.
+
xlnt: xlnt::sheet_view Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Describes a view of a worksheet. Worksheets can have multiple views which show the data differently.
+ More...
+
+
#include <sheet_view.hpp >
+
+
+
Describes a view of a worksheet. Worksheets can have multiple views which show the data differently.
+
+
+
◆
+
+
+
+
+
+
+
+
+ void xlnt::sheet_view::add_selection
+ (
+ const class selection &
+ new_selection )
+
+
+
+
+inline
+
+
+
+
+
Adds the given selection to the collection of selections.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void xlnt::sheet_view::clear_pane
+ (
+ )
+
+
+
+
+inline
+
+
+
+
+
Removes the defined pane from this view.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ void xlnt::sheet_view::clear_selections
+ (
+ )
+
+
+
+
+inline
+
+
+
+
+
Removes all selections.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ void xlnt::sheet_view::default_grid_color
+ (
+ bool
+ is_default )
+
+
+
+
+inline
+
+
+
+
+
If is_default is true, the default grid color will be used.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ bool xlnt::sheet_view::default_grid_color
+ (
+ )
+ const
+
+
+
+
+inline
+
+
+
+
+
Returns true if the default grid color will be used.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ bool xlnt::sheet_view::has_pane
+ (
+ )
+ const
+
+
+
+
+inline
+
+
+
+
+
Returns true if this view has a pane defined.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ bool xlnt::sheet_view::has_selections
+ (
+ )
+ const
+
+
+
+
+inline
+
+
+
+
+
Returns true if this view has any selections.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ bool xlnt::sheet_view::has_top_left_cell
+ (
+ )
+ const
+
+
+
+
+inline
+
+
+
+
+
has a top left cell?
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ void xlnt::sheet_view::id
+ (
+ std::size_t
+ new_id )
+
+
+
+
+inline
+
+
+
+
+
Sets the ID of this view to new_id.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ std::size_t xlnt::sheet_view::id
+ (
+ )
+ const
+
+
+
+
+inline
+
+
+
+
+
Returns the ID of this view.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ bool xlnt::sheet_view::operator==
+ (
+ const sheet_view &
+ rhs )
+ const
+
+
+
+
+inline
+
+
+
+
+
Returns true if this view is equal to rhs based on its id, grid lines setting, default grid color, pane, and selections.
+
+
+
+
+
◆ [1/3]
+
+
+
+
+
+
+
+
+ struct pane & xlnt::sheet_view::pane
+ (
+ )
+
+
+
+
+inline
+
+
+
+
+
Returns a reference to this view's pane.
+
+
+
+
+
◆ [2/3]
+
+
+
+
+
+
+
+
+ const struct pane & xlnt::sheet_view::pane
+ (
+ )
+ const
+
+
+
+
+inline
+
+
+
+
+
Returns a reference to this view's pane.
+
+
+
+
+
◆ [3/3]
+
+
+
+
+
+
+
+
+ void xlnt::sheet_view::pane
+ (
+ const struct pane &
+ new_pane )
+
+
+
+
+inline
+
+
+
+
+
Sets the pane of this view to new_pane.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ class xlnt::selection & xlnt::sheet_view::selection
+ (
+ std::size_t
+ index )
+
+
+
+
+inline
+
+
+
+
+
Returns the selection at the given index.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ std::vector<xlnt::selection > xlnt::sheet_view::selections
+ (
+ )
+ const
+
+
+
+
+inline
+
+
+
+
+
Returns the collection of selections as a vector.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ void xlnt::sheet_view::show_grid_lines
+ (
+ bool
+ show )
+
+
+
+
+inline
+
+
+
+
+
If show is true, grid lines will be shown for sheets using this view.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ bool xlnt::sheet_view::show_grid_lines
+ (
+ )
+ const
+
+
+
+
+inline
+
+
+
+
+
Returns true if grid lines will be shown for sheets using this view.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ void xlnt::sheet_view::top_left_cell
+ (
+ const cell_reference &
+ ref )
+
+
+
+
+inline
+
+
+
+
+
Sets the top left cell of this view.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ cell_reference xlnt::sheet_view::top_left_cell (
+ )
+ const
+
+
+
+
+inline
+
+
+
+
+
Returns the top left cell of this view.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Sets the type of this view.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Returns the type of this view.
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::streaming_workbook_reader , including all inherited members.
+
xlnt: xlnt::streaming_workbook_reader Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
workbook is the container for all other parts of the document.
+ More...
+
+
#include <streaming_workbook_reader.hpp >
+
+void close () Closes currently open read stream. This will be called automatically by the destructor if it hasn't already been called manually. More... has_cell () cell read_cell () Reads the next cell in the current worksheet and optionally returns it if the last cell in the sheet has not yet been read. More... has_worksheet (const std::string &name) void begin_worksheet (const std::string &name) Beings reading of the next worksheet in the workbook and optionally returns its title if the last worksheet has not yet been read. More... worksheet end_worksheet () Ends reading of the current worksheet in the workbook and optionally returns a worksheet object corresponding to the worksheet with the title returned by begin_worksheet() . More... void open (const std::vector< std::uint8_t > &data) Interprets byte vector data as an XLSX file and sets the content of this workbook to match that file. More... void open (const std::string &filename) Interprets file with the given filename as an XLSX file and sets the content of this workbook to match that file. More... void open (const path &filename) Interprets file with the given filename as an XLSX file and sets the content of this workbook to match that file. More... void open (std::istream &stream) Interprets data in stream as an XLSX file and sets the content of this workbook to match that file. More... void open (std::unique_ptr< std::streambuf > &&buffer) Holds the given streambuf internally, creates a std::istream backed by the given buffer, and calls open(std::istream &) with that stream. More... std::vector< std::string > sheet_titles () Returns a vector of the titles of sheets in the workbook in order. More...
+
+
workbook is the container for all other parts of the document.
+
+
+
◆
+
+
+
+
+
+ void xlnt::streaming_workbook_reader::begin_worksheet
+ (
+ const std::string &
+ name )
+
+
+
+
+
Beings reading of the next worksheet in the workbook and optionally returns its title if the last worksheet has not yet been read.
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::streaming_workbook_reader::close
+ (
+ )
+
+
+
+
+
Closes currently open read stream. This will be called automatically by the destructor if it hasn't already been called manually.
+
+
+
+
+
◆
+
+
+
+
+
+ worksheet xlnt::streaming_workbook_reader::end_worksheet (
+ )
+
+
+
+
+
Ends reading of the current worksheet in the workbook and optionally returns a worksheet object corresponding to the worksheet with the title returned by begin_worksheet() .
+
+
+
+
+
◆ [1/5]
+
+
+
+
+
+ void xlnt::streaming_workbook_reader::open
+ (
+ const std::vector< std::uint8_t > &
+ data )
+
+
+
+
+
Interprets byte vector data as an XLSX file and sets the content of this workbook to match that file.
+
+
+
+
+
◆ [2/5]
+
+
+
+
+
+ void xlnt::streaming_workbook_reader::open
+ (
+ const std::string &
+ filename )
+
+
+
+
+
Interprets file with the given filename as an XLSX file and sets the content of this workbook to match that file.
+
+
+
+
+
◆ [3/5]
+
+
+
+
+
+ void xlnt::streaming_workbook_reader::open
+ (
+ const path &
+ filename )
+
+
+
+
+
Interprets file with the given filename as an XLSX file and sets the content of this workbook to match that file.
+
+
+
+
+
◆ [4/5]
+
+
+
+
+
+ void xlnt::streaming_workbook_reader::open
+ (
+ std::istream &
+ stream )
+
+
+
+
+
Interprets data in stream as an XLSX file and sets the content of this workbook to match that file.
+
+
+
+
+
◆ [5/5]
+
+
+
+
+
+ void xlnt::streaming_workbook_reader::open
+ (
+ std::unique_ptr< std::streambuf > &&
+ buffer )
+
+
+
+
+
Holds the given streambuf internally, creates a std::istream backed by the given buffer, and calls open(std::istream &) with that stream.
+
+
+
+
+
◆
+
+
+
+
+
+ cell xlnt::streaming_workbook_reader::read_cell (
+ )
+
+
+
+
+
Reads the next cell in the current worksheet and optionally returns it if the last cell in the sheet has not yet been read.
+
+
+
+
+
◆
+
+
+
+
+
+ std::vector<std::string> xlnt::streaming_workbook_reader::sheet_titles
+ (
+ )
+
+
+
+
+
Returns a vector of the titles of sheets in the workbook in order.
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::streaming_workbook_writer , including all inherited members.
+
xlnt: xlnt::streaming_workbook_writer Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
workbook is the container for all other parts of the document.
+ More...
+
+
#include <streaming_workbook_writer.hpp >
+
+void close () Finishes writing of the remaining contents of the workbook and closes currently open write stream. This will be called automatically by the destructor if it hasn't already been called manually. More... cell add_cell (const cell_reference &ref) Writes a cell to the currently active worksheet at the position given by ref and with the given value. ref should be to the right of or below the previously written cell. More... worksheet add_worksheet (const std::string &title) Ends writing of data to the current sheet and begins writing a new sheet with the given title. More... void open (std::vector< std::uint8_t > &data) Serializes the workbook into an XLSX file and saves the bytes into byte vector data. More... void open (const std::string &filename) Serializes the workbook into an XLSX file and saves the data into a file named filename. More... void open (const xlnt::path &filename) Serializes the workbook into an XLSX file and saves the data into a file named filename. More... void open (std::ostream &stream) Serializes the workbook into an XLSX file and saves the data into stream. More...
+producer_ workbook > workbook_ stream_ stream_buffer_ part_stream_ part_stream_buffer_ serializer_
+
+
workbook is the container for all other parts of the document.
+
+
+
◆
+
+
+
+
+
+ cell xlnt::streaming_workbook_writer::add_cell (
+ const cell_reference &
+ ref )
+
+
+
+
+
Writes a cell to the currently active worksheet at the position given by ref and with the given value. ref should be to the right of or below the previously written cell.
+
+
+
+
+
◆
+
+
+
+
+
+ worksheet xlnt::streaming_workbook_writer::add_worksheet (
+ const std::string &
+ title )
+
+
+
+
+
Ends writing of data to the current sheet and begins writing a new sheet with the given title.
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::streaming_workbook_writer::close
+ (
+ )
+
+
+
+
+
Finishes writing of the remaining contents of the workbook and closes currently open write stream. This will be called automatically by the destructor if it hasn't already been called manually.
+
+
+
+
+
◆ [1/4]
+
+
+
+
+
+ void xlnt::streaming_workbook_writer::open
+ (
+ std::vector< std::uint8_t > &
+ data )
+
+
+
+
+
Serializes the workbook into an XLSX file and saves the bytes into byte vector data.
+
+
+
+
+
◆ [2/4]
+
+
+
+
+
+ void xlnt::streaming_workbook_writer::open
+ (
+ const std::string &
+ filename )
+
+
+
+
+
Serializes the workbook into an XLSX file and saves the data into a file named filename.
+
+
+
+
+
◆ [3/4]
+
+
+
+
+
+ void xlnt::streaming_workbook_writer::open
+ (
+ const xlnt::path &
+ filename )
+
+
+
+
+
Serializes the workbook into an XLSX file and saves the data into a file named filename.
+
+
+
+
+
◆ [4/4]
+
+
+
+
+
+ void xlnt::streaming_workbook_writer::open
+ (
+ std::ostream &
+ stream )
+
+
+
+
+
Serializes the workbook into an XLSX file and saves the data into stream.
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::style , including all inherited members.
+
xlnt: xlnt::style Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Describes a style which has a name and can be applied to multiple individual formats. In Excel this is a "Cell Style".
+ More...
+
+
#include <style.hpp >
+
+ style ()=delete Delete zero-argument constructor More... style (const style &other)=default Default copy constructor. Constructs a style using the same PIMPL as other. More... std::string name () const Returns the name of this style. More... style name (const std::string &name) Sets the name of this style to name. More... bool hidden () const Returns true if this style is hidden. More... style hidden (bool value) Sets the hidden state of this style to value. A hidden style will not be shown in the list of selectable styles in the UI, but will still apply its formatting to cells using it. More... bool custom_builtin () const Returns true if this is a builtin style that has been customized and should therefore be persisted in the workbook. More... std::size_t builtin_id () const Returns the index of the builtin style that this style is an instance of or is a customized version thereof. If style::builtin() is false, this will throw an invalid_attribute exception. More... bool builtin () const Returns true if this is a builtin style. More... class alignment alignment () const Returns the alignment of this style. More... bool alignment_applied () const Returns true if the alignment of this style should be applied to cells using it. More... style alignment (const xlnt::alignment &new_alignment, optional < bool > applied={}) Sets the alignment of this style to new_alignment. Applied, which defaults to true, determines whether the alignment should be enabled for cells using this style. More... class border border () const Returns the border of this style. More... bool border_applied () const Returns true if the border set for this style should be applied to cells using the style. More... style border (const xlnt::border &new_border, optional < bool > applied={}) Sets the border of this style to new_border. Applied, which defaults to true, determines whether the border should be enabled for cells using this style. More... class fill fill () const Returns the fill of this style. More... bool fill_applied () const Returns true if the fill set for this style should be applied to cells using the style. More... style fill (const xlnt::fill &new_fill, optional < bool > applied={}) Sets the fill of this style to new_fill. Applied, which defaults to true, determines whether the border should be enabled for cells using this style. More... class font font () const Returns the font of this style. More... bool font_applied () const Returns true if the font set for this style should be applied to cells using the style. More... style font (const xlnt::font &new_font, optional < bool > applied={}) Sets the font of this style to new_font. Applied, which defaults to true, determines whether the font should be enabled for cells using this style. More... class number_format number_format () const Returns the number_format of this style. More... bool number_format_applied () const Returns true if the number_format set for this style should be applied to cells using the style. More... style number_format (const xlnt::number_format &new_number_format, optional < bool > applied={}) Sets the number format of this style to new_number_format. Applied, which defaults to true, determines whether the number format should be enabled for cells using this style. More... class protection protection () const Returns the protection of this style. More... bool protection_applied () const Returns true if the protection set for this style should be applied to cells using the style. More... style protection (const xlnt::protection &new_protection, optional < bool > applied={}) Sets the border of this style to new_protection. Applied, which defaults to true, determines whether the protection should be enabled for cells using this style. More... bool pivot_button () const Returns true if the pivot table interface is enabled for this style. More... void pivot_button (bool show) If show is true, a pivot table interface will be displayed for cells using this style. More... bool quote_prefix () const Returns true if this style should add a single-quote prefix for all text values. More... void quote_prefix (bool quote) If quote is true, enables a single-quote prefix for all text values in cells using this style (e.g. "abc" will appear as "'abc"). The text will also not be stored in sharedStrings when this is enabled. More... bool operator== (const style &other) const Returns true if this style is equivalent to other. More... bool operator!= (const style &other) const Returns true if this style is not equivalent to other. More...
+detail::stylesheet detail::xlsx_consumer
+
+
Describes a style which has a name and can be applied to multiple individual formats. In Excel this is a "Cell Style".
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ xlnt::style::style
+ (
+ )
+
+
+
+
+delete
+
+
+
+
+
Delete zero-argument constructor
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ xlnt::style::style
+ (
+ const style &
+ other )
+
+
+
+
+default
+
+
+
+
+
Default copy constructor. Constructs a style using the same PIMPL as other.
+
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ class alignment xlnt::style::alignment
+ (
+ )
+ const
+
+
+
+
+
Returns the alignment of this style.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Sets the alignment of this style to new_alignment. Applied, which defaults to true, determines whether the alignment should be enabled for cells using this style.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::style::alignment_applied
+ (
+ )
+ const
+
+
+
+
+
Returns true if the alignment of this style should be applied to cells using it.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ class border xlnt::style::border
+ (
+ )
+ const
+
+
+
+
+
Returns the border of this style.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ style xlnt::style::border (
+ const xlnt::border &
+ new_border ,
+
+ optional < bool > applied = {}
+
+ )
+
+
+
+
+
Sets the border of this style to new_border. Applied, which defaults to true, determines whether the border should be enabled for cells using this style.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::style::border_applied
+ (
+ )
+ const
+
+
+
+
+
Returns true if the border set for this style should be applied to cells using the style.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::style::builtin
+ (
+ )
+ const
+
+
+
+
+
Returns true if this is a builtin style.
+
+
+
+
+
◆
+
+
+
+
+
+ std::size_t xlnt::style::builtin_id
+ (
+ )
+ const
+
+
+
+
+
Returns the index of the builtin style that this style is an instance of or is a customized version thereof. If style::builtin() is false, this will throw an invalid_attribute exception.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::style::custom_builtin
+ (
+ )
+ const
+
+
+
+
+
Returns true if this is a builtin style that has been customized and should therefore be persisted in the workbook.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ class fill xlnt::style::fill
+ (
+ )
+ const
+
+
+
+
+
Returns the fill of this style.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ style xlnt::style::fill (
+ const xlnt::fill &
+ new_fill ,
+
+ optional < bool > applied = {}
+
+ )
+
+
+
+
+
Sets the fill of this style to new_fill. Applied, which defaults to true, determines whether the border should be enabled for cells using this style.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::style::fill_applied
+ (
+ )
+ const
+
+
+
+
+
Returns true if the fill set for this style should be applied to cells using the style.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ class font xlnt::style::font
+ (
+ )
+ const
+
+
+
+
+
Returns the font of this style.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ style xlnt::style::font (
+ const xlnt::font &
+ new_font ,
+
+ optional < bool > applied = {}
+
+ )
+
+
+
+
+
Sets the font of this style to new_font. Applied, which defaults to true, determines whether the font should be enabled for cells using this style.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::style::font_applied
+ (
+ )
+ const
+
+
+
+
+
Returns true if the font set for this style should be applied to cells using the style.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ bool xlnt::style::hidden
+ (
+ )
+ const
+
+
+
+
+
Returns true if this style is hidden.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ style xlnt::style::hidden (
+ bool
+ value )
+
+
+
+
+
Sets the hidden state of this style to value. A hidden style will not be shown in the list of selectable styles in the UI, but will still apply its formatting to cells using it.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ std::string xlnt::style::name
+ (
+ )
+ const
+
+
+
+
+
Returns the name of this style.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ style xlnt::style::name (
+ const std::string &
+ name )
+
+
+
+
+
Sets the name of this style to name.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ class number_format xlnt::style::number_format
+ (
+ )
+ const
+
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Sets the number format of this style to new_number_format. Applied, which defaults to true, determines whether the number format should be enabled for cells using this style.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::style::number_format_applied
+ (
+ )
+ const
+
+
+
+
+
Returns true if the number_format set for this style should be applied to cells using the style.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::style::operator!=
+ (
+ const style &
+ other )
+ const
+
+
+
+
+
Returns true if this style is not equivalent to other.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::style::operator==
+ (
+ const style &
+ other )
+ const
+
+
+
+
+
Returns true if this style is equivalent to other.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ bool xlnt::style::pivot_button
+ (
+ )
+ const
+
+
+
+
+
Returns true if the pivot table interface is enabled for this style.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::style::pivot_button
+ (
+ bool
+ show )
+
+
+
+
+
If show is true, a pivot table interface will be displayed for cells using this style.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ class protection xlnt::style::protection
+ (
+ )
+ const
+
+
+
+
+
Returns the protection of this style.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Sets the border of this style to new_protection. Applied, which defaults to true, determines whether the protection should be enabled for cells using this style.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::style::protection_applied
+ (
+ )
+ const
+
+
+
+
+
Returns true if the protection set for this style should be applied to cells using the style.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ bool xlnt::style::quote_prefix
+ (
+ )
+ const
+
+
+
+
+
Returns true if this style should add a single-quote prefix for all text values.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::style::quote_prefix
+ (
+ bool
+ quote )
+
+
+
+
+
If quote is true, enables a single-quote prefix for all text values in cells using this style (e.g. "abc" will appear as "'abc"). The text will also not be stored in sharedStrings when this is enabled.
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::theme , including all inherited members.
+
xlnt: xlnt::theme Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
A theme is a combination of fonts, colors, and effects. This isn't really supported yet.
+ More...
+
+
#include <theme.hpp >
+
+operator== (const theme &) const
+
+
A theme is a combination of fonts, colors, and effects. This isn't really supported yet.
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::theme_color , including all inherited members.
+
xlnt: xlnt::theme_color Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
A theme color encapsulates a color derived from the theme.
+ More...
+
+
#include <color.hpp >
+
+
+
A theme color encapsulates a color derived from the theme.
+
+
+
◆
+
+
+
+
+
+ xlnt::theme_color::theme_color
+ (
+ std::size_t
+ index )
+
+
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ std::size_t xlnt::theme_color::index
+ (
+ )
+ const
+
+
+
+
+
Returns the index of the color in the theme this points to.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::theme_color::index
+ (
+ std::size_t
+ index )
+
+
+
+
+
Sets the index of this color to index.
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::unhandled_switch_case , including all inherited members.
+
xlnt: xlnt::unhandled_switch_case Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Debug exception for a switch that fell through to the default case
+ More...
+
+
#include <exceptions.hpp >
+
+
+
+
+
+
+
+
+
+
Debug exception for a switch that fell through to the default case
+
+
+
◆ [1/2]
+
+
+
+
+
+ xlnt::unhandled_switch_case::unhandled_switch_case
+ (
+ )
+
+
+
+
+
Default constructor.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Default copy constructor.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ xlnt::unhandled_switch_case::~unhandled_switch_case
+ (
+ )
+
+
+
+
+override
+
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::unsupported , including all inherited members.
+
xlnt: xlnt::unsupported Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Exception for attempting to use a feature which is not supported
+ More...
+
+
#include <exceptions.hpp >
+
+
+
+
+
+
+
+
+
+
Exception for attempting to use a feature which is not supported
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ xlnt::unsupported::unsupported
+ (
+ const std::string &
+ message )
+
+
+
+
+explicit
+
+
+
+
+
Constructs an unsupported exception with a message describing the unsupported feature.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ xlnt::unsupported::unsupported
+ (
+ const unsupported &
+ )
+
+
+
+
+default
+
+
+
+
+
Default copy constructor.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ xlnt::unsupported::~unsupported
+ (
+ )
+
+
+
+
+override
+
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::uri , including all inherited members.
+
xlnt: xlnt::uri Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Encapsulates a uniform resource identifier (URI) as described by RFC 3986.
+ More...
+
+
#include <uri.hpp >
+
+
+
Encapsulates a uniform resource identifier (URI) as described by RFC 3986.
+
+
+
◆ [1/4]
+
+
+
+
+
+ xlnt::uri::uri
+ (
+ )
+
+
+
+
+
Constructs an empty URI.
+
+
+
+
+
◆ [2/4]
+
+
+
+
+
+ xlnt::uri::uri
+ (
+ const uri &
+ base ,
+
+ const uri &
+ relative
+
+ )
+
+
+
+
+
Constructs a URI by combining base with relative.
+
+
+
+
+
◆ [3/4]
+
+
+
+
+
+ xlnt::uri::uri
+ (
+ const uri &
+ base ,
+
+ const path &
+ relative
+
+ )
+
+
+
+
+
Constructs a URI by combining base with relative path.
+
+
+
+
+
◆ [4/4]
+
+
+
+
+
+ xlnt::uri::uri
+ (
+ const std::string &
+ uri_string )
+
+
+
+
+
Constructs a URI by parsing the given uri_string.
+
+
+
+
+
+
◆
+
+
+
+
+
+ std::string xlnt::uri::authentication
+ (
+ )
+ const
+
+
+
+
+
+
◆
+
+
+
+
+
+ std::string xlnt::uri::authority
+ (
+ )
+ const
+
+
+
+
+
+
◆
+
+
+
+
+
+ std::string xlnt::uri::fragment
+ (
+ )
+ const
+
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::uri::has_authentication
+ (
+ )
+ const
+
+
+
+
+
Returns true if an authentication section is specified for this URI.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::uri::has_fragment
+ (
+ )
+ const
+
+
+
+
+
Returns true if this URI has a non-empty fragment section.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::uri::has_port
+ (
+ )
+ const
+
+
+
+
+
Returns true if a non-default port is specified for this URI.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::uri::has_query
+ (
+ )
+ const
+
+
+
+
+
Returns true if this URI has a non-null query string section.
+
+
+
+
+
◆
+
+
+
+
+
+ std::string xlnt::uri::host
+ (
+ )
+ const
+
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::uri::is_absolute
+ (
+ )
+ const
+
+
+
+
+
Returns true if this URI is not relative (i.e. absolute).
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::uri::is_relative
+ (
+ )
+ const
+
+
+
+
+
Returns true if this URI is relative.
+
+
+
+
+
◆
+
+
+
+
+
+ uri xlnt::uri::make_absolute (
+ const uri &
+ base )
+
+
+
+
+
If this URI is relative, an absolute URI will be returned by appending the path to the given absolute base URI.
+
+
+
+
+
◆
+
+
+
+
+
+ uri xlnt::uri::make_reference (
+ const uri &
+ base )
+
+
+
+
+
If this URI is absolute, a relative URI will be returned by removing the common base path from the given absolute base URI.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::uri::operator==
+ (
+ const uri &
+ other )
+ const
+
+
+
+
+
Returns true if this URI is equivalent to other.
+
+
+
+
+
◆
+
+
+
+
+
+ std::string xlnt::uri::password
+ (
+ )
+ const
+
+
+
+
+
+
◆
+
+
+
+
+
+ const class path & xlnt::uri::path
+ (
+ )
+ const
+
+
+
+
+
+
◆
+
+
+
+
+
+ std::size_t xlnt::uri::port
+ (
+ )
+ const
+
+
+
+
+
+
◆
+
+
+
+
+
+ std::string xlnt::uri::query
+ (
+ )
+ const
+
+
+
+
+
+
◆
+
+
+
+
+
+ std::string xlnt::uri::scheme
+ (
+ )
+ const
+
+
+
+
+
+
◆
+
+
+
+
+
+ std::string xlnt::uri::to_string
+ (
+ )
+ const
+
+
+
+
+
Returns a string representation of this URI.
+
+
+
+
+
◆
+
+
+
+
+
+ std::string xlnt::uri::username
+ (
+ )
+ const
+
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::variant , including all inherited members.
+
xlnt: xlnt::variant Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Represents an object that can have variable type.
+ More...
+
+
#include <variant.hpp >
+
+enum type { vector ,
+null ,
+i4 ,
+lpstr ,
+date ,
+boolean
+ The possible types a variant can hold. More...
+ variant () Default constructor. Creates a null-type variant. More... variant (const std::string &value) Creates a string-type variant with the given value. More... variant (const char *value) Creates a string-type variant with the given value. More... variant (std::int32_t value) Creates a i4-type variant with the given value. More... variant (bool value) Creates a bool-type variant with the given value. More... variant (const datetime &value) Creates a date-type variant with the given value. More... variant (const std::initializer_list< std::int32_t > &value) Creates a vector_i4-type variant with the given value. More... variant (const std::vector< std::int32_t > &value) Creates a vector_i4-type variant with the given value. More... variant (const std::initializer_list< const char *> &value) Creates a vector_string-type variant with the given value. More... variant (const std::vector< const char *> &value) Creates a vector_string-type variant with the given value. More... variant (const std::initializer_list< std::string > &value) Creates a vector_string-type variant with the given value. More... variant (const std::vector< std::string > &value) Creates a vector_string-type variant with the given value. More... variant (const std::vector< variant > &value) Creates a vector_variant-type variant with the given value. More... bool is (type t) const Returns true if this variant is of type t. More... template<typename T > T get () const Returns the value of this variant as type T. An exception will be thrown if the types are not convertible. More... type value_type () const Returns the type of this variant. More... operator== (const variant &rhs) const bool get () const std::int32_t get () const std::string get () const datetime get () const std::vector< std::int32_t > get () const std::vector< std::string > get () const std::vector< variant > get () const
+
+
Represents an object that can have variable type.
+
+
+
◆
+
+
+
+
+
The possible types a variant can hold.
+
+
+
+
+
+
◆ [1/13]
+
+
+
+
+
+ xlnt::variant::variant
+ (
+ )
+
+
+
+
+
Default constructor. Creates a null-type variant.
+
+
+
+
+
◆ [2/13]
+
+
+
+
+
+ xlnt::variant::variant
+ (
+ const std::string &
+ value )
+
+
+
+
+
Creates a string-type variant with the given value.
+
+
+
+
+
◆ [3/13]
+
+
+
+
+
+ xlnt::variant::variant
+ (
+ const char *
+ value )
+
+
+
+
+
Creates a string-type variant with the given value.
+
+
+
+
+
◆ [4/13]
+
+
+
+
+
+ xlnt::variant::variant
+ (
+ std::int32_t
+ value )
+
+
+
+
+
Creates a i4-type variant with the given value.
+
+
+
+
+
◆ [5/13]
+
+
+
+
+
+ xlnt::variant::variant
+ (
+ bool
+ value )
+
+
+
+
+
Creates a bool-type variant with the given value.
+
+
+
+
+
◆ [6/13]
+
+
+
+
+
+ xlnt::variant::variant
+ (
+ const datetime &
+ value )
+
+
+
+
+
Creates a date-type variant with the given value.
+
+
+
+
+
◆ [7/13]
+
+
+
+
+
+ xlnt::variant::variant
+ (
+ const std::initializer_list< std::int32_t > &
+ value )
+
+
+
+
+
Creates a vector_i4-type variant with the given value.
+
+
+
+
+
◆ [8/13]
+
+
+
+
+
+ xlnt::variant::variant
+ (
+ const std::vector< std::int32_t > &
+ value )
+
+
+
+
+
Creates a vector_i4-type variant with the given value.
+
+
+
+
+
◆ [9/13]
+
+
+
+
+
+ xlnt::variant::variant
+ (
+ const std::initializer_list< const char *> &
+ value )
+
+
+
+
+
Creates a vector_string-type variant with the given value.
+
+
+
+
+
◆ [10/13]
+
+
+
+
+
+ xlnt::variant::variant
+ (
+ const std::vector< const char *> &
+ value )
+
+
+
+
+
Creates a vector_string-type variant with the given value.
+
+
+
+
+
◆ [11/13]
+
+
+
+
+
+ xlnt::variant::variant
+ (
+ const std::initializer_list< std::string > &
+ value )
+
+
+
+
+
Creates a vector_string-type variant with the given value.
+
+
+
+
+
◆ [12/13]
+
+
+
+
+
+ xlnt::variant::variant
+ (
+ const std::vector< std::string > &
+ value )
+
+
+
+
+
Creates a vector_string-type variant with the given value.
+
+
+
+
+
◆ [13/13]
+
+
+
+
+
+ xlnt::variant::variant
+ (
+ const std::vector< variant > &
+ value )
+
+
+
+
+
Creates a vector_variant-type variant with the given value.
+
+
+
+
+
+
◆
+
+
+
+
+template<typename T >
+
+
+ T xlnt::variant::get
+ (
+ )
+ const
+
+
+
+
+
Returns the value of this variant as type T. An exception will be thrown if the types are not convertible.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::variant::is
+ (
+ type t )
+ const
+
+
+
+
+
Returns true if this variant is of type t.
+
+
+
+
+
◆
+
+
+
+
+
+ type xlnt::variant::value_type (
+ )
+ const
+
+
+
+
+
Returns the type of this variant.
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::workbook , including all inherited members.
+
+ abs_path (const std::string &path)xlnt::workbook active_sheet ()xlnt::workbook active_sheet (std::size_t index)xlnt::workbook add_shared_string (const rich_text &shared, bool allow_duplicates=false)xlnt::workbook app_name () constxlnt::workbook apply_to_cells (std::function< void(cell)> f)xlnt::workbook arch_id_flags (const std::size_t flags)xlnt::workbook base_date () constxlnt::workbook base_date (calendar base_date)xlnt::workbook begin ()xlnt::workbook begin () constxlnt::workbook binaries () constxlnt::workbook calculation_properties () constxlnt::workbook calculation_properties (const class calculation_properties &props)xlnt::workbook cbegin () constxlnt::workbook cend () constxlnt::workbook clear ()xlnt::workbook clear_formats ()xlnt::workbook clear_styles ()xlnt::workbook code_name () constxlnt::workbook code_name (const std::string &code_name)xlnt::workbook const_iterator typedefxlnt::workbook const_reverse_iterator typedefxlnt::workbook contains (const std::string &title) constxlnt::workbook copy_sheet (worksheet worksheet)xlnt::workbook copy_sheet (worksheet worksheet, std::size_t index)xlnt::workbook core_properties () constxlnt::workbook core_property (xlnt::core_property type) constxlnt::workbook core_property (xlnt::core_property type, const variant &value)xlnt::workbook create_builtin_style (std::size_t builtin_id)xlnt::workbook create_format (bool default_format=false)xlnt::workbook create_named_range (const std::string &name, worksheet worksheet, const range_reference &reference)xlnt::workbook create_named_range (const std::string &name, worksheet worksheet, const std::string &reference_string)xlnt::workbook create_sheet ()xlnt::workbook create_sheet (std::size_t index)xlnt::workbook create_sheet_with_rel (const std::string &title, const relationship &rel)xlnt::workbook create_style (const std::string &name)xlnt::workbook custom_properties () constxlnt::workbook custom_property (const std::string &property_name) constxlnt::workbook custom_property (const std::string &property_name, const variant &value)xlnt::workbook default_slicer_style (const std::string &value)xlnt::workbook default_slicer_style () constxlnt::workbook detail::xlsx_consumer (defined in xlnt::workbook )xlnt::workbook friend detail::xlsx_producer (defined in xlnt::workbook )xlnt::workbook friend disable_known_fonts ()xlnt::workbook empty ()xlnt::workbook static enable_known_fonts ()xlnt::workbook end ()xlnt::workbook end () constxlnt::workbook extended_properties () constxlnt::workbook extended_property (xlnt::extended_property type) constxlnt::workbook extended_property (xlnt::extended_property type, const variant &value)xlnt::workbook format (std::size_t format_index)xlnt::workbook format (std::size_t format_index) constxlnt::workbook has_calculation_properties () constxlnt::workbook has_code_name () constxlnt::workbook has_core_property (xlnt::core_property type) constxlnt::workbook has_custom_property (const std::string &property_name) constxlnt::workbook has_extended_property (xlnt::extended_property type) constxlnt::workbook has_file_version () constxlnt::workbook has_named_range (const std::string &name) constxlnt::workbook has_style (const std::string &name) constxlnt::workbook has_theme () constxlnt::workbook has_title () constxlnt::workbook has_view () constxlnt::workbook index (worksheet worksheet)xlnt::workbook iterator typedefxlnt::workbook known_fonts_enabled () constxlnt::workbook last_edited () constxlnt::workbook load (const std::vector< std::uint8_t > &data)xlnt::workbook load (const std::vector< std::uint8_t > &data, const std::string &password)xlnt::workbook load (const std::string &filename)xlnt::workbook load (const std::string &filename, const std::string &password)xlnt::workbook load (const xlnt::path &filename)xlnt::workbook load (const xlnt::path &filename, const std::string &password)xlnt::workbook load (std::istream &stream)xlnt::workbook load (std::istream &stream, const std::string &password)xlnt::workbook lowest_edited () constxlnt::workbook manifest ()xlnt::workbook manifest () constxlnt::workbook named_range (const std::string &name)xlnt::workbook named_ranges () constxlnt::workbook operator!= (const workbook &rhs) constxlnt::workbook operator= (workbook other)xlnt::workbook operator== (const workbook &rhs) constxlnt::workbook operator[] (const std::string &name)xlnt::workbook operator[] (std::size_t index)xlnt::workbook remove_named_range (const std::string &name)xlnt::workbook remove_sheet (worksheet worksheet)xlnt::workbook reverse_iterator typedefxlnt::workbook rup_build () constxlnt::workbook save (std::vector< std::uint8_t > &data) constxlnt::workbook save (std::vector< std::uint8_t > &data, const std::string &password) constxlnt::workbook save (const std::string &filename) constxlnt::workbook save (const std::string &filename, const std::string &password) constxlnt::workbook save (const xlnt::path &filename) constxlnt::workbook save (const xlnt::path &filename, const std::string &password) constxlnt::workbook save (std::ostream &stream) constxlnt::workbook save (std::ostream &stream, const std::string &password) constxlnt::workbook shared_strings (std::size_t index) constxlnt::workbook shared_strings ()xlnt::workbook shared_strings () constxlnt::workbook sheet_by_id (std::size_t id)xlnt::workbook sheet_by_id (std::size_t id) constxlnt::workbook sheet_by_index (std::size_t index)xlnt::workbook sheet_by_index (std::size_t index) constxlnt::workbook sheet_by_title (const std::string &title)xlnt::workbook sheet_by_title (const std::string &title) constxlnt::workbook sheet_count () constxlnt::workbook sheet_hidden_by_index (std::size_t index) constxlnt::workbook sheet_titles () constxlnt::workbook streaming_workbook_reader (defined in xlnt::workbook )xlnt::workbook friend style (const std::string &name)xlnt::workbook style (const std::string &name) constxlnt::workbook theme () constxlnt::workbook theme (const class theme &value)xlnt::workbook thumbnail (const std::vector< std::uint8_t > &thumbnail, const std::string &extension, const std::string &content_type)xlnt::workbook thumbnail () constxlnt::workbook title () constxlnt::workbook title (const std::string &title)xlnt::workbook view () constxlnt::workbook view (const workbook_view &view)xlnt::workbook workbook ()xlnt::workbook workbook (const xlnt::path &file)xlnt::workbook workbook (const xlnt::path &file, const std::string &password)xlnt::workbook workbook (std::istream &data)xlnt::workbook workbook (std::istream &data, const std::string &password)xlnt::workbook workbook (workbook &&other)xlnt::workbook workbook (const workbook &other)xlnt::workbook worksheet (defined in xlnt::workbook )xlnt::workbook friend ~workbook ()xlnt::workbook
xlnt: xlnt::workbook Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
workbook is the container for all other parts of the document.
+ More...
+
+
#include <workbook.hpp >
+
+using iterator = worksheet_iterator typedef for the iterator used for iterating through this workbook (non-const) in a range-based for loop. More... using const_iterator = const_worksheet_iterator typedef for the iterator used for iterating through this workbook (const) in a range-based for loop. More... using reverse_iterator = std::reverse_iterator< iterator > typedef for the iterator used for iterating through this workbook (non-const) in a range-based for loop in reverse order using std::make_reverse_iterator. More... using const_reverse_iterator = std::reverse_iterator< const_iterator > typedef for the iterator used for iterating through this workbook (const) in a range-based for loop in reverse order using std::make_reverse_iterator. More...
+ workbook () Default constructor. Constructs a workbook containing a single empty worksheet using workbook::empty() . More... workbook (const xlnt::path &file) load the xlsx file at path More... workbook (const xlnt::path &file, const std::string &password) load the encrpyted xlsx file at path More... workbook (std::istream &data) construct the workbook from any data stream where the data is the binary form of a workbook More... workbook (std::istream &data, const std::string &password) construct the workbook from any data stream where the data is the binary form of an encrypted workbook More... workbook (workbook &&other) Move constructor. Constructs a workbook from existing workbook, other. More... workbook (const workbook &other) Copy constructor. Constructs this workbook from existing workbook, other. More... ~workbook () Destroys this workbook, deallocating all internal storage space. Any pimpl wrapper classes (e.g. cell) pointing into this workbook will be invalid after this is executed. More... worksheet create_sheet () Creates and returns a sheet after the last sheet in this workbook. More... worksheet create_sheet (std::size_t index ) Creates and returns a sheet at the specified index. More... worksheet create_sheet_with_rel (const std::string &title , const relationship &rel) TODO: This should be private... More... worksheet copy_sheet (worksheet worksheet ) Creates and returns a new sheet after the last sheet initializing it with all of the data from the provided worksheet. More... worksheet copy_sheet (worksheet worksheet , std::size_t index ) Creates and returns a new sheet at the specified index initializing it with all of the data from the provided worksheet. More... worksheet active_sheet () Returns the worksheet that is determined to be active. An active sheet is that which is initially shown by the spreadsheet editor. More... void active_sheet (std::size_t index ) Sets the worksheet that is determined to be active. An active sheet is that which is initially shown by the spreadsheet editor. More... worksheet sheet_by_title (const std::string &title ) Returns the worksheet with the given name. This may throw an exception if the sheet isn't found. Use workbook::contains(const std::string &) to make sure the sheet exists before calling this method. More... const worksheet sheet_by_title (const std::string &title ) const Returns the worksheet with the given name. This may throw an exception if the sheet isn't found. Use workbook::contains(const std::string &) to make sure the sheet exists before calling this method. More... worksheet sheet_by_index (std::size_t index ) Returns the worksheet at the given index. This will throw an exception if index is greater than or equal to the number of sheets in this workbook. More... const worksheet sheet_by_index (std::size_t index ) const Returns the worksheet at the given index. This will throw an exception if index is greater than or equal to the number of sheets in this workbook. More... worksheet sheet_by_id (std::size_t id) Returns the worksheet with a sheetId of id. Sheet IDs are arbitrary numbers that uniquely identify a sheet. Most users won't need this. More... const worksheet sheet_by_id (std::size_t id) const Returns the worksheet with a sheetId of id. Sheet IDs are arbitrary numbers that uniquely identify a sheet. Most users won't need this. More... bool sheet_hidden_by_index (std::size_t index ) const Returns the hidden identifier of the worksheet at the given index. This will throw an exception if index is greater than or equal to the number of sheets in this workbook. More... bool contains (const std::string &title ) const Returns true if this workbook contains a sheet with the given title. More... std::size_t index (worksheet worksheet ) Returns the index of the given worksheet. The worksheet must be owned by this workbook. More... void remove_sheet (worksheet worksheet ) Removes the given worksheet from this workbook. More... void clear () Sets the contents of this workbook to be equivalent to that of a workbook returned by workbook::empty() . More... iterator begin () Returns an iterator to the first worksheet in this workbook. More... iterator end () Returns an iterator to the worksheet following the last worksheet of the workbook. This worksheet acts as a placeholder; attempting to access it will cause an exception to be thrown. More... const_iterator begin () const Returns a const iterator to the first worksheet in this workbook. More... const_iterator end () const Returns a const iterator to the worksheet following the last worksheet of the workbook. This worksheet acts as a placeholder; attempting to access it will cause an exception to be thrown. More... const_iterator cbegin () const Returns an iterator to the first worksheet in this workbook. More... const_iterator cend () const Returns a const iterator to the worksheet following the last worksheet of the workbook. This worksheet acts as a placeholder; attempting to access it will cause an exception to be thrown. More... void apply_to_cells (std::function< void(cell )> f) Applies the function "f" to every non-empty cell in every worksheet in this workbook. More... std::vector< std::string > sheet_titles () const Returns a temporary vector containing the titles of each sheet in the order of the sheets in the workbook. More... std::size_t sheet_count () const Returns the number of sheets in this workbook. More... bool has_core_property (xlnt::core_property type) const Returns true if the workbook has the core property with the given name. More... std::vector< xlnt::core_property > core_properties () const Returns a vector of the type of each core property that is set to a particular value in this workbook. More... variant core_property (xlnt::core_property type) const Returns the value of the given core property. More... void core_property (xlnt::core_property type, const variant &value) Sets the given core property to the provided value. More... bool has_extended_property (xlnt::extended_property type) const Returns true if the workbook has the extended property with the given name. More... std::vector< xlnt::extended_property > extended_properties () const Returns a vector of the type of each extended property that is set to a particular value in this workbook. More... variant extended_property (xlnt::extended_property type) const Returns the value of the given extended property. More... void extended_property (xlnt::extended_property type, const variant &value) Sets the given extended property to the provided value. More... bool has_custom_property (const std::string &property_name) const Returns true if the workbook has the custom property with the given name. More... std::vector< std::string > custom_properties () const Returns a vector of the name of each custom property that is set to a particular value in this workbook. More... variant custom_property (const std::string &property_name) const Returns the value of the given custom property. More... void custom_property (const std::string &property_name, const variant &value) Creates a new custom property in this workbook and sets it to the provided value. More... calendar base_date () const Returns the base date used by this workbook. This will generally be windows_1900 except on Apple based systems when it will default to mac_1904 unless otherwise set via void workbook::base_date(calendar base_date) . More... void base_date (calendar base_date) Sets the base date style of this workbook. This is the date and time that a numeric value of 0 represents. More... bool has_title () const Returns true if this workbook has had its title set. More... std::string title () const Returns the title of this workbook. More... void title (const std::string &title) Sets the title of this workbook to title. More... void abs_path (const std::string &path ) Sets the absolute path of this workbook to path. More... void arch_id_flags (const std::size_t flags) Sets the ArchID flags of this workbook to flags. More... std::vector< xlnt::named_range > named_ranges () const Returns a vector of the named ranges in this workbook. More... void create_named_range (const std::string &name, worksheet worksheet , const range_reference &reference) Creates a new names range. More... void create_named_range (const std::string &name, worksheet worksheet , const std::string &reference_string) Creates a new names range. More... bool has_named_range (const std::string &name) const Returns true if a named range of the given name exists in the workbook. More... class range named_range (const std::string &name) Returns the named range with the given name. More... void remove_named_range (const std::string &name) Deletes the named range with the given name. More... void save (std::vector< std::uint8_t > &data) const Serializes the workbook into an XLSX file and saves the bytes into byte vector data. More... void save (std::vector< std::uint8_t > &data, const std::string &password) const Serializes the workbook into an XLSX file encrypted with the given password and saves the bytes into byte vector data. More... void save (const std::string &filename) const Serializes the workbook into an XLSX file and saves the data into a file named filename. More... void save (const std::string &filename, const std::string &password) const Serializes the workbook into an XLSX file encrypted with the given password and loads the bytes into a file named filename. More... void save (const xlnt::path &filename) const Serializes the workbook into an XLSX file and saves the data into a file named filename. More... void save (const xlnt::path &filename, const std::string &password) const Serializes the workbook into an XLSX file encrypted with the given password and loads the bytes into a file named filename. More... void save (std::ostream &stream) const Serializes the workbook into an XLSX file and saves the data into stream. More... void save (std::ostream &stream, const std::string &password) const Serializes the workbook into an XLSX file encrypted with the given password and loads the bytes into the given stream. More... void load (const std::vector< std::uint8_t > &data) Interprets byte vector data as an XLSX file and sets the content of this workbook to match that file. More... void load (const std::vector< std::uint8_t > &data, const std::string &password) Interprets byte vector data as an XLSX file encrypted with the given password and sets the content of this workbook to match that file. More... void load (const std::string &filename) Interprets file with the given filename as an XLSX file and sets the content of this workbook to match that file. More... void load (const std::string &filename, const std::string &password) Interprets file with the given filename as an XLSX file encrypted with the given password and sets the content of this workbook to match that file. More... void load (const xlnt::path &filename) Interprets file with the given filename as an XLSX file and sets the content of this workbook to match that file. More... void load (const xlnt::path &filename, const std::string &password) Interprets file with the given filename as an XLSX file encrypted with the given password and sets the content of this workbook to match that file. More... void load (std::istream &stream) Interprets data in stream as an XLSX file and sets the content of this workbook to match that file. More... void load (std::istream &stream, const std::string &password) Interprets data in stream as an XLSX file encrypted with the given password and sets the content of this workbook to match that file. More... bool has_view () const Returns true if this workbook has a view. More... workbook_view view () const Returns the view. More... void view (const workbook_view &view) Sets the view to view. More... bool has_code_name () const Returns true if a code name has been set for this workbook. More... std::string code_name () const Returns the code name that was set for this workbook. More... void code_name (const std::string &code_name) Sets the code name of this workbook to code_name. More... bool has_file_version () const Returns true if this workbook has a file version. More... std::string app_name () const Returns the AppName workbook file property. More... std::size_t last_edited () const Returns the LastEdited workbook file property. More... std::size_t lowest_edited () const Returns the LowestEdited workbook file property. More... std::size_t rup_build () const Returns the RupBuild workbook file property. More... bool has_theme () const Returns true if this workbook has a theme defined. More... const xlnt::theme & theme () const Returns a const reference to this workbook's theme. More... void theme (const class theme &value) Sets the theme to value. More... xlnt::format format (std::size_t format_index) Returns the cell format at the given index. The index is the position of the format in xl/styles.xml. More... const xlnt::format format (std::size_t format_index) const Returns the cell format at the given index. The index is the position of the format in xl/styles.xml. More... xlnt::format create_format (bool default_format=false) Creates a new format and returns it. More... void clear_formats () Clear all cell-level formatting and formats from the styelsheet. This leaves all other styling in place (e.g. named styles). More... bool has_style (const std::string &name) const Returns true if this workbook has a style with a name of name. More... class style style (const std::string &name) Returns the named style with the given name. More... const class style style (const std::string &name) const Returns the named style with the given name. More... class style create_style (const std::string &name) Creates a new style and returns it. More... class style create_builtin_style (std::size_t builtin_id) Creates a new style and returns it. More... void clear_styles () Clear all named styles from cells and remove the styles from from the styelsheet. This leaves all other styling in place (e.g. cell formats). More... void default_slicer_style (const std::string &value) Sets the default slicer style to the given value. More... std::string default_slicer_style () const Returns the default slicer style. More... void enable_known_fonts () Enables knownFonts in stylesheet. More... void disable_known_fonts () Disables knownFonts in stylesheet. More... bool known_fonts_enabled () const Returns true if knownFonts are enabled in the stylesheet. More... class manifest & manifest () Returns a reference to the workbook's internal manifest. More... const class manifest & manifest () const Returns a reference to the workbook's internal manifest. More... std::size_t add_shared_string (const rich_text &shared, bool allow_duplicates=false) Append a shared string to the shared string collection in this workbook. This should not generally be called unless you know what you're doing. If allow_duplicates is false and the string is already in the collection, it will not be added. Returns the index of the added string. More... const rich_text & shared_strings (std::size_t index ) const Returns a reference to the shared string related to the specified index More... std::vector< rich_text > & shared_strings () Returns a reference to the shared strings being used by cells in this workbook. More... const std::vector< rich_text > & shared_strings () const Returns a reference to the shared strings being used by cells in this workbook. More... void thumbnail (const std::vector< std::uint8_t > &thumbnail, const std::string &extension, const std::string &content_type) Sets the workbook's thumbnail to the given vector of bytes, thumbnail, with the given extension (e.g. jpg) and content_type (e.g. image/jpeg). More... const std::vector< std::uint8_t > & thumbnail () const Returns a vector of bytes representing the workbook's thumbnail. More... const std::unordered_map< std::string, std::vector< std::uint8_t > > & binaries () const Returns stored binary data. More... bool has_calculation_properties () const Returns true if this workbook has any calculation properties set. More... class calculation_properties calculation_properties () const Returns the calculation properties used in this workbook. More... void calculation_properties (const class calculation_properties &props) Sets the calculation properties of this workbook to props. More... workbook & operator= (workbook other) Set the contents of this workbook to be equal to those of "other". Other is passed as value to allow for copy-swap idiom. More... worksheet operator[] (const std::string &name) Return the worksheet with a title of "name". More... worksheet operator[] (std::size_t index ) Return the worksheet at "index". More... bool operator== (const workbook &rhs) const Return true if this workbook internal implementation points to the same memory as rhs's. More... bool operator!= (const workbook &rhs) const Return true if this workbook internal implementation doesn't point to the same memory as rhs's. More...
+static workbook empty () Constructs and returns an empty workbook similar to a default. Excel workbook More...
+streaming_workbook_reader worksheet detail::xlsx_consumer detail::xlsx_producer
+
+
workbook is the container for all other parts of the document.
+
+
+
◆
+
+
+
+
+
typedef for the iterator used for iterating through this workbook (const) in a range-based for loop.
+
+
+
+
+
◆
+
+
+
+
+
typedef for the iterator used for iterating through this workbook (const) in a range-based for loop in reverse order using std::make_reverse_iterator.
+
+
+
+
+
◆
+
+
+
+
+
typedef for the iterator used for iterating through this workbook (non-const) in a range-based for loop.
+
+
+
+
+
◆
+
+
+
+
+
typedef for the iterator used for iterating through this workbook (non-const) in a range-based for loop in reverse order using std::make_reverse_iterator.
+
+
+
+
+
+
◆ [1/7]
+
+
+
+
+
+ xlnt::workbook::workbook
+ (
+ )
+
+
+
+
+
Default constructor. Constructs a workbook containing a single empty worksheet using workbook::empty() .
+
+
+
+
+
◆ [2/7]
+
+
+
+
+
+ xlnt::workbook::workbook
+ (
+ const xlnt::path &
+ file )
+
+
+
+
+
load the xlsx file at path
+
+
+
+
+
◆ [3/7]
+
+
+
+
+
+ xlnt::workbook::workbook
+ (
+ const xlnt::path &
+ file ,
+
+ const std::string &
+ password
+
+ )
+
+
+
+
+
load the encrpyted xlsx file at path
+
+
+
+
+
◆ [4/7]
+
+
+
+
+
+ xlnt::workbook::workbook
+ (
+ std::istream &
+ data )
+
+
+
+
+
construct the workbook from any data stream where the data is the binary form of a workbook
+
+
+
+
+
◆ [5/7]
+
+
+
+
+
+ xlnt::workbook::workbook
+ (
+ std::istream &
+ data ,
+
+ const std::string &
+ password
+
+ )
+
+
+
+
+
construct the workbook from any data stream where the data is the binary form of an encrypted workbook
+
+
+
+
+
◆ [6/7]
+
+
+
+
+
+ xlnt::workbook::workbook
+ (
+ workbook && other )
+
+
+
+
+
Move constructor. Constructs a workbook from existing workbook, other.
+
+
+
+
+
◆ [7/7]
+
+
+
+
+
+ xlnt::workbook::workbook
+ (
+ const workbook &
+ other )
+
+
+
+
+
Copy constructor. Constructs this workbook from existing workbook, other.
+
+
+
+
+
◆
+
+
+
+
+
+ xlnt::workbook::~workbook
+ (
+ )
+
+
+
+
+
Destroys this workbook, deallocating all internal storage space. Any pimpl wrapper classes (e.g. cell) pointing into this workbook will be invalid after this is executed.
+
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::workbook::abs_path
+ (
+ const std::string &
+ path )
+
+
+
+
+
Sets the absolute path of this workbook to path.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ worksheet xlnt::workbook::active_sheet (
+ )
+
+
+
+
+
Returns the worksheet that is determined to be active. An active sheet is that which is initially shown by the spreadsheet editor.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::workbook::active_sheet
+ (
+ std::size_t
+ index )
+
+
+
+
+
Sets the worksheet that is determined to be active. An active sheet is that which is initially shown by the spreadsheet editor.
+
+
+
+
+
◆
+
+
+
+
+
+ std::size_t xlnt::workbook::add_shared_string
+ (
+ const rich_text &
+ shared ,
+
+ bool
+ allow_duplicates = false
+
+ )
+
+
+
+
+
Append a shared string to the shared string collection in this workbook. This should not generally be called unless you know what you're doing. If allow_duplicates is false and the string is already in the collection, it will not be added. Returns the index of the added string.
+
+
+
+
+
◆
+
+
+
+
+
+ std::string xlnt::workbook::app_name
+ (
+ )
+ const
+
+
+
+
+
Returns the AppName workbook file property.
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::workbook::apply_to_cells
+ (
+ std::function< void(cell )>
+ f )
+
+
+
+
+
Applies the function "f" to every non-empty cell in every worksheet in this workbook.
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::workbook::arch_id_flags
+ (
+ const std::size_t
+ flags )
+
+
+
+
+
Sets the ArchID flags of this workbook to flags.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ calendar xlnt::workbook::base_date (
+ )
+ const
+
+
+
+
+
Returns the base date used by this workbook. This will generally be windows_1900 except on Apple based systems when it will default to mac_1904 unless otherwise set via void workbook::base_date(calendar base_date) .
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::workbook::base_date
+ (
+ calendar base_date )
+
+
+
+
+
Sets the base date style of this workbook. This is the date and time that a numeric value of 0 represents.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ iterator xlnt::workbook::begin (
+ )
+
+
+
+
+
Returns an iterator to the first worksheet in this workbook.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Returns a const iterator to the first worksheet in this workbook.
+
+
+
+
+
◆
+
+
+
+
+
+ const std::unordered_map<std::string, std::vector<std::uint8_t> >& xlnt::workbook::binaries
+ (
+ )
+ const
+
+
+
+
+
Returns stored binary data.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Returns the calculation properties used in this workbook.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Sets the calculation properties of this workbook to props.
+
+
+
+
+
◆
+
+
+
+
+
Returns an iterator to the first worksheet in this workbook.
+
+
+
+
+
◆
+
+
+
+
+
Returns a const iterator to the worksheet following the last worksheet of the workbook. This worksheet acts as a placeholder; attempting to access it will cause an exception to be thrown.
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::workbook::clear
+ (
+ )
+
+
+
+
+
Sets the contents of this workbook to be equivalent to that of a workbook returned by workbook::empty() .
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::workbook::clear_formats
+ (
+ )
+
+
+
+
+
Clear all cell-level formatting and formats from the styelsheet. This leaves all other styling in place (e.g. named styles).
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::workbook::clear_styles
+ (
+ )
+
+
+
+
+
Clear all named styles from cells and remove the styles from from the styelsheet. This leaves all other styling in place (e.g. cell formats).
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ std::string xlnt::workbook::code_name
+ (
+ )
+ const
+
+
+
+
+
Returns the code name that was set for this workbook.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::workbook::code_name
+ (
+ const std::string &
+ code_name )
+
+
+
+
+
Sets the code name of this workbook to code_name.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::workbook::contains
+ (
+ const std::string &
+ title )
+ const
+
+
+
+
+
Returns true if this workbook contains a sheet with the given title.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Creates and returns a new sheet after the last sheet initializing it with all of the data from the provided worksheet.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ worksheet xlnt::workbook::copy_sheet (
+ worksheet worksheet ,
+
+ std::size_t
+ index
+
+ )
+
+
+
+
+
Creates and returns a new sheet at the specified index initializing it with all of the data from the provided worksheet.
+
+
+
+
+
◆
+
+
+
+
+
Returns a vector of the type of each core property that is set to a particular value in this workbook.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Returns the value of the given core property.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Sets the given core property to the provided value.
+
+
+
+
+
◆
+
+
+
+
+
+ class style xlnt::workbook::create_builtin_style
+ (
+ std::size_t
+ builtin_id )
+
+
+
+
+
Creates a new style and returns it.
+
+
+
+
+
◆
+
+
+
+
+
+ xlnt::format xlnt::workbook::create_format (
+ bool
+ default_format = false)
+
+
+
+
+
Creates a new format and returns it.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ void xlnt::workbook::create_named_range
+ (
+ const std::string &
+ name ,
+
+ worksheet worksheet ,
+
+ const range_reference &
+ reference
+
+ )
+
+
+
+
+
Creates a new names range.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::workbook::create_named_range
+ (
+ const std::string &
+ name ,
+
+ worksheet worksheet ,
+
+ const std::string &
+ reference_string
+
+ )
+
+
+
+
+
Creates a new names range.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ worksheet xlnt::workbook::create_sheet (
+ )
+
+
+
+
+
Creates and returns a sheet after the last sheet in this workbook.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ worksheet xlnt::workbook::create_sheet (
+ std::size_t
+ index )
+
+
+
+
+
Creates and returns a sheet at the specified index.
+
+
+
+
+
◆
+
+
+
+
+
+ worksheet xlnt::workbook::create_sheet_with_rel (
+ const std::string &
+ title ,
+
+ const relationship &
+ rel
+
+ )
+
+
+
+
+
TODO: This should be private...
+
+
+
+
+
◆
+
+
+
+
+
+ class style xlnt::workbook::create_style
+ (
+ const std::string &
+ name )
+
+
+
+
+
Creates a new style and returns it.
+
+
+
+
+
◆
+
+
+
+
+
+ std::vector<std::string> xlnt::workbook::custom_properties
+ (
+ )
+ const
+
+
+
+
+
Returns a vector of the name of each custom property that is set to a particular value in this workbook.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ variant xlnt::workbook::custom_property (
+ const std::string &
+ property_name )
+ const
+
+
+
+
+
Returns the value of the given custom property.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::workbook::custom_property
+ (
+ const std::string &
+ property_name ,
+
+ const variant &
+ value
+
+ )
+
+
+
+
+
Creates a new custom property in this workbook and sets it to the provided value.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ void xlnt::workbook::default_slicer_style
+ (
+ const std::string &
+ value )
+
+
+
+
+
Sets the default slicer style to the given value.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ std::string xlnt::workbook::default_slicer_style
+ (
+ )
+ const
+
+
+
+
+
Returns the default slicer style.
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::workbook::disable_known_fonts
+ (
+ )
+
+
+
+
+
Disables knownFonts in stylesheet.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static workbook xlnt::workbook::empty
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Constructs and returns an empty workbook similar to a default. Excel workbook
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::workbook::enable_known_fonts
+ (
+ )
+
+
+
+
+
Enables knownFonts in stylesheet.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ iterator xlnt::workbook::end (
+ )
+
+
+
+
+
Returns an iterator to the worksheet following the last worksheet of the workbook. This worksheet acts as a placeholder; attempting to access it will cause an exception to be thrown.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Returns a const iterator to the worksheet following the last worksheet of the workbook. This worksheet acts as a placeholder; attempting to access it will cause an exception to be thrown.
+
+
+
+
+
◆
+
+
+
+
+
Returns a vector of the type of each extended property that is set to a particular value in this workbook.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Returns the value of the given extended property.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Sets the given extended property to the provided value.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ xlnt::format xlnt::workbook::format (
+ std::size_t
+ format_index )
+
+
+
+
+
Returns the cell format at the given index. The index is the position of the format in xl/styles.xml.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ const xlnt::format xlnt::workbook::format
+ (
+ std::size_t
+ format_index )
+ const
+
+
+
+
+
Returns the cell format at the given index. The index is the position of the format in xl/styles.xml.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::workbook::has_calculation_properties
+ (
+ )
+ const
+
+
+
+
+
Returns true if this workbook has any calculation properties set.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::workbook::has_code_name
+ (
+ )
+ const
+
+
+
+
+
Returns true if a code name has been set for this workbook.
+
+
+
+
+
◆
+
+
+
+
+
Returns true if the workbook has the core property with the given name.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::workbook::has_custom_property
+ (
+ const std::string &
+ property_name )
+ const
+
+
+
+
+
Returns true if the workbook has the custom property with the given name.
+
+
+
+
+
◆
+
+
+
+
+
Returns true if the workbook has the extended property with the given name.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::workbook::has_file_version
+ (
+ )
+ const
+
+
+
+
+
Returns true if this workbook has a file version.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::workbook::has_named_range
+ (
+ const std::string &
+ name )
+ const
+
+
+
+
+
Returns true if a named range of the given name exists in the workbook.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::workbook::has_style
+ (
+ const std::string &
+ name )
+ const
+
+
+
+
+
Returns true if this workbook has a style with a name of name.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::workbook::has_theme
+ (
+ )
+ const
+
+
+
+
+
Returns true if this workbook has a theme defined.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::workbook::has_title
+ (
+ )
+ const
+
+
+
+
+
Returns true if this workbook has had its title set.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::workbook::has_view
+ (
+ )
+ const
+
+
+
+
+
Returns true if this workbook has a view.
+
+
+
+
+
◆
+
+
+
+
+
+ std::size_t xlnt::workbook::index
+ (
+ worksheet worksheet )
+
+
+
+
+
Returns the index of the given worksheet. The worksheet must be owned by this workbook.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::workbook::known_fonts_enabled
+ (
+ )
+ const
+
+
+
+
+
Returns true if knownFonts are enabled in the stylesheet.
+
+
+
+
+
◆
+
+
+
+
+
+ std::size_t xlnt::workbook::last_edited
+ (
+ )
+ const
+
+
+
+
+
Returns the LastEdited workbook file property.
+
+
+
+
+
◆ [1/8]
+
+
+
+
+
+ void xlnt::workbook::load
+ (
+ const std::vector< std::uint8_t > &
+ data )
+
+
+
+
+
Interprets byte vector data as an XLSX file and sets the content of this workbook to match that file.
+
+
+
+
+
◆ [2/8]
+
+
+
+
+
+ void xlnt::workbook::load
+ (
+ const std::vector< std::uint8_t > &
+ data ,
+
+ const std::string &
+ password
+
+ )
+
+
+
+
+
Interprets byte vector data as an XLSX file encrypted with the given password and sets the content of this workbook to match that file.
+
+
+
+
+
◆ [3/8]
+
+
+
+
+
+ void xlnt::workbook::load
+ (
+ const std::string &
+ filename )
+
+
+
+
+
Interprets file with the given filename as an XLSX file and sets the content of this workbook to match that file.
+
+
+
+
+
◆ [4/8]
+
+
+
+
+
+ void xlnt::workbook::load
+ (
+ const std::string &
+ filename ,
+
+ const std::string &
+ password
+
+ )
+
+
+
+
+
Interprets file with the given filename as an XLSX file encrypted with the given password and sets the content of this workbook to match that file.
+
+
+
+
+
◆ [5/8]
+
+
+
+
+
+ void xlnt::workbook::load
+ (
+ const xlnt::path &
+ filename )
+
+
+
+
+
Interprets file with the given filename as an XLSX file and sets the content of this workbook to match that file.
+
+
+
+
+
◆ [6/8]
+
+
+
+
+
+ void xlnt::workbook::load
+ (
+ const xlnt::path &
+ filename ,
+
+ const std::string &
+ password
+
+ )
+
+
+
+
+
Interprets file with the given filename as an XLSX file encrypted with the given password and sets the content of this workbook to match that file.
+
+
+
+
+
◆ [7/8]
+
+
+
+
+
+ void xlnt::workbook::load
+ (
+ std::istream &
+ stream )
+
+
+
+
+
Interprets data in stream as an XLSX file and sets the content of this workbook to match that file.
+
+
+
+
+
◆ [8/8]
+
+
+
+
+
+ void xlnt::workbook::load
+ (
+ std::istream &
+ stream ,
+
+ const std::string &
+ password
+
+ )
+
+
+
+
+
Interprets data in stream as an XLSX file encrypted with the given password and sets the content of this workbook to match that file.
+
+
+
+
+
◆
+
+
+
+
+
+ std::size_t xlnt::workbook::lowest_edited
+ (
+ )
+ const
+
+
+
+
+
Returns the LowestEdited workbook file property.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ class manifest & xlnt::workbook::manifest
+ (
+ )
+
+
+
+
+
Returns a reference to the workbook's internal manifest.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ const class manifest & xlnt::workbook::manifest
+ (
+ )
+ const
+
+
+
+
+
Returns a reference to the workbook's internal manifest.
+
+
+
+
+
◆
+
+
+
+
+
+ class range xlnt::workbook::named_range
+ (
+ const std::string &
+ name )
+
+
+
+
+
Returns the named range with the given name.
+
+
+
+
+
◆
+
+
+
+
+
Returns a vector of the named ranges in this workbook.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::workbook::operator!=
+ (
+ const workbook &
+ rhs )
+ const
+
+
+
+
+
Return true if this workbook internal implementation doesn't point to the same memory as rhs's.
+
+
+
+
+
◆
+
+
+
+
+
Set the contents of this workbook to be equal to those of "other". Other is passed as value to allow for copy-swap idiom.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::workbook::operator==
+ (
+ const workbook &
+ rhs )
+ const
+
+
+
+
+
Return true if this workbook internal implementation points to the same memory as rhs's.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ worksheet xlnt::workbook::operator[] (
+ const std::string &
+ name )
+
+
+
+
+
Return the worksheet with a title of "name".
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ worksheet xlnt::workbook::operator[] (
+ std::size_t
+ index )
+
+
+
+
+
Return the worksheet at "index".
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::workbook::remove_named_range
+ (
+ const std::string &
+ name )
+
+
+
+
+
Deletes the named range with the given name.
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::workbook::remove_sheet
+ (
+ worksheet worksheet )
+
+
+
+
+
Removes the given worksheet from this workbook.
+
+
+
+
+
◆
+
+
+
+
+
+ std::size_t xlnt::workbook::rup_build
+ (
+ )
+ const
+
+
+
+
+
Returns the RupBuild workbook file property.
+
+
+
+
+
◆ [1/8]
+
+
+
+
+
+ void xlnt::workbook::save
+ (
+ std::vector< std::uint8_t > &
+ data )
+ const
+
+
+
+
+
Serializes the workbook into an XLSX file and saves the bytes into byte vector data.
+
+
+
+
+
◆ [2/8]
+
+
+
+
+
+ void xlnt::workbook::save
+ (
+ std::vector< std::uint8_t > &
+ data ,
+
+ const std::string &
+ password
+
+ )
+ const
+
+
+
+
+
Serializes the workbook into an XLSX file encrypted with the given password and saves the bytes into byte vector data.
+
+
+
+
+
◆ [3/8]
+
+
+
+
+
+ void xlnt::workbook::save
+ (
+ const std::string &
+ filename )
+ const
+
+
+
+
+
Serializes the workbook into an XLSX file and saves the data into a file named filename.
+
+
+
+
+
◆ [4/8]
+
+
+
+
+
+ void xlnt::workbook::save
+ (
+ const std::string &
+ filename ,
+
+ const std::string &
+ password
+
+ )
+ const
+
+
+
+
+
Serializes the workbook into an XLSX file encrypted with the given password and loads the bytes into a file named filename.
+
+
+
+
+
◆ [5/8]
+
+
+
+
+
+ void xlnt::workbook::save
+ (
+ const xlnt::path &
+ filename )
+ const
+
+
+
+
+
Serializes the workbook into an XLSX file and saves the data into a file named filename.
+
+
+
+
+
◆ [6/8]
+
+
+
+
+
+ void xlnt::workbook::save
+ (
+ const xlnt::path &
+ filename ,
+
+ const std::string &
+ password
+
+ )
+ const
+
+
+
+
+
Serializes the workbook into an XLSX file encrypted with the given password and loads the bytes into a file named filename.
+
+
+
+
+
◆ [7/8]
+
+
+
+
+
+ void xlnt::workbook::save
+ (
+ std::ostream &
+ stream )
+ const
+
+
+
+
+
Serializes the workbook into an XLSX file and saves the data into stream.
+
+
+
+
+
◆ [8/8]
+
+
+
+
+
+ void xlnt::workbook::save
+ (
+ std::ostream &
+ stream ,
+
+ const std::string &
+ password
+
+ )
+ const
+
+
+
+
+
Serializes the workbook into an XLSX file encrypted with the given password and loads the bytes into the given stream.
+
+
+
+
+
◆ [1/3]
+
+
+
+
+
+ const rich_text & xlnt::workbook::shared_strings
+ (
+ std::size_t
+ index )
+ const
+
+
+
+
+
Returns a reference to the shared string related to the specified index
+
+
+
+
+
◆ [2/3]
+
+
+
+
+
+ std::vector<rich_text >& xlnt::workbook::shared_strings
+ (
+ )
+
+
+
+
+
Returns a reference to the shared strings being used by cells in this workbook.
+
+
+
+
+
◆ [3/3]
+
+
+
+
+
+ const std::vector<rich_text >& xlnt::workbook::shared_strings
+ (
+ )
+ const
+
+
+
+
+
Returns a reference to the shared strings being used by cells in this workbook.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ worksheet xlnt::workbook::sheet_by_id (
+ std::size_t
+ id )
+
+
+
+
+
Returns the worksheet with a sheetId of id. Sheet IDs are arbitrary numbers that uniquely identify a sheet. Most users won't need this.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ const worksheet xlnt::workbook::sheet_by_id
+ (
+ std::size_t
+ id )
+ const
+
+
+
+
+
Returns the worksheet with a sheetId of id. Sheet IDs are arbitrary numbers that uniquely identify a sheet. Most users won't need this.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ worksheet xlnt::workbook::sheet_by_index (
+ std::size_t
+ index )
+
+
+
+
+
Returns the worksheet at the given index. This will throw an exception if index is greater than or equal to the number of sheets in this workbook.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ const worksheet xlnt::workbook::sheet_by_index
+ (
+ std::size_t
+ index )
+ const
+
+
+
+
+
Returns the worksheet at the given index. This will throw an exception if index is greater than or equal to the number of sheets in this workbook.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ worksheet xlnt::workbook::sheet_by_title (
+ const std::string &
+ title )
+
+
+
+
+
Returns the worksheet with the given name. This may throw an exception if the sheet isn't found. Use workbook::contains(const std::string &) to make sure the sheet exists before calling this method.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ const worksheet xlnt::workbook::sheet_by_title
+ (
+ const std::string &
+ title )
+ const
+
+
+
+
+
Returns the worksheet with the given name. This may throw an exception if the sheet isn't found. Use workbook::contains(const std::string &) to make sure the sheet exists before calling this method.
+
+
+
+
+
◆
+
+
+
+
+
+ std::size_t xlnt::workbook::sheet_count
+ (
+ )
+ const
+
+
+
+
+
Returns the number of sheets in this workbook.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::workbook::sheet_hidden_by_index
+ (
+ std::size_t
+ index )
+ const
+
+
+
+
+
Returns the hidden identifier of the worksheet at the given index. This will throw an exception if index is greater than or equal to the number of sheets in this workbook.
+
+
+
+
+
◆
+
+
+
+
+
+ std::vector<std::string> xlnt::workbook::sheet_titles
+ (
+ )
+ const
+
+
+
+
+
Returns a temporary vector containing the titles of each sheet in the order of the sheets in the workbook.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ class style xlnt::workbook::style
+ (
+ const std::string &
+ name )
+
+
+
+
+
Returns the named style with the given name.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ const class style xlnt::workbook::style
+ (
+ const std::string &
+ name )
+ const
+
+
+
+
+
Returns the named style with the given name.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ const xlnt::theme & xlnt::workbook::theme
+ (
+ )
+ const
+
+
+
+
+
Returns a const reference to this workbook's theme.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::workbook::theme
+ (
+ const class theme &
+ value )
+
+
+
+
+
Sets the theme to value.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ void xlnt::workbook::thumbnail
+ (
+ const std::vector< std::uint8_t > &
+ thumbnail ,
+
+ const std::string &
+ extension ,
+
+ const std::string &
+ content_type
+
+ )
+
+
+
+
+
Sets the workbook's thumbnail to the given vector of bytes, thumbnail, with the given extension (e.g. jpg) and content_type (e.g. image/jpeg).
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ const std::vector<std::uint8_t>& xlnt::workbook::thumbnail
+ (
+ )
+ const
+
+
+
+
+
Returns a vector of bytes representing the workbook's thumbnail.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ std::string xlnt::workbook::title
+ (
+ )
+ const
+
+
+
+
+
Returns the title of this workbook.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::workbook::title
+ (
+ const std::string &
+ title )
+
+
+
+
+
Sets the title of this workbook to title.
+
+
+
+
+
◆ [1/2]
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::workbook::view
+ (
+ const workbook_view &
+ view )
+
+
+
+
+
Sets the view to view.
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::workbook_view , including all inherited members.
+
xlnt: xlnt::workbook_view Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
A workbook can be opened in multiple windows with different views. This class represents a particular view used by one window.
+ More...
+
+
#include <workbook_view.hpp >
+
+
+
A workbook can be opened in multiple windows with different views. This class represents a particular view used by one window.
+
+
+
◆
+
+
+
+
+
+ optional <std::size_t> xlnt::workbook_view::active_tab
+
+
+
+
The optional index to the active sheet in this view.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::workbook_view::auto_filter_date_grouping = true
+
+
+
+
+
If true, dates will be grouped when presenting the user with filtering options.
+
+
+
+
+
◆
+
+
+
+
+
+ optional <std::size_t> xlnt::workbook_view::first_sheet
+
+
+
+
The optional index to the first sheet in this view.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::workbook_view::minimized = false
+
+
+
+
+
If true, the view will be minimized.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::workbook_view::show_horizontal_scroll = true
+
+
+
+
+
If true, the horizontal scroll bar will be displayed.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::workbook_view::show_sheet_tabs = true
+
+
+
+
+
If true, the sheet tabs will be displayed.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::workbook_view::show_vertical_scroll = true
+
+
+
+
+
If true, the vertical scroll bar will be displayed.
+
+
+
+
+
◆
+
+
+
+
+
+ optional <std::size_t> xlnt::workbook_view::tab_ratio
+
+
+
+
The optional ratio between the tabs bar and the horizontal scroll bar.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::workbook_view::visible = true
+
+
+
+
+
If true, the workbook window will be visible.
+
+
+
+
+
◆
+
+
+
+
+
+ optional <std::size_t> xlnt::workbook_view::window_height
+
+
+
+
The height of the workbook window in twips.
+
+
+
+
+
◆
+
+
+
+
+
+ optional <std::size_t> xlnt::workbook_view::window_width
+
+
+
+
The width of the workbook window in twips.
+
+
+
+
+
◆
+
+
+
+
+
+ optional <int> xlnt::workbook_view::x_window
+
+
+
+
The distance of the workbook window from the left side of the screen in twips.
+
+
+
+
+
◆
+
+
+
+
+
+ optional <int> xlnt::workbook_view::y_window
+
+
+
+
The distance of the workbook window from the top of the screen in twips.
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::worksheet , including all inherited members.
+
+ active_cell (const cell_reference &ref)xlnt::worksheet active_cell () constxlnt::worksheet add_column_properties (column_t column, const class column_properties &props)xlnt::worksheet add_row_properties (row_t row, const class row_properties &props)xlnt::worksheet add_view (const sheet_view &new_view)xlnt::worksheet auto_filter () constxlnt::worksheet auto_filter (const std::string &range_string)xlnt::worksheet auto_filter (const xlnt::range &range)xlnt::worksheet auto_filter (const range_reference &reference)xlnt::worksheet begin ()xlnt::worksheet begin () constxlnt::worksheet calculate_dimension (bool skip_null=true, bool skip_row_props=false) constxlnt::worksheet cbegin () constxlnt::worksheet cell (defined in xlnt::worksheet )xlnt::worksheet friend cell (const cell_reference &reference)xlnt::worksheet cell (const cell_reference &reference) constxlnt::worksheet cell (column_t column, row_t row)xlnt::worksheet cell (column_t column, row_t row) constxlnt::worksheet cend () constxlnt::worksheet clear_auto_filter ()xlnt::worksheet clear_cell (const cell_reference &ref)xlnt::worksheet clear_page_breaks ()xlnt::worksheet clear_print_area ()xlnt::worksheet clear_print_titles ()xlnt::worksheet clear_row (row_t row)xlnt::worksheet column_properties (column_t column)xlnt::worksheet column_properties (column_t column) constxlnt::worksheet column_width (column_t column) constxlnt::worksheet columns (bool skip_null=true)xlnt::worksheet columns (bool skip_null=true) constxlnt::worksheet compare (const worksheet &other, bool reference) constxlnt::worksheet conditional_format (const range_reference &ref, const condition &when)xlnt::worksheet const_iterator typedefxlnt::worksheet const_range_iterator (defined in xlnt::worksheet )xlnt::worksheet friend const_reverse_iterator typedefxlnt::worksheet create_named_range (const std::string &name, const std::string &reference_string)xlnt::worksheet create_named_range (const std::string &name, const range_reference &reference)xlnt::worksheet delete_columns (column_t column, std::uint32_t amount)xlnt::worksheet delete_rows (row_t row, std::uint32_t amount)xlnt::worksheet detail::xlsx_consumer (defined in xlnt::worksheet )xlnt::worksheet friend detail::xlsx_producer (defined in xlnt::worksheet )xlnt::worksheet friend end ()xlnt::worksheet end () constxlnt::worksheet format_properties () constxlnt::worksheet format_properties (const sheet_format_properties &properties)xlnt::worksheet freeze_panes (cell top_left_cell)xlnt::worksheet freeze_panes (const cell_reference &top_left_coordinate)xlnt::worksheet frozen_panes () constxlnt::worksheet garbage_collect ()xlnt::worksheet has_active_cell () constxlnt::worksheet has_auto_filter () constxlnt::worksheet has_cell (const cell_reference &reference) constxlnt::worksheet has_column_properties (column_t column) constxlnt::worksheet has_drawing () constxlnt::worksheet has_frozen_panes () constxlnt::worksheet has_header_footer () constxlnt::worksheet has_named_range (const std::string &name) constxlnt::worksheet has_page_margins () constxlnt::worksheet has_page_setup () constxlnt::worksheet has_phonetic_properties () constxlnt::worksheet has_print_area () constxlnt::worksheet has_print_titles () constxlnt::worksheet has_row_properties (row_t row) constxlnt::worksheet has_view () constxlnt::worksheet header_footer () constxlnt::worksheet header_footer (const class header_footer &new_header_footer)xlnt::worksheet highest_column () constxlnt::worksheet highest_column_or_props () constxlnt::worksheet highest_row () constxlnt::worksheet highest_row_or_props () constxlnt::worksheet id () constxlnt::worksheet id (std::size_t id)xlnt::worksheet insert_columns (column_t column, std::uint32_t amount)xlnt::worksheet insert_rows (row_t row, std::uint32_t amount)xlnt::worksheet is_empty () constxlnt::worksheet iterator typedefxlnt::worksheet lowest_column () constxlnt::worksheet lowest_column_or_props () constxlnt::worksheet lowest_row () constxlnt::worksheet lowest_row_or_props () constxlnt::worksheet merge_cells (const std::string &reference_string)xlnt::worksheet merge_cells (const range_reference &reference)xlnt::worksheet merged_ranges () constxlnt::worksheet named_range (const std::string &name)xlnt::worksheet named_range (const std::string &name) constxlnt::worksheet next_row () constxlnt::worksheet operator!= (const worksheet &other) constxlnt::worksheet operator!= (std::nullptr_t) constxlnt::worksheet operator= (const worksheet &other)xlnt::worksheet operator== (const worksheet &other) constxlnt::worksheet operator== (std::nullptr_t) constxlnt::worksheet operator[] (const cell_reference &reference)xlnt::worksheet operator[] (const cell_reference &reference) constxlnt::worksheet page_break_at_column (column_t column)xlnt::worksheet page_break_at_row (row_t row)xlnt::worksheet page_break_columns () constxlnt::worksheet page_break_rows () constxlnt::worksheet page_margins () constxlnt::worksheet page_margins (const class page_margins &margins)xlnt::worksheet page_setup () constxlnt::worksheet page_setup (const struct page_setup &setup)xlnt::worksheet path () constxlnt::worksheet phonetic_properties () constxlnt::worksheet phonetic_properties (const phonetic_pr &phonetic_props)xlnt::worksheet point_pos (int left, int top) constxlnt::worksheet print_area (const std::string &print_area)xlnt::worksheet print_area () constxlnt::worksheet print_title_cols (column_t start, column_t end)xlnt::worksheet print_title_cols () constxlnt::worksheet print_title_rows (row_t start, row_t end)xlnt::worksheet print_title_rows () constxlnt::worksheet range (const std::string &reference_string)xlnt::worksheet range (const std::string &reference_string) constxlnt::worksheet range (const range_reference &reference)xlnt::worksheet range (const range_reference &reference) constxlnt::worksheet range_iterator (defined in xlnt::worksheet )xlnt::worksheet friend referring_relationship () constxlnt::worksheet remove_named_range (const std::string &name)xlnt::worksheet reserve (std::size_t n)xlnt::worksheet reverse_iterator typedefxlnt::worksheet row_height (row_t row) constxlnt::worksheet row_properties (row_t row)xlnt::worksheet row_properties (row_t row) constxlnt::worksheet rows (bool skip_null=true)xlnt::worksheet rows (bool skip_null=true) constxlnt::worksheet sheet_state () constxlnt::worksheet sheet_state (xlnt::sheet_state state)xlnt::worksheet title () constxlnt::worksheet title (const std::string &title)xlnt::worksheet unfreeze_panes ()xlnt::worksheet unmerge_cells (const std::string &reference_string)xlnt::worksheet unmerge_cells (const range_reference &reference)xlnt::worksheet view (std::size_t index=0) constxlnt::worksheet workbook (defined in xlnt::worksheet )xlnt::worksheet friend workbook ()xlnt::worksheet workbook () constxlnt::worksheet worksheet ()xlnt::worksheet worksheet (const worksheet &rhs)xlnt::worksheet
xlnt: xlnt::worksheet Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
A worksheet is a 2D array of cells starting with cell A1 in the top-left corner and extending indefinitely down and right as needed.
+ More...
+
+
#include <worksheet.hpp >
+
+ worksheet () Construct a null worksheet. No methods should be called on such a worksheet. More... worksheet (const worksheet &rhs) Copy constructor. This worksheet will point to the same memory as rhs's worksheet. More... class workbook & workbook () Returns a reference to the workbook this worksheet is owned by. More... const class workbook & workbook () const Returns a reference to the workbook this worksheet is owned by. More... void garbage_collect () Deletes data held in the worksheet that does not affect the internal data or display. For example, unreference styles and empty cells will be removed. More... std::size_t id () const Returns the unique numeric identifier of this worksheet. This will sometimes but not necessarily be the index of the worksheet in the workbook. More... void id (std::size_t id) Set the unique numeric identifier. The id defaults to the lowest unused id in the workbook so this should not be called without a good reason. More... std::string title () const Returns the title of this sheet. More... void title (const std::string &title) Sets the title of this sheet. More... cell_reference frozen_panes () const Returns the top left corner of the region above and to the left of which panes are frozen. More... void freeze_panes (cell top_left_cell) Freeze panes above and to the left of top_left_cell. More... void freeze_panes (const cell_reference &top_left_coordinate) Freeze panes above and to the left of top_left_coordinate. More... void unfreeze_panes () Remove frozen panes. The data in those panes will be unaffected–this affects only the view. More... bool has_frozen_panes () const Returns true if this sheet has a frozen row, frozen column, or both. More... bool has_cell (const cell_reference &reference) const Returns true if this sheet has an initialized cell at the given reference. More... class cell cell (const cell_reference &reference) Returns the cell at the given reference. If the cell doesn't exist, it will be initialized to null before being returned. More... const class cell cell (const cell_reference &reference) const Returns the cell at the given reference. If the cell doesn't exist, an invalid_parameter exception will be thrown. More... class cell cell (column_t column, row_t row) Returns the cell at the given column and row. If the cell doesn't exist, it will be initialized to null before being returned. More... const class cell cell (column_t column, row_t row) const Returns the cell at the given column and row. If the cell doesn't exist, an invalid_parameter exception will be thrown. More... class range range (const std::string &reference_string) Returns the range defined by reference string. If reference string is the name of a previously-defined named range in the sheet, it will be returned. More... const class range range (const std::string &reference_string) const Returns the range defined by reference string. If reference string is the name of a previously-defined named range in the sheet, it will be returned. More... class range range (const range_reference &reference) Returns the range defined by reference. More... const class range range (const range_reference &reference) const Returns the range defined by reference. More... class range rows (bool skip_null=true) Returns a range encompassing all cells in this sheet which will be iterated upon in row-major order. If skip_null is true (default), the range does not contain empty rows/columns at its boundaries and empty rows and cells will be skipped during iteration of the range. More... const class range rows (bool skip_null=true) const Returns a range encompassing all cells in this sheet which will be iterated upon in row-major order. If skip_null is true (default), the range does not contain empty rows/columns at its boundaries and empty rows and cells will be skipped during iteration of the range. More... class range columns (bool skip_null=true) Returns a range ecompassing all cells in this sheet which will be iterated upon in column-major order. If skip_null is true (default), the range does not contain empty rows/columns at its boundaries and empty columns and cells will be skipped during iteration of the range. More... const class range columns (bool skip_null=true) const Returns a range ecompassing all cells in this sheet which will be iterated upon in column-major order. If skip_null is true (default), the range does not contain empty rows/columns at its boundaries and empty columns and cells will be skipped during iteration of the range. More... void clear_cell (const cell_reference &ref) Clears memory used by the given cell. More... void clear_row (row_t row) Clears memory used by all cells in the given row. More... void insert_rows (row_t row, std::uint32_t amount) Insert empty rows before the given row index More... void insert_columns (column_t column, std::uint32_t amount) Insert empty columns before the given column index More... void delete_rows (row_t row, std::uint32_t amount) Delete rows before the given row index More... void delete_columns (column_t column, std::uint32_t amount) Delete columns before the given column index More... xlnt::column_properties & column_properties (column_t column) Returns the column properties for the given column. More... const xlnt::column_properties & column_properties (column_t column) const Returns the column properties for the given column. More... bool has_column_properties (column_t column) const Returns true if column properties have been set for the given column. More... void add_column_properties (column_t column, const class column_properties &props) Sets column properties for the given column to props. More... double column_width (column_t column) const Calculates the width of the given column. This will be the default column width if a custom width is not set on this column's column_properties . More... xlnt::row_properties & row_properties (row_t row) Returns the row properties for the given row. More... const xlnt::row_properties & row_properties (row_t row) const Returns the row properties for the given row. More... bool has_row_properties (row_t row) const Returns true if row properties have been set for the given row. More... void add_row_properties (row_t row, const class row_properties &props) Sets row properties for the given row to props. More... double row_height (row_t row) const Calculate the height of the given row. This will be the default row height if a custom height is not set on this row's row_properties . More... cell_reference point_pos (int left, int top) const Returns a reference to the cell at the given point coordinates. More... void create_named_range (const std::string &name, const std::string &reference_string) Creates a new named range with the given name encompassing the string representing a range. More... void create_named_range (const std::string &name, const range_reference &reference) Creates a new named range with the given name encompassing the given range reference. More... bool has_named_range (const std::string &name) const Returns true if this worksheet contains a named range with the given name. More... class range named_range (const std::string &name) Returns the named range with the given name. Throws key_not_found exception if the named range doesn't exist. More... const class range named_range (const std::string &name) const Returns the named range with the given name. Throws key_not_found exception if the named range doesn't exist. More... void remove_named_range (const std::string &name) Removes a named range with the given name. More... row_t lowest_row () const Returns the row of the first non-empty cell in the worksheet. More... row_t lowest_row_or_props () const Returns the row of the first non-empty cell or lowest row with properties in the worksheet. More... row_t highest_row () const Returns the row of the last non-empty cell in the worksheet. More... row_t highest_row_or_props () const Returns the row of the last non-empty cell or highest row with properties in the worksheet. More... row_t next_row () const Returns the row directly below the last non-empty cell in the worksheet. More... column_t lowest_column () const Returns the column of the first non-empty cell in the worksheet. More... column_t lowest_column_or_props () const Returns the column of the first non-empty cell or lowest column with properties in the worksheet. More... column_t highest_column () const Returns the column of the last non-empty cell in the worksheet. More... column_t highest_column_or_props () const Returns the column of the last non-empty cell or highest column with properties in the worksheet. More... range_reference calculate_dimension (bool skip_null=true, bool skip_row_props=false) const Returns a range_reference pointing to the full range of cells in the worksheet. If skip_null is true (default), empty cells (For example if the first row or column is empty) will not be included in upper left bound of range. If skip_row_props is false (default), rows with only properties being defined will be returned too. More... void merge_cells (const std::string &reference_string) Merges the cells within the range represented by the given string. More... void merge_cells (const range_reference &reference) Merges the cells within the given range. More... void unmerge_cells (const std::string &reference_string) Removes the merging of the cells in the range represented by the given string. More... void unmerge_cells (const range_reference &reference) Removes the merging of the cells in the given range. More... std::vector< range_reference > merged_ranges () const Returns a vector of references of all merged ranges in the worksheet. More... bool operator== (const worksheet &other) const Returns true if this worksheet refers to the same worksheet as other. More... bool operator!= (const worksheet &other) const Returns true if this worksheet doesn't refer to the same worksheet as other. More... bool operator== (std::nullptr_t) const Returns true if this worksheet is null. More... bool operator!= (std::nullptr_t) const Returns true if this worksheet is not null. More... void operator= (const worksheet &other) Sets the internal pointer of this worksheet object to point to other. More... class cell operator[] (const cell_reference &reference) Convenience method for worksheet::cell method. More... const class cell operator[] (const cell_reference &reference) const Convenience method for worksheet::cell method. More... bool compare (const worksheet &other, bool reference) const Returns true if this worksheet is equal to other. If reference is true, the comparison will only check that both worksheets point to the same sheet in the same workbook. More... bool has_page_setup () const Returns true if this worksheet has a page setup. More... xlnt::page_setup page_setup () const Returns the page setup for this sheet. More... void page_setup (const struct page_setup &setup) Sets the page setup for this sheet to setup. More... bool has_page_margins () const Returns true if this page has margins. More... xlnt::page_margins page_margins () const Returns the margins of this sheet. More... void page_margins (const class page_margins &margins) Sets the margins of this sheet to margins. More... range_reference auto_filter () const Returns the current auto-filter of this sheet. More... void auto_filter (const std::string &range_string) Sets the auto-filter of this sheet to the range defined by range_string. More... void auto_filter (const xlnt::range &range ) Sets the auto-filter of this sheet to the given range. More... void auto_filter (const range_reference &reference) Sets the auto-filter of this sheet to the range defined by reference. More... void clear_auto_filter () Clear the auto-filter from this sheet. More... bool has_auto_filter () const Returns true if this sheet has an auto-filter set. More... void reserve (std::size_t n) Reserve n rows. This can be optionally called before adding many rows to improve performance. More... bool has_phonetic_properties () const Returns true if this sheet has phonetic properties More... const phonetic_pr & phonetic_properties () const Returns the phonetic properties of this sheet. More... void phonetic_properties (const phonetic_pr &phonetic_props) Sets the phonetic properties of this sheet to phonetic_props More... bool has_header_footer () const Returns true if this sheet has a header/footer. More... class header_footer header_footer () const Returns the header/footer of this sheet. More... void header_footer (const class header_footer &new_header_footer) Sets the header/footer of this sheet to new_header_footer. More... xlnt::sheet_state sheet_state () const Returns the sheet state of this sheet. More... void sheet_state (xlnt::sheet_state state) Sets the sheet state of this sheet. More... iterator begin () Returns an iterator to the first row in this sheet. More... iterator end () Returns an iterator one past the last row in this sheet. More... const_iterator begin () const Return a constant iterator to the first row in this sheet. More... const_iterator end () const Returns a constant iterator to one past the last row in this sheet. More... const_iterator cbegin () const Return a constant iterator to the first row in this sheet. More... const_iterator cend () const Returns a constant iterator to one past the last row in this sheet. More... void print_title_rows (row_t start, row_t end ) Sets rows to repeat at top during printing. More... optional < std::pair< row_t , row_t > > print_title_rows () const Get rows to repeat at top during printing. More... void print_title_cols (column_t start, column_t end ) Sets columns to repeat at left during printing. More... optional < std::pair< column_t , column_t > > print_title_cols () const Get columns to repeat at left during printing. More... bool has_print_titles () const Returns true if the sheet has print titles defined. More... void clear_print_titles () Remove all print titles. More... void print_area (const std::string &print_area) Sets the print area of this sheet to print_area. More... void clear_print_area () Clear the print area of this sheet. More... range_reference print_area () const Returns the print area defined for this sheet. More... bool has_print_area () const Returns true if the print area is defined for this sheet. More... bool has_view () const Returns true if this sheet has any number of views defined. More... sheet_view & view (std::size_t index=0) const Returns the view at the given index. More... void add_view (const sheet_view &new_view) Adds new_view to the set of available views for this sheet. More... void active_cell (const cell_reference &ref) Set the active cell on the default worksheet view to the given reference. More... bool has_active_cell () const Returns true if the worksheet has a view and the view has an active cell. More... cell_reference active_cell () const Returns the active cell on the default worksheet view. More... void clear_page_breaks () Remove all manual column and row page breaks (represented as dashed blue lines in the page view in Excel). More... const std::vector< row_t > & page_break_rows () const Returns vector where each element represents a row which will break a page below it. More... void page_break_at_row (row_t row) Add a page break at the given row. More... const std::vector< column_t > & page_break_columns () const Returns vector where each element represents a column which will break a page to the right. More... void page_break_at_column (column_t column) Add a page break at the given column. More... xlnt::conditional_format conditional_format (const range_reference &ref, const condition &when) Creates a conditional format for the given range with the given condition. More... xlnt::path path () const Returns the path of this worksheet in the containing package. More... relationship referring_relationship () const Returns the relationship from the parent workbook to this worksheet. More... sheet_format_properties format_properties () const Returns the current formatting properties. More... void format_properties (const sheet_format_properties &properties) Sets the format properties to the given properties. More... bool has_drawing () const Returns true if this worksheet has a page setup. More... bool is_empty () const Returns true if this worksheet is empty. A worksheet is considered empty if it doesn't have any cells. More...
+cell const_range_iterator range_iterator workbook detail::xlsx_consumer detail::xlsx_producer
+
+
A worksheet is a 2D array of cells starting with cell A1 in the top-left corner and extending indefinitely down and right as needed.
+
+
+
◆
+
+
+
+
+
Iterate over a non-const worksheet with an iterator of this type.
+
+
+
+
+
◆
+
+
+
+
+
Iterate in reverse order over a const worksheet with an iterator of this type.
+
+
+
+
+
◆
+
+
+
+
+
Iterate over a non-const worksheet with an iterator of this type.
+
+
+
+
+
◆
+
+
+
+
+
Iterate in reverse over a non-const worksheet with an iterator of this type.
+
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ xlnt::worksheet::worksheet
+ (
+ )
+
+
+
+
+
Construct a null worksheet. No methods should be called on such a worksheet.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ xlnt::worksheet::worksheet
+ (
+ const worksheet &
+ rhs )
+
+
+
+
+
Copy constructor. This worksheet will point to the same memory as rhs's worksheet.
+
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ void xlnt::worksheet::active_cell
+ (
+ const cell_reference &
+ ref )
+
+
+
+
+
Set the active cell on the default worksheet view to the given reference.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Returns the active cell on the default worksheet view.
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::worksheet::add_column_properties
+ (
+ column_t column ,
+
+ const class column_properties &
+ props
+
+ )
+
+
+
+
+
Sets column properties for the given column to props.
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::worksheet::add_row_properties
+ (
+ row_t row ,
+
+ const class row_properties &
+ props
+
+ )
+
+
+
+
+
Sets row properties for the given row to props.
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::worksheet::add_view
+ (
+ const sheet_view &
+ new_view )
+
+
+
+
+
Adds new_view to the set of available views for this sheet.
+
+
+
+
+
◆ [1/4]
+
+
+
+
+
Returns the current auto-filter of this sheet.
+
+
+
+
+
◆ [2/4]
+
+
+
+
+
+ void xlnt::worksheet::auto_filter
+ (
+ const std::string &
+ range_string )
+
+
+
+
+
Sets the auto-filter of this sheet to the range defined by range_string.
+
+
+
+
+
◆ [3/4]
+
+
+
+
+
+ void xlnt::worksheet::auto_filter
+ (
+ const xlnt::range &
+ range )
+
+
+
+
+
Sets the auto-filter of this sheet to the given range.
+
+
+
+
+
◆ [4/4]
+
+
+
+
+
+ void xlnt::worksheet::auto_filter
+ (
+ const range_reference &
+ reference )
+
+
+
+
+
Sets the auto-filter of this sheet to the range defined by reference.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ iterator xlnt::worksheet::begin (
+ )
+
+
+
+
+
Returns an iterator to the first row in this sheet.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Return a constant iterator to the first row in this sheet.
+
+
+
+
+
◆
+
+
+
+
+
+ range_reference xlnt::worksheet::calculate_dimension (
+ bool
+ skip_null = true,
+
+ bool
+ skip_row_props = false
+
+ )
+ const
+
+
+
+
+
Returns a range_reference pointing to the full range of cells in the worksheet. If skip_null is true (default), empty cells (For example if the first row or column is empty) will not be included in upper left bound of range. If skip_row_props is false (default), rows with only properties being defined will be returned too.
+
+
+
+
+
◆
+
+
+
+
+
Return a constant iterator to the first row in this sheet.
+
+
+
+
+
◆ [1/4]
+
+
+
+
+
+ const class cell xlnt::worksheet::cell
+ (
+ column_t column ,
+
+ row_t row
+
+ )
+ const
+
+
+
+
+
Returns the cell at the given column and row. If the cell doesn't exist, an invalid_parameter exception will be thrown.
+
+
+
+
+
◆ [2/4]
+
+
+
+
+
+ class cell xlnt::worksheet::cell
+ (
+ column_t column ,
+
+ row_t row
+
+ )
+
+
+
+
+
Returns the cell at the given column and row. If the cell doesn't exist, it will be initialized to null before being returned.
+
+
+
+
+
◆ [3/4]
+
+
+
+
+
Returns the cell at the given reference. If the cell doesn't exist, it will be initialized to null before being returned.
+
+
+
+
+
◆ [4/4]
+
+
+
+
+
+ const class cell xlnt::worksheet::cell
+ (
+ const cell_reference &
+ reference )
+ const
+
+
+
+
+
Returns the cell at the given reference. If the cell doesn't exist, an invalid_parameter exception will be thrown.
+
+
+
+
+
◆
+
+
+
+
+
Returns a constant iterator to one past the last row in this sheet.
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::worksheet::clear_auto_filter
+ (
+ )
+
+
+
+
+
Clear the auto-filter from this sheet.
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::worksheet::clear_cell
+ (
+ const cell_reference &
+ ref )
+
+
+
+
+
Clears memory used by the given cell.
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::worksheet::clear_page_breaks
+ (
+ )
+
+
+
+
+
Remove all manual column and row page breaks (represented as dashed blue lines in the page view in Excel).
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::worksheet::clear_print_area
+ (
+ )
+
+
+
+
+
Clear the print area of this sheet.
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::worksheet::clear_print_titles
+ (
+ )
+
+
+
+
+
Remove all print titles.
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::worksheet::clear_row
+ (
+ row_t row )
+
+
+
+
+
Clears memory used by all cells in the given row.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Returns the column properties for the given column.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Returns the column properties for the given column.
+
+
+
+
+
◆
+
+
+
+
+
+ double xlnt::worksheet::column_width
+ (
+ column_t column )
+ const
+
+
+
+
+
Calculates the width of the given column. This will be the default column width if a custom width is not set on this column's column_properties .
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ const class range xlnt::worksheet::columns
+ (
+ bool
+ skip_null = true)
+ const
+
+
+
+
+
Returns a range ecompassing all cells in this sheet which will be iterated upon in column-major order. If skip_null is true (default), the range does not contain empty rows/columns at its boundaries and empty columns and cells will be skipped during iteration of the range.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ class range xlnt::worksheet::columns
+ (
+ bool
+ skip_null = true)
+
+
+
+
+
Returns a range ecompassing all cells in this sheet which will be iterated upon in column-major order. If skip_null is true (default), the range does not contain empty rows/columns at its boundaries and empty columns and cells will be skipped during iteration of the range.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::worksheet::compare
+ (
+ const worksheet &
+ other ,
+
+ bool
+ reference
+
+ )
+ const
+
+
+
+
+
Returns true if this worksheet is equal to other. If reference is true, the comparison will only check that both worksheets point to the same sheet in the same workbook.
+
+
+
+
+
◆
+
+
+
+
+
Creates a conditional format for the given range with the given condition.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ void xlnt::worksheet::create_named_range
+ (
+ const std::string &
+ name ,
+
+ const std::string &
+ reference_string
+
+ )
+
+
+
+
+
Creates a new named range with the given name encompassing the string representing a range.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::worksheet::create_named_range
+ (
+ const std::string &
+ name ,
+
+ const range_reference &
+ reference
+
+ )
+
+
+
+
+
Creates a new named range with the given name encompassing the given range reference.
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::worksheet::delete_columns
+ (
+ column_t column ,
+
+ std::uint32_t
+ amount
+
+ )
+
+
+
+
+
Delete columns before the given column index
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::worksheet::delete_rows
+ (
+ row_t row ,
+
+ std::uint32_t
+ amount
+
+ )
+
+
+
+
+
Delete rows before the given row index
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ iterator xlnt::worksheet::end (
+ )
+
+
+
+
+
Returns an iterator one past the last row in this sheet.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Returns a constant iterator to one past the last row in this sheet.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Returns the current formatting properties.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Sets the format properties to the given properties.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ void xlnt::worksheet::freeze_panes
+ (
+ cell top_left_cell )
+
+
+
+
+
Freeze panes above and to the left of top_left_cell.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::worksheet::freeze_panes
+ (
+ const cell_reference &
+ top_left_coordinate )
+
+
+
+
+
Freeze panes above and to the left of top_left_coordinate.
+
+
+
+
+
◆
+
+
+
+
+
Returns the top left corner of the region above and to the left of which panes are frozen.
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::worksheet::garbage_collect
+ (
+ )
+
+
+
+
+
Deletes data held in the worksheet that does not affect the internal data or display. For example, unreference styles and empty cells will be removed.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::worksheet::has_active_cell
+ (
+ )
+ const
+
+
+
+
+
Returns true if the worksheet has a view and the view has an active cell.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::worksheet::has_auto_filter
+ (
+ )
+ const
+
+
+
+
+
Returns true if this sheet has an auto-filter set.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::worksheet::has_cell
+ (
+ const cell_reference &
+ reference )
+ const
+
+
+
+
+
Returns true if this sheet has an initialized cell at the given reference.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::worksheet::has_column_properties
+ (
+ column_t column )
+ const
+
+
+
+
+
Returns true if column properties have been set for the given column.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::worksheet::has_drawing
+ (
+ )
+ const
+
+
+
+
+
Returns true if this worksheet has a page setup.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::worksheet::has_frozen_panes
+ (
+ )
+ const
+
+
+
+
+
Returns true if this sheet has a frozen row, frozen column, or both.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::worksheet::has_header_footer
+ (
+ )
+ const
+
+
+
+
+
Returns true if this sheet has a header/footer.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::worksheet::has_named_range
+ (
+ const std::string &
+ name )
+ const
+
+
+
+
+
Returns true if this worksheet contains a named range with the given name.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::worksheet::has_page_margins
+ (
+ )
+ const
+
+
+
+
+
Returns true if this page has margins.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::worksheet::has_page_setup
+ (
+ )
+ const
+
+
+
+
+
Returns true if this worksheet has a page setup.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::worksheet::has_phonetic_properties
+ (
+ )
+ const
+
+
+
+
+
Returns true if this sheet has phonetic properties
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::worksheet::has_print_area
+ (
+ )
+ const
+
+
+
+
+
Returns true if the print area is defined for this sheet.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::worksheet::has_print_titles
+ (
+ )
+ const
+
+
+
+
+
Returns true if the sheet has print titles defined.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::worksheet::has_row_properties
+ (
+ row_t row )
+ const
+
+
+
+
+
Returns true if row properties have been set for the given row.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::worksheet::has_view
+ (
+ )
+ const
+
+
+
+
+
Returns true if this sheet has any number of views defined.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ class header_footer xlnt::worksheet::header_footer
+ (
+ )
+ const
+
+
+
+
+
Returns the header/footer of this sheet.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::worksheet::header_footer
+ (
+ const class header_footer &
+ new_header_footer )
+
+
+
+
+
Sets the header/footer of this sheet to new_header_footer.
+
+
+
+
+
◆
+
+
+
+
+
+ column_t xlnt::worksheet::highest_column (
+ )
+ const
+
+
+
+
+
Returns the column of the last non-empty cell in the worksheet.
+
+
+
+
+
◆
+
+
+
+
+
+ column_t xlnt::worksheet::highest_column_or_props (
+ )
+ const
+
+
+
+
+
Returns the column of the last non-empty cell or highest column with properties in the worksheet.
+
+
+
+
+
◆
+
+
+
+
+
+ row_t xlnt::worksheet::highest_row (
+ )
+ const
+
+
+
+
+
Returns the row of the last non-empty cell in the worksheet.
+
+
+
+
+
◆
+
+
+
+
+
+ row_t xlnt::worksheet::highest_row_or_props (
+ )
+ const
+
+
+
+
+
Returns the row of the last non-empty cell or highest row with properties in the worksheet.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ std::size_t xlnt::worksheet::id
+ (
+ )
+ const
+
+
+
+
+
Returns the unique numeric identifier of this worksheet. This will sometimes but not necessarily be the index of the worksheet in the workbook.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::worksheet::id
+ (
+ std::size_t
+ id )
+
+
+
+
+
Set the unique numeric identifier. The id defaults to the lowest unused id in the workbook so this should not be called without a good reason.
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::worksheet::insert_columns
+ (
+ column_t column ,
+
+ std::uint32_t
+ amount
+
+ )
+
+
+
+
+
Insert empty columns before the given column index
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::worksheet::insert_rows
+ (
+ row_t row ,
+
+ std::uint32_t
+ amount
+
+ )
+
+
+
+
+
Insert empty rows before the given row index
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::worksheet::is_empty
+ (
+ )
+ const
+
+
+
+
+
Returns true if this worksheet is empty. A worksheet is considered empty if it doesn't have any cells.
+
+
+
+
+
◆
+
+
+
+
+
+ column_t xlnt::worksheet::lowest_column (
+ )
+ const
+
+
+
+
+
Returns the column of the first non-empty cell in the worksheet.
+
+
+
+
+
◆
+
+
+
+
+
+ column_t xlnt::worksheet::lowest_column_or_props (
+ )
+ const
+
+
+
+
+
Returns the column of the first non-empty cell or lowest column with properties in the worksheet.
+
+
+
+
+
◆
+
+
+
+
+
+ row_t xlnt::worksheet::lowest_row (
+ )
+ const
+
+
+
+
+
Returns the row of the first non-empty cell in the worksheet.
+
+
+
+
+
◆
+
+
+
+
+
+ row_t xlnt::worksheet::lowest_row_or_props (
+ )
+ const
+
+
+
+
+
Returns the row of the first non-empty cell or lowest row with properties in the worksheet.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ void xlnt::worksheet::merge_cells
+ (
+ const std::string &
+ reference_string )
+
+
+
+
+
Merges the cells within the range represented by the given string.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::worksheet::merge_cells
+ (
+ const range_reference &
+ reference )
+
+
+
+
+
Merges the cells within the given range.
+
+
+
+
+
◆
+
+
+
+
+
+ std::vector<range_reference > xlnt::worksheet::merged_ranges
+ (
+ )
+ const
+
+
+
+
+
Returns a vector of references of all merged ranges in the worksheet.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ class range xlnt::worksheet::named_range
+ (
+ const std::string &
+ name )
+
+
+
+
+
Returns the named range with the given name. Throws key_not_found exception if the named range doesn't exist.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ const class range xlnt::worksheet::named_range
+ (
+ const std::string &
+ name )
+ const
+
+
+
+
+
Returns the named range with the given name. Throws key_not_found exception if the named range doesn't exist.
+
+
+
+
+
◆
+
+
+
+
+
+ row_t xlnt::worksheet::next_row (
+ )
+ const
+
+
+
+
+
Returns the row directly below the last non-empty cell in the worksheet.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ bool xlnt::worksheet::operator!=
+ (
+ const worksheet &
+ other )
+ const
+
+
+
+
+
Returns true if this worksheet doesn't refer to the same worksheet as other.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ bool xlnt::worksheet::operator!=
+ (
+ std::nullptr_t
+ )
+ const
+
+
+
+
+
Returns true if this worksheet is not null.
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::worksheet::operator=
+ (
+ const worksheet &
+ other )
+
+
+
+
+
Sets the internal pointer of this worksheet object to point to other.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ bool xlnt::worksheet::operator==
+ (
+ const worksheet &
+ other )
+ const
+
+
+
+
+
Returns true if this worksheet refers to the same worksheet as other.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ bool xlnt::worksheet::operator==
+ (
+ std::nullptr_t
+ )
+ const
+
+
+
+
+
Returns true if this worksheet is null.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ class cell xlnt::worksheet::operator[]
+ (
+ const cell_reference &
+ reference )
+
+
+
+
+
Convenience method for worksheet::cell method.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ const class cell xlnt::worksheet::operator[]
+ (
+ const cell_reference &
+ reference )
+ const
+
+
+
+
+
Convenience method for worksheet::cell method.
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::worksheet::page_break_at_column
+ (
+ column_t column )
+
+
+
+
+
Add a page break at the given column.
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::worksheet::page_break_at_row
+ (
+ row_t row )
+
+
+
+
+
Add a page break at the given row.
+
+
+
+
+
◆
+
+
+
+
+
+ const std::vector<column_t >& xlnt::worksheet::page_break_columns
+ (
+ )
+ const
+
+
+
+
+
Returns vector where each element represents a column which will break a page to the right.
+
+
+
+
+
◆
+
+
+
+
+
+ const std::vector<row_t >& xlnt::worksheet::page_break_rows
+ (
+ )
+ const
+
+
+
+
+
Returns vector where each element represents a row which will break a page below it.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Returns the margins of this sheet.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::worksheet::page_margins
+ (
+ const class page_margins &
+ margins )
+
+
+
+
+
Sets the margins of this sheet to margins.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Returns the page setup for this sheet.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::worksheet::page_setup
+ (
+ const struct page_setup &
+ setup )
+
+
+
+
+
Sets the page setup for this sheet to setup.
+
+
+
+
+
◆
+
+
+
+
+
+ xlnt::path xlnt::worksheet::path (
+ )
+ const
+
+
+
+
+
Returns the path of this worksheet in the containing package.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ const phonetic_pr & xlnt::worksheet::phonetic_properties
+ (
+ )
+ const
+
+
+
+
+
Returns the phonetic properties of this sheet.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::worksheet::phonetic_properties
+ (
+ const phonetic_pr &
+ phonetic_props )
+
+
+
+
+
Sets the phonetic properties of this sheet to phonetic_props
+
+
+
+
+
◆
+
+
+
+
+
+ cell_reference xlnt::worksheet::point_pos (
+ int
+ left ,
+
+ int
+ top
+
+ )
+ const
+
+
+
+
+
Returns a reference to the cell at the given point coordinates.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ void xlnt::worksheet::print_area
+ (
+ const std::string &
+ print_area )
+
+
+
+
+
Sets the print area of this sheet to print_area.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Returns the print area defined for this sheet.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ void xlnt::worksheet::print_title_cols
+ (
+ column_t start ,
+
+ column_t end
+
+ )
+
+
+
+
+
Sets columns to repeat at left during printing.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Get columns to repeat at left during printing.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ void xlnt::worksheet::print_title_rows
+ (
+ row_t start ,
+
+ row_t end
+
+ )
+
+
+
+
+
Sets rows to repeat at top during printing.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ optional <std::pair<row_t , row_t > > xlnt::worksheet::print_title_rows (
+ )
+ const
+
+
+
+
+
Get rows to repeat at top during printing.
+
+
+
+
+
◆ [1/4]
+
+
+
+
+
Returns the range defined by reference.
+
+
+
+
+
◆ [2/4]
+
+
+
+
+
+ const class range xlnt::worksheet::range
+ (
+ const std::string &
+ reference_string )
+ const
+
+
+
+
+
Returns the range defined by reference string. If reference string is the name of a previously-defined named range in the sheet, it will be returned.
+
+
+
+
+
◆ [3/4]
+
+
+
+
+
+ class range xlnt::worksheet::range
+ (
+ const std::string &
+ reference_string )
+
+
+
+
+
Returns the range defined by reference string. If reference string is the name of a previously-defined named range in the sheet, it will be returned.
+
+
+
+
+
◆ [4/4]
+
+
+
+
+
Returns the range defined by reference.
+
+
+
+
+
◆
+
+
+
+
+
+ relationship xlnt::worksheet::referring_relationship (
+ )
+ const
+
+
+
+
+
Returns the relationship from the parent workbook to this worksheet.
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::worksheet::remove_named_range
+ (
+ const std::string &
+ name )
+
+
+
+
+
Removes a named range with the given name.
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::worksheet::reserve
+ (
+ std::size_t
+ n )
+
+
+
+
+
Reserve n rows. This can be optionally called before adding many rows to improve performance.
+
+
+
+
+
◆
+
+
+
+
+
+ double xlnt::worksheet::row_height
+ (
+ row_t row )
+ const
+
+
+
+
+
Calculate the height of the given row. This will be the default row height if a custom height is not set on this row's row_properties .
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Returns the row properties for the given row.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Returns the row properties for the given row.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ const class range xlnt::worksheet::rows
+ (
+ bool
+ skip_null = true)
+ const
+
+
+
+
+
Returns a range encompassing all cells in this sheet which will be iterated upon in row-major order. If skip_null is true (default), the range does not contain empty rows/columns at its boundaries and empty rows and cells will be skipped during iteration of the range.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ class range xlnt::worksheet::rows
+ (
+ bool
+ skip_null = true)
+
+
+
+
+
Returns a range encompassing all cells in this sheet which will be iterated upon in row-major order. If skip_null is true (default), the range does not contain empty rows/columns at its boundaries and empty rows and cells will be skipped during iteration of the range.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Returns the sheet state of this sheet.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Sets the sheet state of this sheet.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ std::string xlnt::worksheet::title
+ (
+ )
+ const
+
+
+
+
+
Returns the title of this sheet.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::worksheet::title
+ (
+ const std::string &
+ title )
+
+
+
+
+
Sets the title of this sheet.
+
+
+
+
+
◆
+
+
+
+
+
+ void xlnt::worksheet::unfreeze_panes
+ (
+ )
+
+
+
+
+
Remove frozen panes. The data in those panes will be unaffected–this affects only the view.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ void xlnt::worksheet::unmerge_cells
+ (
+ const std::string &
+ reference_string )
+
+
+
+
+
Removes the merging of the cells in the range represented by the given string.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::worksheet::unmerge_cells
+ (
+ const range_reference &
+ reference )
+
+
+
+
+
Removes the merging of the cells in the given range.
+
+
+
+
+
◆
+
+
+
+
+
+ sheet_view & xlnt::worksheet::view (
+ std::size_t
+ index = 0)
+ const
+
+
+
+
+
Returns the view at the given index.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ class workbook & xlnt::worksheet::workbook
+ (
+ )
+
+
+
+
+
Returns a reference to the workbook this worksheet is owned by.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ const class workbook & xlnt::worksheet::workbook
+ (
+ )
+ const
+
+
+
+
+
Returns a reference to the workbook this worksheet is owned by.
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::worksheet_iterator , including all inherited members.
+
xlnt: xlnt::worksheet_iterator Class Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
An iterator which is used to iterate over the worksheets in a workbook.
+ More...
+
+
#include <worksheet_iterator.hpp >
+
+using iterator_category = std::bidirectional_iterator_tag iterator tags required for use with standard algorithms and adapters More... value_type = worksheet difference_type = std::ptrdiff_t pointer = worksheet * reference = worksheet
+
+
An iterator which is used to iterate over the worksheets in a workbook.
+
+
+
◆
+
+
+
+
+
iterator tags required for use with standard algorithms and adapters
+
+
+
+
+
+
◆ [1/4]
+
+
+
+
+
+
+
+
+ xlnt::worksheet_iterator::worksheet_iterator
+ (
+ )
+
+
+
+
+default
+
+
+
+
+
Default Constructs a worksheet iterator
+
+
+
+
+
◆ [2/4]
+
+
+
+
+
+ xlnt::worksheet_iterator::worksheet_iterator
+ (
+ workbook & wb ,
+
+ std::size_t
+ index
+
+ )
+
+
+
+
+
Constructs a worksheet iterator from a workbook and sheet index.
+
+
+
+
+
◆ [3/4]
+
+
+
+
+
+
+
+
+ xlnt::worksheet_iterator::worksheet_iterator
+ (
+ const worksheet_iterator &
+ )
+
+
+
+
+default
+
+
+
+
+
Copy constructs a worksheet iterator from another iterator.
+
+
+
+
+
◆ [4/4]
+
+
+
+
+
Move constructs a worksheet iterator from a temporary iterator.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ xlnt::worksheet_iterator::~worksheet_iterator
+ (
+ )
+
+
+
+
+default
+
+
+
+
+
Default destructor
+
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::worksheet_iterator::operator!=
+ (
+ const worksheet_iterator &
+ comparand )
+ const
+
+
+
+
+
Returns true if this iterator doesn't point to the same worksheet as comparand.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ reference xlnt::worksheet_iterator::operator* (
+ )
+
+
+
+
+
Dereferences the iterator to return the worksheet it is pointing to. If the iterator points to one-past-the-end of the workbook, an invalid_parameter exception will be thrown.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ const reference xlnt::worksheet_iterator::operator*
+ (
+ )
+ const
+
+
+
+
+
Dereferences the iterator to return the worksheet it is pointing to. If the iterator points to one-past-the-end of the workbook, an invalid_parameter exception will be thrown.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Post-increment the iterator's internal workseet index. Returns a copy of the iterator as it was before being incremented.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Pre-increment the iterator's internal workseet index. Returns a refernce to the same iterator.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Post-decrement the iterator's internal workseet index. Returns a copy of the iterator as it was before being incremented.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Pre-decrement the iterator's internal workseet index. Returns a refernce to the same iterator.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Copy assigns the iterator so that it points to the same worksheet in the same workbook.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Move assign the iterator from a temporary iterator
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::worksheet_iterator::operator==
+ (
+ const worksheet_iterator &
+ comparand )
+ const
+
+
+
+
+
Returns true if this iterator points to the same worksheet as comparand.
+
+
+
+
The documentation for this class was generated from the following file:
+
xlnt: xlnt/styles/color.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
30 #include <xlnt/xlnt_config.hpp> 31 #include <xlnt/utils/optional.hpp> 50 std::size_t index()
const ;
55 void index(std::size_t index);
78 std::size_t index()
const ;
83 void index(std::size_t index);
101 rgb_color (
const std::string &hex_string);
107 rgb_color (std::uint8_t r, std::uint8_t g, std::uint8_t b, std::uint8_t a = 255);
112 std::string hex_string()
const ;
117 std::uint8_t red()
const ;
122 std::uint8_t green()
const ;
127 std::uint8_t blue()
const ;
132 std::uint8_t alpha()
const ;
137 std::array<std::uint8_t, 3> rgb()
const ;
142 std::array<std::uint8_t, 4> rgba()
const ;
148 std::array<std::uint8_t, 4> rgba_;
170 static const color black();
175 static const color white();
180 static const color red();
185 static const color darkred();
190 static const color blue();
195 static const color darkblue();
200 static const color green();
205 static const color darkgreen();
210 static const color yellow();
215 static const color darkyellow();
250 void auto_(
bool value);
291 bool has_tint()
const ;
301 void tint(
double tint);
347 bool auto_color =
false ;
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
Colors can be applied to many parts of a cell's style.
Definition: color.hpp:164
+
color_type
Some colors are references to colors rather than having a particular RGB value.
Definition: color.hpp:154
+
bool operator==(std::nullptr_t, const cell &cell)
Returns true if this cell is uninitialized.
+
A theme is a combination of fonts, colors, and effects. This isn't really supported yet...
Definition: theme.hpp:34
+
An indexed color encapsulates a simple index to a color in the indexedColors of the stylesheet...
Definition: color.hpp:38
+
+
A theme color encapsulates a color derived from the theme.
Definition: color.hpp:67
+
An RGB color describes a color in terms of its red, green, blue, and alpha components.
Definition: color.hpp:95
+
bool operator!=(const std::string &reference_string, const range_reference &ref)
Returns true if the string representation of the range is not equivalent to ref.
+
xlnt: xlnt/worksheet/column_properties.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
27 #include <xlnt/xlnt_config.hpp> 46 bool custom_width =
false ;
58 bool best_fit =
false ;
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
optional< double > width
The optional width of the column
Definition: column_properties.hpp:41
+
bool custom_width
If true, this is a custom width
Definition: column_properties.hpp:46
+
bool operator==(std::nullptr_t, const cell &cell)
Returns true if this cell is uninitialized.
+
bool best_fit
Is this column sized to fit its content as best it can serialise if true
Definition: column_properties.hpp:58
+
bool hidden
If true, this column will be hidden
Definition: column_properties.hpp:63
+
+
optional< std::size_t > style
The style index of this column. This shouldn't be used since style indices aren't supposed to be used...
Definition: column_properties.hpp:52
+
Properties applied to a column in a worksheet. Columns can have a size and a style.
Definition: column_properties.hpp:35
+
xlnt: xlnt/cell/comment.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
28 #include <xlnt/xlnt_config.hpp> 29 #include <xlnt/cell/rich_text.hpp> 52 comment (
const std::string &text,
const std::string &author);
62 std::string plain_text()
const ;
67 std::string author()
const ;
87 void position(
int left,
int top);
102 void size(
int width,
int height);
138 bool visible_ =
false ;
+
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
bool operator==(std::nullptr_t, const cell &cell)
Returns true if this cell is uninitialized.
+
Encapsulates zero or more formatted text runs where a text run is a string of text with the same defi...
Definition: rich_text.hpp:40
+
bool operator!=(const std::string &reference_string, const range_reference &ref)
Returns true if the string representation of the range is not equivalent to ref.
+
xlnt: xlnt/styles/conditional_format.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
30 #include <xlnt/xlnt_config.hpp> 31 #include <xlnt/utils/optional.hpp> 41 struct conditional_format_impl;
51 static condition text_starts_with(
const std::string &start);
52 static condition text_ends_with(
const std::string &end);
53 static condition text_contains(
const std::string &start);
54 static condition text_does_not_contain(
const std::string &start);
58 return text_comparand_ == rhs.text_comparand_;
62 friend class detail::xlsx_producer;
69 enum class condition_operator
77 std::string text_comparand_;
103 bool has_border()
const ;
108 class border border() const;
118 bool has_fill()
const ;
123 class fill fill() const;
133 bool has_font()
const ;
138 class font font() const;
156 friend struct detail::stylesheet;
157 friend class detail::xlsx_consumer;
167 detail::conditional_format_impl *d_;
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
+
Describes the font style of a particular cell.
Definition: font.hpp:40
+
Definition: conditional_format.hpp:48
+
Describes the fill style of a particular cell.
Definition: fill.hpp:298
+
Describes the border style of a particular cell.
Definition: border.hpp:93
+
bool operator==(std::nullptr_t, const cell &cell)
Returns true if this cell is uninitialized.
+
bool operator!=(const std::string &reference_string, const range_reference &ref)
Returns true if the string representation of the range is not equivalent to ref.
+
xlnt: xlnt/utils/date.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
28 #include <xlnt/xlnt_config.hpp> 29 #include <xlnt/utils/calendar.hpp> 49 static date from_number(
int days_since_base_year,
calendar base_date);
54 date (
int year_,
int month_,
int day_);
59 int to_number(
calendar base_date)
const ;
int year
The year
Definition: date.hpp:80
+
int day
The day
Definition: date.hpp:90
+
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
bool operator==(std::nullptr_t, const cell &cell)
Returns true if this cell is uninitialized.
+
value is an ISO 8601 formatted date
+
int month
The month
Definition: date.hpp:85
+
bool operator!=(const std::string &reference_string, const range_reference &ref)
Returns true if the string representation of the range is not equivalent to ref.
+
A date is a specific day specified in terms of a year, month, and day. It can also be initialized as ...
Definition: date.hpp:38
+
calendar
An enumeration of possible base dates. Dates in Excel are stored as days since this base date...
Definition: calendar.hpp:34
+
xlnt: xlnt/utils/datetime.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
28 #include <xlnt/xlnt_config.hpp> 29 #include <xlnt/utils/calendar.hpp> 62 static datetime from_iso_string(
const std::string &iso_string);
72 datetime (
int year_,
int month_,
int day_,
int hour_ = 0,
int minute_ = 0,
int second_ = 0,
int microsecond_ = 0);
77 std::string to_string()
const ;
82 std::string to_iso_string()
const ;
87 double to_number(
calendar base_date)
const ;
int day
The day
Definition: datetime.hpp:113
+
int month
The month
Definition: datetime.hpp:108
+
+
int year
The year
Definition: datetime.hpp:103
+
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
int second
The second
Definition: datetime.hpp:128
+
A time is a specific time of the day specified in terms of an hour, minute, second, and microsecond (0-999999). It can also be initialized as a fraction of a day using time::from_number.
Definition: time.hpp:37
+
bool operator==(std::nullptr_t, const cell &cell)
Returns true if this cell is uninitialized.
+
int microsecond
The microsecond
Definition: datetime.hpp:133
+
value is an ISO 8601 formatted date
+
A datetime is a combination of a date and a time.
Definition: datetime.hpp:39
+
int minute
The minute
Definition: datetime.hpp:123
+
A date is a specific day specified in terms of a year, month, and day. It can also be initialized as ...
Definition: date.hpp:38
+
int hour
The hour
Definition: datetime.hpp:118
+
calendar
An enumeration of possible base dates. Dates in Excel are stored as days since this base date...
Definition: calendar.hpp:34
+
xlnt: xlnt/drawing Directory Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/dir_444bdef59305848c74f247ba2f4975c0.html b/dir_444bdef59305848c74f247ba2f4975c0.html
new file mode 100644
index 00000000..7aa9b8f6
--- /dev/null
+++ b/dir_444bdef59305848c74f247ba2f4975c0.html
@@ -0,0 +1,77 @@
+
+
+
+xlnt: xlnt/styles Directory Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/dir_a2ba14e48bce6e1f15b0e4976a7ae561.html b/dir_a2ba14e48bce6e1f15b0e4976a7ae561.html
new file mode 100644
index 00000000..01b92079
--- /dev/null
+++ b/dir_a2ba14e48bce6e1f15b0e4976a7ae561.html
@@ -0,0 +1,77 @@
+
+
+
+xlnt: xlnt/utils Directory Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/dir_b460c39dddf0b2b77bf994e057921e59.html b/dir_b460c39dddf0b2b77bf994e057921e59.html
new file mode 100644
index 00000000..8b4b263b
--- /dev/null
+++ b/dir_b460c39dddf0b2b77bf994e057921e59.html
@@ -0,0 +1,77 @@
+
+
+
+xlnt: xlnt/worksheet Directory Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/dir_dc9b64237c59c74217dbe45730c2787a.html b/dir_dc9b64237c59c74217dbe45730c2787a.html
new file mode 100644
index 00000000..6bddce37
--- /dev/null
+++ b/dir_dc9b64237c59c74217dbe45730c2787a.html
@@ -0,0 +1,77 @@
+
+
+
+xlnt: xlnt/packaging Directory Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/dir_ed22e2414a27c8e61ce5d3669ca24332.html b/dir_ed22e2414a27c8e61ce5d3669ca24332.html
new file mode 100644
index 00000000..2d191c18
--- /dev/null
+++ b/dir_ed22e2414a27c8e61ce5d3669ca24332.html
@@ -0,0 +1,81 @@
+
+
+
+xlnt: xlnt Directory Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
xlnt: xlnt/cell Directory Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/dir_f95b7898fc6564c70c096586ad2b3d19.html b/dir_f95b7898fc6564c70c096586ad2b3d19.html
new file mode 100644
index 00000000..b792ea9f
--- /dev/null
+++ b/dir_f95b7898fc6564c70c096586ad2b3d19.html
@@ -0,0 +1,77 @@
+
+
+
+xlnt: xlnt/workbook Directory Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/doc.png b/doc.png
new file mode 100644
index 00000000..17edabff
Binary files /dev/null and b/doc.png differ
diff --git a/document__security_8hpp_source.html b/document__security_8hpp_source.html
new file mode 100644
index 00000000..f497723e
--- /dev/null
+++ b/document__security_8hpp_source.html
@@ -0,0 +1,86 @@
+
+
+
+xlnt: xlnt/workbook/document_security.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
29 #include <xlnt/xlnt_config.hpp> 75 bool lock_revision =
false ;
80 bool lock_structure =
false ;
86 bool lock_windows =
false ;
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
std::string hash_algorithm
The algorithm used to create and verify this lock.
Definition: document_security.hpp:48
+
lock_verifier workbook_lock
The settings to allow the structure and windows lock to be removed.
Definition: document_security.hpp:96
+
std::size_t spin_count
The number of times the hash should be applied to the password combined with the salt. This allows the difficulty of the hash to be increased as computing power increases.
Definition: document_security.hpp:64
+
lock_verifier revision_lock
The settings to allow the revision lock to be removed.
Definition: document_security.hpp:91
+
Properties governing how the data in a workbook should be protected. These values can be ignored by c...
Definition: document_security.hpp:37
+
std::string salt
The initial salt combined with the password used to prevent rainbow table attacks ...
Definition: document_security.hpp:53
+
Holds data describing the verifier that locks revisions or a workbook.
Definition: document_security.hpp:43
+
std::string hash
The actual hash value represented as a string
Definition: document_security.hpp:58
+
+
+
+xlnt: xlnt/utils/exceptions.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
30 #include <xlnt/xlnt_config.hpp> 31 #include <xlnt/cell/index_types.hpp> 38 class XLNT_API
exception :
public std::runtime_error
45 explicit exception (
const std::string &message);
61 void message(
const std::string &message);
66 std::string message();
Exception for any data type inconsistencies.
Definition: exceptions.hpp:168
+
Exception for a workbook with no visible worksheets
Definition: exceptions.hpp:283
+
Exception for attempting to use a feature which is not supported
Definition: exceptions.hpp:327
+
std::uint32_t row_t
All rows should be referred to by an instance of this type.
Definition: index_types.hpp:40
+
The data submitted which cannot be used directly in Excel files. It must be removed or escaped...
Definition: exceptions.hpp:146
+
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
Exception for a bad parameter value
Definition: exceptions.hpp:78
+
Exception when setting a class's attribute to an invalid value
Definition: exceptions.hpp:239
+
Exception for bad sheet names.
Definition: exceptions.hpp:100
+
Exception for a key that doesn't exist in a container
Definition: exceptions.hpp:261
+
Exception for bad column indices in A1-style cell references.
Definition: exceptions.hpp:190
+
Parent type of all custom exceptions thrown in this library.
Definition: exceptions.hpp:38
+
Exception for trying to open a non-XLSX file.
Definition: exceptions.hpp:122
+
Columns can be referred to as a string A,B,...Z,AA,AB,..,ZZ,AAA,...,ZZZ or as a 1-indexed index...
Definition: index_types.hpp:47
+
Debug exception for a switch that fell through to the default case
Definition: exceptions.hpp:305
+
Exception for converting between numeric and A1-style cell references.
Definition: exceptions.hpp:212
+
xlnt: xlnt/packaging/ext_list.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
26 #include <xlnt/xlnt_config.hpp> 27 #include <xlnt/packaging/uri.hpp> 49 ext (xml::parser &parser,
const std::string &ns);
50 ext (
const uri &ID,
const std::string &serialised);
51 void serialise(xml::serializer &serialiser,
const std::string &ns);
54 std::string serialised_value_;
57 explicit ext_list (xml::parser &parser,
const std::string &ns);
58 void serialize(xml::serializer &serialiser,
const std::string &ns);
60 void add_extension(
const uri &ID,
const std::string &element);
62 bool has_extension(
const uri &extension_uri)
const ;
64 const ext &extension(
const uri &extension_uri)
const ;
66 const std::vector<ext> &extensions()
const ;
71 std::vector<ext> extensions_;
76 return lhs.extension_ID_ == rhs.extension_ID_
77 && lhs.serialised_value_ == rhs.serialised_value_;
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
Encapsulates a uniform resource identifier (URI) as described by RFC 3986.
Definition: uri.hpp:37
+
bool operator==(std::nullptr_t, const cell &cell)
Returns true if this cell is uninitialized.
+
Definition: spreadsheet_drawing.hpp:30
+
Definition: ext_list.hpp:47
+
A list of xml extensions that may or may not be understood by the parser preservation is required for...
Definition: ext_list.hpp:44
+
xlnt: xlnt/workbook/external_book.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
27 #include <xlnt/xlnt_config.hpp> Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
A reference to an external workbook for use in formulae.
Definition: external_book.hpp:34
+
xlnt: File List
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all documented files with brief descriptions:
+
[detail level 1 2 3 ]
+ ▼ xlnt ▼ cell cell.hpp cell_reference.hpp cell_type.hpp comment.hpp hyperlink.hpp index_types.hpp phonetic_run.hpp rich_text.hpp rich_text_run.hpp ▼ drawing spreadsheet_drawing.hpp ▼ packaging ext_list.hpp manifest.hpp relationship.hpp uri.hpp ▼ styles alignment.hpp border.hpp color.hpp conditional_format.hpp fill.hpp font.hpp format.hpp number_format.hpp protection.hpp style.hpp ▼ utils calendar.hpp date.hpp datetime.hpp exceptions.hpp numeric.hpp optional.hpp path.hpp scoped_enum_hash.hpp time.hpp timedelta.hpp variant.hpp ▼ workbook calculation_properties.hpp document_security.hpp external_book.hpp metadata_property.hpp named_range.hpp streaming_workbook_reader.hpp streaming_workbook_writer.hpp theme.hpp workbook.hpp workbook_view.hpp worksheet_iterator.hpp ▼ worksheet cell_iterator.hpp cell_vector.hpp column_properties.hpp header_footer.hpp major_order.hpp page_margins.hpp page_setup.hpp pane.hpp phonetic_pr.hpp print_options.hpp range.hpp range_iterator.hpp range_reference.hpp row_properties.hpp selection.hpp sheet_format_properties.hpp sheet_pr.hpp sheet_protection.hpp sheet_view.hpp worksheet.hpp xlnt.hpp xlnt_config.hpp
+
+
xlnt: xlnt/styles/fill.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
27 #include <unordered_map> 29 #include <xlnt/xlnt_config.hpp> 30 #include <xlnt/styles/color.hpp> 31 #include <xlnt/utils/optional.hpp> 172 double degree()
const ;
191 double right()
const ;
215 double bottom()
const ;
237 std::unordered_map<double, color> stops()
const ;
283 std::unordered_map<double, color> stops_;
307 static fill solid(
const color &fill_color);
pattern_fill_type
The pattern of pixels upon which the corresponding pattern fill will be displayed ...
Definition: fill.hpp:38
+
Encapsulates a fill which transitions between colors at particular "stops".
Definition: fill.hpp:142
+
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
Colors can be applied to many parts of a cell's style.
Definition: color.hpp:164
+
Describes the fill style of a particular cell.
Definition: fill.hpp:298
+
bool operator==(std::nullptr_t, const cell &cell)
Returns true if this cell is uninitialized.
+
Represents a fill which colors the cell based on a foreground and background color and a pattern...
Definition: fill.hpp:65
+
Encapsulates a path that points to location in a filesystem.
Definition: path.hpp:37
+
fill_type
Enumerates the possible fill types
Definition: fill.hpp:289
+
Many settings in xlnt are allowed to not have a value set. This class encapsulates a value which may ...
Definition: format.hpp:43
+
gradient_fill_type
Enumerates the types of gradient fills
Definition: fill.hpp:133
+
bool operator!=(const std::string &reference_string, const range_reference &ref)
Returns true if the string representation of the range is not equivalent to ref.
+
xlnt: xlnt/styles/font.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
29 #include <xlnt/xlnt_config.hpp> 30 #include <xlnt/styles/color.hpp> 31 #include <xlnt/utils/optional.hpp> 63 font &bold(
bool bold);
73 font &subscript(
bool value);
78 bool subscript()
const ;
83 font &superscript(
bool value);
88 bool superscript()
const ;
93 font &italic(
bool italic);
103 font &strikethrough(
bool strikethrough);
108 bool strikethrough()
const ;
113 font &outline(
bool outline);
118 bool outline()
const ;
123 font &shadow(
bool shadow);
138 bool underlined()
const ;
148 bool has_size()
const ;
153 font &size(
double size);
163 bool has_name()
const ;
168 font &name(
const std::string &name);
173 const std::string &name()
const ;
178 bool has_color()
const ;
193 bool has_family()
const ;
198 font &family(std::size_t family);
203 std::size_t family()
const ;
208 bool has_charset()
const ;
215 font &charset(std::size_t charset);
220 std::size_t charset()
const ;
225 bool has_scheme()
const ;
230 font &scheme(
const std::string &scheme);
235 const std::string &scheme()
const ;
271 bool italic_ =
false ;
276 bool superscript_ =
false ;
281 bool subscript_ =
false ;
286 bool strikethrough_ =
false ;
291 bool outline_ =
false ;
296 bool shadow_ =
false ;
underline_style
Text can be underlined in the enumerated ways
Definition: font.hpp:46
+
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
Describes the font style of a particular cell.
Definition: font.hpp:40
+
Colors can be applied to many parts of a cell's style.
Definition: color.hpp:164
+
bool operator==(std::nullptr_t, const cell &cell)
Returns true if this cell is uninitialized.
+
bool operator!=(const font &other) const
Returns true if left is not exactly equal to right.
Definition: font.hpp:245
+
+
Describes a style which has a name and can be applied to multiple individual formats. In Excel this is a "Cell Style".
Definition: style.hpp:55
+
xlnt: xlnt/styles/format.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
29 #include <xlnt/xlnt_config.hpp> 76 bool alignment_applied()
const ;
81 class border border() const;
93 bool border_applied()
const ;
98 class fill fill() const;
110 bool fill_applied()
const ;
115 class font font() const;
127 bool font_applied()
const ;
144 bool number_format_applied()
const ;
154 bool protection_applied()
const ;
166 bool pivot_button()
const ;
172 void pivot_button(
bool show);
177 bool quote_prefix()
const ;
184 void quote_prefix(
bool quote);
189 bool has_style()
const ;
204 format style(
const class style &new_style);
216 const class style style() const;
219 friend struct detail::stylesheet;
220 friend class detail::xlsx_producer;
221 friend class detail::xlsx_consumer;
227 format (detail::format_impl *d);
232 detail::format_impl *d_;
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
Describes the font style of a particular cell.
Definition: font.hpp:40
+
Describes the fill style of a particular cell.
Definition: fill.hpp:298
+
Describes the border style of a particular cell.
Definition: border.hpp:93
+
Describes a unit of data in a worksheet at a specific coordinate and its associated properties...
Definition: cell.hpp:83
+
+
Many settings in xlnt are allowed to not have a value set. This class encapsulates a value which may ...
Definition: format.hpp:43
+
+
Alignment options that determine how text should be displayed within a cell.
Definition: alignment.hpp:62
+
Describes the protection style of a particular cell.
Definition: protection.hpp:37
+
Describes a style which has a name and can be applied to multiple individual formats. In Excel this is a "Cell Style".
Definition: style.hpp:55
+
xlnt: Class Members
+
+
+
+
+
+
+
+
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+
xlnt: Class Members
+
+
+
+
+
+
+
+
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+
xlnt: Class Members
+
+
+
+
+
+
+
+
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+back()
+: xlnt::cell_vector
+, xlnt::range
+
+background()
+: xlnt::pattern_fill
+
+base_col_width
+: xlnt::sheet_format_properties
+
+base_date()
+: xlnt::cell
+, xlnt::workbook
+
+begin()
+: xlnt::cell_vector
+, xlnt::range
+, xlnt::workbook
+, xlnt::worksheet
+
+begin_worksheet()
+: xlnt::streaming_workbook_reader
+
+best_fit
+: xlnt::column_properties
+
+binaries()
+: xlnt::workbook
+
+black()
+: xlnt::color
+
+blue()
+: xlnt::color
+, xlnt::rgb_color
+
+bold()
+: xlnt::font
+
+border()
+: xlnt::border
+, xlnt::cell
+, xlnt::conditional_format
+, xlnt::format
+, xlnt::range
+, xlnt::style
+
+border_applied()
+: xlnt::format
+, xlnt::style
+
+bottom()
+: xlnt::gradient_fill
+, xlnt::page_margins
+
+bottom_left()
+: xlnt::range_reference
+
+bottom_right()
+: xlnt::range_reference
+
+builtin()
+: xlnt::style
+
+builtin_id()
+: xlnt::style
+
+
+
xlnt: Class Members
+
+
+
+
+
+
+
+
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+calc_id
+: xlnt::calculation_properties
+
+calculate_dimension()
+: xlnt::worksheet
+
+calculation_properties()
+: xlnt::workbook
+
+canonicalize()
+: xlnt::manifest
+
+cbegin()
+: xlnt::cell_vector
+, xlnt::range
+, xlnt::workbook
+, xlnt::worksheet
+
+cell()
+: xlnt::cell
+, xlnt::range
+, xlnt::worksheet
+
+cell_iterator()
+: xlnt::cell_iterator
+
+cell_reference()
+: xlnt::cell_reference
+
+cell_vector()
+: xlnt::cell_vector
+
+cend()
+: xlnt::cell_vector
+, xlnt::range
+, xlnt::workbook
+, xlnt::worksheet
+
+charset()
+: xlnt::font
+
+check_string()
+: xlnt::cell
+
+clear()
+: xlnt::manifest
+, xlnt::optional< T >
+, xlnt::rich_text
+, xlnt::workbook
+
+clear_auto_filter()
+: xlnt::worksheet
+
+clear_cell()
+: xlnt::worksheet
+
+clear_cells()
+: xlnt::range
+
+clear_comment()
+: xlnt::cell
+
+clear_first_page_footer()
+: xlnt::header_footer
+
+clear_first_page_header()
+: xlnt::header_footer
+
+clear_footer()
+: xlnt::header_footer
+
+clear_format()
+: xlnt::cell
+
+clear_formats()
+: xlnt::workbook
+
+clear_formula()
+: xlnt::cell
+
+clear_header()
+: xlnt::header_footer
+
+clear_odd_even_footer()
+: xlnt::header_footer
+
+clear_odd_even_header()
+: xlnt::header_footer
+
+clear_page_breaks()
+: xlnt::worksheet
+
+clear_pane()
+: xlnt::sheet_view
+
+clear_print_area()
+: xlnt::worksheet
+
+clear_print_titles()
+: xlnt::worksheet
+
+clear_row()
+: xlnt::worksheet
+
+clear_selections()
+: xlnt::sheet_view
+
+clear_stops()
+: xlnt::gradient_fill
+
+clear_style()
+: xlnt::cell
+, xlnt::format
+
+clear_styles()
+: xlnt::workbook
+
+clear_value()
+: xlnt::cell
+
+close()
+: xlnt::streaming_workbook_reader
+, xlnt::streaming_workbook_writer
+
+code_name
+: xlnt::sheet_pr
+, xlnt::workbook
+
+color()
+: xlnt::border::border_property
+, xlnt::color
+, xlnt::font
+
+column()
+: xlnt::cell
+, xlnt::cell_reference
+
+column_absolute()
+: xlnt::cell_reference
+
+column_index()
+: xlnt::cell
+, xlnt::cell_reference
+
+column_index_from_string()
+: xlnt::column_t
+
+column_properties()
+: xlnt::worksheet
+
+column_string()
+: xlnt::column_t
+
+column_string_from_index()
+: xlnt::column_t
+
+column_t()
+: xlnt::column_t
+
+column_width()
+: xlnt::worksheet
+
+columns()
+: xlnt::worksheet
+
+comment()
+: xlnt::cell
+, xlnt::comment
+
+compare()
+: xlnt::worksheet
+
+computed_alignment()
+: xlnt::cell
+
+computed_border()
+: xlnt::cell
+
+computed_fill()
+: xlnt::cell
+
+computed_font()
+: xlnt::cell
+
+computed_number_format()
+: xlnt::cell
+
+computed_protection()
+: xlnt::cell
+
+concurrent_calc
+: xlnt::calculation_properties
+
+conditional_format()
+: xlnt::conditional_format
+, xlnt::range
+, xlnt::worksheet
+
+const_cell_iterator()
+: xlnt::const_cell_iterator
+
+const_iterator
+: xlnt::cell_vector
+, xlnt::range
+, xlnt::workbook
+, xlnt::worksheet
+
+const_range_iterator()
+: xlnt::const_range_iterator
+
+const_reverse_iterator
+: xlnt::cell_vector
+, xlnt::range
+, xlnt::workbook
+, xlnt::worksheet
+
+const_worksheet_iterator()
+: xlnt::const_worksheet_iterator
+
+contains()
+: xlnt::range
+, xlnt::range_reference
+, xlnt::workbook
+
+content_type()
+: xlnt::manifest
+
+copy_sheet()
+: xlnt::workbook
+
+core_properties()
+: xlnt::workbook
+
+core_property()
+: xlnt::workbook
+
+crbegin()
+: xlnt::cell_vector
+, xlnt::range
+
+create_builtin_style()
+: xlnt::workbook
+
+create_format()
+: xlnt::workbook
+
+create_named_range()
+: xlnt::workbook
+, xlnt::worksheet
+
+create_sheet()
+: xlnt::workbook
+
+create_sheet_with_rel()
+: xlnt::workbook
+
+create_style()
+: xlnt::workbook
+
+crend()
+: xlnt::cell_vector
+, xlnt::range
+
+custom_builtin()
+: xlnt::style
+
+custom_format
+: xlnt::row_properties
+
+custom_height
+: xlnt::row_properties
+
+custom_properties()
+: xlnt::workbook
+
+custom_property()
+: xlnt::workbook
+
+custom_width
+: xlnt::column_properties
+
+
+
xlnt: Class Members
+
+
+
+
+
+
+
+
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+
xlnt: Class Members
+
+
+
+
+
+
+
+
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+
xlnt: Class Members - Enumerations
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/functions_f.html b/functions_f.html
new file mode 100644
index 00000000..e5c9f84f
--- /dev/null
+++ b/functions_f.html
@@ -0,0 +1,176 @@
+
+
+
+xlnt: Class Members
+
+
+
+
+
+
+
+
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+family()
+: xlnt::font
+
+filename()
+: xlnt::path
+
+fill()
+: xlnt::cell
+, xlnt::conditional_format
+, xlnt::fill
+, xlnt::format
+, xlnt::range
+, xlnt::style
+
+fill_applied()
+: xlnt::format
+, xlnt::style
+
+filter_mode
+: xlnt::sheet_pr
+
+first_page_footer()
+: xlnt::header_footer
+
+first_page_header()
+: xlnt::header_footer
+
+first_sheet
+: xlnt::workbook_view
+
+fit_to_height()
+: xlnt::page_setup
+
+fit_to_page()
+: xlnt::page_setup
+
+fit_to_width()
+: xlnt::page_setup
+
+font()
+: xlnt::cell
+, xlnt::conditional_format
+, xlnt::font
+, xlnt::format
+, xlnt::range
+, xlnt::style
+
+font_applied()
+: xlnt::format
+, xlnt::style
+
+font_id()
+: xlnt::phonetic_pr
+
+font_id_t
+: xlnt::phonetic_pr
+
+footer()
+: xlnt::header_footer
+, xlnt::page_margins
+
+foreground()
+: xlnt::pattern_fill
+
+format()
+: xlnt::cell
+, xlnt::number_format
+, xlnt::workbook
+
+format_properties()
+: xlnt::worksheet
+
+format_string()
+: xlnt::number_format
+
+formula()
+: xlnt::cell
+
+fragment()
+: xlnt::uri
+
+freeze_panes()
+: xlnt::worksheet
+
+from_builtin_id()
+: xlnt::number_format
+
+from_iso_string()
+: xlnt::datetime
+
+from_number()
+: xlnt::date
+, xlnt::datetime
+, xlnt::time
+, xlnt::timedelta
+
+front()
+: xlnt::cell_vector
+, xlnt::range
+
+frozen_panes()
+: xlnt::worksheet
+
+
+
xlnt: Class Members - Functions
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/functions_func_0x7e.html b/functions_func_0x7e.html
new file mode 100644
index 00000000..04410079
--- /dev/null
+++ b/functions_func_0x7e.html
@@ -0,0 +1,139 @@
+
+
+
+xlnt: Class Members - Functions
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/functions_func_b.html b/functions_func_b.html
new file mode 100644
index 00000000..d4f62e33
--- /dev/null
+++ b/functions_func_b.html
@@ -0,0 +1,134 @@
+
+
+
+xlnt: Class Members - Functions
+
+
+
+
+
+
+
+
+
+
+
+
+back()
+: xlnt::cell_vector
+, xlnt::range
+
+background()
+: xlnt::pattern_fill
+
+base_date()
+: xlnt::cell
+, xlnt::workbook
+
+begin()
+: xlnt::cell_vector
+, xlnt::range
+, xlnt::workbook
+, xlnt::worksheet
+
+begin_worksheet()
+: xlnt::streaming_workbook_reader
+
+binaries()
+: xlnt::workbook
+
+black()
+: xlnt::color
+
+blue()
+: xlnt::color
+, xlnt::rgb_color
+
+bold()
+: xlnt::font
+
+border()
+: xlnt::border
+, xlnt::cell
+, xlnt::conditional_format
+, xlnt::format
+, xlnt::range
+, xlnt::style
+
+border_applied()
+: xlnt::format
+, xlnt::style
+
+bottom()
+: xlnt::gradient_fill
+, xlnt::page_margins
+
+bottom_left()
+: xlnt::range_reference
+
+bottom_right()
+: xlnt::range_reference
+
+builtin()
+: xlnt::style
+
+builtin_id()
+: xlnt::style
+
+
+
xlnt: Class Members - Functions
+
+
+
+
+
+
+
+
+
+
+
+
+calculate_dimension()
+: xlnt::worksheet
+
+calculation_properties()
+: xlnt::workbook
+
+canonicalize()
+: xlnt::manifest
+
+cbegin()
+: xlnt::cell_vector
+, xlnt::range
+, xlnt::workbook
+, xlnt::worksheet
+
+cell()
+: xlnt::cell
+, xlnt::range
+, xlnt::worksheet
+
+cell_iterator()
+: xlnt::cell_iterator
+
+cell_reference()
+: xlnt::cell_reference
+
+cell_vector()
+: xlnt::cell_vector
+
+cend()
+: xlnt::cell_vector
+, xlnt::range
+, xlnt::workbook
+, xlnt::worksheet
+
+charset()
+: xlnt::font
+
+check_string()
+: xlnt::cell
+
+clear()
+: xlnt::manifest
+, xlnt::optional< T >
+, xlnt::rich_text
+, xlnt::workbook
+
+clear_auto_filter()
+: xlnt::worksheet
+
+clear_cell()
+: xlnt::worksheet
+
+clear_cells()
+: xlnt::range
+
+clear_comment()
+: xlnt::cell
+
+clear_first_page_footer()
+: xlnt::header_footer
+
+clear_first_page_header()
+: xlnt::header_footer
+
+clear_footer()
+: xlnt::header_footer
+
+clear_format()
+: xlnt::cell
+
+clear_formats()
+: xlnt::workbook
+
+clear_formula()
+: xlnt::cell
+
+clear_header()
+: xlnt::header_footer
+
+clear_odd_even_footer()
+: xlnt::header_footer
+
+clear_odd_even_header()
+: xlnt::header_footer
+
+clear_page_breaks()
+: xlnt::worksheet
+
+clear_pane()
+: xlnt::sheet_view
+
+clear_print_area()
+: xlnt::worksheet
+
+clear_print_titles()
+: xlnt::worksheet
+
+clear_row()
+: xlnt::worksheet
+
+clear_selections()
+: xlnt::sheet_view
+
+clear_stops()
+: xlnt::gradient_fill
+
+clear_style()
+: xlnt::cell
+, xlnt::format
+
+clear_styles()
+: xlnt::workbook
+
+clear_value()
+: xlnt::cell
+
+close()
+: xlnt::streaming_workbook_reader
+, xlnt::streaming_workbook_writer
+
+code_name()
+: xlnt::workbook
+
+color()
+: xlnt::border::border_property
+, xlnt::color
+, xlnt::font
+
+column()
+: xlnt::cell
+, xlnt::cell_reference
+
+column_absolute()
+: xlnt::cell_reference
+
+column_index()
+: xlnt::cell
+, xlnt::cell_reference
+
+column_index_from_string()
+: xlnt::column_t
+
+column_properties()
+: xlnt::worksheet
+
+column_string()
+: xlnt::column_t
+
+column_string_from_index()
+: xlnt::column_t
+
+column_t()
+: xlnt::column_t
+
+column_width()
+: xlnt::worksheet
+
+columns()
+: xlnt::worksheet
+
+comment()
+: xlnt::cell
+, xlnt::comment
+
+compare()
+: xlnt::worksheet
+
+computed_alignment()
+: xlnt::cell
+
+computed_border()
+: xlnt::cell
+
+computed_fill()
+: xlnt::cell
+
+computed_font()
+: xlnt::cell
+
+computed_number_format()
+: xlnt::cell
+
+computed_protection()
+: xlnt::cell
+
+conditional_format()
+: xlnt::conditional_format
+, xlnt::range
+, xlnt::worksheet
+
+const_cell_iterator()
+: xlnt::const_cell_iterator
+
+const_range_iterator()
+: xlnt::const_range_iterator
+
+const_worksheet_iterator()
+: xlnt::const_worksheet_iterator
+
+contains()
+: xlnt::range
+, xlnt::range_reference
+, xlnt::workbook
+
+content_type()
+: xlnt::manifest
+
+copy_sheet()
+: xlnt::workbook
+
+core_properties()
+: xlnt::workbook
+
+core_property()
+: xlnt::workbook
+
+crbegin()
+: xlnt::cell_vector
+, xlnt::range
+
+create_builtin_style()
+: xlnt::workbook
+
+create_format()
+: xlnt::workbook
+
+create_named_range()
+: xlnt::workbook
+, xlnt::worksheet
+
+create_sheet()
+: xlnt::workbook
+
+create_sheet_with_rel()
+: xlnt::workbook
+
+create_style()
+: xlnt::workbook
+
+crend()
+: xlnt::cell_vector
+, xlnt::range
+
+custom_builtin()
+: xlnt::style
+
+custom_properties()
+: xlnt::workbook
+
+custom_property()
+: xlnt::workbook
+
+
+
xlnt: Class Members - Functions
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/functions_func_e.html b/functions_func_e.html
new file mode 100644
index 00000000..9a1aa25c
--- /dev/null
+++ b/functions_func_e.html
@@ -0,0 +1,119 @@
+
+
+
+xlnt: Class Members - Functions
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/functions_func_f.html b/functions_func_f.html
new file mode 100644
index 00000000..0bf7c908
--- /dev/null
+++ b/functions_func_f.html
@@ -0,0 +1,167 @@
+
+
+
+xlnt: Class Members - Functions
+
+
+
+
+
+
+
+
+
+
+
+
+family()
+: xlnt::font
+
+filename()
+: xlnt::path
+
+fill()
+: xlnt::cell
+, xlnt::conditional_format
+, xlnt::fill
+, xlnt::format
+, xlnt::range
+, xlnt::style
+
+fill_applied()
+: xlnt::format
+, xlnt::style
+
+first_page_footer()
+: xlnt::header_footer
+
+first_page_header()
+: xlnt::header_footer
+
+fit_to_height()
+: xlnt::page_setup
+
+fit_to_page()
+: xlnt::page_setup
+
+fit_to_width()
+: xlnt::page_setup
+
+font()
+: xlnt::cell
+, xlnt::conditional_format
+, xlnt::font
+, xlnt::format
+, xlnt::range
+, xlnt::style
+
+font_applied()
+: xlnt::format
+, xlnt::style
+
+font_id()
+: xlnt::phonetic_pr
+
+footer()
+: xlnt::header_footer
+, xlnt::page_margins
+
+foreground()
+: xlnt::pattern_fill
+
+format()
+: xlnt::cell
+, xlnt::number_format
+, xlnt::workbook
+
+format_properties()
+: xlnt::worksheet
+
+format_string()
+: xlnt::number_format
+
+formula()
+: xlnt::cell
+
+fragment()
+: xlnt::uri
+
+freeze_panes()
+: xlnt::worksheet
+
+from_builtin_id()
+: xlnt::number_format
+
+from_iso_string()
+: xlnt::datetime
+
+from_number()
+: xlnt::date
+, xlnt::datetime
+, xlnt::time
+, xlnt::timedelta
+
+front()
+: xlnt::cell_vector
+, xlnt::range
+
+frozen_panes()
+: xlnt::worksheet
+
+
+
xlnt: Class Members - Functions
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/functions_func_h.html b/functions_func_h.html
new file mode 100644
index 00000000..472e655b
--- /dev/null
+++ b/functions_func_h.html
@@ -0,0 +1,316 @@
+
+
+
+xlnt: Class Members - Functions
+
+
+
+
+
+
+
+
+
+
+
+
+has_active_cell()
+: xlnt::selection
+, xlnt::worksheet
+
+has_alignment()
+: xlnt::phonetic_pr
+
+has_authentication()
+: xlnt::uri
+
+has_auto_filter()
+: xlnt::worksheet
+
+has_border()
+: xlnt::conditional_format
+
+has_calculation_properties()
+: xlnt::workbook
+
+has_cell()
+: xlnt::worksheet
+
+has_charset()
+: xlnt::font
+
+has_code_name()
+: xlnt::workbook
+
+has_color()
+: xlnt::font
+
+has_column_properties()
+: xlnt::worksheet
+
+has_comment()
+: xlnt::cell
+
+has_core_property()
+: xlnt::workbook
+
+has_custom_property()
+: xlnt::workbook
+
+has_default_type()
+: xlnt::manifest
+
+has_drawing()
+: xlnt::worksheet
+
+has_extended_property()
+: xlnt::workbook
+
+has_family()
+: xlnt::font
+
+has_file_version()
+: xlnt::workbook
+
+has_fill()
+: xlnt::conditional_format
+
+has_first_page_footer()
+: xlnt::header_footer
+
+has_first_page_header()
+: xlnt::header_footer
+
+has_font()
+: xlnt::conditional_format
+
+has_footer()
+: xlnt::header_footer
+
+has_format()
+: xlnt::cell
+
+has_formula()
+: xlnt::cell
+
+has_fragment()
+: xlnt::uri
+
+has_frozen_panes()
+: xlnt::worksheet
+
+has_header()
+: xlnt::header_footer
+
+has_header_footer()
+: xlnt::worksheet
+
+has_hyperlink()
+: xlnt::cell
+
+has_id()
+: xlnt::number_format
+
+has_name()
+: xlnt::font
+
+has_named_range()
+: xlnt::workbook
+, xlnt::worksheet
+
+has_odd_even_footer()
+: xlnt::header_footer
+
+has_odd_even_header()
+: xlnt::header_footer
+
+has_override_type()
+: xlnt::manifest
+
+has_page_margins()
+: xlnt::worksheet
+
+has_page_setup()
+: xlnt::worksheet
+
+has_pane()
+: xlnt::sheet_view
+
+has_paper_size()
+: xlnt::page_setup
+
+has_phonetic_properties()
+: xlnt::rich_text
+, xlnt::worksheet
+
+has_port()
+: xlnt::uri
+
+has_print_area()
+: xlnt::worksheet
+
+has_print_titles()
+: xlnt::worksheet
+
+has_query()
+: xlnt::uri
+
+has_rel_id()
+: xlnt::page_setup
+
+has_relationship()
+: xlnt::manifest
+
+has_row_properties()
+: xlnt::worksheet
+
+has_scale()
+: xlnt::page_setup
+
+has_scheme()
+: xlnt::font
+
+has_selections()
+: xlnt::sheet_view
+
+has_size()
+: xlnt::font
+
+has_sqref()
+: xlnt::selection
+
+has_style()
+: xlnt::cell
+, xlnt::format
+, xlnt::workbook
+
+has_theme()
+: xlnt::workbook
+
+has_tint()
+: xlnt::color
+
+has_title()
+: xlnt::workbook
+
+has_top_left_cell()
+: xlnt::sheet_view
+
+has_type()
+: xlnt::phonetic_pr
+
+has_value()
+: xlnt::cell
+, xlnt::cell_iterator
+, xlnt::const_cell_iterator
+
+has_view()
+: xlnt::workbook
+, xlnt::worksheet
+
+hash_password()
+: xlnt::sheet_protection
+
+hashed_password()
+: xlnt::sheet_protection
+
+header()
+: xlnt::header_footer
+, xlnt::page_margins
+
+header_footer()
+: xlnt::worksheet
+
+height()
+: xlnt::cell
+, xlnt::comment
+, xlnt::range_reference
+
+hex_string()
+: xlnt::rgb_color
+
+hidden()
+: xlnt::protection
+, xlnt::style
+
+hide()
+: xlnt::comment
+
+highest_column()
+: xlnt::worksheet
+
+highest_column_or_props()
+: xlnt::worksheet
+
+highest_row()
+: xlnt::worksheet
+
+highest_row_or_props()
+: xlnt::worksheet
+
+horizontal()
+: xlnt::alignment
+
+host()
+: xlnt::uri
+
+hyperlink()
+: xlnt::cell
+
+
+
xlnt: Class Members - Functions
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/functions_func_k.html b/functions_func_k.html
new file mode 100644
index 00000000..d68cde27
--- /dev/null
+++ b/functions_func_k.html
@@ -0,0 +1,79 @@
+
+
+
+xlnt: Class Members - Functions
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/functions_func_l.html b/functions_func_l.html
new file mode 100644
index 00000000..58594042
--- /dev/null
+++ b/functions_func_l.html
@@ -0,0 +1,112 @@
+
+
+
+xlnt: Class Members - Functions
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/functions_func_m.html b/functions_func_m.html
new file mode 100644
index 00000000..f6aee063
--- /dev/null
+++ b/functions_func_m.html
@@ -0,0 +1,100 @@
+
+
+
+xlnt: Class Members - Functions
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/functions_func_n.html b/functions_func_n.html
new file mode 100644
index 00000000..a5106a76
--- /dev/null
+++ b/functions_func_n.html
@@ -0,0 +1,116 @@
+
+
+
+xlnt: Class Members - Functions
+
+
+
+
+
+
+
+
+
+
+
+
+name()
+: xlnt::font
+, xlnt::named_range
+, xlnt::style
+
+named_range()
+: xlnt::named_range
+, xlnt::workbook
+, xlnt::worksheet
+
+named_ranges()
+: xlnt::workbook
+
+next_row()
+: xlnt::worksheet
+
+no_visible_worksheets()
+: xlnt::no_visible_worksheets
+
+now()
+: xlnt::datetime
+, xlnt::time
+
+number()
+: xlnt::number_format
+
+number_00()
+: xlnt::number_format
+
+number_comma_separated1()
+: xlnt::number_format
+
+number_format()
+: xlnt::cell
+, xlnt::format
+, xlnt::number_format
+, xlnt::range
+, xlnt::style
+
+number_format_applied()
+: xlnt::format
+, xlnt::style
+
+
+
xlnt: Class Members - Functions
+
+
+
+
+
+
+
+
+
+
+
+
+odd_even_footer()
+: xlnt::header_footer
+
+odd_even_header()
+: xlnt::header_footer
+
+odd_footer()
+: xlnt::header_footer
+
+odd_header()
+: xlnt::header_footer
+
+offset()
+: xlnt::cell
+
+open()
+: xlnt::streaming_workbook_reader
+, xlnt::streaming_workbook_writer
+
+operator!=()
+: xlnt::alignment
+, xlnt::border::border_property
+, xlnt::border
+, xlnt::cell
+, xlnt::cell_iterator
+, xlnt::cell_reference
+, xlnt::color
+, xlnt::column_t
+, xlnt::comment
+, xlnt::conditional_format
+, xlnt::const_cell_iterator
+, xlnt::const_range_iterator
+, xlnt::const_worksheet_iterator
+, xlnt::date
+, xlnt::fill
+, xlnt::font
+, xlnt::gradient_fill
+, xlnt::number_format
+, xlnt::optional< T >
+, xlnt::path
+, xlnt::pattern_fill
+, xlnt::protection
+, xlnt::range
+, xlnt::range_iterator
+, xlnt::range_reference
+, xlnt::relationship
+, xlnt::rich_text
+, xlnt::style
+, xlnt::workbook
+, xlnt::worksheet
+, xlnt::worksheet_iterator
+
+operator()()
+: std::hash< xlnt::column_t >
+, std::hash< xlnt::path >
+, xlnt::cell_reference_hash
+, xlnt::column_hash
+, xlnt::scoped_enum_hash< Enum >
+
+operator*()
+: xlnt::cell_iterator
+, xlnt::const_cell_iterator
+, xlnt::const_range_iterator
+, xlnt::const_worksheet_iterator
+, xlnt::range_iterator
+, xlnt::worksheet_iterator
+
+operator++()
+: xlnt::cell_iterator
+, xlnt::column_t
+, xlnt::const_cell_iterator
+, xlnt::const_range_iterator
+, xlnt::const_worksheet_iterator
+, xlnt::range_iterator
+, xlnt::worksheet_iterator
+
+operator+=()
+: xlnt::column_t
+
+operator,()
+: xlnt::cell_reference
+
+operator--()
+: xlnt::cell_iterator
+, xlnt::column_t
+, xlnt::const_cell_iterator
+, xlnt::const_range_iterator
+, xlnt::const_worksheet_iterator
+, xlnt::range_iterator
+, xlnt::worksheet_iterator
+
+operator-=()
+: xlnt::column_t
+
+operator<()
+: xlnt::column_t
+
+operator<=()
+: xlnt::column_t
+
+operator=()
+: xlnt::cell
+, xlnt::cell_iterator
+, xlnt::column_t
+, xlnt::const_cell_iterator
+, xlnt::const_range_iterator
+, xlnt::const_worksheet_iterator
+, xlnt::named_range
+, xlnt::optional< T >
+, xlnt::range_iterator
+, xlnt::rich_text
+, xlnt::workbook
+, xlnt::worksheet
+, xlnt::worksheet_iterator
+
+operator==()
+: xlnt::alignment
+, xlnt::border::border_property
+, xlnt::border
+, xlnt::cell
+, xlnt::cell_iterator
+, xlnt::cell_reference
+, xlnt::color
+, xlnt::column_t
+, xlnt::comment
+, xlnt::conditional_format
+, xlnt::const_cell_iterator
+, xlnt::const_range_iterator
+, xlnt::const_worksheet_iterator
+, xlnt::date
+, xlnt::datetime
+, xlnt::fill
+, xlnt::font
+, xlnt::gradient_fill
+, xlnt::number_format
+, xlnt::optional< T >
+, xlnt::pane
+, xlnt::path
+, xlnt::pattern_fill
+, xlnt::protection
+, xlnt::range
+, xlnt::range_iterator
+, xlnt::range_reference
+, xlnt::relationship
+, xlnt::rich_text
+, xlnt::selection
+, xlnt::sheet_view
+, xlnt::style
+, xlnt::time
+, xlnt::uri
+, xlnt::workbook
+, xlnt::worksheet
+, xlnt::worksheet_iterator
+
+operator>()
+: xlnt::column_t
+
+operator>=()
+: xlnt::column_t
+
+operator[]()
+: xlnt::cell_vector
+, xlnt::range
+, xlnt::workbook
+, xlnt::worksheet
+
+optional()
+: xlnt::optional< T >
+
+outline()
+: xlnt::font
+
+override_type()
+: xlnt::manifest
+
+
+
xlnt: Class Members - Functions
+
+
+
+
+
+
+
+
+
+
+
+
+page_break()
+: xlnt::page_setup
+
+page_break_at_column()
+: xlnt::worksheet
+
+page_break_at_row()
+: xlnt::worksheet
+
+page_break_columns()
+: xlnt::worksheet
+
+page_break_rows()
+: xlnt::worksheet
+
+page_margins()
+: xlnt::page_margins
+, xlnt::worksheet
+
+page_setup()
+: xlnt::page_setup
+, xlnt::worksheet
+
+pane()
+: xlnt::selection
+, xlnt::sheet_view
+
+paper_size()
+: xlnt::page_setup
+
+parent()
+: xlnt::path
+
+parts()
+: xlnt::manifest
+
+parts_with_overriden_types()
+: xlnt::manifest
+
+password()
+: xlnt::sheet_protection
+, xlnt::uri
+
+path()
+: xlnt::path
+, xlnt::uri
+, xlnt::worksheet
+
+pattern_fill()
+: xlnt::fill
+, xlnt::pattern_fill
+
+percentage()
+: xlnt::number_format
+
+percentage_00()
+: xlnt::number_format
+
+phonetic_pr()
+: xlnt::phonetic_pr
+
+phonetic_properties()
+: xlnt::rich_text
+, xlnt::worksheet
+
+phonetic_runs()
+: xlnt::rich_text
+
+phonetics_visible()
+: xlnt::cell
+
+pivot_button()
+: xlnt::format
+, xlnt::style
+
+plain_text()
+: xlnt::comment
+, xlnt::rich_text
+
+point_pos()
+: xlnt::worksheet
+
+port()
+: xlnt::uri
+
+position()
+: xlnt::comment
+
+print_area()
+: xlnt::worksheet
+
+print_title_cols()
+: xlnt::worksheet
+
+print_title_rows()
+: xlnt::worksheet
+
+protection()
+: xlnt::cell
+, xlnt::format
+, xlnt::protection
+, xlnt::range
+, xlnt::style
+
+protection_applied()
+: xlnt::format
+, xlnt::style
+
+
+
xlnt: Class Members - Functions
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/functions_func_r.html b/functions_func_r.html
new file mode 100644
index 00000000..12b3a5b2
--- /dev/null
+++ b/functions_func_r.html
@@ -0,0 +1,185 @@
+
+
+
+xlnt: Class Members - Functions
+
+
+
+
+
+
+
+
+
+
+
+
+range()
+: xlnt::range
+, xlnt::worksheet
+
+range_iterator()
+: xlnt::range_iterator
+
+range_reference()
+: xlnt::range_reference
+
+rbegin()
+: xlnt::cell_vector
+, xlnt::range
+
+read_cell()
+: xlnt::streaming_workbook_reader
+
+read_contents()
+: xlnt::path
+
+red()
+: xlnt::color
+, xlnt::rgb_color
+
+reference()
+: xlnt::cell
+, xlnt::range
+
+referring_relationship()
+: xlnt::worksheet
+
+register_default_type()
+: xlnt::manifest
+
+register_override_type()
+: xlnt::manifest
+
+register_relationship()
+: xlnt::manifest
+
+rel_id()
+: xlnt::page_setup
+
+relationship()
+: xlnt::manifest
+, xlnt::relationship
+
+relationships()
+: xlnt::manifest
+
+relative_to()
+: xlnt::path
+
+remove_named_range()
+: xlnt::workbook
+, xlnt::worksheet
+
+remove_sheet()
+: xlnt::workbook
+
+rend()
+: xlnt::cell_vector
+, xlnt::range
+
+reserve()
+: xlnt::worksheet
+
+resolve()
+: xlnt::path
+
+rgb()
+: xlnt::color
+, xlnt::rgb_color
+
+rgb_color()
+: xlnt::rgb_color
+
+rgba()
+: xlnt::rgb_color
+
+rich_text()
+: xlnt::rich_text
+
+right()
+: xlnt::gradient_fill
+, xlnt::page_margins
+
+rotation()
+: xlnt::alignment
+
+row()
+: xlnt::cell
+, xlnt::cell_reference
+
+row_absolute()
+: xlnt::cell_reference
+
+row_height()
+: xlnt::worksheet
+
+row_properties()
+: xlnt::worksheet
+
+rows()
+: xlnt::worksheet
+
+runs()
+: xlnt::rich_text
+
+rup_build()
+: xlnt::workbook
+
+
+
xlnt: Class Members - Functions
+
+
+
+
+
+
+
+
+
+
+
+
+save()
+: xlnt::workbook
+
+scale()
+: xlnt::page_setup
+
+scale_with_doc()
+: xlnt::header_footer
+
+scheme()
+: xlnt::font
+, xlnt::uri
+
+selection()
+: xlnt::selection
+, xlnt::sheet_view
+
+selections()
+: xlnt::sheet_view
+
+serialise()
+: xlnt::phonetic_pr
+
+set()
+: xlnt::optional< T >
+
+shadow()
+: xlnt::font
+
+shared_strings()
+: xlnt::workbook
+
+sheet_by_id()
+: xlnt::workbook
+
+sheet_by_index()
+: xlnt::workbook
+
+sheet_by_title()
+: xlnt::workbook
+
+sheet_count()
+: xlnt::workbook
+
+sheet_hidden_by_index()
+: xlnt::workbook
+
+sheet_state()
+: xlnt::page_setup
+, xlnt::worksheet
+
+sheet_titles()
+: xlnt::streaming_workbook_reader
+, xlnt::workbook
+
+show()
+: xlnt::comment
+
+show_grid_lines()
+: xlnt::sheet_view
+
+show_phonetics()
+: xlnt::cell
+
+shrink()
+: xlnt::alignment
+
+side()
+: xlnt::border
+
+size()
+: xlnt::comment
+, xlnt::font
+
+solid()
+: xlnt::fill
+
+source()
+: xlnt::relationship
+
+split()
+: xlnt::path
+
+split_extension()
+: xlnt::path
+
+split_reference()
+: xlnt::cell_reference
+
+sqref()
+: xlnt::selection
+
+stops()
+: xlnt::gradient_fill
+
+strikethrough()
+: xlnt::font
+
+string()
+: xlnt::path
+
+style()
+: xlnt::border::border_property
+, xlnt::cell
+, xlnt::format
+, xlnt::range
+, xlnt::style
+, xlnt::workbook
+
+subscript()
+: xlnt::font
+
+superscript()
+: xlnt::font
+
+system_separator()
+: xlnt::path
+
+
+
xlnt: Class Members - Functions
+
+
+
+
+
+
+
+
+
+
+
+
+target()
+: xlnt::relationship
+
+target_mode()
+: xlnt::relationship
+
+target_worksheet()
+: xlnt::range
+
+targets()
+: xlnt::named_range
+
+text()
+: xlnt::comment
+, xlnt::number_format
+
+theme()
+: xlnt::color
+, xlnt::workbook
+
+theme_color()
+: xlnt::theme_color
+
+thumbnail()
+: xlnt::workbook
+
+time()
+: xlnt::time
+
+timedelta()
+: xlnt::timedelta
+
+tint()
+: xlnt::color
+
+title()
+: xlnt::workbook
+, xlnt::worksheet
+
+to_iso_string()
+: xlnt::datetime
+
+to_number()
+: xlnt::date
+, xlnt::datetime
+, xlnt::time
+, xlnt::timedelta
+
+to_range()
+: xlnt::cell_reference
+
+to_string()
+: xlnt::cell
+, xlnt::cell_reference
+, xlnt::datetime
+, xlnt::range_reference
+, xlnt::uri
+
+today()
+: xlnt::date
+, xlnt::datetime
+
+top()
+: xlnt::comment
+, xlnt::gradient_fill
+, xlnt::page_margins
+
+top_left()
+: xlnt::range_reference
+
+top_left_cell()
+: xlnt::sheet_view
+
+top_right()
+: xlnt::range_reference
+
+type()
+: xlnt::color
+, xlnt::fill
+, xlnt::gradient_fill
+, xlnt::pattern_fill
+, xlnt::phonetic_pr
+, xlnt::relationship
+, xlnt::sheet_view
+
+type_as_string()
+: xlnt::phonetic_pr
+
+type_from_string()
+: xlnt::phonetic_pr
+
+
+
xlnt: Class Members - Functions
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/functions_func_v.html b/functions_func_v.html
new file mode 100644
index 00000000..b8d18e9e
--- /dev/null
+++ b/functions_func_v.html
@@ -0,0 +1,95 @@
+
+
+
+xlnt: Class Members - Functions
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/functions_func_w.html b/functions_func_w.html
new file mode 100644
index 00000000..19730850
--- /dev/null
+++ b/functions_func_w.html
@@ -0,0 +1,100 @@
+
+
+
+xlnt: Class Members - Functions
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/functions_func_y.html b/functions_func_y.html
new file mode 100644
index 00000000..1ec7467f
--- /dev/null
+++ b/functions_func_y.html
@@ -0,0 +1,76 @@
+
+
+
+xlnt: Class Members - Functions
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/functions_g.html b/functions_g.html
new file mode 100644
index 00000000..bf1f83a2
--- /dev/null
+++ b/functions_g.html
@@ -0,0 +1,97 @@
+
+
+
+xlnt: Class Members
+
+
+
+
+
+
+
+
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+
xlnt: Class Members
+
+
+
+
+
+
+
+
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+has_active_cell()
+: xlnt::selection
+, xlnt::worksheet
+
+has_alignment()
+: xlnt::phonetic_pr
+
+has_authentication()
+: xlnt::uri
+
+has_auto_filter()
+: xlnt::worksheet
+
+has_border()
+: xlnt::conditional_format
+
+has_calculation_properties()
+: xlnt::workbook
+
+has_cell()
+: xlnt::worksheet
+
+has_charset()
+: xlnt::font
+
+has_code_name()
+: xlnt::workbook
+
+has_color()
+: xlnt::font
+
+has_column_properties()
+: xlnt::worksheet
+
+has_comment()
+: xlnt::cell
+
+has_core_property()
+: xlnt::workbook
+
+has_custom_property()
+: xlnt::workbook
+
+has_default_type()
+: xlnt::manifest
+
+has_drawing()
+: xlnt::worksheet
+
+has_extended_property()
+: xlnt::workbook
+
+has_family()
+: xlnt::font
+
+has_file_version()
+: xlnt::workbook
+
+has_fill()
+: xlnt::conditional_format
+
+has_first_page_footer()
+: xlnt::header_footer
+
+has_first_page_header()
+: xlnt::header_footer
+
+has_font()
+: xlnt::conditional_format
+
+has_footer()
+: xlnt::header_footer
+
+has_format()
+: xlnt::cell
+
+has_formula()
+: xlnt::cell
+
+has_fragment()
+: xlnt::uri
+
+has_frozen_panes()
+: xlnt::worksheet
+
+has_header()
+: xlnt::header_footer
+
+has_header_footer()
+: xlnt::worksheet
+
+has_hyperlink()
+: xlnt::cell
+
+has_id()
+: xlnt::number_format
+
+has_name()
+: xlnt::font
+
+has_named_range()
+: xlnt::workbook
+, xlnt::worksheet
+
+has_odd_even_footer()
+: xlnt::header_footer
+
+has_odd_even_header()
+: xlnt::header_footer
+
+has_override_type()
+: xlnt::manifest
+
+has_page_margins()
+: xlnt::worksheet
+
+has_page_setup()
+: xlnt::worksheet
+
+has_pane()
+: xlnt::sheet_view
+
+has_paper_size()
+: xlnt::page_setup
+
+has_phonetic_properties()
+: xlnt::rich_text
+, xlnt::worksheet
+
+has_port()
+: xlnt::uri
+
+has_print_area()
+: xlnt::worksheet
+
+has_print_titles()
+: xlnt::worksheet
+
+has_query()
+: xlnt::uri
+
+has_rel_id()
+: xlnt::page_setup
+
+has_relationship()
+: xlnt::manifest
+
+has_row_properties()
+: xlnt::worksheet
+
+has_scale()
+: xlnt::page_setup
+
+has_scheme()
+: xlnt::font
+
+has_selections()
+: xlnt::sheet_view
+
+has_size()
+: xlnt::font
+
+has_sqref()
+: xlnt::selection
+
+has_style()
+: xlnt::cell
+, xlnt::format
+, xlnt::workbook
+
+has_theme()
+: xlnt::workbook
+
+has_tint()
+: xlnt::color
+
+has_title()
+: xlnt::workbook
+
+has_top_left_cell()
+: xlnt::sheet_view
+
+has_type()
+: xlnt::phonetic_pr
+
+has_value()
+: xlnt::cell
+, xlnt::cell_iterator
+, xlnt::const_cell_iterator
+
+has_view()
+: xlnt::workbook
+, xlnt::worksheet
+
+hash
+: xlnt::document_security::lock_verifier
+
+hash_algorithm
+: xlnt::document_security::lock_verifier
+
+hash_password()
+: xlnt::sheet_protection
+
+hashed_password()
+: xlnt::sheet_protection
+
+header()
+: xlnt::header_footer
+, xlnt::page_margins
+
+header_footer()
+: xlnt::worksheet
+
+height()
+: xlnt::cell
+, xlnt::comment
+, xlnt::range_reference
+, xlnt::row_properties
+
+hex_string()
+: xlnt::rgb_color
+
+hidden
+: xlnt::column_properties
+, xlnt::protection
+, xlnt::row_properties
+, xlnt::style
+
+hide()
+: xlnt::comment
+
+highest_column()
+: xlnt::worksheet
+
+highest_column_or_props()
+: xlnt::worksheet
+
+highest_row()
+: xlnt::worksheet
+
+highest_row_or_props()
+: xlnt::worksheet
+
+horizontal()
+: xlnt::alignment
+
+horizontal_centered
+: xlnt::print_options
+
+horizontal_dpi_
+: xlnt::page_setup
+
+host()
+: xlnt::uri
+
+hour
+: xlnt::datetime
+, xlnt::time
+
+hours
+: xlnt::timedelta
+
+hyperlink()
+: xlnt::cell
+
+
+
xlnt: Class Members
+
+
+
+
+
+
+
+
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+id()
+: xlnt::number_format
+, xlnt::relationship
+, xlnt::sheet_view
+, xlnt::worksheet
+
+illegal_character()
+: xlnt::illegal_character
+
+indent()
+: xlnt::alignment
+
+index
+: xlnt::column_t
+, xlnt::indexed_color
+, xlnt::theme_color
+, xlnt::workbook
+
+index_t
+: xlnt::column_t
+
+indexed()
+: xlnt::color
+
+indexed_color()
+: xlnt::indexed_color
+
+insert_columns()
+: xlnt::worksheet
+
+insert_rows()
+: xlnt::worksheet
+
+invalid_attribute()
+: xlnt::invalid_attribute
+
+invalid_cell_reference()
+: xlnt::invalid_cell_reference
+
+invalid_column_index()
+: xlnt::invalid_column_index
+
+invalid_data_type()
+: xlnt::invalid_data_type
+
+invalid_file()
+: xlnt::invalid_file
+
+invalid_parameter()
+: xlnt::invalid_parameter
+
+invalid_sheet_title()
+: xlnt::invalid_sheet_title
+
+is()
+: xlnt::variant
+
+is_absolute()
+: xlnt::path
+, xlnt::uri
+
+is_builtin_format()
+: xlnt::number_format
+
+is_date()
+: xlnt::cell
+
+is_date_format()
+: xlnt::number_format
+
+is_directory()
+: xlnt::path
+
+is_empty()
+: xlnt::worksheet
+
+is_file()
+: xlnt::path
+
+is_merged()
+: xlnt::cell
+
+is_relative()
+: xlnt::path
+, xlnt::uri
+
+is_root()
+: xlnt::path
+
+is_set()
+: xlnt::optional< T >
+
+is_single_cell()
+: xlnt::range_reference
+
+italic()
+: xlnt::font
+
+iterator
+: xlnt::cell_vector
+, xlnt::range
+, xlnt::workbook
+, xlnt::worksheet
+
+iterator_category
+: xlnt::cell_iterator
+, xlnt::const_cell_iterator
+, xlnt::const_range_iterator
+, xlnt::const_worksheet_iterator
+, xlnt::range_iterator
+, xlnt::worksheet_iterator
+
+
+
xlnt: Class Members
+
+
+
+
+
+
+
+
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+
xlnt: Class Members
+
+
+
+
+
+
+
+
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+
xlnt: Class Members
+
+
+
+
+
+
+
+
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+
xlnt: Class Members
+
+
+
+
+
+
+
+
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+name()
+: xlnt::font
+, xlnt::named_range
+, xlnt::style
+
+named_range()
+: xlnt::named_range
+, xlnt::workbook
+, xlnt::worksheet
+
+named_ranges()
+: xlnt::workbook
+
+next_row()
+: xlnt::worksheet
+
+no_visible_worksheets()
+: xlnt::no_visible_worksheets
+
+now()
+: xlnt::datetime
+, xlnt::time
+
+number()
+: xlnt::number_format
+
+number_00()
+: xlnt::number_format
+
+number_comma_separated1()
+: xlnt::number_format
+
+number_format()
+: xlnt::cell
+, xlnt::format
+, xlnt::number_format
+, xlnt::range
+, xlnt::style
+
+number_format_applied()
+: xlnt::format
+, xlnt::style
+
+
+
xlnt: Class Members
+
+
+
+
+
+
+
+
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+odd_even_footer()
+: xlnt::header_footer
+
+odd_even_header()
+: xlnt::header_footer
+
+odd_footer()
+: xlnt::header_footer
+
+odd_header()
+: xlnt::header_footer
+
+offset()
+: xlnt::cell
+
+open()
+: xlnt::streaming_workbook_reader
+, xlnt::streaming_workbook_writer
+
+operator!=()
+: xlnt::alignment
+, xlnt::border::border_property
+, xlnt::border
+, xlnt::cell
+, xlnt::cell_iterator
+, xlnt::cell_reference
+, xlnt::color
+, xlnt::column_t
+, xlnt::comment
+, xlnt::conditional_format
+, xlnt::const_cell_iterator
+, xlnt::const_range_iterator
+, xlnt::const_worksheet_iterator
+, xlnt::date
+, xlnt::fill
+, xlnt::font
+, xlnt::gradient_fill
+, xlnt::number_format
+, xlnt::optional< T >
+, xlnt::path
+, xlnt::pattern_fill
+, xlnt::protection
+, xlnt::range
+, xlnt::range_iterator
+, xlnt::range_reference
+, xlnt::relationship
+, xlnt::rich_text
+, xlnt::style
+, xlnt::workbook
+, xlnt::worksheet
+, xlnt::worksheet_iterator
+
+operator()()
+: std::hash< xlnt::column_t >
+, std::hash< xlnt::path >
+, xlnt::cell_reference_hash
+, xlnt::column_hash
+, xlnt::scoped_enum_hash< Enum >
+
+operator*()
+: xlnt::cell_iterator
+, xlnt::const_cell_iterator
+, xlnt::const_range_iterator
+, xlnt::const_worksheet_iterator
+, xlnt::range_iterator
+, xlnt::worksheet_iterator
+
+operator+
+: xlnt::column_t
+
+operator++()
+: xlnt::cell_iterator
+, xlnt::column_t
+, xlnt::const_cell_iterator
+, xlnt::const_range_iterator
+, xlnt::const_worksheet_iterator
+, xlnt::range_iterator
+, xlnt::worksheet_iterator
+
+operator+=()
+: xlnt::column_t
+
+operator,()
+: xlnt::cell_reference
+
+operator-
+: xlnt::column_t
+
+operator--()
+: xlnt::cell_iterator
+, xlnt::column_t
+, xlnt::const_cell_iterator
+, xlnt::const_range_iterator
+, xlnt::const_worksheet_iterator
+, xlnt::range_iterator
+, xlnt::worksheet_iterator
+
+operator-=()
+: xlnt::column_t
+
+operator<()
+: xlnt::column_t
+
+operator<=()
+: xlnt::column_t
+
+operator=()
+: xlnt::cell
+, xlnt::cell_iterator
+, xlnt::column_t
+, xlnt::const_cell_iterator
+, xlnt::const_range_iterator
+, xlnt::const_worksheet_iterator
+, xlnt::named_range
+, xlnt::optional< T >
+, xlnt::range_iterator
+, xlnt::rich_text
+, xlnt::workbook
+, xlnt::worksheet
+, xlnt::worksheet_iterator
+
+operator==()
+: xlnt::alignment
+, xlnt::border::border_property
+, xlnt::border
+, xlnt::cell
+, xlnt::cell_iterator
+, xlnt::cell_reference
+, xlnt::color
+, xlnt::column_t
+, xlnt::comment
+, xlnt::conditional_format
+, xlnt::const_cell_iterator
+, xlnt::const_range_iterator
+, xlnt::const_worksheet_iterator
+, xlnt::date
+, xlnt::datetime
+, xlnt::fill
+, xlnt::font
+, xlnt::gradient_fill
+, xlnt::number_format
+, xlnt::optional< T >
+, xlnt::pane
+, xlnt::path
+, xlnt::pattern_fill
+, xlnt::protection
+, xlnt::range
+, xlnt::range_iterator
+, xlnt::range_reference
+, xlnt::relationship
+, xlnt::rich_text
+, xlnt::selection
+, xlnt::sheet_view
+, xlnt::style
+, xlnt::time
+, xlnt::uri
+, xlnt::workbook
+, xlnt::worksheet
+, xlnt::worksheet_iterator
+
+operator>()
+: xlnt::column_t
+
+operator>=()
+: xlnt::column_t
+
+operator[]()
+: xlnt::cell_vector
+, xlnt::range
+, xlnt::workbook
+, xlnt::worksheet
+
+optional()
+: xlnt::optional< T >
+
+orientation_
+: xlnt::page_setup
+
+outline()
+: xlnt::font
+
+override_type()
+: xlnt::manifest
+
+
+
xlnt: Class Members
+
+
+
+
+
+
+
+
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+page_break()
+: xlnt::page_setup
+
+page_break_at_column()
+: xlnt::worksheet
+
+page_break_at_row()
+: xlnt::worksheet
+
+page_break_columns()
+: xlnt::worksheet
+
+page_break_rows()
+: xlnt::worksheet
+
+page_margins()
+: xlnt::page_margins
+, xlnt::worksheet
+
+page_setup()
+: xlnt::page_setup
+, xlnt::worksheet
+
+pane()
+: xlnt::selection
+, xlnt::sheet_view
+
+paper_size()
+: xlnt::page_setup
+
+parent()
+: xlnt::path
+
+parts()
+: xlnt::manifest
+
+parts_with_overriden_types()
+: xlnt::manifest
+
+password()
+: xlnt::sheet_protection
+, xlnt::uri
+
+path()
+: xlnt::path
+, xlnt::uri
+, xlnt::worksheet
+
+pattern_fill()
+: xlnt::fill
+, xlnt::pattern_fill
+
+percentage()
+: xlnt::number_format
+
+percentage_00()
+: xlnt::number_format
+
+phonetic_pr()
+: xlnt::phonetic_pr
+
+phonetic_properties()
+: xlnt::rich_text
+, xlnt::worksheet
+
+phonetic_runs()
+: xlnt::rich_text
+
+phonetic_type
+: xlnt::phonetic_pr
+
+phonetics_visible()
+: xlnt::cell
+
+pivot_button()
+: xlnt::format
+, xlnt::style
+
+plain_text()
+: xlnt::comment
+, xlnt::rich_text
+
+point_pos()
+: xlnt::worksheet
+
+port()
+: xlnt::uri
+
+position()
+: xlnt::comment
+
+print_area()
+: xlnt::worksheet
+
+print_grid_lines
+: xlnt::print_options
+
+print_headings
+: xlnt::print_options
+
+print_title_cols()
+: xlnt::worksheet
+
+print_title_rows()
+: xlnt::worksheet
+
+protection()
+: xlnt::cell
+, xlnt::format
+, xlnt::protection
+, xlnt::range
+, xlnt::style
+
+protection_applied()
+: xlnt::format
+, xlnt::style
+
+published
+: xlnt::sheet_pr
+
+
+
xlnt: Class Members
+
+
+
+
+
+
+
+
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+
xlnt: Class Members
+
+
+
+
+
+
+
+
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+range()
+: xlnt::range
+, xlnt::worksheet
+
+range_iterator()
+: xlnt::range_iterator
+
+range_reference()
+: xlnt::range_reference
+
+rbegin()
+: xlnt::cell_vector
+, xlnt::range
+
+read_cell()
+: xlnt::streaming_workbook_reader
+
+read_contents()
+: xlnt::path
+
+red()
+: xlnt::color
+, xlnt::rgb_color
+
+reference()
+: xlnt::cell
+, xlnt::range
+
+referring_relationship()
+: xlnt::worksheet
+
+register_default_type()
+: xlnt::manifest
+
+register_override_type()
+: xlnt::manifest
+
+register_relationship()
+: xlnt::manifest
+
+rel_id()
+: xlnt::page_setup
+
+relationship()
+: xlnt::manifest
+, xlnt::relationship
+
+relationships()
+: xlnt::manifest
+
+relative_to()
+: xlnt::path
+
+remove_named_range()
+: xlnt::workbook
+, xlnt::worksheet
+
+remove_sheet()
+: xlnt::workbook
+
+rend()
+: xlnt::cell_vector
+, xlnt::range
+
+reserve()
+: xlnt::worksheet
+
+resolve()
+: xlnt::path
+
+reverse_iterator
+: xlnt::cell_vector
+, xlnt::range
+, xlnt::workbook
+, xlnt::worksheet
+
+revision_lock
+: xlnt::document_security
+
+rgb()
+: xlnt::color
+, xlnt::rgb_color
+
+rgb_color()
+: xlnt::rgb_color
+
+rgba()
+: xlnt::rgb_color
+
+rich_text()
+: xlnt::rich_text
+
+right()
+: xlnt::gradient_fill
+, xlnt::page_margins
+
+rotation()
+: xlnt::alignment
+
+row()
+: xlnt::cell
+, xlnt::cell_reference
+
+row_absolute()
+: xlnt::cell_reference
+
+row_height()
+: xlnt::worksheet
+
+row_properties()
+: xlnt::worksheet
+
+rows()
+: xlnt::worksheet
+
+runs()
+: xlnt::rich_text
+
+rup_build()
+: xlnt::workbook
+
+
+
xlnt: Class Members - Related Functions
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/functions_s.html b/functions_s.html
new file mode 100644
index 00000000..bc1b3bca
--- /dev/null
+++ b/functions_s.html
@@ -0,0 +1,233 @@
+
+
+
+xlnt: Class Members
+
+
+
+
+
+
+
+
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+salt
+: xlnt::document_security::lock_verifier
+
+save()
+: xlnt::workbook
+
+scale()
+: xlnt::page_setup
+
+scale_with_doc()
+: xlnt::header_footer
+
+scheme()
+: xlnt::font
+, xlnt::uri
+
+second
+: xlnt::datetime
+, xlnt::time
+
+seconds
+: xlnt::timedelta
+
+selection()
+: xlnt::selection
+, xlnt::sheet_view
+
+selections()
+: xlnt::sheet_view
+
+serialise()
+: xlnt::phonetic_pr
+
+set()
+: xlnt::optional< T >
+
+shadow()
+: xlnt::font
+
+shared_strings()
+: xlnt::workbook
+
+sheet_by_id()
+: xlnt::workbook
+
+sheet_by_index()
+: xlnt::workbook
+
+sheet_by_title()
+: xlnt::workbook
+
+sheet_count()
+: xlnt::workbook
+
+sheet_hidden_by_index()
+: xlnt::workbook
+
+sheet_state()
+: xlnt::page_setup
+, xlnt::worksheet
+
+sheet_titles()
+: xlnt::streaming_workbook_reader
+, xlnt::workbook
+
+show()
+: xlnt::comment
+
+show_grid_lines()
+: xlnt::sheet_view
+
+show_horizontal_scroll
+: xlnt::workbook_view
+
+show_phonetics()
+: xlnt::cell
+
+show_sheet_tabs
+: xlnt::workbook_view
+
+show_vertical_scroll
+: xlnt::workbook_view
+
+shrink()
+: xlnt::alignment
+
+side()
+: xlnt::border
+
+size()
+: xlnt::comment
+, xlnt::font
+
+solid()
+: xlnt::fill
+
+source()
+: xlnt::relationship
+
+spans
+: xlnt::row_properties
+
+spin_count
+: xlnt::document_security::lock_verifier
+
+split()
+: xlnt::path
+
+split_extension()
+: xlnt::path
+
+split_reference()
+: xlnt::cell_reference
+
+sqref()
+: xlnt::selection
+
+state
+: xlnt::pane
+
+stops()
+: xlnt::gradient_fill
+
+strikethrough()
+: xlnt::font
+
+string()
+: xlnt::path
+
+style()
+: xlnt::border::border_property
+, xlnt::cell
+, xlnt::column_properties
+, xlnt::format
+, xlnt::range
+, xlnt::row_properties
+, xlnt::style
+, xlnt::workbook
+
+subscript()
+: xlnt::font
+
+superscript()
+: xlnt::font
+
+swap
+: xlnt::column_t
+
+sync_horizontal
+: xlnt::sheet_pr
+
+sync_ref
+: xlnt::sheet_pr
+
+sync_vertical
+: xlnt::sheet_pr
+
+system_separator()
+: xlnt::path
+
+
+
xlnt: Class Members
+
+
+
+
+
+
+
+
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+tab_ratio
+: xlnt::workbook_view
+
+target
+: xlnt::named_range
+, xlnt::relationship
+
+target_mode()
+: xlnt::relationship
+
+target_worksheet()
+: xlnt::range
+
+targets()
+: xlnt::named_range
+
+text()
+: xlnt::comment
+, xlnt::number_format
+
+theme()
+: xlnt::color
+, xlnt::workbook
+
+theme_color()
+: xlnt::theme_color
+
+thumbnail()
+: xlnt::workbook
+
+time()
+: xlnt::time
+
+timedelta()
+: xlnt::timedelta
+
+tint()
+: xlnt::color
+
+title()
+: xlnt::workbook
+, xlnt::worksheet
+
+to_iso_string()
+: xlnt::datetime
+
+to_number()
+: xlnt::date
+, xlnt::datetime
+, xlnt::time
+, xlnt::timedelta
+
+to_range()
+: xlnt::cell_reference
+
+to_string()
+: xlnt::cell
+, xlnt::cell_reference
+, xlnt::datetime
+, xlnt::range_reference
+, xlnt::uri
+
+today()
+: xlnt::date
+, xlnt::datetime
+
+top()
+: xlnt::comment
+, xlnt::gradient_fill
+, xlnt::page_margins
+
+top_left()
+: xlnt::range_reference
+
+top_left_cell
+: xlnt::pane
+, xlnt::sheet_view
+
+top_right()
+: xlnt::range_reference
+
+transition_entry
+: xlnt::sheet_pr
+
+transition_evaluation
+: xlnt::sheet_pr
+
+type
+: xlnt::cell
+, xlnt::color
+, xlnt::fill
+, xlnt::gradient_fill
+, xlnt::pattern_fill
+, xlnt::phonetic_pr
+, xlnt::relationship
+, xlnt::sheet_view
+, xlnt::variant
+
+type_as_string()
+: xlnt::phonetic_pr
+
+type_from_string()
+: xlnt::phonetic_pr
+
+
+
xlnt: Class Members - Typedefs
+
+
+
+
+
+
+
+
+
+
+const_iterator
+: xlnt::cell_vector
+, xlnt::range
+, xlnt::workbook
+, xlnt::worksheet
+
+const_reverse_iterator
+: xlnt::cell_vector
+, xlnt::range
+, xlnt::workbook
+, xlnt::worksheet
+
+font_id_t
+: xlnt::phonetic_pr
+
+index_t
+: xlnt::column_t
+
+iterator
+: xlnt::cell_vector
+, xlnt::range
+, xlnt::workbook
+, xlnt::worksheet
+
+iterator_category
+: xlnt::cell_iterator
+, xlnt::const_cell_iterator
+, xlnt::const_range_iterator
+, xlnt::const_worksheet_iterator
+, xlnt::range_iterator
+, xlnt::worksheet_iterator
+
+reverse_iterator
+: xlnt::cell_vector
+, xlnt::range
+, xlnt::workbook
+, xlnt::worksheet
+
+target
+: xlnt::named_range
+
+type
+: xlnt::cell
+
+
+
xlnt: Class Members
+
+
+
+
+
+
+
+
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+
xlnt: Class Members
+
+
+
+
+
+
+
+
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+
xlnt: Class Members - Variables
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
xlnt: Class Members
+
+
+
+
+
+
+
+
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+
xlnt: Class Members
+
+
+
+
+
+
+
+
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+
xlnt: Class Members
+
+
+
+
+
+
+
+
+
+
Here is a list of all documented class members with links to the class documentation for each member:
+
+
+
xlnt: xlnt/worksheet/header_footer.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
29 #include <unordered_map> 31 #include <xlnt/xlnt_config.hpp> 32 #include <xlnt/cell/rich_text.hpp> 33 #include <xlnt/utils/scoped_enum_hash.hpp> 58 bool has_header()
const ;
63 bool has_footer()
const ;
68 bool align_with_margins()
const ;
79 bool different_odd_even()
const ;
84 bool different_first()
const ;
89 bool scale_with_doc()
const ;
101 bool has_header(
location where)
const ;
134 bool has_first_page_header()
const ;
139 bool has_first_page_header(
location where)
const ;
144 void clear_first_page_header();
149 void clear_first_page_header(
location where);
168 bool has_odd_even_header()
const ;
173 bool has_odd_even_header(
location where)
const ;
178 void clear_odd_even_header();
183 void clear_odd_even_header(
location where);
209 bool has_footer(
location where)
const ;
242 bool has_first_page_footer()
const ;
247 bool has_first_page_footer(
location where)
const ;
252 void clear_first_page_footer();
257 void clear_first_page_footer(
location where);
276 bool has_odd_even_footer()
const ;
281 bool has_odd_even_footer(
location where)
const ;
286 void clear_odd_even_footer();
291 void clear_odd_even_footer(
location where);
315 bool align_with_margins_ =
false ;
316 bool different_odd_even_ =
false ;
317 bool scale_with_doc_ =
false ;
319 using container = std::unordered_map<location, rich_text, scoped_enum_hash<location>>;
321 container odd_headers_;
322 container even_headers_;
323 container first_headers_;
324 container odd_footers_;
325 container even_footers_;
326 container first_footers_;
+
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
+
bool operator==(std::nullptr_t, const cell &cell)
Returns true if this cell is uninitialized.
+
Encapsulates zero or more formatted text runs where a text run is a string of text with the same defi...
Definition: rich_text.hpp:40
+
xlnt: Class Hierarchy
+
+
+
+
+
+
+
+
+
+
+
This inheritance list is sorted roughly, but not completely, alphabetically:
+
[detail level 1 2 3 ]
+ C xlnt::alignment Alignment options that determine how text should be displayed within a cell. C xlnt::border Describes the border style of a particular cell. C xlnt::border::border_property Each side of a cell can have a border_property applied to it to change how it is displayed. C xlnt::calculation_properties Workbook file properties relating to calculations. C xlnt::cell Describes a unit of data in a worksheet at a specific coordinate and its associated properties. C xlnt::cell_iterator A cell iterator iterates over a 1D range by row or by column. C xlnt::cell_reference An object used to refer to a cell. References have two parts, the column and the row. In Excel, the reference string A1 refers to the top-left-most cell. A cell_reference can be initialized from a string of this form or a 1-indexed ordered pair of the form column, row. C xlnt::cell_reference_hash Functor for hashing a cell reference. Allows for use of std::unordered_set<cell_reference, cel_reference_hash> and similar. C xlnt::cell_vector A cell vector is a linear (1D) range of cells, either vertical or horizontal depending on the major order specified in the constructor. C xlnt::color Colors can be applied to many parts of a cell's style. C xlnt::column_hash Functor for hashing a column. Allows for use of std::unordered_set<column_t, column_hash> and similar. C xlnt::column_properties Properties applied to a column in a worksheet. Columns can have a size and a style. C xlnt::column_t Columns can be referred to as a string A,B,...Z,AA,AB,..,ZZ,AAA,...,ZZZ or as a 1-indexed index. This class encapsulates both of these forms of column referencing and allows for conversions between them. C xlnt::comment A comment can be applied to a cell to provide extra information about its contents. C xlnt::condition C xlnt::conditional_format Describes a conditional format that will be applied to all cells in the associated range that satisfy the condition. This can only be constructed using methods on worksheet or range. C xlnt::const_cell_iterator A cell iterator iterates over a 1D range by row or by column. C xlnt::const_range_iterator A const version of range_iterator which does not allow modification to the dereferenced cell_vector . C xlnt::const_worksheet_iterator An iterator which is used to iterate over the worksheets in a const workbook. C xlnt::date A date is a specific day specified in terms of a year, month, and day. It can also be initialized as a number of days since a base date using date::from_number . C xlnt::datetime A datetime is a combination of a date and a time. C xlnt::document_security Properties governing how the data in a workbook should be protected. These values can be ignored by consumers. C xlnt::ext_list::ext C xlnt::ext_list A list of xml extensions that may or may not be understood by the parser preservation is required for round-tripping even if extension is not understood [serialised: extLst] C xlnt::external_book A reference to an external workbook for use in formulae. C xlnt::fill Describes the fill style of a particular cell. C xlnt::font Describes the font style of a particular cell. C xlnt::format Describes the formatting of a particular cell. C xlnt::gradient_fill Encapsulates a fill which transitions between colors at particular "stops". C std::hash< xlnt::cell_reference > C std::hash< xlnt::column_t > Template specialization to allow xlnt::column_t to be used as a key in a std container. C std::hash< xlnt::path > Template specialization to allow xlnt:path to be used as a key in a std container. C xlnt::header_footer Represents the header and footer of a sheet in a workbook. C xlnt::hyperlink Describes a hyperlink pointing from a cell to another cell or a URL. C xlnt::indexed_color An indexed color encapsulates a simple index to a color in the indexedColors of the stylesheet. C xlnt::document_security::lock_verifier Holds data describing the verifier that locks revisions or a workbook. C xlnt::manifest The manifest keeps track of all files in the OOXML package and their type and relationships. C xlnt::named_range A 2D range of cells in a worksheet that is referred to by name. ws->range("A1:B2") could be replaced by ws->range("range1") C xlnt::number_format Describes the number formatting applied to text and numbers within a certain cell. C xlnt::detail::number_serialiser C xlnt::optional< T > Many settings in xlnt are allowed to not have a value set. This class encapsulates a value which may or may not be set. Memory is allocated within the optional class. C xlnt::optional< align > C xlnt::optional< bool > C xlnt::optional< border_style > C xlnt::optional< class xlnt::color > C xlnt::optional< diagonal_direction > C xlnt::optional< double > C xlnt::optional< horizontal_alignment > C xlnt::optional< int > C xlnt::optional< phonetic_type > C xlnt::optional< std::size_t > C xlnt::optional< std::string > C xlnt::optional< vertical_alignment > C xlnt::optional< xlnt::border::border_property > C xlnt::optional< xlnt::cell_reference > C xlnt::optional< xlnt::color > C xlnt::optional< xlnt::font > C xlnt::optional< xlnt::orientation > C xlnt::optional< xlnt::pane > C xlnt::optional< xlnt::paper_size > C xlnt::optional< xlnt::phonetic_pr > C xlnt::optional< xlnt::range_reference > C xlnt::page_margins Describes the margins around a worksheet for printing. C xlnt::page_setup Describes how a worksheet will be converted into a page during printing. C xlnt::pane A fixed portion of a worksheet. C xlnt::path Encapsulates a path that points to location in a filesystem. C xlnt::pattern_fill Represents a fill which colors the cell based on a foreground and background color and a pattern. C xlnt::phonetic_pr Phonetic properties Element provides a collection of properties that affect display of East Asian Languages [Serialised phoneticPr] C xlnt::phonetic_run Encapsulates a run of text that C xlnt::print_options C xlnt::protection Describes the protection style of a particular cell. C xlnt::range A range is a 2D collection of cells with defined extens that can be iterated upon. C xlnt::range_iterator An iterator used by worksheet and range for traversing a 2D grid of cells by row/column then across that row/column. C xlnt::range_reference A range_reference describes a rectangular area of a worksheet with positive width and height defined by a top-left and bottom-right corner. C xlnt::relationship Represents an association between a source Package or part, and a target object which can be a part or external resource. C xlnt::rgb_color An RGB color describes a color in terms of its red, green, blue, and alpha components. C xlnt::rich_text Encapsulates zero or more formatted text runs where a text run is a string of text with the same defined formatting. C xlnt::rich_text_hash C xlnt::rich_text_run Typedef a rich_text_run as a pair of string and optional font. C xlnt::row_properties The properties of a row in a worksheet. ► C runtime_error ► C xlnt::exception Parent type of all custom exceptions thrown in this library. C xlnt::illegal_character The data submitted which cannot be used directly in Excel files. It must be removed or escaped. C xlnt::invalid_attribute Exception when setting a class's attribute to an invalid value C xlnt::invalid_cell_reference Exception for converting between numeric and A1-style cell references. C xlnt::invalid_column_index Exception for bad column indices in A1-style cell references. C xlnt::invalid_data_type Exception for any data type inconsistencies. C xlnt::invalid_file Exception for trying to open a non-XLSX file. C xlnt::invalid_parameter Exception for a bad parameter value C xlnt::invalid_sheet_title Exception for bad sheet names. C xlnt::key_not_found Exception for a key that doesn't exist in a container C xlnt::no_visible_worksheets Exception for a workbook with no visible worksheets C xlnt::unhandled_switch_case Debug exception for a switch that fell through to the default case C xlnt::unsupported Exception for attempting to use a feature which is not supported C xlnt::scoped_enum_hash< Enum > Allows a scoped enum (aka "enum class") to be used as a key in a std::unordered_map. C xlnt::selection The selected area of a worksheet. C xlnt::sheet_format_properties General worksheet formatting properties. C xlnt::sheet_pr C xlnt::sheet_protection Protection applied to a particular worksheet to prevent it from being modified. C xlnt::sheet_view Describes a view of a worksheet. Worksheets can have multiple views which show the data differently. C xlnt::drawing::spreadsheet_drawing The spreadsheet_drawing class encapsulates the information captured from objects within the spreadsheetDrawing schema. C xlnt::streaming_workbook_reader workbook is the container for all other parts of the document. C xlnt::streaming_workbook_writer workbook is the container for all other parts of the document. C xlnt::style Describes a style which has a name and can be applied to multiple individual formats. In Excel this is a "Cell Style". C xlnt::theme A theme is a combination of fonts, colors, and effects. This isn't really supported yet. C xlnt::theme_color A theme color encapsulates a color derived from the theme. C xlnt::time A time is a specific time of the day specified in terms of an hour, minute, second, and microsecond (0-999999). It can also be initialized as a fraction of a day using time::from_number . C xlnt::timedelta Represents a span of time between two datetimes. This is not fully supported yet throughout the library. C xlnt::uri Encapsulates a uniform resource identifier (URI) as described by RFC 3986. C xlnt::variant Represents an object that can have variable type. C xlnt::workbook workbook is the container for all other parts of the document. C xlnt::workbook_view A workbook can be opened in multiple windows with different views. This class represents a particular view used by one window. C xlnt::worksheet A worksheet is a 2D array of cells starting with cell A1 in the top-left corner and extending indefinitely down and right as needed. C xlnt::worksheet_iterator An iterator which is used to iterate over the worksheets in a workbook.
+
+
xlnt: xlnt/cell/hyperlink.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
26 #include <xlnt/xlnt_config.hpp> 32 struct hyperlink_impl;
48 std::string url()
const ;
50 std::string target_range()
const ;
52 bool has_display()
const ;
53 void display(
const std::string &value);
54 const std::string &display()
const ;
56 bool has_tooltip()
const ;
57 void tooltip(
const std::string &value);
58 const std::string &tooltip()
const ;
60 bool has_location()
const ;
61 void location(
const std::string &value);
62 const std::string &location()
const ;
67 detail::hyperlink_impl *d_;
Represents an association between a source Package or part, and a target object which can be a part o...
Definition: relationship.hpp:102
+
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
Describes a unit of data in a worksheet at a specific coordinate and its associated properties...
Definition: cell.hpp:83
+
Describes a hyperlink pointing from a cell to another cell or a URL.
Definition: hyperlink.hpp:42
+
The relationship references a part that is inside the package.
+
xlnt: Main Page
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/index__types_8hpp_source.html b/index__types_8hpp_source.html
new file mode 100644
index 00000000..4a53c9cd
--- /dev/null
+++ b/index__types_8hpp_source.html
@@ -0,0 +1,87 @@
+
+
+
+xlnt: xlnt/cell/index_types.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
30 #include <xlnt/xlnt_config.hpp> 63 static index_t column_index_from_string(
const std::string &column_string);
73 static std::string column_string_from_index(
index_t column_index);
88 column_t (
const std::string &column_string);
98 std::string column_string()
const ;
103 column_t &operator=(
const std::string &rhs);
108 column_t &operator=(
const char *rhs);
133 bool operator== (
const std::string &other)
const ;
153 bool operator!= (
const std::string &other)
const ;
163 bool operator>(
const column_t &other)
const ;
168 bool operator>=(
const column_t &other)
const ;
173 bool operator<(
const column_t &other)
const ;
178 bool operator<=(
const column_t &other)
const ;
271 enum class row_or_col_t : int
286 std::size_t operator()(
const column_t &k)
const ;
index_t index
Internal numeric value of this column index.
Definition: index_types.hpp:268
+
std::uint32_t index_t
Alias declaration for the internal numeric type of this column.
Definition: index_types.hpp:53
+
std::uint32_t row_t
All rows should be referred to by an instance of this type.
Definition: index_types.hpp:40
+
Definition: cell_reference.hpp:261
+
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
size_t operator()(const xlnt::column_t &k) const
Returns the result of hashing column k.
Definition: index_types.hpp:302
+
bool operator==(std::nullptr_t, const cell &cell)
Returns true if this cell is uninitialized.
+
Columns can be referred to as a string A,B,...Z,AA,AB,..,ZZ,AAA,...,ZZZ or as a 1-indexed index...
Definition: index_types.hpp:47
+
bool operator!=(const std::string &reference_string, const range_reference &ref)
Returns true if the string representation of the range is not equivalent to ref.
+
Functor for hashing a column. Allows for use of std::unordered_set<column_t, column_hash> and similar...
Definition: index_types.hpp:281
+
0){return}bC.fireWith(av,[bF]);if(bF.fn.trigger){bF(av).trigger("ready").off("ready")}}},bindReady:function(){if(bC){return}bC=bF.Callbacks("once memory");if(av.readyState==="complete"){return setTimeout(bF.ready,1)}if(av.addEventListener){av.addEventListener("DOMContentLoaded",e,false);bb.addEventListener("load",bF.ready,false)}else{if(av.attachEvent){av.attachEvent("onreadystatechange",e);bb.attachEvent("onload",bF.ready);var b0=false;try{b0=bb.frameElement==null}catch(b1){}if(av.documentElement.doScroll&&b0){bw()}}}},isFunction:function(b0){return bF.type(b0)==="function"},isArray:Array.isArray||function(b0){return bF.type(b0)==="array"},isWindow:function(b0){return b0&&typeof b0==="object"&&"setInterval" in b0},isNumeric:function(b0){return !isNaN(parseFloat(b0))&&isFinite(b0)},type:function(b0){return b0==null?String(b0):bx[bL.call(b0)]||"object"},isPlainObject:function(b2){if(!b2||bF.type(b2)!=="object"||b2.nodeType||bF.isWindow(b2)){return false}try{if(b2.constructor&&!bG.call(b2,"constructor")&&!bG.call(b2.constructor.prototype,"isPrototypeOf")){return false}}catch(b1){return false}var b0;for(b0 in b2){}return b0===L||bG.call(b2,b0)},isEmptyObject:function(b1){for(var b0 in b1){return false}return true},error:function(b0){throw new Error(b0)},parseJSON:function(b0){if(typeof b0!=="string"||!b0){return null}b0=bF.trim(b0);if(bb.JSON&&bb.JSON.parse){return bb.JSON.parse(b0)}if(bN.test(b0.replace(bW,"@").replace(bP,"]").replace(bJ,""))){return(new Function("return "+b0))()}bF.error("Invalid JSON: "+b0)},parseXML:function(b2){var b0,b1;try{if(bb.DOMParser){b1=new DOMParser();b0=b1.parseFromString(b2,"text/xml")}else{b0=new ActiveXObject("Microsoft.XMLDOM");b0.async="false";b0.loadXML(b2)}}catch(b3){b0=L}if(!b0||!b0.documentElement||b0.getElementsByTagName("parsererror").length){bF.error("Invalid XML: "+b2)}return b0},noop:function(){},globalEval:function(b0){if(b0&&bM.test(b0)){(bb.execScript||function(b1){bb["eval"].call(bb,b1)})(b0)}},camelCase:function(b0){return b0.replace(bZ,"ms-").replace(bB,bT)},nodeName:function(b1,b0){return b1.nodeName&&b1.nodeName.toUpperCase()===b0.toUpperCase()},each:function(b3,b6,b2){var b1,b4=0,b5=b3.length,b0=b5===L||bF.isFunction(b3);if(b2){if(b0){for(b1 in b3){if(b6.apply(b3[b1],b2)===false){break}}}else{for(;b40&&b0[0]&&b0[b1-1])||b1===0||bF.isArray(b0));if(b3){for(;b21?aJ.call(arguments,0):bG;if(!(--bw)){bC.resolveWith(bC,bx)}}}function bz(bF){return function(bG){bB[bF]=arguments.length>1?aJ.call(arguments,0):bG;bC.notifyWith(bE,bB)}}if(e>1){for(;bva
";bJ.shrinkWrapBlocks=(bv.offsetWidth!==2)}bv.style.cssText=bS+bR;bv.innerHTML=bP;bU=bv.firstChild;bV=bU.firstChild;bN=bU.nextSibling.firstChild.firstChild;bO={doesNotAddBorder:(bV.offsetTop!==5),doesAddBorderForTableAndCells:(bN.offsetTop===5)};bV.style.position="fixed";bV.style.top="20px";bO.fixedPosition=(bV.offsetTop===20||bV.offsetTop===15);bV.style.position=bV.style.top="";bU.style.overflow="hidden";bU.style.position="relative";bO.subtractsBorderForOverflowNotVisible=(bV.offsetTop===-5);bO.doesNotIncludeMarginInBodyOffset=(bQ.offsetTop!==bL);bQ.removeChild(bM);bv=bM=null;b.extend(bJ,bO)});return bJ})();var aS=/^(?:\{.*\}|\[.*\])$/,aA=/([A-Z])/g;b.extend({cache:{},uuid:0,expando:"jQuery"+(b.fn.jquery+Math.random()).replace(/\D/g,""),noData:{embed:true,object:"clsid:D27CDB6E-AE6D-11cf-96B8-444553540000",applet:true},hasData:function(e){e=e.nodeType?b.cache[e[b.expando]]:e[b.expando];return !!e&&!S(e)},data:function(bx,bv,bz,by){if(!b.acceptData(bx)){return}var bG,bA,bD,bE=b.expando,bC=typeof bv==="string",bF=bx.nodeType,e=bF?b.cache:bx,bw=bF?bx[bE]:bx[bE]&&bE,bB=bv==="events";if((!bw||!e[bw]||(!bB&&!by&&!e[bw].data))&&bC&&bz===L){return}if(!bw){if(bF){bx[bE]=bw=++b.uuid}else{bw=bE}}if(!e[bw]){e[bw]={};if(!bF){e[bw].toJSON=b.noop}}if(typeof bv==="object"||typeof bv==="function"){if(by){e[bw]=b.extend(e[bw],bv)}else{e[bw].data=b.extend(e[bw].data,bv)}}bG=bA=e[bw];if(!by){if(!bA.data){bA.data={}}bA=bA.data}if(bz!==L){bA[b.camelCase(bv)]=bz}if(bB&&!bA[bv]){return bG.events}if(bC){bD=bA[bv];if(bD==null){bD=bA[b.camelCase(bv)]}}else{bD=bA}return bD},removeData:function(bx,bv,by){if(!b.acceptData(bx)){return}var bB,bA,bz,bC=b.expando,bD=bx.nodeType,e=bD?b.cache:bx,bw=bD?bx[bC]:bC;if(!e[bw]){return}if(bv){bB=by?e[bw]:e[bw].data;if(bB){if(!b.isArray(bv)){if(bv in bB){bv=[bv]}else{bv=b.camelCase(bv);if(bv in bB){bv=[bv]}else{bv=bv.split(" ")}}}for(bA=0,bz=bv.length;bA-1){return true}}return false},val:function(bx){var e,bv,by,bw=this[0];if(!arguments.length){if(bw){e=b.valHooks[bw.nodeName.toLowerCase()]||b.valHooks[bw.type];if(e&&"get" in e&&(bv=e.get(bw,"value"))!==L){return bv}bv=bw.value;return typeof bv==="string"?bv.replace(aU,""):bv==null?"":bv}return}by=b.isFunction(bx);return this.each(function(bA){var bz=b(this),bB;if(this.nodeType!==1){return}if(by){bB=bx.call(this,bA,bz.val())}else{bB=bx}if(bB==null){bB=""}else{if(typeof bB==="number"){bB+=""}else{if(b.isArray(bB)){bB=b.map(bB,function(bC){return bC==null?"":bC+""})}}}e=b.valHooks[this.nodeName.toLowerCase()]||b.valHooks[this.type];if(!e||!("set" in e)||e.set(this,bB,"value")===L){this.value=bB}})}});b.extend({valHooks:{option:{get:function(e){var bv=e.attributes.value;return !bv||bv.specified?e.value:e.text}},select:{get:function(e){var bA,bv,bz,bx,by=e.selectedIndex,bB=[],bC=e.options,bw=e.type==="select-one";if(by<0){return null}bv=bw?by:0;bz=bw?by+1:bC.length;for(;bv=0});if(!e.length){bv.selectedIndex=-1}return e}}},attrFn:{val:true,css:true,html:true,text:true,data:true,width:true,height:true,offset:true},attr:function(bA,bx,bB,bz){var bw,e,by,bv=bA.nodeType;if(!bA||bv===3||bv===8||bv===2){return}if(bz&&bx in b.attrFn){return b(bA)[bx](bB)}if(typeof bA.getAttribute==="undefined"){return b.prop(bA,bx,bB)}by=bv!==1||!b.isXMLDoc(bA);if(by){bx=bx.toLowerCase();e=b.attrHooks[bx]||(ao.test(bx)?aY:be)}if(bB!==L){if(bB===null){b.removeAttr(bA,bx);return}else{if(e&&"set" in e&&by&&(bw=e.set(bA,bB,bx))!==L){return bw}else{bA.setAttribute(bx,""+bB);return bB}}}else{if(e&&"get" in e&&by&&(bw=e.get(bA,bx))!==null){return bw}else{bw=bA.getAttribute(bx);return bw===null?L:bw}}},removeAttr:function(bx,bz){var by,bA,bv,e,bw=0;if(bz&&bx.nodeType===1){bA=bz.toLowerCase().split(af);e=bA.length;for(;bw=0)}}})});var bd=/^(?:textarea|input|select)$/i,n=/^([^\.]*)?(?:\.(.+))?$/,J=/\bhover(\.\S+)?\b/,aO=/^key/,bf=/^(?:mouse|contextmenu)|click/,T=/^(?:focusinfocus|focusoutblur)$/,U=/^(\w*)(?:#([\w\-]+))?(?:\.([\w\-]+))?$/,Y=function(e){var bv=U.exec(e);if(bv){bv[1]=(bv[1]||"").toLowerCase();bv[3]=bv[3]&&new RegExp("(?:^|\\s)"+bv[3]+"(?:\\s|$)")}return bv},j=function(bw,e){var bv=bw.attributes||{};return((!e[1]||bw.nodeName.toLowerCase()===e[1])&&(!e[2]||(bv.id||{}).value===e[2])&&(!e[3]||e[3].test((bv["class"]||{}).value)))},bt=function(e){return b.event.special.hover?e:e.replace(J,"mouseenter$1 mouseleave$1")};b.event={add:function(bx,bC,bJ,bA,by){var bD,bB,bK,bI,bH,bF,e,bG,bv,bz,bw,bE;if(bx.nodeType===3||bx.nodeType===8||!bC||!bJ||!(bD=b._data(bx))){return}if(bJ.handler){bv=bJ;bJ=bv.handler}if(!bJ.guid){bJ.guid=b.guid++}bK=bD.events;if(!bK){bD.events=bK={}}bB=bD.handle;if(!bB){bD.handle=bB=function(bL){return typeof b!=="undefined"&&(!bL||b.event.triggered!==bL.type)?b.event.dispatch.apply(bB.elem,arguments):L};bB.elem=bx}bC=b.trim(bt(bC)).split(" ");for(bI=0;bI=0){bG=bG.slice(0,-1);bw=true}if(bG.indexOf(".")>=0){bx=bG.split(".");bG=bx.shift();bx.sort()}if((!bA||b.event.customEvent[bG])&&!b.event.global[bG]){return}bv=typeof bv==="object"?bv[b.expando]?bv:new b.Event(bG,bv):new b.Event(bG);bv.type=bG;bv.isTrigger=true;bv.exclusive=bw;bv.namespace=bx.join(".");bv.namespace_re=bv.namespace?new RegExp("(^|\\.)"+bx.join("\\.(?:.*\\.)?")+"(\\.|$)"):null;by=bG.indexOf(":")<0?"on"+bG:"";if(!bA){e=b.cache;for(bC in e){if(e[bC].events&&e[bC].events[bG]){b.event.trigger(bv,bD,e[bC].handle.elem,true)}}return}bv.result=L;if(!bv.target){bv.target=bA}bD=bD!=null?b.makeArray(bD):[];bD.unshift(bv);bF=b.event.special[bG]||{};if(bF.trigger&&bF.trigger.apply(bA,bD)===false){return}bB=[[bA,bF.bindType||bG]];if(!bJ&&!bF.noBubble&&!b.isWindow(bA)){bI=bF.delegateType||bG;bH=T.test(bI+bG)?bA:bA.parentNode;bz=null;for(;bH;bH=bH.parentNode){bB.push([bH,bI]);bz=bH}if(bz&&bz===bA.ownerDocument){bB.push([bz.defaultView||bz.parentWindow||bb,bI])}}for(bC=0;bCbA){bH.push({elem:this,matches:bz.slice(bA)})}for(bC=0;bC0?this.on(e,null,bx,bw):this.trigger(e)};if(b.attrFn){b.attrFn[e]=true}if(aO.test(e)){b.event.fixHooks[e]=b.event.keyHooks}if(bf.test(e)){b.event.fixHooks[e]=b.event.mouseHooks}});
+/*!
+ * Sizzle CSS Selector Engine
+ * Copyright 2011, The Dojo Foundation
+ * Released under the MIT, BSD, and GPL Licenses.
+ * More information: http://sizzlejs.com/
+ */
+(function(){var bH=/((?:\((?:\([^()]+\)|[^()]+)+\)|\[(?:\[[^\[\]]*\]|['"][^'"]*['"]|[^\[\]'"]+)+\]|\\.|[^ >+~,(\[\\]+)+|[>+~])(\s*,\s*)?((?:.|\r|\n)*)/g,bC="sizcache"+(Math.random()+"").replace(".",""),bI=0,bL=Object.prototype.toString,bB=false,bA=true,bK=/\\/g,bO=/\r\n/g,bQ=/\W/;[0,0].sort(function(){bA=false;return 0});var by=function(bV,e,bY,bZ){bY=bY||[];e=e||av;var b1=e;if(e.nodeType!==1&&e.nodeType!==9){return[]}if(!bV||typeof bV!=="string"){return bY}var bS,b3,b6,bR,b2,b5,b4,bX,bU=true,bT=by.isXML(e),bW=[],b0=bV;do{bH.exec("");bS=bH.exec(b0);if(bS){b0=bS[3];bW.push(bS[1]);if(bS[2]){bR=bS[3];break}}}while(bS);if(bW.length>1&&bD.exec(bV)){if(bW.length===2&&bE.relative[bW[0]]){b3=bM(bW[0]+bW[1],e,bZ)}else{b3=bE.relative[bW[0]]?[e]:by(bW.shift(),e);while(bW.length){bV=bW.shift();if(bE.relative[bV]){bV+=bW.shift()}b3=bM(bV,b3,bZ)}}}else{if(!bZ&&bW.length>1&&e.nodeType===9&&!bT&&bE.match.ID.test(bW[0])&&!bE.match.ID.test(bW[bW.length-1])){b2=by.find(bW.shift(),e,bT);e=b2.expr?by.filter(b2.expr,b2.set)[0]:b2.set[0]}if(e){b2=bZ?{expr:bW.pop(),set:bF(bZ)}:by.find(bW.pop(),bW.length===1&&(bW[0]==="~"||bW[0]==="+")&&e.parentNode?e.parentNode:e,bT);b3=b2.expr?by.filter(b2.expr,b2.set):b2.set;if(bW.length>0){b6=bF(b3)}else{bU=false}while(bW.length){b5=bW.pop();b4=b5;if(!bE.relative[b5]){b5=""}else{b4=bW.pop()}if(b4==null){b4=e}bE.relative[b5](b6,b4,bT)}}else{b6=bW=[]}}if(!b6){b6=b3}if(!b6){by.error(b5||bV)}if(bL.call(b6)==="[object Array]"){if(!bU){bY.push.apply(bY,b6)}else{if(e&&e.nodeType===1){for(bX=0;b6[bX]!=null;bX++){if(b6[bX]&&(b6[bX]===true||b6[bX].nodeType===1&&by.contains(e,b6[bX]))){bY.push(b3[bX])}}}else{for(bX=0;b6[bX]!=null;bX++){if(b6[bX]&&b6[bX].nodeType===1){bY.push(b3[bX])}}}}}else{bF(b6,bY)}if(bR){by(bR,b1,bY,bZ);by.uniqueSort(bY)}return bY};by.uniqueSort=function(bR){if(bJ){bB=bA;bR.sort(bJ);if(bB){for(var e=1;e0};by.find=function(bX,e,bY){var bW,bS,bU,bT,bV,bR;if(!bX){return[]}for(bS=0,bU=bE.order.length;bS":function(bW,bR){var bV,bU=typeof bR==="string",bS=0,e=bW.length;if(bU&&!bQ.test(bR)){bR=bR.toLowerCase();for(;bS=0)){if(!bS){e.push(bV)}}else{if(bS){bR[bU]=false}}}}return false},ID:function(e){return e[1].replace(bK,"")},TAG:function(bR,e){return bR[1].replace(bK,"").toLowerCase()},CHILD:function(e){if(e[1]==="nth"){if(!e[2]){by.error(e[0])}e[2]=e[2].replace(/^\+|\s*/g,"");var bR=/(-?)(\d*)(?:n([+\-]?\d*))?/.exec(e[2]==="even"&&"2n"||e[2]==="odd"&&"2n+1"||!/\D/.test(e[2])&&"0n+"+e[2]||e[2]);e[2]=(bR[1]+(bR[2]||1))-0;e[3]=bR[3]-0}else{if(e[2]){by.error(e[0])}}e[0]=bI++;return e},ATTR:function(bU,bR,bS,e,bV,bW){var bT=bU[1]=bU[1].replace(bK,"");if(!bW&&bE.attrMap[bT]){bU[1]=bE.attrMap[bT]}bU[4]=(bU[4]||bU[5]||"").replace(bK,"");if(bU[2]==="~="){bU[4]=" "+bU[4]+" "}return bU},PSEUDO:function(bU,bR,bS,e,bV){if(bU[1]==="not"){if((bH.exec(bU[3])||"").length>1||/^\w/.test(bU[3])){bU[3]=by(bU[3],null,null,bR)}else{var bT=by.filter(bU[3],bR,bS,true^bV);if(!bS){e.push.apply(e,bT)}return false}}else{if(bE.match.POS.test(bU[0])||bE.match.CHILD.test(bU[0])){return true}}return bU},POS:function(e){e.unshift(true);return e}},filters:{enabled:function(e){return e.disabled===false&&e.type!=="hidden"},disabled:function(e){return e.disabled===true},checked:function(e){return e.checked===true},selected:function(e){if(e.parentNode){e.parentNode.selectedIndex}return e.selected===true},parent:function(e){return !!e.firstChild},empty:function(e){return !e.firstChild},has:function(bS,bR,e){return !!by(e[3],bS).length},header:function(e){return(/h\d/i).test(e.nodeName)},text:function(bS){var e=bS.getAttribute("type"),bR=bS.type;return bS.nodeName.toLowerCase()==="input"&&"text"===bR&&(e===bR||e===null)},radio:function(e){return e.nodeName.toLowerCase()==="input"&&"radio"===e.type},checkbox:function(e){return e.nodeName.toLowerCase()==="input"&&"checkbox"===e.type},file:function(e){return e.nodeName.toLowerCase()==="input"&&"file"===e.type},password:function(e){return e.nodeName.toLowerCase()==="input"&&"password"===e.type},submit:function(bR){var e=bR.nodeName.toLowerCase();return(e==="input"||e==="button")&&"submit"===bR.type},image:function(e){return e.nodeName.toLowerCase()==="input"&&"image"===e.type},reset:function(bR){var e=bR.nodeName.toLowerCase();return(e==="input"||e==="button")&&"reset"===bR.type},button:function(bR){var e=bR.nodeName.toLowerCase();return e==="input"&&"button"===bR.type||e==="button"},input:function(e){return(/input|select|textarea|button/i).test(e.nodeName)},focus:function(e){return e===e.ownerDocument.activeElement}},setFilters:{first:function(bR,e){return e===0},last:function(bS,bR,e,bT){return bR===bT.length-1},even:function(bR,e){return e%2===0},odd:function(bR,e){return e%2===1},lt:function(bS,bR,e){return bRe[3]-0},nth:function(bS,bR,e){return e[3]-0===bR},eq:function(bS,bR,e){return e[3]-0===bR}},filter:{PSEUDO:function(bS,bX,bW,bY){var e=bX[1],bR=bE.filters[e];if(bR){return bR(bS,bW,bX,bY)}else{if(e==="contains"){return(bS.textContent||bS.innerText||bw([bS])||"").indexOf(bX[3])>=0}else{if(e==="not"){var bT=bX[3];for(var bV=0,bU=bT.length;bV=0)}}},ID:function(bR,e){return bR.nodeType===1&&bR.getAttribute("id")===e},TAG:function(bR,e){return(e==="*"&&bR.nodeType===1)||!!bR.nodeName&&bR.nodeName.toLowerCase()===e},CLASS:function(bR,e){return(" "+(bR.className||bR.getAttribute("class"))+" ").indexOf(e)>-1},ATTR:function(bV,bT){var bS=bT[1],e=by.attr?by.attr(bV,bS):bE.attrHandle[bS]?bE.attrHandle[bS](bV):bV[bS]!=null?bV[bS]:bV.getAttribute(bS),bW=e+"",bU=bT[2],bR=bT[4];return e==null?bU==="!=":!bU&&by.attr?e!=null:bU==="="?bW===bR:bU==="*="?bW.indexOf(bR)>=0:bU==="~="?(" "+bW+" ").indexOf(bR)>=0:!bR?bW&&e!==false:bU==="!="?bW!==bR:bU==="^="?bW.indexOf(bR)===0:bU==="$="?bW.substr(bW.length-bR.length)===bR:bU==="|="?bW===bR||bW.substr(0,bR.length+1)===bR+"-":false},POS:function(bU,bR,bS,bV){var e=bR[2],bT=bE.setFilters[e];if(bT){return bT(bU,bS,bR,bV)}}}};var bD=bE.match.POS,bx=function(bR,e){return"\\"+(e-0+1)};for(var bz in bE.match){bE.match[bz]=new RegExp(bE.match[bz].source+(/(?![^\[]*\])(?![^\(]*\))/.source));bE.leftMatch[bz]=new RegExp(/(^(?:.|\r|\n)*?)/.source+bE.match[bz].source.replace(/\\(\d+)/g,bx))}var bF=function(bR,e){bR=Array.prototype.slice.call(bR,0);if(e){e.push.apply(e,bR);return e}return bR};try{Array.prototype.slice.call(av.documentElement.childNodes,0)[0].nodeType}catch(bP){bF=function(bU,bT){var bS=0,bR=bT||[];if(bL.call(bU)==="[object Array]"){Array.prototype.push.apply(bR,bU)}else{if(typeof bU.length==="number"){for(var e=bU.length;bS
";if(bT.querySelectorAll&&bT.querySelectorAll(".TEST").length===0){return}by=function(b4,bV,bZ,b3){bV=bV||av;if(!b3&&!by.isXML(bV)){var b2=/^(\w+$)|^\.([\w\-]+$)|^#([\w\-]+$)/.exec(b4);if(b2&&(bV.nodeType===1||bV.nodeType===9)){if(b2[1]){return bF(bV.getElementsByTagName(b4),bZ)}else{if(b2[2]&&bE.find.CLASS&&bV.getElementsByClassName){return bF(bV.getElementsByClassName(b2[2]),bZ)}}}if(bV.nodeType===9){if(b4==="body"&&bV.body){return bF([bV.body],bZ)}else{if(b2&&b2[3]){var bY=bV.getElementById(b2[3]);if(bY&&bY.parentNode){if(bY.id===b2[3]){return bF([bY],bZ)}}else{return bF([],bZ)}}}try{return bF(bV.querySelectorAll(b4),bZ)}catch(b0){}}else{if(bV.nodeType===1&&bV.nodeName.toLowerCase()!=="object"){var bW=bV,bX=bV.getAttribute("id"),bU=bX||bS,b6=bV.parentNode,b5=/^\s*[+~]/.test(b4);if(!bX){bV.setAttribute("id",bU)}else{bU=bU.replace(/'/g,"\\$&")}if(b5&&b6){bV=bV.parentNode}try{if(!b5||b6){return bF(bV.querySelectorAll("[id='"+bU+"'] "+b4),bZ)}}catch(b1){}finally{if(!bX){bW.removeAttribute("id")}}}}}return e(b4,bV,bZ,b3)};for(var bR in e){by[bR]=e[bR]}bT=null})()}(function(){var e=av.documentElement,bS=e.matchesSelector||e.mozMatchesSelector||e.webkitMatchesSelector||e.msMatchesSelector;if(bS){var bU=!bS.call(av.createElement("div"),"div"),bR=false;try{bS.call(av.documentElement,"[test!='']:sizzle")}catch(bT){bR=true}by.matchesSelector=function(bW,bY){bY=bY.replace(/\=\s*([^'"\]]*)\s*\]/g,"='$1']");if(!by.isXML(bW)){try{if(bR||!bE.match.PSEUDO.test(bY)&&!/!=/.test(bY)){var bV=bS.call(bW,bY);if(bV||!bU||bW.document&&bW.document.nodeType!==11){return bV}}}catch(bX){}}return by(bY,null,null,[bW]).length>0}}})();(function(){var e=av.createElement("div");e.innerHTML="
";if(!e.getElementsByClassName||e.getElementsByClassName("e").length===0){return}e.lastChild.className="e";if(e.getElementsByClassName("e").length===1){return}bE.order.splice(1,0,"CLASS");bE.find.CLASS=function(bR,bS,bT){if(typeof bS.getElementsByClassName!=="undefined"&&!bT){return bS.getElementsByClassName(bR[1])}};e=null})();function bv(bR,bW,bV,bZ,bX,bY){for(var bT=0,bS=bZ.length;bT0){bU=e;break}}}e=e[bR]}bZ[bT]=bU}}}if(av.documentElement.contains){by.contains=function(bR,e){return bR!==e&&(bR.contains?bR.contains(e):true)}}else{if(av.documentElement.compareDocumentPosition){by.contains=function(bR,e){return !!(bR.compareDocumentPosition(e)&16)}}else{by.contains=function(){return false}}}by.isXML=function(e){var bR=(e?e.ownerDocument||e:0).documentElement;return bR?bR.nodeName!=="HTML":false};var bM=function(bS,e,bW){var bV,bX=[],bU="",bY=e.nodeType?[e]:e;while((bV=bE.match.PSEUDO.exec(bS))){bU+=bV[0];bS=bS.replace(bE.match.PSEUDO,"")}bS=bE.relative[bS]?bS+"*":bS;for(var bT=0,bR=bY.length;bT0){for(bB=bA;bB=0:b.filter(e,this).length>0:this.filter(e).length>0)},closest:function(by,bx){var bv=[],bw,e,bz=this[0];if(b.isArray(by)){var bB=1;while(bz&&bz.ownerDocument&&bz!==bx){for(bw=0;bw-1:b.find.matchesSelector(bz,by)){bv.push(bz);break}else{bz=bz.parentNode;if(!bz||!bz.ownerDocument||bz===bx||bz.nodeType===11){break}}}}bv=bv.length>1?b.unique(bv):bv;return this.pushStack(bv,"closest",by)},index:function(e){if(!e){return(this[0]&&this[0].parentNode)?this.prevAll().length:-1}if(typeof e==="string"){return b.inArray(this[0],b(e))}return b.inArray(e.jquery?e[0]:e,this)},add:function(e,bv){var bx=typeof e==="string"?b(e,bv):b.makeArray(e&&e.nodeType?[e]:e),bw=b.merge(this.get(),bx);return this.pushStack(C(bx[0])||C(bw[0])?bw:b.unique(bw))},andSelf:function(){return this.add(this.prevObject)}});function C(e){return !e||!e.parentNode||e.parentNode.nodeType===11}b.each({parent:function(bv){var e=bv.parentNode;return e&&e.nodeType!==11?e:null},parents:function(e){return b.dir(e,"parentNode")},parentsUntil:function(bv,e,bw){return b.dir(bv,"parentNode",bw)},next:function(e){return b.nth(e,2,"nextSibling")},prev:function(e){return b.nth(e,2,"previousSibling")},nextAll:function(e){return b.dir(e,"nextSibling")},prevAll:function(e){return b.dir(e,"previousSibling")},nextUntil:function(bv,e,bw){return b.dir(bv,"nextSibling",bw)},prevUntil:function(bv,e,bw){return b.dir(bv,"previousSibling",bw)},siblings:function(e){return b.sibling(e.parentNode.firstChild,e)},children:function(e){return b.sibling(e.firstChild)},contents:function(e){return b.nodeName(e,"iframe")?e.contentDocument||e.contentWindow.document:b.makeArray(e.childNodes)}},function(e,bv){b.fn[e]=function(by,bw){var bx=b.map(this,bv,by);if(!ab.test(e)){bw=by}if(bw&&typeof bw==="string"){bx=b.filter(bw,bx)}bx=this.length>1&&!ay[e]?b.unique(bx):bx;if((this.length>1||a9.test(bw))&&aq.test(e)){bx=bx.reverse()}return this.pushStack(bx,e,P.call(arguments).join(","))}});b.extend({filter:function(bw,e,bv){if(bv){bw=":not("+bw+")"}return e.length===1?b.find.matchesSelector(e[0],bw)?[e[0]]:[]:b.find.matches(bw,e)},dir:function(bw,bv,by){var e=[],bx=bw[bv];while(bx&&bx.nodeType!==9&&(by===L||bx.nodeType!==1||!b(bx).is(by))){if(bx.nodeType===1){e.push(bx)}bx=bx[bv]}return e},nth:function(by,e,bw,bx){e=e||1;var bv=0;for(;by;by=by[bw]){if(by.nodeType===1&&++bv===e){break}}return by},sibling:function(bw,bv){var e=[];for(;bw;bw=bw.nextSibling){if(bw.nodeType===1&&bw!==bv){e.push(bw)}}return e}});function aG(bx,bw,e){bw=bw||0;if(b.isFunction(bw)){return b.grep(bx,function(bz,by){var bA=!!bw.call(bz,by,bz);return bA===e})}else{if(bw.nodeType){return b.grep(bx,function(bz,by){return(bz===bw)===e})}else{if(typeof bw==="string"){var bv=b.grep(bx,function(by){return by.nodeType===1});if(bp.test(bw)){return b.filter(bw,bv,!e)}else{bw=b.filter(bw,bv)}}}}return b.grep(bx,function(bz,by){return(b.inArray(bz,bw)>=0)===e})}function a(e){var bw=aR.split("|"),bv=e.createDocumentFragment();if(bv.createElement){while(bw.length){bv.createElement(bw.pop())}}return bv}var aR="abbr|article|aside|audio|canvas|datalist|details|figcaption|figure|footer|header|hgroup|mark|meter|nav|output|progress|section|summary|time|video",ag=/ jQuery\d+="(?:\d+|null)"/g,ar=/^\s+/,R=/<(?!area|br|col|embed|hr|img|input|link|meta|param)(([\w:]+)[^>]*)\/>/ig,d=/<([\w:]+)/,w=/",""],legend:[1,""," "],thead:[1,""],tr:[2,""],td:[3,""],col:[2,""],area:[1,""," "],_default:[0,"",""]},ac=a(av);ax.optgroup=ax.option;ax.tbody=ax.tfoot=ax.colgroup=ax.caption=ax.thead;ax.th=ax.td;if(!b.support.htmlSerialize){ax._default=[1,"div","
"]}b.fn.extend({text:function(e){if(b.isFunction(e)){return this.each(function(bw){var bv=b(this);bv.text(e.call(this,bw,bv.text()))})}if(typeof e!=="object"&&e!==L){return this.empty().append((this[0]&&this[0].ownerDocument||av).createTextNode(e))}return b.text(this)},wrapAll:function(e){if(b.isFunction(e)){return this.each(function(bw){b(this).wrapAll(e.call(this,bw))})}if(this[0]){var bv=b(e,this[0].ownerDocument).eq(0).clone(true);if(this[0].parentNode){bv.insertBefore(this[0])}bv.map(function(){var bw=this;while(bw.firstChild&&bw.firstChild.nodeType===1){bw=bw.firstChild}return bw}).append(this)}return this},wrapInner:function(e){if(b.isFunction(e)){return this.each(function(bv){b(this).wrapInner(e.call(this,bv))})}return this.each(function(){var bv=b(this),bw=bv.contents();if(bw.length){bw.wrapAll(e)}else{bv.append(e)}})},wrap:function(e){var bv=b.isFunction(e);return this.each(function(bw){b(this).wrapAll(bv?e.call(this,bw):e)})},unwrap:function(){return this.parent().each(function(){if(!b.nodeName(this,"body")){b(this).replaceWith(this.childNodes)}}).end()},append:function(){return this.domManip(arguments,true,function(e){if(this.nodeType===1){this.appendChild(e)}})},prepend:function(){return this.domManip(arguments,true,function(e){if(this.nodeType===1){this.insertBefore(e,this.firstChild)}})},before:function(){if(this[0]&&this[0].parentNode){return this.domManip(arguments,false,function(bv){this.parentNode.insertBefore(bv,this)})}else{if(arguments.length){var e=b.clean(arguments);e.push.apply(e,this.toArray());return this.pushStack(e,"before",arguments)}}},after:function(){if(this[0]&&this[0].parentNode){return this.domManip(arguments,false,function(bv){this.parentNode.insertBefore(bv,this.nextSibling)})}else{if(arguments.length){var e=this.pushStack(this,"after",arguments);e.push.apply(e,b.clean(arguments));return e}}},remove:function(e,bx){for(var bv=0,bw;(bw=this[bv])!=null;bv++){if(!e||b.filter(e,[bw]).length){if(!bx&&bw.nodeType===1){b.cleanData(bw.getElementsByTagName("*"));b.cleanData([bw])}if(bw.parentNode){bw.parentNode.removeChild(bw)}}}return this},empty:function(){for(var e=0,bv;(bv=this[e])!=null;e++){if(bv.nodeType===1){b.cleanData(bv.getElementsByTagName("*"))}while(bv.firstChild){bv.removeChild(bv.firstChild)}}return this},clone:function(bv,e){bv=bv==null?false:bv;e=e==null?bv:e;return this.map(function(){return b.clone(this,bv,e)})},html:function(bx){if(bx===L){return this[0]&&this[0].nodeType===1?this[0].innerHTML.replace(ag,""):null}else{if(typeof bx==="string"&&!ae.test(bx)&&(b.support.leadingWhitespace||!ar.test(bx))&&!ax[(d.exec(bx)||["",""])[1].toLowerCase()]){bx=bx.replace(R,"<$1>");try{for(var bw=0,bv=this.length;bw1&&bw0?this.clone(true):this).get();b(bC[bA])[bv](by);bz=bz.concat(by)}return this.pushStack(bz,e,bC.selector)}}});function bg(e){if(typeof e.getElementsByTagName!=="undefined"){return e.getElementsByTagName("*")}else{if(typeof e.querySelectorAll!=="undefined"){return e.querySelectorAll("*")}else{return[]}}}function az(e){if(e.type==="checkbox"||e.type==="radio"){e.defaultChecked=e.checked}}function E(e){var bv=(e.nodeName||"").toLowerCase();if(bv==="input"){az(e)}else{if(bv!=="script"&&typeof e.getElementsByTagName!=="undefined"){b.grep(e.getElementsByTagName("input"),az)}}}function al(e){var bv=av.createElement("div");ac.appendChild(bv);bv.innerHTML=e.outerHTML;return bv.firstChild}b.extend({clone:function(by,bA,bw){var e,bv,bx,bz=b.support.html5Clone||!ah.test("<"+by.nodeName)?by.cloneNode(true):al(by);if((!b.support.noCloneEvent||!b.support.noCloneChecked)&&(by.nodeType===1||by.nodeType===11)&&!b.isXMLDoc(by)){ai(by,bz);e=bg(by);bv=bg(bz);for(bx=0;e[bx];++bx){if(bv[bx]){ai(e[bx],bv[bx])}}}if(bA){t(by,bz);if(bw){e=bg(by);bv=bg(bz);for(bx=0;e[bx];++bx){t(e[bx],bv[bx])}}}e=bv=null;return bz},clean:function(bw,by,bH,bA){var bF;by=by||av;if(typeof by.createElement==="undefined"){by=by.ownerDocument||by[0]&&by[0].ownerDocument||av}var bI=[],bB;for(var bE=0,bz;(bz=bw[bE])!=null;bE++){if(typeof bz==="number"){bz+=""}if(!bz){continue}if(typeof bz==="string"){if(!W.test(bz)){bz=by.createTextNode(bz)}else{bz=bz.replace(R,"<$1>");var bK=(d.exec(bz)||["",""])[1].toLowerCase(),bx=ax[bK]||ax._default,bD=bx[0],bv=by.createElement("div");if(by===av){ac.appendChild(bv)}else{a(by).appendChild(bv)}bv.innerHTML=bx[1]+bz+bx[2];while(bD--){bv=bv.lastChild}if(!b.support.tbody){var e=w.test(bz),bC=bK==="table"&&!e?bv.firstChild&&bv.firstChild.childNodes:bx[1]===""&&!e?bv.childNodes:[];for(bB=bC.length-1;bB>=0;--bB){if(b.nodeName(bC[bB],"tbody")&&!bC[bB].childNodes.length){bC[bB].parentNode.removeChild(bC[bB])}}}if(!b.support.leadingWhitespace&&ar.test(bz)){bv.insertBefore(by.createTextNode(ar.exec(bz)[0]),bv.firstChild)}bz=bv.childNodes}}var bG;if(!b.support.appendChecked){if(bz[0]&&typeof(bG=bz.length)==="number"){for(bB=0;bB=0){return bx+"px"}}else{return bx}}}});if(!b.support.opacity){b.cssHooks.opacity={get:function(bv,e){return au.test((e&&bv.currentStyle?bv.currentStyle.filter:bv.style.filter)||"")?(parseFloat(RegExp.$1)/100)+"":e?"1":""},set:function(by,bz){var bx=by.style,bv=by.currentStyle,e=b.isNumeric(bz)?"alpha(opacity="+bz*100+")":"",bw=bv&&bv.filter||bx.filter||"";bx.zoom=1;if(bz>=1&&b.trim(bw.replace(ak,""))===""){bx.removeAttribute("filter");if(bv&&!bv.filter){return}}bx.filter=ak.test(bw)?bw.replace(ak,e):bw+" "+e}}}b(function(){if(!b.support.reliableMarginRight){b.cssHooks.marginRight={get:function(bw,bv){var e;b.swap(bw,{display:"inline-block"},function(){if(bv){e=Z(bw,"margin-right","marginRight")}else{e=bw.style.marginRight}});return e}}}});if(av.defaultView&&av.defaultView.getComputedStyle){aI=function(by,bw){var bv,bx,e;bw=bw.replace(z,"-$1").toLowerCase();if((bx=by.ownerDocument.defaultView)&&(e=bx.getComputedStyle(by,null))){bv=e.getPropertyValue(bw);if(bv===""&&!b.contains(by.ownerDocument.documentElement,by)){bv=b.style(by,bw)}}return bv}}if(av.documentElement.currentStyle){aX=function(bz,bw){var bA,e,by,bv=bz.currentStyle&&bz.currentStyle[bw],bx=bz.style;if(bv===null&&bx&&(by=bx[bw])){bv=by}if(!bc.test(bv)&&bn.test(bv)){bA=bx.left;e=bz.runtimeStyle&&bz.runtimeStyle.left;if(e){bz.runtimeStyle.left=bz.currentStyle.left}bx.left=bw==="fontSize"?"1em":(bv||0);bv=bx.pixelLeft+"px";bx.left=bA;if(e){bz.runtimeStyle.left=e}}return bv===""?"auto":bv}}Z=aI||aX;function p(by,bw,bv){var bA=bw==="width"?by.offsetWidth:by.offsetHeight,bz=bw==="width"?an:a1,bx=0,e=bz.length;if(bA>0){if(bv!=="border"){for(;bx)<[^<]*)*<\/script>/gi,q=/^(?:select|textarea)/i,h=/\s+/,br=/([?&])_=[^&]*/,K=/^([\w\+\.\-]+:)(?:\/\/([^\/?#:]*)(?::(\d+))?)?/,A=b.fn.load,aa={},r={},aE,s,aV=["*/"]+["*"];try{aE=bl.href}catch(aw){aE=av.createElement("a");aE.href="";aE=aE.href}s=K.exec(aE.toLowerCase())||[];function f(e){return function(by,bA){if(typeof by!=="string"){bA=by;by="*"}if(b.isFunction(bA)){var bx=by.toLowerCase().split(h),bw=0,bz=bx.length,bv,bB,bC;for(;bw=0){var e=bw.slice(by,bw.length);bw=bw.slice(0,by)}var bx="GET";if(bz){if(b.isFunction(bz)){bA=bz;bz=L}else{if(typeof bz==="object"){bz=b.param(bz,b.ajaxSettings.traditional);bx="POST"}}}var bv=this;b.ajax({url:bw,type:bx,dataType:"html",data:bz,complete:function(bC,bB,bD){bD=bC.responseText;if(bC.isResolved()){bC.done(function(bE){bD=bE});bv.html(e?b("").append(bD.replace(a6,"")).find(e):bD)}if(bA){bv.each(bA,[bD,bB,bC])}}});return this},serialize:function(){return b.param(this.serializeArray())},serializeArray:function(){return this.map(function(){return this.elements?b.makeArray(this.elements):this}).filter(function(){return this.name&&!this.disabled&&(this.checked||q.test(this.nodeName)||aZ.test(this.type))}).map(function(e,bv){var bw=b(this).val();return bw==null?null:b.isArray(bw)?b.map(bw,function(by,bx){return{name:bv.name,value:by.replace(bs,"\r\n")}}):{name:bv.name,value:bw.replace(bs,"\r\n")}}).get()}});b.each("ajaxStart ajaxStop ajaxComplete ajaxError ajaxSuccess ajaxSend".split(" "),function(e,bv){b.fn[bv]=function(bw){return this.on(bv,bw)}});b.each(["get","post"],function(e,bv){b[bv]=function(bw,by,bz,bx){if(b.isFunction(by)){bx=bx||bz;bz=by;by=L}return b.ajax({type:bv,url:bw,data:by,success:bz,dataType:bx})}});b.extend({getScript:function(e,bv){return b.get(e,L,bv,"script")},getJSON:function(e,bv,bw){return b.get(e,bv,bw,"json")},ajaxSetup:function(bv,e){if(e){am(bv,b.ajaxSettings)}else{e=bv;bv=b.ajaxSettings}am(bv,e);return bv},ajaxSettings:{url:aE,isLocal:aM.test(s[1]),global:true,type:"GET",contentType:"application/x-www-form-urlencoded",processData:true,async:true,accepts:{xml:"application/xml, text/xml",html:"text/html",text:"text/plain",json:"application/json, text/javascript","*":aV},contents:{xml:/xml/,html:/html/,json:/json/},responseFields:{xml:"responseXML",text:"responseText"},converters:{"* text":bb.String,"text html":true,"text json":b.parseJSON,"text xml":b.parseXML},flatOptions:{context:true,url:true}},ajaxPrefilter:f(aa),ajaxTransport:f(r),ajax:function(bz,bx){if(typeof bz==="object"){bx=bz;bz=L}bx=bx||{};var bD=b.ajaxSetup({},bx),bS=bD.context||bD,bG=bS!==bD&&(bS.nodeType||bS instanceof b)?b(bS):b.event,bR=b.Deferred(),bN=b.Callbacks("once memory"),bB=bD.statusCode||{},bC,bH={},bO={},bQ,by,bL,bE,bI,bA=0,bw,bK,bJ={readyState:0,setRequestHeader:function(bT,bU){if(!bA){var e=bT.toLowerCase();bT=bO[e]=bO[e]||bT;bH[bT]=bU}return this},getAllResponseHeaders:function(){return bA===2?bQ:null},getResponseHeader:function(bT){var e;if(bA===2){if(!by){by={};while((e=aD.exec(bQ))){by[e[1].toLowerCase()]=e[2]}}e=by[bT.toLowerCase()]}return e===L?null:e},overrideMimeType:function(e){if(!bA){bD.mimeType=e}return this},abort:function(e){e=e||"abort";if(bL){bL.abort(e)}bF(0,e);return this}};function bF(bZ,bU,b0,bW){if(bA===2){return}bA=2;if(bE){clearTimeout(bE)}bL=L;bQ=bW||"";bJ.readyState=bZ>0?4:0;var bT,b4,b3,bX=bU,bY=b0?bj(bD,bJ,b0):L,bV,b2;if(bZ>=200&&bZ<300||bZ===304){if(bD.ifModified){if((bV=bJ.getResponseHeader("Last-Modified"))){b.lastModified[bC]=bV}if((b2=bJ.getResponseHeader("Etag"))){b.etag[bC]=b2}}if(bZ===304){bX="notmodified";bT=true}else{try{b4=G(bD,bY);bX="success";bT=true}catch(b1){bX="parsererror";b3=b1}}}else{b3=bX;if(!bX||bZ){bX="error";if(bZ<0){bZ=0}}}bJ.status=bZ;bJ.statusText=""+(bU||bX);if(bT){bR.resolveWith(bS,[b4,bX,bJ])}else{bR.rejectWith(bS,[bJ,bX,b3])}bJ.statusCode(bB);bB=L;if(bw){bG.trigger("ajax"+(bT?"Success":"Error"),[bJ,bD,bT?b4:b3])}bN.fireWith(bS,[bJ,bX]);if(bw){bG.trigger("ajaxComplete",[bJ,bD]);if(!(--b.active)){b.event.trigger("ajaxStop")}}}bR.promise(bJ);bJ.success=bJ.done;bJ.error=bJ.fail;bJ.complete=bN.add;bJ.statusCode=function(bT){if(bT){var e;if(bA<2){for(e in bT){bB[e]=[bB[e],bT[e]]}}else{e=bT[bJ.status];bJ.then(e,e)}}return this};bD.url=((bz||bD.url)+"").replace(bq,"").replace(c,s[1]+"//");bD.dataTypes=b.trim(bD.dataType||"*").toLowerCase().split(h);if(bD.crossDomain==null){bI=K.exec(bD.url.toLowerCase());bD.crossDomain=!!(bI&&(bI[1]!=s[1]||bI[2]!=s[2]||(bI[3]||(bI[1]==="http:"?80:443))!=(s[3]||(s[1]==="http:"?80:443))))}if(bD.data&&bD.processData&&typeof bD.data!=="string"){bD.data=b.param(bD.data,bD.traditional)}aW(aa,bD,bx,bJ);if(bA===2){return false}bw=bD.global;bD.type=bD.type.toUpperCase();bD.hasContent=!aQ.test(bD.type);if(bw&&b.active++===0){b.event.trigger("ajaxStart")}if(!bD.hasContent){if(bD.data){bD.url+=(M.test(bD.url)?"&":"?")+bD.data;delete bD.data}bC=bD.url;if(bD.cache===false){var bv=b.now(),bP=bD.url.replace(br,"$1_="+bv);bD.url=bP+((bP===bD.url)?(M.test(bD.url)?"&":"?")+"_="+bv:"")}}if(bD.data&&bD.hasContent&&bD.contentType!==false||bx.contentType){bJ.setRequestHeader("Content-Type",bD.contentType)}if(bD.ifModified){bC=bC||bD.url;if(b.lastModified[bC]){bJ.setRequestHeader("If-Modified-Since",b.lastModified[bC])}if(b.etag[bC]){bJ.setRequestHeader("If-None-Match",b.etag[bC])}}bJ.setRequestHeader("Accept",bD.dataTypes[0]&&bD.accepts[bD.dataTypes[0]]?bD.accepts[bD.dataTypes[0]]+(bD.dataTypes[0]!=="*"?", "+aV+"; q=0.01":""):bD.accepts["*"]);for(bK in bD.headers){bJ.setRequestHeader(bK,bD.headers[bK])}if(bD.beforeSend&&(bD.beforeSend.call(bS,bJ,bD)===false||bA===2)){bJ.abort();return false}for(bK in {success:1,error:1,complete:1}){bJ[bK](bD[bK])}bL=aW(r,bD,bx,bJ);if(!bL){bF(-1,"No Transport")}else{bJ.readyState=1;if(bw){bG.trigger("ajaxSend",[bJ,bD])}if(bD.async&&bD.timeout>0){bE=setTimeout(function(){bJ.abort("timeout")},bD.timeout)}try{bA=1;bL.send(bH,bF)}catch(bM){if(bA<2){bF(-1,bM)}else{throw bM}}}return bJ},param:function(e,bw){var bv=[],by=function(bz,bA){bA=b.isFunction(bA)?bA():bA;bv[bv.length]=encodeURIComponent(bz)+"="+encodeURIComponent(bA)};if(bw===L){bw=b.ajaxSettings.traditional}if(b.isArray(e)||(e.jquery&&!b.isPlainObject(e))){b.each(e,function(){by(this.name,this.value)})}else{for(var bx in e){v(bx,e[bx],bw,by)}}return bv.join("&").replace(k,"+")}});function v(bw,by,bv,bx){if(b.isArray(by)){b.each(by,function(bA,bz){if(bv||ap.test(bw)){bx(bw,bz)}else{v(bw+"["+(typeof bz==="object"||b.isArray(bz)?bA:"")+"]",bz,bv,bx)}})}else{if(!bv&&by!=null&&typeof by==="object"){for(var e in by){v(bw+"["+e+"]",by[e],bv,bx)}}else{bx(bw,by)}}}b.extend({active:0,lastModified:{},etag:{}});function bj(bD,bC,bz){var bv=bD.contents,bB=bD.dataTypes,bw=bD.responseFields,by,bA,bx,e;for(bA in bw){if(bA in bz){bC[bw[bA]]=bz[bA]}}while(bB[0]==="*"){bB.shift();if(by===L){by=bD.mimeType||bC.getResponseHeader("content-type")}}if(by){for(bA in bv){if(bv[bA]&&bv[bA].test(by)){bB.unshift(bA);break}}}if(bB[0] in bz){bx=bB[0]}else{for(bA in bz){if(!bB[0]||bD.converters[bA+" "+bB[0]]){bx=bA;break}if(!e){e=bA}}bx=bx||e}if(bx){if(bx!==bB[0]){bB.unshift(bx)}return bz[bx]}}function G(bH,bz){if(bH.dataFilter){bz=bH.dataFilter(bz,bH.dataType)}var bD=bH.dataTypes,bG={},bA,bE,bw=bD.length,bB,bC=bD[0],bx,by,bF,bv,e;for(bA=1;bA
=bw.duration+this.startTime){this.now=this.end;this.pos=this.state=1;this.update();bw.animatedProperties[this.prop]=true;for(bA in bw.animatedProperties){if(bw.animatedProperties[bA]!==true){e=false}}if(e){if(bw.overflow!=null&&!b.support.shrinkWrapBlocks){b.each(["","X","Y"],function(bC,bD){bz.style["overflow"+bD]=bw.overflow[bC]})}if(bw.hide){b(bz).hide()}if(bw.hide||bw.show){for(bA in bw.animatedProperties){b.style(bz,bA,bw.orig[bA]);b.removeData(bz,"fxshow"+bA,true);b.removeData(bz,"toggle"+bA,true)}}bv=bw.complete;if(bv){bw.complete=false;bv.call(bz)}}return false}else{if(bw.duration==Infinity){this.now=bx}else{bB=bx-this.startTime;this.state=bB/bw.duration;this.pos=b.easing[bw.animatedProperties[this.prop]](this.state,bB,0,1,bw.duration);this.now=this.start+((this.end-this.start)*this.pos)}this.update()}return true}};b.extend(b.fx,{tick:function(){var bw,bv=b.timers,e=0;for(;e").appendTo(e),bw=bv.css("display");bv.remove();if(bw==="none"||bw===""){if(!a8){a8=av.createElement("iframe");a8.frameBorder=a8.width=a8.height=0}e.appendChild(a8);if(!m||!a8.createElement){m=(a8.contentWindow||a8.contentDocument).document;m.write((av.compatMode==="CSS1Compat"?"":"")+"");m.close()}bv=m.createElement(bx);m.body.appendChild(bv);bw=b.css(bv,"display");e.removeChild(a8)}Q[bx]=bw}return Q[bx]}var V=/^t(?:able|d|h)$/i,ad=/^(?:body|html)$/i;if("getBoundingClientRect" in av.documentElement){b.fn.offset=function(bI){var by=this[0],bB;if(bI){return this.each(function(e){b.offset.setOffset(this,bI,e)})}if(!by||!by.ownerDocument){return null}if(by===by.ownerDocument.body){return b.offset.bodyOffset(by)}try{bB=by.getBoundingClientRect()}catch(bF){}var bH=by.ownerDocument,bw=bH.documentElement;if(!bB||!b.contains(bw,by)){return bB?{top:bB.top,left:bB.left}:{top:0,left:0}}var bC=bH.body,bD=aK(bH),bA=bw.clientTop||bC.clientTop||0,bE=bw.clientLeft||bC.clientLeft||0,bv=bD.pageYOffset||b.support.boxModel&&bw.scrollTop||bC.scrollTop,bz=bD.pageXOffset||b.support.boxModel&&bw.scrollLeft||bC.scrollLeft,bG=bB.top+bv-bA,bx=bB.left+bz-bE;return{top:bG,left:bx}}}else{b.fn.offset=function(bF){var bz=this[0];if(bF){return this.each(function(bG){b.offset.setOffset(this,bF,bG)})}if(!bz||!bz.ownerDocument){return null}if(bz===bz.ownerDocument.body){return b.offset.bodyOffset(bz)}var bC,bw=bz.offsetParent,bv=bz,bE=bz.ownerDocument,bx=bE.documentElement,bA=bE.body,bB=bE.defaultView,e=bB?bB.getComputedStyle(bz,null):bz.currentStyle,bD=bz.offsetTop,by=bz.offsetLeft;while((bz=bz.parentNode)&&bz!==bA&&bz!==bx){if(b.support.fixedPosition&&e.position==="fixed"){break}bC=bB?bB.getComputedStyle(bz,null):bz.currentStyle;bD-=bz.scrollTop;by-=bz.scrollLeft;if(bz===bw){bD+=bz.offsetTop;by+=bz.offsetLeft;if(b.support.doesNotAddBorder&&!(b.support.doesAddBorderForTableAndCells&&V.test(bz.nodeName))){bD+=parseFloat(bC.borderTopWidth)||0;by+=parseFloat(bC.borderLeftWidth)||0}bv=bw;bw=bz.offsetParent}if(b.support.subtractsBorderForOverflowNotVisible&&bC.overflow!=="visible"){bD+=parseFloat(bC.borderTopWidth)||0;by+=parseFloat(bC.borderLeftWidth)||0}e=bC}if(e.position==="relative"||e.position==="static"){bD+=bA.offsetTop;by+=bA.offsetLeft}if(b.support.fixedPosition&&e.position==="fixed"){bD+=Math.max(bx.scrollTop,bA.scrollTop);by+=Math.max(bx.scrollLeft,bA.scrollLeft)}return{top:bD,left:by}}}b.offset={bodyOffset:function(e){var bw=e.offsetTop,bv=e.offsetLeft;if(b.support.doesNotIncludeMarginInBodyOffset){bw+=parseFloat(b.css(e,"marginTop"))||0;bv+=parseFloat(b.css(e,"marginLeft"))||0}return{top:bw,left:bv}},setOffset:function(bx,bG,bA){var bB=b.css(bx,"position");if(bB==="static"){bx.style.position="relative"}var bz=b(bx),bv=bz.offset(),e=b.css(bx,"top"),bE=b.css(bx,"left"),bF=(bB==="absolute"||bB==="fixed")&&b.inArray("auto",[e,bE])>-1,bD={},bC={},bw,by;if(bF){bC=bz.position();bw=bC.top;by=bC.left}else{bw=parseFloat(e)||0;by=parseFloat(bE)||0}if(b.isFunction(bG)){bG=bG.call(bx,bA,bv)}if(bG.top!=null){bD.top=(bG.top-bv.top)+bw}if(bG.left!=null){bD.left=(bG.left-bv.left)+by}if("using" in bG){bG.using.call(bx,bD)}else{bz.css(bD)}}};b.fn.extend({position:function(){if(!this[0]){return null}var bw=this[0],bv=this.offsetParent(),bx=this.offset(),e=ad.test(bv[0].nodeName)?{top:0,left:0}:bv.offset();bx.top-=parseFloat(b.css(bw,"marginTop"))||0;bx.left-=parseFloat(b.css(bw,"marginLeft"))||0;e.top+=parseFloat(b.css(bv[0],"borderTopWidth"))||0;e.left+=parseFloat(b.css(bv[0],"borderLeftWidth"))||0;return{top:bx.top-e.top,left:bx.left-e.left}},offsetParent:function(){return this.map(function(){var e=this.offsetParent||av.body;while(e&&(!ad.test(e.nodeName)&&b.css(e,"position")==="static")){e=e.offsetParent}return e})}});b.each(["Left","Top"],function(bv,e){var bw="scroll"+e;b.fn[bw]=function(bz){var bx,by;if(bz===L){bx=this[0];if(!bx){return null}by=aK(bx);return by?("pageXOffset" in by)?by[bv?"pageYOffset":"pageXOffset"]:b.support.boxModel&&by.document.documentElement[bw]||by.document.body[bw]:bx[bw]}return this.each(function(){by=aK(this);if(by){by.scrollTo(!bv?bz:b(by).scrollLeft(),bv?bz:b(by).scrollTop())}else{this[bw]=bz}})}});function aK(e){return b.isWindow(e)?e:e.nodeType===9?e.defaultView||e.parentWindow:false}b.each(["Height","Width"],function(bv,e){var bw=e.toLowerCase();b.fn["inner"+e]=function(){var bx=this[0];return bx?bx.style?parseFloat(b.css(bx,bw,"padding")):this[bw]():null};b.fn["outer"+e]=function(by){var bx=this[0];return bx?bx.style?parseFloat(b.css(bx,bw,by?"margin":"border")):this[bw]():null};b.fn[bw]=function(bz){var bA=this[0];if(!bA){return bz==null?null:this}if(b.isFunction(bz)){return this.each(function(bE){var bD=b(this);bD[bw](bz.call(this,bE,bD[bw]()))})}if(b.isWindow(bA)){var bB=bA.document.documentElement["client"+e],bx=bA.document.body;return bA.document.compatMode==="CSS1Compat"&&bB||bx&&bx["client"+e]||bB}else{if(bA.nodeType===9){return Math.max(bA.documentElement["client"+e],bA.body["scroll"+e],bA.documentElement["scroll"+e],bA.body["offset"+e],bA.documentElement["offset"+e])}else{if(bz===L){var bC=b.css(bA,bw),by=parseFloat(bC);return b.isNumeric(by)?by:bC}else{return this.css(bw,typeof bz==="string"?bz:bz+"px")}}}}});bb.jQuery=bb.$=b;if(typeof define==="function"&&define.amd&&define.amd.jQuery){define("jquery",[],function(){return b})}})(window);/*!
+ * jQuery UI 1.8.18
+ *
+ * Copyright 2011, AUTHORS.txt (http://jqueryui.com/about)
+ * Dual licensed under the MIT or GPL Version 2 licenses.
+ * http://jquery.org/license
+ *
+ * http://docs.jquery.com/UI
+ */
+(function(a,d){a.ui=a.ui||{};if(a.ui.version){return}a.extend(a.ui,{version:"1.8.18",keyCode:{ALT:18,BACKSPACE:8,CAPS_LOCK:20,COMMA:188,COMMAND:91,COMMAND_LEFT:91,COMMAND_RIGHT:93,CONTROL:17,DELETE:46,DOWN:40,END:35,ENTER:13,ESCAPE:27,HOME:36,INSERT:45,LEFT:37,MENU:93,NUMPAD_ADD:107,NUMPAD_DECIMAL:110,NUMPAD_DIVIDE:111,NUMPAD_ENTER:108,NUMPAD_MULTIPLY:106,NUMPAD_SUBTRACT:109,PAGE_DOWN:34,PAGE_UP:33,PERIOD:190,RIGHT:39,SHIFT:16,SPACE:32,TAB:9,UP:38,WINDOWS:91}});a.fn.extend({propAttr:a.fn.prop||a.fn.attr,_focus:a.fn.focus,focus:function(e,f){return typeof e==="number"?this.each(function(){var g=this;setTimeout(function(){a(g).focus();if(f){f.call(g)}},e)}):this._focus.apply(this,arguments)},scrollParent:function(){var e;if((a.browser.msie&&(/(static|relative)/).test(this.css("position")))||(/absolute/).test(this.css("position"))){e=this.parents().filter(function(){return(/(relative|absolute|fixed)/).test(a.curCSS(this,"position",1))&&(/(auto|scroll)/).test(a.curCSS(this,"overflow",1)+a.curCSS(this,"overflow-y",1)+a.curCSS(this,"overflow-x",1))}).eq(0)}else{e=this.parents().filter(function(){return(/(auto|scroll)/).test(a.curCSS(this,"overflow",1)+a.curCSS(this,"overflow-y",1)+a.curCSS(this,"overflow-x",1))}).eq(0)}return(/fixed/).test(this.css("position"))||!e.length?a(document):e},zIndex:function(h){if(h!==d){return this.css("zIndex",h)}if(this.length){var f=a(this[0]),e,g;while(f.length&&f[0]!==document){e=f.css("position");if(e==="absolute"||e==="relative"||e==="fixed"){g=parseInt(f.css("zIndex"),10);if(!isNaN(g)&&g!==0){return g}}f=f.parent()}}return 0},disableSelection:function(){return this.bind((a.support.selectstart?"selectstart":"mousedown")+".ui-disableSelection",function(e){e.preventDefault()})},enableSelection:function(){return this.unbind(".ui-disableSelection")}});a.each(["Width","Height"],function(g,e){var f=e==="Width"?["Left","Right"]:["Top","Bottom"],h=e.toLowerCase(),k={innerWidth:a.fn.innerWidth,innerHeight:a.fn.innerHeight,outerWidth:a.fn.outerWidth,outerHeight:a.fn.outerHeight};function j(m,l,i,n){a.each(f,function(){l-=parseFloat(a.curCSS(m,"padding"+this,true))||0;if(i){l-=parseFloat(a.curCSS(m,"border"+this+"Width",true))||0}if(n){l-=parseFloat(a.curCSS(m,"margin"+this,true))||0}});return l}a.fn["inner"+e]=function(i){if(i===d){return k["inner"+e].call(this)}return this.each(function(){a(this).css(h,j(this,i)+"px")})};a.fn["outer"+e]=function(i,l){if(typeof i!=="number"){return k["outer"+e].call(this,i)}return this.each(function(){a(this).css(h,j(this,i,true,l)+"px")})}});function c(g,e){var j=g.nodeName.toLowerCase();if("area"===j){var i=g.parentNode,h=i.name,f;if(!g.href||!h||i.nodeName.toLowerCase()!=="map"){return false}f=a("img[usemap=#"+h+"]")[0];return !!f&&b(f)}return(/input|select|textarea|button|object/.test(j)?!g.disabled:"a"==j?g.href||e:e)&&b(g)}function b(e){return !a(e).parents().andSelf().filter(function(){return a.curCSS(this,"visibility")==="hidden"||a.expr.filters.hidden(this)}).length}a.extend(a.expr[":"],{data:function(g,f,e){return !!a.data(g,e[3])},focusable:function(e){return c(e,!isNaN(a.attr(e,"tabindex")))},tabbable:function(g){var e=a.attr(g,"tabindex"),f=isNaN(e);return(f||e>=0)&&c(g,!f)}});a(function(){var e=document.body,f=e.appendChild(f=document.createElement("div"));f.offsetHeight;a.extend(f.style,{minHeight:"100px",height:"auto",padding:0,borderWidth:0});a.support.minHeight=f.offsetHeight===100;a.support.selectstart="onselectstart" in f;e.removeChild(f).style.display="none"});a.extend(a.ui,{plugin:{add:function(f,g,j){var h=a.ui[f].prototype;for(var e in j){h.plugins[e]=h.plugins[e]||[];h.plugins[e].push([g,j[e]])}},call:function(e,g,f){var j=e.plugins[g];if(!j||!e.element[0].parentNode){return}for(var h=0;h0){return true}h[e]=1;g=(h[e]>0);h[e]=0;return g},isOverAxis:function(f,e,g){return(f>e)&&(f<(e+g))},isOver:function(j,f,i,h,e,g){return a.ui.isOverAxis(j,i,e)&&a.ui.isOverAxis(f,h,g)}})})(jQuery);/*!
+ * jQuery UI Widget 1.8.18
+ *
+ * Copyright 2011, AUTHORS.txt (http://jqueryui.com/about)
+ * Dual licensed under the MIT or GPL Version 2 licenses.
+ * http://jquery.org/license
+ *
+ * http://docs.jquery.com/UI/Widget
+ */
+(function(b,d){if(b.cleanData){var c=b.cleanData;b.cleanData=function(f){for(var g=0,h;(h=f[g])!=null;g++){try{b(h).triggerHandler("remove")}catch(j){}}c(f)}}else{var a=b.fn.remove;b.fn.remove=function(e,f){return this.each(function(){if(!f){if(!e||b.filter(e,[this]).length){b("*",this).add([this]).each(function(){try{b(this).triggerHandler("remove")}catch(g){}})}}return a.call(b(this),e,f)})}}b.widget=function(f,h,e){var g=f.split(".")[0],j;f=f.split(".")[1];j=g+"-"+f;if(!e){e=h;h=b.Widget}b.expr[":"][j]=function(k){return !!b.data(k,f)};b[g]=b[g]||{};b[g][f]=function(k,l){if(arguments.length){this._createWidget(k,l)}};var i=new h();i.options=b.extend(true,{},i.options);b[g][f].prototype=b.extend(true,i,{namespace:g,widgetName:f,widgetEventPrefix:b[g][f].prototype.widgetEventPrefix||f,widgetBaseClass:j},e);b.widget.bridge(f,b[g][f])};b.widget.bridge=function(f,e){b.fn[f]=function(i){var g=typeof i==="string",h=Array.prototype.slice.call(arguments,1),j=this;i=!g&&h.length?b.extend.apply(null,[true,i].concat(h)):i;if(g&&i.charAt(0)==="_"){return j}if(g){this.each(function(){var k=b.data(this,f),l=k&&b.isFunction(k[i])?k[i].apply(k,h):k;if(l!==k&&l!==d){j=l;return false}})}else{this.each(function(){var k=b.data(this,f);if(k){k.option(i||{})._init()}else{b.data(this,f,new e(i,this))}})}return j}};b.Widget=function(e,f){if(arguments.length){this._createWidget(e,f)}};b.Widget.prototype={widgetName:"widget",widgetEventPrefix:"",options:{disabled:false},_createWidget:function(f,g){b.data(g,this.widgetName,this);this.element=b(g);this.options=b.extend(true,{},this.options,this._getCreateOptions(),f);var e=this;this.element.bind("remove."+this.widgetName,function(){e.destroy()});this._create();this._trigger("create");this._init()},_getCreateOptions:function(){return b.metadata&&b.metadata.get(this.element[0])[this.widgetName]},_create:function(){},_init:function(){},destroy:function(){this.element.unbind("."+this.widgetName).removeData(this.widgetName);this.widget().unbind("."+this.widgetName).removeAttr("aria-disabled").removeClass(this.widgetBaseClass+"-disabled ui-state-disabled")},widget:function(){return this.element},option:function(f,g){var e=f;if(arguments.length===0){return b.extend({},this.options)}if(typeof f==="string"){if(g===d){return this.options[f]}e={};e[f]=g}this._setOptions(e);return this},_setOptions:function(f){var e=this;b.each(f,function(g,h){e._setOption(g,h)});return this},_setOption:function(e,f){this.options[e]=f;if(e==="disabled"){this.widget()[f?"addClass":"removeClass"](this.widgetBaseClass+"-disabled ui-state-disabled").attr("aria-disabled",f)}return this},enable:function(){return this._setOption("disabled",false)},disable:function(){return this._setOption("disabled",true)},_trigger:function(e,f,g){var j,i,h=this.options[e];g=g||{};f=b.Event(f);f.type=(e===this.widgetEventPrefix?e:this.widgetEventPrefix+e).toLowerCase();f.target=this.element[0];i=f.originalEvent;if(i){for(j in i){if(!(j in f)){f[j]=i[j]}}}this.element.trigger(f,g);return !(b.isFunction(h)&&h.call(this.element[0],f,g)===false||f.isDefaultPrevented())}}})(jQuery);/*!
+ * jQuery UI Mouse 1.8.18
+ *
+ * Copyright 2011, AUTHORS.txt (http://jqueryui.com/about)
+ * Dual licensed under the MIT or GPL Version 2 licenses.
+ * http://jquery.org/license
+ *
+ * http://docs.jquery.com/UI/Mouse
+ *
+ * Depends:
+ * jquery.ui.widget.js
+ */
+(function(b,c){var a=false;b(document).mouseup(function(d){a=false});b.widget("ui.mouse",{options:{cancel:":input,option",distance:1,delay:0},_mouseInit:function(){var d=this;this.element.bind("mousedown."+this.widgetName,function(e){return d._mouseDown(e)}).bind("click."+this.widgetName,function(e){if(true===b.data(e.target,d.widgetName+".preventClickEvent")){b.removeData(e.target,d.widgetName+".preventClickEvent");e.stopImmediatePropagation();return false}});this.started=false},_mouseDestroy:function(){this.element.unbind("."+this.widgetName)},_mouseDown:function(f){if(a){return}(this._mouseStarted&&this._mouseUp(f));this._mouseDownEvent=f;var e=this,g=(f.which==1),d=(typeof this.options.cancel=="string"&&f.target.nodeName?b(f.target).closest(this.options.cancel).length:false);if(!g||d||!this._mouseCapture(f)){return true}this.mouseDelayMet=!this.options.delay;if(!this.mouseDelayMet){this._mouseDelayTimer=setTimeout(function(){e.mouseDelayMet=true},this.options.delay)}if(this._mouseDistanceMet(f)&&this._mouseDelayMet(f)){this._mouseStarted=(this._mouseStart(f)!==false);if(!this._mouseStarted){f.preventDefault();return true}}if(true===b.data(f.target,this.widgetName+".preventClickEvent")){b.removeData(f.target,this.widgetName+".preventClickEvent")}this._mouseMoveDelegate=function(h){return e._mouseMove(h)};this._mouseUpDelegate=function(h){return e._mouseUp(h)};b(document).bind("mousemove."+this.widgetName,this._mouseMoveDelegate).bind("mouseup."+this.widgetName,this._mouseUpDelegate);f.preventDefault();a=true;return true},_mouseMove:function(d){if(b.browser.msie&&!(document.documentMode>=9)&&!d.button){return this._mouseUp(d)}if(this._mouseStarted){this._mouseDrag(d);return d.preventDefault()}if(this._mouseDistanceMet(d)&&this._mouseDelayMet(d)){this._mouseStarted=(this._mouseStart(this._mouseDownEvent,d)!==false);(this._mouseStarted?this._mouseDrag(d):this._mouseUp(d))}return !this._mouseStarted},_mouseUp:function(d){b(document).unbind("mousemove."+this.widgetName,this._mouseMoveDelegate).unbind("mouseup."+this.widgetName,this._mouseUpDelegate);if(this._mouseStarted){this._mouseStarted=false;if(d.target==this._mouseDownEvent.target){b.data(d.target,this.widgetName+".preventClickEvent",true)}this._mouseStop(d)}return false},_mouseDistanceMet:function(d){return(Math.max(Math.abs(this._mouseDownEvent.pageX-d.pageX),Math.abs(this._mouseDownEvent.pageY-d.pageY))>=this.options.distance)},_mouseDelayMet:function(d){return this.mouseDelayMet},_mouseStart:function(d){},_mouseDrag:function(d){},_mouseStop:function(d){},_mouseCapture:function(d){return true}})})(jQuery);(function(c,d){c.widget("ui.resizable",c.ui.mouse,{widgetEventPrefix:"resize",options:{alsoResize:false,animate:false,animateDuration:"slow",animateEasing:"swing",aspectRatio:false,autoHide:false,containment:false,ghost:false,grid:false,handles:"e,s,se",helper:false,maxHeight:null,maxWidth:null,minHeight:10,minWidth:10,zIndex:1000},_create:function(){var f=this,k=this.options;this.element.addClass("ui-resizable");c.extend(this,{_aspectRatio:!!(k.aspectRatio),aspectRatio:k.aspectRatio,originalElement:this.element,_proportionallyResizeElements:[],_helper:k.helper||k.ghost||k.animate?k.helper||"ui-resizable-helper":null});if(this.element[0].nodeName.match(/canvas|textarea|input|select|button|img/i)){this.element.wrap(c('
').css({position:this.element.css("position"),width:this.element.outerWidth(),height:this.element.outerHeight(),top:this.element.css("top"),left:this.element.css("left")}));this.element=this.element.parent().data("resizable",this.element.data("resizable"));this.elementIsWrapper=true;this.element.css({marginLeft:this.originalElement.css("marginLeft"),marginTop:this.originalElement.css("marginTop"),marginRight:this.originalElement.css("marginRight"),marginBottom:this.originalElement.css("marginBottom")});this.originalElement.css({marginLeft:0,marginTop:0,marginRight:0,marginBottom:0});this.originalResizeStyle=this.originalElement.css("resize");this.originalElement.css("resize","none");this._proportionallyResizeElements.push(this.originalElement.css({position:"static",zoom:1,display:"block"}));this.originalElement.css({margin:this.originalElement.css("margin")});this._proportionallyResize()}this.handles=k.handles||(!c(".ui-resizable-handle",this.element).length?"e,s,se":{n:".ui-resizable-n",e:".ui-resizable-e",s:".ui-resizable-s",w:".ui-resizable-w",se:".ui-resizable-se",sw:".ui-resizable-sw",ne:".ui-resizable-ne",nw:".ui-resizable-nw"});if(this.handles.constructor==String){if(this.handles=="all"){this.handles="n,e,s,w,se,sw,ne,nw"}var l=this.handles.split(",");this.handles={};for(var g=0;g l.width),s=a(l.height)&&i.minHeight&&(i.minHeight>l.height);if(h){l.width=i.minWidth}if(s){l.height=i.minHeight}if(t){l.width=i.maxWidth}if(m){l.height=i.maxHeight}var f=this.originalPosition.left+this.originalSize.width,p=this.position.top+this.size.height;var k=/sw|nw|w/.test(q),e=/nw|ne|n/.test(q);if(h&&k){l.left=f-i.minWidth}if(t&&k){l.left=f-i.maxWidth}if(s&&e){l.top=p-i.minHeight}if(m&&e){l.top=p-i.maxHeight}var n=!l.width&&!l.height;if(n&&!l.left&&l.top){l.top=null}else{if(n&&!l.top&&l.left){l.left=null}}return l},_proportionallyResize:function(){var k=this.options;if(!this._proportionallyResizeElements.length){return}var g=this.helper||this.element;for(var f=0;f');var e=c.browser.msie&&c.browser.version<7,g=(e?1:0),h=(e?2:-1);this.helper.addClass(this._helper).css({width:this.element.outerWidth()+h,height:this.element.outerHeight()+h,position:"absolute",left:this.elementOffset.left-g+"px",top:this.elementOffset.top-g+"px",zIndex:++i.zIndex});this.helper.appendTo("body").disableSelection()}else{this.helper=this.element}},_change:{e:function(g,f,e){return{width:this.originalSize.width+f}},w:function(h,f,e){var j=this.options,g=this.originalSize,i=this.originalPosition;return{left:i.left+f,width:g.width-f}},n:function(h,f,e){var j=this.options,g=this.originalSize,i=this.originalPosition;return{top:i.top+e,height:g.height-e}},s:function(g,f,e){return{height:this.originalSize.height+e}},se:function(g,f,e){return c.extend(this._change.s.apply(this,arguments),this._change.e.apply(this,[g,f,e]))},sw:function(g,f,e){return c.extend(this._change.s.apply(this,arguments),this._change.w.apply(this,[g,f,e]))},ne:function(g,f,e){return c.extend(this._change.n.apply(this,arguments),this._change.e.apply(this,[g,f,e]))},nw:function(g,f,e){return c.extend(this._change.n.apply(this,arguments),this._change.w.apply(this,[g,f,e]))}},_propagate:function(f,e){c.ui.plugin.call(this,f,[e,this.ui()]);(f!="resize"&&this._trigger(f,e,this.ui()))},plugins:{},ui:function(){return{originalElement:this.originalElement,element:this.element,helper:this.helper,position:this.position,size:this.size,originalSize:this.originalSize,originalPosition:this.originalPosition}}});c.extend(c.ui.resizable,{version:"1.8.18"});c.ui.plugin.add("resizable","alsoResize",{start:function(f,g){var e=c(this).data("resizable"),i=e.options;var h=function(j){c(j).each(function(){var k=c(this);k.data("resizable-alsoresize",{width:parseInt(k.width(),10),height:parseInt(k.height(),10),left:parseInt(k.css("left"),10),top:parseInt(k.css("top"),10)})})};if(typeof(i.alsoResize)=="object"&&!i.alsoResize.parentNode){if(i.alsoResize.length){i.alsoResize=i.alsoResize[0];h(i.alsoResize)}else{c.each(i.alsoResize,function(j){h(j)})}}else{h(i.alsoResize)}},resize:function(g,i){var f=c(this).data("resizable"),j=f.options,h=f.originalSize,l=f.originalPosition;var k={height:(f.size.height-h.height)||0,width:(f.size.width-h.width)||0,top:(f.position.top-l.top)||0,left:(f.position.left-l.left)||0},e=function(m,n){c(m).each(function(){var q=c(this),r=c(this).data("resizable-alsoresize"),p={},o=n&&n.length?n:q.parents(i.originalElement[0]).length?["width","height"]:["width","height","top","left"];c.each(o,function(s,u){var t=(r[u]||0)+(k[u]||0);if(t&&t>=0){p[u]=t||null}});q.css(p)})};if(typeof(j.alsoResize)=="object"&&!j.alsoResize.nodeType){c.each(j.alsoResize,function(m,n){e(m,n)})}else{e(j.alsoResize)}},stop:function(e,f){c(this).removeData("resizable-alsoresize")}});c.ui.plugin.add("resizable","animate",{stop:function(i,n){var p=c(this).data("resizable"),j=p.options;var h=p._proportionallyResizeElements,e=h.length&&(/textarea/i).test(h[0].nodeName),f=e&&c.ui.hasScroll(h[0],"left")?0:p.sizeDiff.height,l=e?0:p.sizeDiff.width;var g={width:(p.size.width-l),height:(p.size.height-f)},k=(parseInt(p.element.css("left"),10)+(p.position.left-p.originalPosition.left))||null,m=(parseInt(p.element.css("top"),10)+(p.position.top-p.originalPosition.top))||null;p.element.animate(c.extend(g,m&&k?{top:m,left:k}:{}),{duration:j.animateDuration,easing:j.animateEasing,step:function(){var o={width:parseInt(p.element.css("width"),10),height:parseInt(p.element.css("height"),10),top:parseInt(p.element.css("top"),10),left:parseInt(p.element.css("left"),10)};if(h&&h.length){c(h[0]).css({width:o.width,height:o.height})}p._updateCache(o);p._propagate("resize",i)}})}});c.ui.plugin.add("resizable","containment",{start:function(f,r){var t=c(this).data("resizable"),j=t.options,l=t.element;var g=j.containment,k=(g instanceof c)?g.get(0):(/parent/.test(g))?l.parent().get(0):g;if(!k){return}t.containerElement=c(k);if(/document/.test(g)||g==document){t.containerOffset={left:0,top:0};t.containerPosition={left:0,top:0};t.parentData={element:c(document),left:0,top:0,width:c(document).width(),height:c(document).height()||document.body.parentNode.scrollHeight}}else{var n=c(k),i=[];c(["Top","Right","Left","Bottom"]).each(function(p,o){i[p]=b(n.css("padding"+o))});t.containerOffset=n.offset();t.containerPosition=n.position();t.containerSize={height:(n.innerHeight()-i[3]),width:(n.innerWidth()-i[1])};var q=t.containerOffset,e=t.containerSize.height,m=t.containerSize.width,h=(c.ui.hasScroll(k,"left")?k.scrollWidth:m),s=(c.ui.hasScroll(k)?k.scrollHeight:e);t.parentData={element:k,left:q.left,top:q.top,width:h,height:s}}},resize:function(g,q){var t=c(this).data("resizable"),i=t.options,f=t.containerSize,p=t.containerOffset,m=t.size,n=t.position,r=t._aspectRatio||g.shiftKey,e={top:0,left:0},h=t.containerElement;if(h[0]!=document&&(/static/).test(h.css("position"))){e=p}if(n.left<(t._helper?p.left:0)){t.size.width=t.size.width+(t._helper?(t.position.left-p.left):(t.position.left-e.left));if(r){t.size.height=t.size.width/i.aspectRatio}t.position.left=i.helper?p.left:0}if(n.top<(t._helper?p.top:0)){t.size.height=t.size.height+(t._helper?(t.position.top-p.top):t.position.top);if(r){t.size.width=t.size.height*i.aspectRatio}t.position.top=t._helper?p.top:0}t.offset.left=t.parentData.left+t.position.left;t.offset.top=t.parentData.top+t.position.top;var l=Math.abs((t._helper?t.offset.left-e.left:(t.offset.left-e.left))+t.sizeDiff.width),s=Math.abs((t._helper?t.offset.top-e.top:(t.offset.top-p.top))+t.sizeDiff.height);var k=t.containerElement.get(0)==t.element.parent().get(0),j=/relative|absolute/.test(t.containerElement.css("position"));if(k&&j){l-=t.parentData.left}if(l+t.size.width>=t.parentData.width){t.size.width=t.parentData.width-l;if(r){t.size.height=t.size.width/t.aspectRatio}}if(s+t.size.height>=t.parentData.height){t.size.height=t.parentData.height-s;if(r){t.size.width=t.size.height*t.aspectRatio}}},stop:function(f,n){var q=c(this).data("resizable"),g=q.options,l=q.position,m=q.containerOffset,e=q.containerPosition,i=q.containerElement;var j=c(q.helper),r=j.offset(),p=j.outerWidth()-q.sizeDiff.width,k=j.outerHeight()-q.sizeDiff.height;if(q._helper&&!g.animate&&(/relative/).test(i.css("position"))){c(this).css({left:r.left-e.left-m.left,width:p,height:k})}if(q._helper&&!g.animate&&(/static/).test(i.css("position"))){c(this).css({left:r.left-e.left-m.left,width:p,height:k})}}});c.ui.plugin.add("resizable","ghost",{start:function(g,h){var e=c(this).data("resizable"),i=e.options,f=e.size;e.ghost=e.originalElement.clone();e.ghost.css({opacity:0.25,display:"block",position:"relative",height:f.height,width:f.width,margin:0,left:0,top:0}).addClass("ui-resizable-ghost").addClass(typeof i.ghost=="string"?i.ghost:"");e.ghost.appendTo(e.helper)},resize:function(f,g){var e=c(this).data("resizable"),h=e.options;if(e.ghost){e.ghost.css({position:"relative",height:e.size.height,width:e.size.width})}},stop:function(f,g){var e=c(this).data("resizable"),h=e.options;if(e.ghost&&e.helper){e.helper.get(0).removeChild(e.ghost.get(0))}}});c.ui.plugin.add("resizable","grid",{resize:function(e,m){var p=c(this).data("resizable"),h=p.options,k=p.size,i=p.originalSize,j=p.originalPosition,n=p.axis,l=h._aspectRatio||e.shiftKey;h.grid=typeof h.grid=="number"?[h.grid,h.grid]:h.grid;var g=Math.round((k.width-i.width)/(h.grid[0]||1))*(h.grid[0]||1),f=Math.round((k.height-i.height)/(h.grid[1]||1))*(h.grid[1]||1);if(/^(se|s|e)$/.test(n)){p.size.width=i.width+g;p.size.height=i.height+f}else{if(/^(ne)$/.test(n)){p.size.width=i.width+g;p.size.height=i.height+f;p.position.top=j.top-f}else{if(/^(sw)$/.test(n)){p.size.width=i.width+g;p.size.height=i.height+f;p.position.left=j.left-g}else{p.size.width=i.width+g;p.size.height=i.height+f;p.position.top=j.top-f;p.position.left=j.left-g}}}}});var b=function(e){return parseInt(e,10)||0};var a=function(e){return !isNaN(parseInt(e,10))}})(jQuery);/*!
+ * jQuery hashchange event - v1.3 - 7/21/2010
+ * http://benalman.com/projects/jquery-hashchange-plugin/
+ *
+ * Copyright (c) 2010 "Cowboy" Ben Alman
+ * Dual licensed under the MIT and GPL licenses.
+ * http://benalman.com/about/license/
+ */
+(function($,e,b){var c="hashchange",h=document,f,g=$.event.special,i=h.documentMode,d="on"+c in e&&(i===b||i>7);function a(j){j=j||location.href;return"#"+j.replace(/^[^#]*#?(.*)$/,"$1")}$.fn[c]=function(j){return j?this.bind(c,j):this.trigger(c)};$.fn[c].delay=50;g[c]=$.extend(g[c],{setup:function(){if(d){return false}$(f.start)},teardown:function(){if(d){return false}$(f.stop)}});f=(function(){var j={},p,m=a(),k=function(q){return q},l=k,o=k;j.start=function(){p||n()};j.stop=function(){p&&clearTimeout(p);p=b};function n(){var r=a(),q=o(m);if(r!==m){l(m=r,q);$(e).trigger(c)}else{if(q!==m){location.href=location.href.replace(/#.*/,"")+q}}p=setTimeout(n,$.fn[c].delay)}$.browser.msie&&!d&&(function(){var q,r;j.start=function(){if(!q){r=$.fn[c].src;r=r&&r+a();q=$('').hide().one("load",function(){r||l(a());n()}).attr("src",r||"javascript:0").insertAfter("body")[0].contentWindow;h.onpropertychange=function(){try{if(event.propertyName==="title"){q.document.title=h.title}}catch(s){}}}};j.stop=k;o=function(){return a(q.location.href)};l=function(v,s){var u=q.document,t=$.fn[c].domain;if(v!==s){u.title=h.title;u.open();t&&u.write('
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
26 #include <xlnt/xlnt_config.hpp> Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
major_order
Defines whether iterating a range returns columns or rows sequentially.
Definition: major_order.hpp:33
+
xlnt: xlnt/packaging/manifest.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
28 #include <unordered_map> 30 #include <xlnt/xlnt_config.hpp> 31 #include <xlnt/packaging/relationship.hpp> 32 #include <xlnt/utils/path.hpp> 52 std::vector<path> parts()
const ;
64 bool has_relationship(
const path &source,
const std::string &rel_id)
const ;
76 class relationship relationship(const path &source,
const std::string &rel_id)
const ;
81 std::vector<xlnt::relationship> relationships(
const path &source)
const ;
86 std::vector<xlnt::relationship> relationships(
const path &source,
relationship_type type)
const ;
92 path canonicalize(
const std::vector<xlnt::relationship> &rels)
const ;
102 std::string register_relationship(
const class relationship &rel);
110 std::unordered_map<std::string, std::string> unregister_relationship(
const uri &source,
const std::string &rel_id);
117 std::string content_type(
const path &part)
const ;
124 bool has_default_type(
const std::string &extension)
const ;
129 std::vector<std::string> extensions_with_default_types()
const ;
134 std::string default_type(
const std::string &extension)
const ;
139 void register_default_type(
const std::string &extension,
const std::string &type);
144 void unregister_default_type(
const std::string &extension);
152 bool has_override_type(
const path &part)
const ;
158 std::string override_type(
const path &part)
const ;
163 std::vector<path> parts_with_overriden_types()
const ;
168 void register_override_type(
const path &part,
const std::string &type);
173 void unregister_override_type(
const path &part);
181 std::string next_relationship_id(
const path &part)
const ;
186 std::unordered_map<std::string, std::string> default_content_types_;
191 std::unordered_map<path, std::string> override_content_types_;
196 std::unordered_map<path, std::unordered_map<std::string, xlnt::relationship>> relationships_;
Represents an association between a source Package or part, and a target object which can be a part o...
Definition: relationship.hpp:102
+
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
Encapsulates a uniform resource identifier (URI) as described by RFC 3986.
Definition: uri.hpp:37
+
bool operator==(std::nullptr_t, const cell &cell)
Returns true if this cell is uninitialized.
+
Encapsulates a path that points to location in a filesystem.
Definition: path.hpp:37
+
relationship_type
All package relationships must be one of these defined types.
Definition: relationship.hpp:53
+
target_mode
Specifies whether the target of a relationship is inside or outside the Package.
Definition: relationship.hpp:38
+
The manifest keeps track of all files in the OOXML package and their type and relationships.
Definition: manifest.hpp:40
+
xlnt: xlnt/workbook/metadata_property.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
26 #include <xlnt/xlnt_config.hpp> 60 characters_with_spaces,
core_property
Every core property in a workbook must be one of these types.
Definition: metadata_property.hpp:33
+
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
extended_property
Every extended property in a workbook must be one of these types.
Definition: metadata_property.hpp:55
+
xlnt: xlnt/workbook/named_range.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
30 #include <xlnt/xlnt_config.hpp> 34 class range_reference;
47 using target = std::pair<worksheet, range_reference>;
62 named_range (
const std::string &name,
const std::vector<target> &targets);
67 std::string name()
const ;
72 const std::vector<target> &targets()
const ;
90 std::vector<target> targets_;
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
bool operator==(std::nullptr_t, const cell &cell)
Returns true if this cell is uninitialized.
+
std::pair< worksheet, range_reference > target
Type alias for the combination of sheet and range this named_range points to.
Definition: named_range.hpp:47
+
A 2D range of cells in a worksheet that is referred to by name. ws->range("A1:B2") could be replaced ...
Definition: named_range.hpp:41
+
xlnt: Namespace Members
+
+
+
+
+
+
+
+
+
+
Here is a list of all documented namespace members with links to the namespaces they belong to:
+
+
+border_side
+: xlnt
+
+border_style
+: xlnt
+
+
+
+
+
+calendar
+: xlnt
+
+cell_type
+: xlnt
+
+color_type
+: xlnt
+
+core_property
+: xlnt
+
+
+
+
+
+diagonal_direction
+: xlnt
+
+
+
+
+
+extended_property
+: xlnt
+
+
+
+
+
+
+
+
+gradient_fill_type
+: xlnt
+
+
+
+
+
+horizontal_alignment
+: xlnt
+
+
+
+
+
+
+
+
+operator!=()
+: xlnt
+
+operator<<()
+: xlnt
+
+operator==()
+: xlnt
+
+orientation
+: xlnt
+
+
+
+
+
+page_break
+: xlnt
+
+pane_corner
+: xlnt
+
+pane_state
+: xlnt
+
+paper_size
+: xlnt
+
+pattern_fill_type
+: xlnt
+
+
+
+
+
+relationship_type
+: xlnt
+
+row_t
+: xlnt
+
+
+
+
+
+sheet_state
+: xlnt
+
+sheet_view_type
+: xlnt
+
+
+
+
+
+
+
+
+vertical_alignment
+: xlnt
+
+
+
xlnt: Namespace Members
+
+
+
+
+
+
+
+
+
+
+border_side
+: xlnt
+
+border_style
+: xlnt
+
+calendar
+: xlnt
+
+cell_type
+: xlnt
+
+color_type
+: xlnt
+
+core_property
+: xlnt
+
+diagonal_direction
+: xlnt
+
+extended_property
+: xlnt
+
+fill_type
+: xlnt
+
+gradient_fill_type
+: xlnt
+
+horizontal_alignment
+: xlnt
+
+major_order
+: xlnt
+
+orientation
+: xlnt
+
+page_break
+: xlnt
+
+pane_corner
+: xlnt
+
+pane_state
+: xlnt
+
+paper_size
+: xlnt
+
+pattern_fill_type
+: xlnt
+
+relationship_type
+: xlnt
+
+sheet_state
+: xlnt
+
+sheet_view_type
+: xlnt
+
+target_mode
+: xlnt
+
+vertical_alignment
+: xlnt
+
+
+
xlnt: Namespace Members
+
+
+
+
+
+
+
+
+
+
+operator!=()
+: xlnt
+
+operator<<()
+: xlnt
+
+operator==()
+: xlnt
+
+
+
xlnt: Namespace Members
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/namespaces.html b/namespaces.html
new file mode 100644
index 00000000..0860d15d
--- /dev/null
+++ b/namespaces.html
@@ -0,0 +1,78 @@
+
+
+
+xlnt: Namespace List
+
+
+
+
+
+
+
+
+
+
+
Here is a list of all documented namespaces with brief descriptions:
+
+ N xlnt Enumerates the possible types a cell can be determined by it's current value.
+
+
xlnt: xlnt Namespace Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Enumerates the possible types a cell can be determined by it's current value.
+More...
+
+class alignment Alignment options that determine how text should be displayed within a cell. More... class border Describes the border style of a particular cell. More... class calculation_properties Workbook file properties relating to calculations. More... class cell Describes a unit of data in a worksheet at a specific coordinate and its associated properties. More... class cell_iterator A cell iterator iterates over a 1D range by row or by column. More... class cell_reference An object used to refer to a cell. References have two parts, the column and the row. In Excel, the reference string A1 refers to the top-left-most cell. A cell_reference can be initialized from a string of this form or a 1-indexed ordered pair of the form column, row. More... struct cell_reference_hash Functor for hashing a cell reference. Allows for use of std::unordered_set<cell_reference, cel_reference_hash> and similar. More... class cell_vector A cell vector is a linear (1D) range of cells, either vertical or horizontal depending on the major order specified in the constructor. More... class color Colors can be applied to many parts of a cell's style. More... struct column_hash Functor for hashing a column. Allows for use of std::unordered_set<column_t, column_hash> and similar. More... class column_properties Properties applied to a column in a worksheet. Columns can have a size and a style. More... class column_t Columns can be referred to as a string A,B,...Z,AA,AB,..,ZZ,AAA,...,ZZZ or as a 1-indexed index. This class encapsulates both of these forms of column referencing and allows for conversions between them. More... class comment A comment can be applied to a cell to provide extra information about its contents. More... class condition class conditional_format Describes a conditional format that will be applied to all cells in the associated range that satisfy the condition. This can only be constructed using methods on worksheet or range. More... class const_cell_iterator A cell iterator iterates over a 1D range by row or by column. More... class const_range_iterator A const version of range_iterator which does not allow modification to the dereferenced cell_vector . More... class const_worksheet_iterator An iterator which is used to iterate over the worksheets in a const workbook. More... struct date A date is a specific day specified in terms of a year, month, and day. It can also be initialized as a number of days since a base date using date::from_number . More... struct datetime A datetime is a combination of a date and a time. More... class document_security Properties governing how the data in a workbook should be protected. These values can be ignored by consumers. More... class exception Parent type of all custom exceptions thrown in this library. More... class ext_list A list of xml extensions that may or may not be understood by the parser preservation is required for round-tripping even if extension is not understood [serialised: extLst] More... class external_book A reference to an external workbook for use in formulae. More... class fill Describes the fill style of a particular cell. More... class font Describes the font style of a particular cell. More... class format Describes the formatting of a particular cell. More... class gradient_fill Encapsulates a fill which transitions between colors at particular "stops". More... class header_footer Represents the header and footer of a sheet in a workbook. More... class hyperlink Describes a hyperlink pointing from a cell to another cell or a URL. More... class illegal_character The data submitted which cannot be used directly in Excel files. It must be removed or escaped. More... class indexed_color An indexed color encapsulates a simple index to a color in the indexedColors of the stylesheet. More... class invalid_attribute Exception when setting a class's attribute to an invalid value More... class invalid_cell_reference Exception for converting between numeric and A1-style cell references. More... class invalid_column_index Exception for bad column indices in A1-style cell references. More... class invalid_data_type Exception for any data type inconsistencies. More... class invalid_file Exception for trying to open a non-XLSX file. More... class invalid_parameter Exception for a bad parameter value More... class invalid_sheet_title Exception for bad sheet names. More... class key_not_found Exception for a key that doesn't exist in a container More... class manifest The manifest keeps track of all files in the OOXML package and their type and relationships. More... class named_range A 2D range of cells in a worksheet that is referred to by name. ws->range("A1:B2") could be replaced by ws->range("range1") More... class no_visible_worksheets Exception for a workbook with no visible worksheets More... class number_format Describes the number formatting applied to text and numbers within a certain cell. More... class optional Many settings in xlnt are allowed to not have a value set. This class encapsulates a value which may or may not be set. Memory is allocated within the optional class. More... class page_margins Describes the margins around a worksheet for printing. More... struct page_setup Describes how a worksheet will be converted into a page during printing. More... struct pane A fixed portion of a worksheet. More... class path Encapsulates a path that points to location in a filesystem. More... class pattern_fill Represents a fill which colors the cell based on a foreground and background color and a pattern. More... class phonetic_pr Phonetic properties Element provides a collection of properties that affect display of East Asian Languages [Serialised phoneticPr] More... struct phonetic_run Encapsulates a run of text that More... struct print_options class protection Describes the protection style of a particular cell. More... class range A range is a 2D collection of cells with defined extens that can be iterated upon. More... class range_iterator An iterator used by worksheet and range for traversing a 2D grid of cells by row/column then across that row/column. More... class range_reference A range_reference describes a rectangular area of a worksheet with positive width and height defined by a top-left and bottom-right corner. More... class relationship Represents an association between a source Package or part, and a target object which can be a part or external resource. More... class rgb_color An RGB color describes a color in terms of its red, green, blue, and alpha components. More... class rich_text Encapsulates zero or more formatted text runs where a text run is a string of text with the same defined formatting. More... class rich_text_hash struct rich_text_run Typedef a rich_text_run as a pair of string and optional font. More... class row_properties The properties of a row in a worksheet. More... struct scoped_enum_hash Allows a scoped enum (aka "enum class") to be used as a key in a std::unordered_map. More... class selection The selected area of a worksheet. More... class sheet_format_properties General worksheet formatting properties. More... struct sheet_pr class sheet_protection Protection applied to a particular worksheet to prevent it from being modified. More... class sheet_view Describes a view of a worksheet. Worksheets can have multiple views which show the data differently. More... class streaming_workbook_reader workbook is the container for all other parts of the document. More... class streaming_workbook_writer workbook is the container for all other parts of the document. More... class style Describes a style which has a name and can be applied to multiple individual formats. In Excel this is a "Cell Style". More... class theme A theme is a combination of fonts, colors, and effects. This isn't really supported yet. More... class theme_color A theme color encapsulates a color derived from the theme. More... struct time A time is a specific time of the day specified in terms of an hour, minute, second, and microsecond (0-999999). It can also be initialized as a fraction of a day using time::from_number . More... struct timedelta Represents a span of time between two datetimes. This is not fully supported yet throughout the library. More... class unhandled_switch_case Debug exception for a switch that fell through to the default case More... class unsupported Exception for attempting to use a feature which is not supported More... class uri Encapsulates a uniform resource identifier (URI) as described by RFC 3986. More... class variant Represents an object that can have variable type. More... class workbook workbook is the container for all other parts of the document. More... class workbook_view A workbook can be opened in multiple windows with different views. This class represents a particular view used by one window. More... class worksheet A worksheet is a 2D array of cells starting with cell A1 in the top-left corner and extending indefinitely down and right as needed. More... class worksheet_iterator An iterator which is used to iterate over the worksheets in a workbook. More...
+using row_t = std::uint32_t All rows should be referred to by an instance of this type. More...
+enum cell_type { cell_type::empty ,
+cell_type::boolean ,
+cell_type::date ,
+cell_type::error ,
+cell_type::inline_string ,
+cell_type::number ,
+cell_type::shared_string ,
+cell_type::formula_string
+ Enumerates the possible types a cell can be determined by it's current value. More... row_or_col_t : int { row ,
+column
+ } enum target_mode { target_mode::internal ,
+target_mode::external
+ } Specifies whether the target of a relationship is inside or outside the Package. More... enum relationship_type { unknown ,
+core_properties ,
+extended_properties ,
+custom_properties ,
+office_document ,
+thumbnail ,
+printer_settings ,
+calculation_chain ,
+chartsheet ,
+comments ,
+connections ,
+custom_property ,
+custom_xml_mappings ,
+dialogsheet ,
+drawings ,
+external_workbook_references ,
+pivot_table ,
+pivot_table_cache_definition ,
+pivot_table_cache_records ,
+query_table ,
+shared_string_table ,
+shared_workbook_revision_headers ,
+shared_workbook ,
+theme ,
+revision_log ,
+shared_workbook_user_data ,
+single_cell_table_definitions ,
+stylesheet ,
+table_definition ,
+vml_drawing ,
+volatile_dependencies ,
+worksheet ,
+vbaproject ,
+hyperlink ,
+image
+ All package relationships must be one of these defined types. More... enum horizontal_alignment { general ,
+left ,
+center ,
+right ,
+fill ,
+justify ,
+center_continuous ,
+distributed
+ Text can be aligned horizontally within a cell in these enumerated ways. More... enum vertical_alignment { top ,
+center ,
+bottom ,
+justify ,
+distributed
+ Text can be aligned vertically within a cell in these enumerated ways. More... enum border_side { start ,
+end ,
+top ,
+bottom ,
+diagonal ,
+vertical ,
+horizontal
+ Enumerates the sides of a cell to which a border style can be applied. More... enum border_style { none ,
+dashdot ,
+dashdotdot ,
+dashed ,
+dotted ,
+double_ ,
+hair ,
+medium ,
+mediumdashdot ,
+mediumdashdotdot ,
+mediumdashed ,
+slantdashdot ,
+thick ,
+thin
+ Enumerates the pattern of the border lines on a particular side. More... enum diagonal_direction { neither ,
+up ,
+down ,
+both
+ } Cells can have borders that go from the top-left to bottom-right or from the top-right to bottom-left, or both, or neither. Used by style->border. More... enum color_type { indexed ,
+theme ,
+rgb
+ } Some colors are references to colors rather than having a particular RGB value. More... enum pattern_fill_type { none ,
+solid ,
+mediumgray ,
+darkgray ,
+lightgray ,
+darkhorizontal ,
+darkvertical ,
+darkdown ,
+darkup ,
+darkgrid ,
+darktrellis ,
+lighthorizontal ,
+lightvertical ,
+lightdown ,
+lightup ,
+lightgrid ,
+lighttrellis ,
+gray125 ,
+gray0625
+ The pattern of pixels upon which the corresponding pattern fill will be displayed More... enum gradient_fill_type { linear ,
+path
+ } Enumerates the types of gradient fills More... enum fill_type { pattern ,
+gradient
+ } Enumerates the possible fill types More... enum calendar { windows_1900 ,
+mac_1904
+ } An enumeration of possible base dates. Dates in Excel are stored as days since this base date. More... enum core_property { category ,
+content_status ,
+created ,
+creator ,
+description ,
+identifier ,
+keywords ,
+language ,
+last_modified_by ,
+last_printed ,
+modified ,
+revision ,
+subject ,
+title ,
+version
+ Every core property in a workbook must be one of these types. More... enum extended_property { application ,
+app_version ,
+characters ,
+characters_with_spaces ,
+company ,
+dig_sig ,
+doc_security ,
+heading_pairs ,
+hidden_slides ,
+h_links ,
+hyperlink_base ,
+hyperlinks_changed ,
+lines ,
+links_up_to_date ,
+manager ,
+m_m_clips ,
+notes ,
+pages ,
+paragraphs ,
+presentation_format ,
+scale_crop ,
+shared_doc ,
+slides ,
+template_ ,
+titles_of_parts ,
+total_time ,
+words
+ Every extended property in a workbook must be one of these types. More... enum major_order { column ,
+row
+ } Defines whether iterating a range returns columns or rows sequentially. More... enum orientation { default_orientation ,
+portrait ,
+landscape
+ } The orientation of the worksheet when it is printed. More... enum page_break { none = 0,
+row = 1,
+column = 2
+ } The types of page breaks. More... enum paper_size { letter = 1,
+letter_small = 2,
+tabloid = 3,
+ledger = 4,
+legal = 5,
+statement = 6,
+executive = 7,
+a3 = 8,
+a4 = 9,
+a4_small = 10,
+a5 = 11
+ The possible paper sizes for printing. More... enum sheet_state { visible ,
+hidden ,
+very_hidden
+ } Defines how a worksheet appears in the workbook. A workbook must have at least one sheet which is visible at all times. More... enum pane_state { frozen ,
+frozen_split ,
+split
+ } Enumeration of possible states of a pane More... enum pane_corner { top_left ,
+top_right ,
+bottom_left ,
+bottom_right
+ } Enumeration of the four quadrants of a worksheet More... enum sheet_view_type { normal ,
+page_break_preview ,
+page_layout
+ } Enumeration of possible types of sheet views More...
+bool operator== (std::nullptr_t, const cell &cell ) Returns true if this cell is uninitialized. More... bool operator== (const cell &cell , std::nullptr_t) Returns true if this cell is uninitialized. More... std::ostream & operator<< (std::ostream &stream, const xlnt::cell &cell ) Convenience function for writing cell to an ostream. Uses cell::to_string() internally. More... std::string cell::value< std::string > () const operator== (const ext_list::ext &lhs, const ext_list::ext &rhs) operator== (const calculation_properties &lhs, const calculation_properties &rhs) operator== (const workbook_view &lhs, const workbook_view &rhs) operator== (const column_properties &lhs, const column_properties &rhs) operator== (const print_options &lhs, const print_options &rhs) bool operator== (const std::string &reference_string, const range_reference &ref) Returns true if the string representation of the range is equivalent to ref. More... bool operator== (const char *reference_string, const range_reference &ref) Returns true if the string representation of the range is equivalent to ref. More... bool operator!= (const std::string &reference_string, const range_reference &ref) Returns true if the string representation of the range is not equivalent to ref. More... bool operator!= (const char *reference_string, const range_reference &ref) Returns true if the string representation of the range is not equivalent to ref. More... operator== (const row_properties &lhs, const row_properties &rhs) operator== (const sheet_format_properties &lhs, const sheet_format_properties &rhs) operator== (const sheet_pr &lhs, const sheet_pr &rhs)
+
+
Enumerates the possible types a cell can be determined by it's current value.
+
+
+
◆
+
+
+
+
+
All rows should be referred to by an instance of this type.
+
+
+
+
+
+
◆
+
+
+
+
+
Enumerates the sides of a cell to which a border style can be applied.
+
+
+
+
+
◆
+
+
+
+
+
Enumerates the pattern of the border lines on a particular side.
+
+
+
+
+
◆
+
+
+
+
+
An enumeration of possible base dates. Dates in Excel are stored as days since this base date.
+
+
+
+
+
◆
+
+
+
+
+
Enumerates the possible types a cell can be determined by it's current value.
+
+Enumerator no value
+value is TRUE or FALSE
+value is an ISO 8601 formatted date
+value is a known error code such as #VALUE!
+value is a string stored in the cell
+value is a number
+value is a string shared with other cells to save space
+value is the string result of a formula
+
+
+
+
+
+
◆
+
+
+
+
+
Some colors are references to colors rather than having a particular RGB value.
+
+
+
+
+
◆
+
+
+
+
+
Every core property in a workbook must be one of these types.
+
+
+
+
+
◆
+
+
+
+
+
Cells can have borders that go from the top-left to bottom-right or from the top-right to bottom-left, or both, or neither. Used by style->border.
+
+
+
+
+
◆
+
+
+
+
+
Every extended property in a workbook must be one of these types.
+
+
+
+
+
◆
+
+
+
+
+
Enumerates the possible fill types
+
+
+
+
+
◆
+
+
+
+
+
Enumerates the types of gradient fills
+
+
+
+
+
◆
+
+
+
+
+
Text can be aligned horizontally within a cell in these enumerated ways.
+
+
+
+
+
◆
+
+
+
+
+
Defines whether iterating a range returns columns or rows sequentially.
+
+
+
+
+
◆
+
+
+
+
+
The orientation of the worksheet when it is printed.
+
+
+
+
+
◆
+
+
+
+
+
The types of page breaks.
+
+
+
+
+
◆
+
+
+
+
+
Enumeration of the four quadrants of a worksheet
+
+
+
+
+
◆
+
+
+
+
+
Enumeration of possible states of a pane
+
+
+
+
+
◆
+
+
+
+
+
The possible paper sizes for printing.
+
+
+
+
+
◆
+
+
+
+
+
The pattern of pixels upon which the corresponding pattern fill will be displayed
+
+
+
+
+
◆
+
+
+
+
+
All package relationships must be one of these defined types.
+
+
+
+
+
◆
+
+
+
+
+
Defines how a worksheet appears in the workbook. A workbook must have at least one sheet which is visible at all times.
+
+
+
+
+
◆
+
+
+
+
+
Enumeration of possible types of sheet views
+
+
+
+
+
◆
+
+
+
+
+
Specifies whether the target of a relationship is inside or outside the Package.
+
+Enumerator The relationship references a resource that is external to the package.
+The relationship references a part that is inside the package.
+
+
+
+
+
+
◆
+
+
+
+
+
Text can be aligned vertically within a cell in these enumerated ways.
+
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ bool xlnt::operator!=
+ (
+ const std::string &
+ reference_string ,
+
+ const range_reference &
+ ref
+
+ )
+
+
+
+
+
Returns true if the string representation of the range is not equivalent to ref.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ bool xlnt::operator!=
+ (
+ const char *
+ reference_string ,
+
+ const range_reference &
+ ref
+
+ )
+
+
+
+
+
Returns true if the string representation of the range is not equivalent to ref.
+
+
+
+
+
◆
+
+
+
+
+
+ std::ostream& xlnt::operator<<
+ (
+ std::ostream &
+ stream ,
+
+ const xlnt::cell &
+ cell
+
+ )
+
+
+
+
+
Convenience function for writing cell to an ostream. Uses cell::to_string() internally.
+
+
+
+
+
◆ [1/4]
+
+
+
+
+
+ bool xlnt::operator==
+ (
+ const std::string &
+ reference_string ,
+
+ const range_reference &
+ ref
+
+ )
+
+
+
+
+
Returns true if the string representation of the range is equivalent to ref.
+
+
+
+
+
◆ [2/4]
+
+
+
+
+
+ bool xlnt::operator==
+ (
+ const char *
+ reference_string ,
+
+ const range_reference &
+ ref
+
+ )
+
+
+
+
+
Returns true if the string representation of the range is equivalent to ref.
+
+
+
+
+
◆ [3/4]
+
+
+
+
+
+ bool xlnt::operator==
+ (
+ std::nullptr_t
+ ,
+
+
+ const cell &
+ cell
+
+ )
+
+
+
+
+
Returns true if this cell is uninitialized.
+
+
+
+
+
◆ [4/4]
+
+
+
+
+
+ bool xlnt::operator==
+ (
+ const cell &
+ cell ,
+
+ std::nullptr_t
+
+
+
+ )
+
+
+
+
+
Returns true if this cell is uninitialized.
+
+
+
+
xlnt: xlnt/styles/number_format.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
30 #include <xlnt/xlnt_config.hpp> 31 #include <xlnt/utils/optional.hpp> 176 static bool is_builtin_format(std::size_t builtin_id);
182 static const number_format &from_builtin_id(std::size_t builtin_id);
204 number_format (
const std::string &code, std::size_t custom_id);
209 void format_string(
const std::string &format_code);
214 void format_string(
const std::string &format_code, std::size_t custom_id);
219 std::string format_string()
const ;
229 void id(std::size_t
id );
234 std::size_t id()
const ;
239 std::string
format (
const std::string &text)
const ;
245 std::string format(
double number,
calendar base_date)
const ;
250 bool is_date_format()
const ;
271 std::string format_string_;
+
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
bool operator==(std::nullptr_t, const cell &cell)
Returns true if this cell is uninitialized.
+
+
+
+
bool operator!=(const std::string &reference_string, const range_reference &ref)
Returns true if the string representation of the range is not equivalent to ref.
+
calendar
An enumeration of possible base dates. Dates in Excel are stored as days since this base date...
Definition: calendar.hpp:34
+
xlnt: xlnt/utils/numeric.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
26 #include <xlnt/xlnt_config.hpp> 33 #include <type_traits> 44 template <
typename Number>
45 constexpr Number abs(Number val)
47 return (val < Number{0}) ? -val : val;
53 template <
typename NumberL,
typename NumberR>
54 constexpr
typename std::common_type<NumberL, NumberR>::type (max)(NumberL lval, NumberR rval)
56 return (lval < rval) ? rval : lval;
62 template <
typename NumberL,
typename NumberR>
63 constexpr
typename std::common_type<NumberL, NumberR>::type (min)(NumberL lval, NumberR rval)
65 return (lval < rval) ? lval : rval;
77 template <
typename EpsilonType = float,
78 typename LNumber,
typename RNumber>
79 bool float_equals(
const LNumber &lhs,
const RNumber &rhs,
80 int epsilon_scale = 20)
83 using common_t =
typename std::common_type<LNumber, RNumber>::type;
85 static_assert(std::is_floating_point<LNumber>::value || std::is_floating_point<RNumber>::value,
86 "Using this function with two integers is just wasting time. Use ==" );
87 static_assert(std::numeric_limits<EpsilonType>::epsilon() < EpsilonType{1},
88 "epsilon >= 1.0 will cause all comparisons to return true" );
91 if (std::isnan(lhs) || std::isnan(rhs))
98 constexpr common_t epsilon =
static_cast< common_t
> (std::numeric_limits<EpsilonType>::epsilon());
103 common_t scaled_fuzz = epsilon_scale * epsilon * max(max(xlnt::detail::abs<common_t>(lhs),
104 xlnt::detail::abs<common_t>(rhs)),
106 return ((lhs + scaled_fuzz) >= rhs) && ((rhs + scaled_fuzz) >= lhs);
111 static constexpr
int Excel_Digit_Precision = 15;
112 bool should_convert_comma;
114 static void convert_comma_to_pt(
char *buf,
int len)
116 char *buf_end = buf + len;
117 char *decimal = std::find(buf, buf_end,
',' );
118 if (decimal != buf_end)
124 static void convert_pt_to_comma(
char *buf,
size_t len)
126 char *buf_end = buf + len;
127 char *decimal = std::find(buf, buf_end,
'.' );
128 if (decimal != buf_end)
136 : should_convert_comma(localeconv()->decimal_point[0] ==
',' )
142 std::string serialise(
double d)
const 145 int len = snprintf(buf,
sizeof (buf),
"%.15g" , d);
146 if (should_convert_comma)
148 convert_comma_to_pt(buf, len);
150 return std::string(buf, static_cast<size_t>(len));
155 std::string serialise_short(
double d)
const 158 int len = snprintf(buf,
sizeof (buf),
"%f" , d);
159 if (should_convert_comma)
161 convert_comma_to_pt(buf, len);
163 return std::string(buf, static_cast<size_t>(len));
166 double deserialise(
const std::string &s, ptrdiff_t *len_converted)
const 169 assert(len_converted !=
nullptr );
170 char *end_of_convert;
171 if (!should_convert_comma)
173 double d = strtod(s.c_str(), &end_of_convert);
174 *len_converted = end_of_convert - s.c_str();
178 assert(s.size() + 1 <
sizeof (buf));
179 const char *cstr = s.c_str();
180 auto copy_end = std::copy(cstr, cstr + s.size() + 1, buf);
181 convert_pt_to_comma(buf, static_cast<size_t>(copy_end - buf));
182 double d = strtod(buf, &end_of_convert);
183 *len_converted = end_of_convert - buf;
187 double deserialise(
const std::string &s)
const 190 return deserialise(s, &ignore);
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
Definition: numeric.hpp:109
+
xlnt: xlnt/utils/optional.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
26 #include "xlnt/utils/exceptions.hpp" 27 #include "xlnt/utils/numeric.hpp" 28 #include "xlnt/xlnt_config.hpp" 29 #include <type_traits> 41 #if ((defined(_MSC_VER) && _MSC_VER <= 1900) || (defined(__GNUC__) && __GNUC__ < 5)) 43 #define XLNT_NOEXCEPT_VALUE_COMPAT(...) (false) 45 #define XLNT_NOEXCEPT_VALUE_COMPAT(...) (__VA_ARGS__) 46 using ctor_copy_T_noexcept =
typename std::conditional<std::is_nothrow_copy_constructible<T>{}, std::true_type, std::false_type>::type;
47 using ctor_move_T_noexcept =
typename std::conditional<std::is_nothrow_move_constructible<T>{}, std::true_type, std::false_type>::type;
48 using copy_ctor_noexcept = ctor_copy_T_noexcept;
49 using move_ctor_noexcept = ctor_move_T_noexcept;
50 using set_copy_noexcept_t =
typename std::conditional<std::is_nothrow_copy_constructible<T>{} && std::is_nothrow_assignable<T, T>{}, std::true_type, std::false_type>::type;
51 using set_move_noexcept_t =
typename std::conditional<std::is_nothrow_move_constructible<T>{} && std::is_nothrow_move_assignable<T>{}, std::true_type, std::false_type>::type;
52 using clear_noexcept_t =
typename std::conditional<std::is_nothrow_destructible<T>{}, std::true_type, std::false_type>::type;
54 template <typename U = T, typename std::enable_if<!std::is_floating_point<U>::value>::type * =
nullptr >
58 constexpr
bool compare_equal(
const U &lhs,
const U &rhs)
const 66 template <typename U = T, typename std::enable_if<std::is_floating_point<U>::value>::type * =
nullptr >
67 constexpr
bool compare_equal(
const U &lhs,
const U &rhs)
const 69 return detail::float_equals(lhs, rhs);
85 optional (
const T &value) noexcept(XLNT_NOEXCEPT_VALUE_COMPAT(ctor_copy_T_noexcept{}))
88 new (&storage_) T(value);
95 optional (T &&value) noexcept(XLNT_NOEXCEPT_VALUE_COMPAT(ctor_move_T_noexcept{}))
98 new (&storage_) T(std::move(value));
106 : has_value_(other.has_value_)
110 new (&storage_) T(other.value_ref());
119 : has_value_(other.has_value_)
123 new (&storage_) T(std::move(other.value_ref()));
134 if (other.has_value_)
136 set (other.value_ref());
151 if (other.has_value_)
153 set (std::move(other.value_ref()));
183 void set (
const T &value) noexcept(XLNT_NOEXCEPT_VALUE_COMPAT(set_copy_noexcept_t{}))
185 #if defined(__GNUC__) && !defined(__clang__) 186 #pragma GCC diagnostic push 187 #pragma GCC diagnostic ignored "-Wmaybe-uninitialized" 195 new (&storage_) T(value);
198 #if defined(__GNUC__) && !defined(__clang__) 199 #pragma GCC diagnostic pop 206 void set (T &&value) noexcept(XLNT_NOEXCEPT_VALUE_COMPAT(set_move_noexcept_t{}))
212 #if defined(__GNUC__) && !defined(__clang__) 213 #pragma GCC diagnostic push 214 #pragma GCC diagnostic ignored "-Wmaybe-uninitialized" 218 value_ref() = std::move(value);
222 new (&storage_) T(std::move(value));
225 #if defined(__GNUC__) && !defined(__clang__) 226 #pragma GCC diagnostic pop 251 void clear () noexcept(XLNT_NOEXCEPT_VALUE_COMPAT(clear_noexcept_t{}))
255 reinterpret_cast< T *
> (&storage_)->~T();
295 if (has_value_ != other.has_value_)
304 return compare_equal(value_ref(), other.value_ref());
319 T &value_ref() noexcept
321 return *
reinterpret_cast< T *
> (&storage_);
324 const T &value_ref()
const noexcept
326 return *
reinterpret_cast< const T *
> (&storage_);
330 typename std::aligned_storage<sizeof(T), alignof(T)>::type storage_;
333 #ifdef XLNT_NOEXCEPT_VALUE_COMPAT 334 #undef XLNT_NOEXCEPT_VALUE_COMPAT optional() noexcept
Default contructor. is_set() will be false initially.
Definition: optional.hpp:76
+
void clear() noexcept(XLNT_NOEXCEPT_VALUE_COMPAT(clear_noexcept_t{}))
After this is called, is_set() will return false until a new value is provided.
Definition: optional.hpp:251
+
bool is_set() const noexcept
Returns true if this object currently has a value set. This should be called before accessing the val...
Definition: optional.hpp:175
+
optional & operator=(T &&rhs) noexcept(XLNT_NOEXCEPT_VALUE_COMPAT(set_move_noexcept_t{}))
Assignment operator overload. Equivalent to setting the value using optional::set.
Definition: optional.hpp:242
+
optional(optional &&other) noexcept(XLNT_NOEXCEPT_VALUE_COMPAT(move_ctor_noexcept{}))
Move constructs this optional from other. Clears the value from other if set noexcept if T move ctor ...
Definition: optional.hpp:118
+
bool operator==(const optional< T > &other) const noexcept
Returns true if neither this nor other have a value or both have a value and those values are equal a...
Definition: optional.hpp:293
+
optional(T &&value) noexcept(XLNT_NOEXCEPT_VALUE_COMPAT(ctor_move_T_noexcept{}))
Constructs this optional with a value. noexcept if T move ctor is noexcept
Definition: optional.hpp:95
+
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
Exception when setting a class's attribute to an invalid value
Definition: exceptions.hpp:239
+
Many settings in xlnt are allowed to not have a value set. This class encapsulates a value which may ...
Definition: format.hpp:43
+
optional & operator=(const T &rhs) noexcept(XLNT_NOEXCEPT_VALUE_COMPAT(set_copy_noexcept_t{}))
Assignment operator overload. Equivalent to setting the value using optional::set.
Definition: optional.hpp:233
+
~optional() noexcept
Destructor cleans up the T instance if set
Definition: optional.hpp:166
+
optional & operator=(const optional &other) noexcept(XLNT_NOEXCEPT_VALUE_COMPAT(set_copy_noexcept_t{} &&clear_noexcept_t{}))
Copy assignment of this optional from other noexcept if set and clear are noexcept for T& ...
Definition: optional.hpp:132
+
optional(const T &value) noexcept(XLNT_NOEXCEPT_VALUE_COMPAT(ctor_copy_T_noexcept{}))
Constructs this optional with a value. noexcept if T copy ctor is noexcept
Definition: optional.hpp:85
+
optional(const optional &other) noexcept(XLNT_NOEXCEPT_VALUE_COMPAT(copy_ctor_noexcept{}))
Copy constructs this optional from other noexcept if T copy ctor is noexcept
Definition: optional.hpp:105
+
optional & operator=(optional &&other) noexcept(XLNT_NOEXCEPT_VALUE_COMPAT(set_move_noexcept_t{} &&clear_noexcept_t{}))
Move assignment of this optional from other noexcept if set and clear are noexcept for T&& ...
Definition: optional.hpp:149
+
bool operator!=(const optional< T > &other) const noexcept
Returns false if neither this nor other have a value or both have a value and those values are equal ...
Definition: optional.hpp:312
+
xlnt: xlnt/worksheet/page_margins.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
27 #include <xlnt/xlnt_config.hpp> 60 void left(
double left);
65 double bottom()
const ;
70 void bottom(
double bottom);
80 void right(
double right);
85 double header()
const ;
90 void header(
double header);
95 double footer()
const ;
100 void footer(
double footer);
123 double right_ = 0.75;
128 double header_ = 0.5;
133 double footer_ = 0.5;
Describes the margins around a worksheet for printing.
Definition: page_margins.hpp:34
+
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
bool operator==(std::nullptr_t, const cell &cell)
Returns true if this cell is uninitialized.
+
xlnt: xlnt/worksheet/page_setup.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
27 #include <xlnt/xlnt_config.hpp> 28 #include <xlnt/utils/optional.hpp> 125 bool has_paper_size()
const ;
130 bool fit_to_page()
const ;
135 void fit_to_page(
bool fit_to_page);
140 bool fit_to_height()
const ;
145 void fit_to_height(
bool fit_to_height);
150 bool fit_to_width()
const ;
155 void fit_to_width(
bool fit_to_width);
160 void scale(
double scale);
165 double scale()
const ;
170 bool has_scale()
const ;
175 const std::string& rel_id()
const ;
180 void rel_id(
const std::string& val);
185 bool has_rel_id()
const ;
orientation
The orientation of the worksheet when it is printed.
Definition: page_setup.hpp:35
+
xlnt::optional< std::size_t > horizontal_dpi_
The horizontal dpi
Definition: page_setup.hpp:194
+
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
bool operator==(std::nullptr_t, const cell &cell)
Returns true if this cell is uninitialized.
+
paper_size
The possible paper sizes for printing.
Definition: page_setup.hpp:55
+
sheet_state
Defines how a worksheet appears in the workbook. A workbook must have at least one sheet which is vis...
Definition: page_setup.hpp:74
+
+
xlnt::optional< std::size_t > vertical_dpi_
The vertical dpi
Definition: page_setup.hpp:198
+
Describes how a worksheet will be converted into a page during printing.
Definition: page_setup.hpp:84
+
xlnt::optional< xlnt::orientation > orientation_
The orientation
Definition: page_setup.hpp:190
+
page_break
The types of page breaks.
Definition: page_setup.hpp:45
+
xlnt: xlnt/worksheet/pane.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
27 #include <xlnt/xlnt_config.hpp> 28 #include <xlnt/cell/cell_reference.hpp> 29 #include <xlnt/cell/index_types.hpp> std::uint32_t row_t
All rows should be referred to by an instance of this type.
Definition: index_types.hpp:40
+
pane_state state
The state of the pane
Definition: pane.hpp:67
+
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
row_t y_split
The row where the split should take place
Definition: pane.hpp:77
+
optional< cell_reference > top_left_cell
The optional top left cell
Definition: pane.hpp:62
+
pane_corner active_pane
The pane which contains the active cell
Definition: pane.hpp:72
+
A fixed portion of a worksheet.
Definition: pane.hpp:57
+
pane_corner
Enumeration of the four quadrants of a worksheet
Definition: pane.hpp:46
+
bool operator==(const pane &rhs) const
Returns true if this pane is equal to rhs based on its top-left cell, state, active pane...
Definition: pane.hpp:88
+
Many settings in xlnt are allowed to not have a value set. This class encapsulates a value which may ...
Definition: format.hpp:43
+
pane_state
Enumeration of possible states of a pane
Definition: pane.hpp:36
+
Columns can be referred to as a string A,B,...Z,AA,AB,..,ZZ,AAA,...,ZZZ or as a 1-indexed index...
Definition: index_types.hpp:47
+
column_t x_split
The column where the split should take place
Definition: pane.hpp:82
+
xlnt: xlnt/utils/path.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
30 #include <xlnt/xlnt_config.hpp> 43 static char system_separator();
53 explicit path (
const std::string &path_string);
58 path (
const std::string &path_string,
char sep);
65 bool is_relative()
const ;
70 bool is_absolute()
const ;
86 std::string filename()
const ;
91 std::string extension()
const ;
96 std::pair<std::string, std::string> split_extension()
const ;
104 std::vector<std::string> split()
const ;
110 const std::string &string()
const ;
113 std::wstring wstring()
const ;
125 path resolve(
const path &base_path)
const ;
132 path relative_to(
const path &base_path)
const ;
146 bool is_directory()
const ;
152 bool is_file()
const ;
160 std::string read_contents()
const ;
167 path append(
const std::string &to_append)
const ;
172 path append(
const path &to_append)
const ;
193 char guess_separator()
const ;
198 std::string internal_;
216 static hash<string> hasher;
217 return hasher(p.
string ());
const std::string & string() const
Create a string representing this path separated by the provided separator or the system-default sepa...
+
Definition: cell_reference.hpp:261
+
size_t operator()(const xlnt::path &p) const
Returns a hashed represenation of the given path.
Definition: path.hpp:214
+
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
bool operator==(std::nullptr_t, const cell &cell)
Returns true if this cell is uninitialized.
+
Encapsulates a path that points to location in a filesystem.
Definition: path.hpp:37
+
bool operator!=(const std::string &reference_string, const range_reference &ref)
Returns true if the string representation of the range is not equivalent to ref.
+
xlnt: xlnt/worksheet/phonetic_pr.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
26 #include <xlnt/xlnt_config.hpp> 27 #include <xlnt/utils/optional.hpp> 41 static std::string Serialised_ID();
83 void serialise(std::ostream &output_stream)
const ;
98 bool has_type()
const ;
113 bool has_alignment()
const ;
129 static const std::string &type_as_string(
phonetic_type type);
134 static phonetic_type type_from_string(
const std::string &str);
144 static align alignment_from_string(
const std::string &str);
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
Describes the font style of a particular cell.
Definition: font.hpp:40
+
phonetic_type
possible values for type property
Definition: phonetic_pr.hpp:57
+
bool operator==(std::nullptr_t, const cell &cell)
Returns true if this cell is uninitialized.
+
std::uint32_t font_id_t
FontID represented by an unsigned 32-bit integer
Definition: phonetic_pr.hpp:68
+
+
Alignment options that determine how text should be displayed within a cell.
Definition: alignment.hpp:62
+
align
possible values for alignment property
Definition: phonetic_pr.hpp:46
+
Phonetic properties Element provides a collection of properties that affect display of East Asian Lan...
Definition: phonetic_pr.hpp:38
+
xlnt: xlnt/cell/phonetic_run.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
28 #include <xlnt/xlnt_config.hpp> Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
bool operator==(std::nullptr_t, const cell &cell)
Returns true if this cell is uninitialized.
+
Encapsulates a run of text that
Definition: phonetic_run.hpp:35
+
bool operator!=(const std::string &reference_string, const range_reference &ref)
Returns true if the string representation of the range is not equivalent to ref.
+
xlnt: xlnt/worksheet/print_options.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
26 #include <xlnt/xlnt_config.hpp> 27 #include <xlnt/utils/optional.hpp> Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
optional< bool > vertical_centered
center on page vertically
Definition: print_options.hpp:56
+
bool operator==(std::nullptr_t, const cell &cell)
Returns true if this cell is uninitialized.
+
optional< bool > grid_lines_set
if both print grid lines and this are true, grid lines are printed
Definition: print_options.hpp:41
+
Definition: print_options.hpp:31
+
optional< bool > horizontal_centered
center on page horizontally
Definition: print_options.hpp:51
+
optional< bool > print_grid_lines
if both grid_lines_set and this are true, grid lines are printed
Definition: print_options.hpp:36
+
+
optional< bool > print_headings
print row and column headings
Definition: print_options.hpp:46
+
xlnt: xlnt/styles/protection.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
29 #include <xlnt/xlnt_config.hpp> 30 #include <xlnt/utils/optional.hpp> Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
bool operator==(std::nullptr_t, const cell &cell)
Returns true if this cell is uninitialized.
+
bool operator!=(const std::string &reference_string, const range_reference &ref)
Returns true if the string representation of the range is not equivalent to ref.
+
Describes the protection style of a particular cell.
Definition: protection.hpp:37
+
xlnt: xlnt/worksheet/range.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
32 #include <xlnt/xlnt_config.hpp> 33 #include <xlnt/styles/alignment.hpp> 34 #include <xlnt/styles/border.hpp> 35 #include <xlnt/styles/conditional_format.hpp> 36 #include <xlnt/styles/fill.hpp> 37 #include <xlnt/styles/font.hpp> 38 #include <xlnt/styles/number_format.hpp> 39 #include <xlnt/styles/protection.hpp> 40 #include <xlnt/worksheet/cell_vector.hpp> 41 #include <xlnt/worksheet/major_order.hpp> 42 #include <xlnt/worksheet/range_iterator.hpp> 43 #include <xlnt/worksheet/range_reference.hpp> 44 #include <xlnt/worksheet/worksheet.hpp> 48 class const_range_iterator;
81 major_order order = major_order::row,
bool skip_null =
false );
123 const worksheet &target_worksheet()
const ;
133 std::size_t length()
const ;
271 void apply(std::function<
void (
class cell )> f);
A range is a 2D collection of cells with defined extens that can be iterated upon.
Definition: range.hpp:54
+
A const version of range_iterator which does not allow modification to the dereferenced cell_vector...
Definition: range_iterator.hpp:162
+
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
+
Describes the font style of a particular cell.
Definition: font.hpp:40
+
Definition: conditional_format.hpp:48
+
Describes the fill style of a particular cell.
Definition: fill.hpp:298
+
A worksheet is a 2D array of cells starting with cell A1 in the top-left corner and extending indefin...
Definition: worksheet.hpp:76
+
major_order
Defines whether iterating a range returns columns or rows sequentially.
Definition: major_order.hpp:33
+
Describes the border style of a particular cell.
Definition: border.hpp:93
+
bool operator==(std::nullptr_t, const cell &cell)
Returns true if this cell is uninitialized.
+
An object used to refer to a cell. References have two parts, the column and the row. In Excel, the reference string A1 refers to the top-left-most cell. A cell_reference can be initialized from a string of this form or a 1-indexed ordered pair of the form column, row.
Definition: cell_reference.hpp:59
+
Describes a unit of data in a worksheet at a specific coordinate and its associated properties...
Definition: cell.hpp:83
+
std::reverse_iterator< const_iterator > const_reverse_iterator
Alias for the const reverse iterator type
Definition: range.hpp:75
+
+
An iterator used by worksheet and range for traversing a 2D grid of cells by row/column then across t...
Definition: range_iterator.hpp:42
+
Alignment options that determine how text should be displayed within a cell.
Definition: alignment.hpp:62
+
A cell vector is a linear (1D) range of cells, either vertical or horizontal depending on the major o...
Definition: cell_vector.hpp:46
+
bool operator!=(const std::string &reference_string, const range_reference &ref)
Returns true if the string representation of the range is not equivalent to ref.
+
A range_reference describes a rectangular area of a worksheet with positive width and height defined ...
Definition: range_reference.hpp:35
+
std::reverse_iterator< iterator > reverse_iterator
Alias for the reverse iterator type
Definition: range.hpp:70
+
Describes the protection style of a particular cell.
Definition: protection.hpp:37
+
Describes a style which has a name and can be applied to multiple individual formats. In Excel this is a "Cell Style".
Definition: style.hpp:55
+
xlnt: xlnt/worksheet/range_iterator.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
28 #include <xlnt/xlnt_config.hpp> 29 #include <xlnt/cell/cell_reference.hpp> 30 #include <xlnt/worksheet/major_order.hpp> 31 #include <xlnt/worksheet/range_reference.hpp> 32 #include <xlnt/worksheet/worksheet.hpp> 50 using difference_type = std::ptrdiff_t;
135 bool skip_null_ =
false ;
170 using difference_type = std::ptrdiff_t;
250 bool skip_null_ =
false ;
260 detail::worksheet_impl *ws_;
A const version of range_iterator which does not allow modification to the dereferenced cell_vector...
Definition: range_iterator.hpp:162
+
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
std::bidirectional_iterator_tag iterator_category
this iterator meets the interface requirements of bidirection_iterator
Definition: range_iterator.hpp:168
+
std::bidirectional_iterator_tag iterator_category
iterator tags required for use with standard algorithms and adapters
Definition: range_iterator.hpp:48
+
A worksheet is a 2D array of cells starting with cell A1 in the top-left corner and extending indefin...
Definition: worksheet.hpp:76
+
major_order
Defines whether iterating a range returns columns or rows sequentially.
Definition: major_order.hpp:33
+
bool operator==(std::nullptr_t, const cell &cell)
Returns true if this cell is uninitialized.
+
An object used to refer to a cell. References have two parts, the column and the row. In Excel, the reference string A1 refers to the top-left-most cell. A cell_reference can be initialized from a string of this form or a 1-indexed ordered pair of the form column, row.
Definition: cell_reference.hpp:59
+
An iterator used by worksheet and range for traversing a 2D grid of cells by row/column then across t...
Definition: range_iterator.hpp:42
+
A cell vector is a linear (1D) range of cells, either vertical or horizontal depending on the major o...
Definition: cell_vector.hpp:46
+
bool operator!=(const std::string &reference_string, const range_reference &ref)
Returns true if the string representation of the range is not equivalent to ref.
+
A range_reference describes a rectangular area of a worksheet with positive width and height defined ...
Definition: range_reference.hpp:35
+
xlnt: xlnt/worksheet/range_reference.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
26 #include <xlnt/xlnt_config.hpp> 27 #include <xlnt/cell/cell_reference.hpp> 75 bool is_single_cell()
const ;
80 std::size_t width()
const ;
85 std::size_t height()
const ;
116 std::string to_string()
const ;
132 bool operator== (
const std::string &reference_string)
const ;
138 bool operator== (
const char *reference_string)
const ;
149 bool operator!= (
const std::string &reference_string)
const ;
155 bool operator!= (
const char *reference_string)
const ;
std::uint32_t row_t
All rows should be referred to by an instance of this type.
Definition: index_types.hpp:40
+
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
bool operator==(std::nullptr_t, const cell &cell)
Returns true if this cell is uninitialized.
+
An object used to refer to a cell. References have two parts, the column and the row. In Excel, the reference string A1 refers to the top-left-most cell. A cell_reference can be initialized from a string of this form or a 1-indexed ordered pair of the form column, row.
Definition: cell_reference.hpp:59
+
Columns can be referred to as a string A,B,...Z,AA,AB,..,ZZ,AAA,...,ZZZ or as a 1-indexed index...
Definition: index_types.hpp:47
+
bool operator!=(const std::string &reference_string, const range_reference &ref)
Returns true if the string representation of the range is not equivalent to ref.
+
A range_reference describes a rectangular area of a worksheet with positive width and height defined ...
Definition: range_reference.hpp:35
+
xlnt: xlnt/packaging/relationship.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
29 #include <xlnt/xlnt_config.hpp> 30 #include <xlnt/packaging/uri.hpp> 31 #include <xlnt/utils/path.hpp> 74 external_workbook_references,
76 pivot_table_cache_definition,
77 pivot_table_cache_records,
80 shared_workbook_revision_headers,
84 shared_workbook_user_data,
85 single_cell_table_definitions,
89 volatile_dependencies,
119 const std::string &id()
const ;
134 const uri &source()
const ;
139 const uri &target()
const ;
Represents an association between a source Package or part, and a target object which can be a part o...
Definition: relationship.hpp:102
+
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
Encapsulates a uniform resource identifier (URI) as described by RFC 3986.
Definition: uri.hpp:37
+
A worksheet is a 2D array of cells starting with cell A1 in the top-left corner and extending indefin...
Definition: worksheet.hpp:76
+
bool operator==(std::nullptr_t, const cell &cell)
Returns true if this cell is uninitialized.
+
A theme is a combination of fonts, colors, and effects. This isn't really supported yet...
Definition: theme.hpp:34
+
Describes a hyperlink pointing from a cell to another cell or a URL.
Definition: hyperlink.hpp:42
+
relationship_type
All package relationships must be one of these defined types.
Definition: relationship.hpp:53
+
target_mode
Specifies whether the target of a relationship is inside or outside the Package.
Definition: relationship.hpp:38
+
bool operator!=(const std::string &reference_string, const range_reference &ref)
Returns true if the string representation of the range is not equivalent to ref.
+
The relationship references a part that is inside the package.
+
xlnt: xlnt/cell/rich_text.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
29 #include <xlnt/xlnt_config.hpp> 30 #include <xlnt/cell/phonetic_run.hpp> 31 #include <xlnt/cell/rich_text_run.hpp> 32 #include <xlnt/worksheet/phonetic_pr.hpp> 61 rich_text (
const std::string &plain_text,
const class font &text_font);
77 void plain_text(
const std::string &s,
bool preserve_space);
82 std::string plain_text()
const ;
87 std::vector<rich_text_run> runs()
const ;
92 void runs(
const std::vector<rich_text_run> &new_runs);
102 std::vector<phonetic_run> phonetic_runs()
const ;
107 void phonetic_runs(
const std::vector<phonetic_run> &new_phonetic_runs);
117 bool has_phonetic_properties()
const ;
127 void phonetic_properties(
const phonetic_pr &phonetic_props);
147 bool operator== (
const std::string &rhs)
const ;
152 bool operator!= (
const std::string &rhs)
const ;
158 std::vector<rich_text_run> runs_;
159 std::vector<phonetic_run> phonetic_runs_;
166 std::size_t operator()(
const rich_text &k)
const 170 for (
auto r : k.
runs ())
172 res ^= std::hash<std::string>()(r.first);
Typedef a rich_text_run as a pair of string and optional font.
Definition: rich_text_run.hpp:37
+
std::vector< rich_text_run > runs() const
Returns a copy of the individual runs that comprise this text.
+
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
Describes the font style of a particular cell.
Definition: font.hpp:40
+
bool operator==(std::nullptr_t, const cell &cell)
Returns true if this cell is uninitialized.
+
Encapsulates zero or more formatted text runs where a text run is a string of text with the same defi...
Definition: rich_text.hpp:40
+
Encapsulates a run of text that
Definition: phonetic_run.hpp:35
+
Many settings in xlnt are allowed to not have a value set. This class encapsulates a value which may ...
Definition: format.hpp:43
+
Definition: rich_text.hpp:163
+
bool operator!=(const std::string &reference_string, const range_reference &ref)
Returns true if the string representation of the range is not equivalent to ref.
+
Phonetic properties Element provides a collection of properties that affect display of East Asian Lan...
Definition: phonetic_pr.hpp:38
+
xlnt: xlnt/cell/rich_text_run.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
28 #include <xlnt/xlnt_config.hpp> 29 #include <xlnt/styles/font.hpp> 30 #include <xlnt/utils/optional.hpp> Typedef a rich_text_run as a pair of string and optional font.
Definition: rich_text_run.hpp:37
+
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
bool operator==(std::nullptr_t, const cell &cell)
Returns true if this cell is uninitialized.
+
Many settings in xlnt are allowed to not have a value set. This class encapsulates a value which may ...
Definition: format.hpp:43
+
bool operator!=(const std::string &reference_string, const range_reference &ref)
Returns true if the string representation of the range is not equivalent to ref.
+
xlnt: xlnt/worksheet/row_properties.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
27 #include <xlnt/xlnt_config.hpp> 50 bool custom_height =
false ;
bool custom_height
Whether or not the height is different from the default
Definition: row_properties.hpp:50
+
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
optional< double > height
Row height
Definition: row_properties.hpp:40
+
optional< double > dy_descent
Distance in pixels from the bottom of the cell to the baseline of the cell content ...
Definition: row_properties.hpp:45
+
The properties of a row in a worksheet.
Definition: row_properties.hpp:34
+
optional< std::string > spans
The row column span, used as part of the row block optimisation. This used for loading this attribute...
Definition: row_properties.hpp:72
+
bool operator==(std::nullptr_t, const cell &cell)
Returns true if this cell is uninitialized.
+
optional< bool > custom_format
True if row style should be applied
Definition: row_properties.hpp:60
+
optional< std::size_t > style
The index to the style used by all cells in this row
Definition: row_properties.hpp:65
+
+
bool hidden
Whether or not the row should be hidden
Definition: row_properties.hpp:55
+
xlnt: xlnt/utils/scoped_enum_hash.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
34 template <
typename Enum>
42 static std::hash<std::size_t> hasher;
43 return hasher(static_cast<std::size_t>(e));
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
Allows a scoped enum (aka "enum class") to be used as a key in a std::unordered_map.
Definition: scoped_enum_hash.hpp:35
+
std::size_t operator()(Enum e) const
Cast the enumeration e to a std::size_t and hash that value using std::hash.
Definition: scoped_enum_hash.hpp:40
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
do a search
+ {
+ this.Search();
+ }
+ }
+
+ this.OnSearchSelectKey = function(evt)
+ {
+ var e = (evt) ? evt : window.event; // for IE
+ if (e.keyCode==40 && this.searchIndex0) // Up
+ {
+ this.searchIndex--;
+ this.OnSelectItem(this.searchIndex);
+ }
+ else if (e.keyCode==13 || e.keyCode==27)
+ {
+ this.OnSelectItem(this.searchIndex);
+ this.CloseSelectionWindow();
+ this.DOMSearchField().focus();
+ }
+ return false;
+ }
+
+ // --------- Actions
+
+ // Closes the results window.
+ this.CloseResultsWindow = function()
+ {
+ this.DOMPopupSearchResultsWindow().style.display = 'none';
+ this.DOMSearchClose().style.display = 'none';
+ this.Activate(false);
+ }
+
+ this.CloseSelectionWindow = function()
+ {
+ this.DOMSearchSelectWindow().style.display = 'none';
+ }
+
+ // Performs a search.
+ this.Search = function()
+ {
+ this.keyTimeout = 0;
+
+ // strip leading whitespace
+ var searchValue = this.DOMSearchField().value.replace(/^ +/, "");
+
+ var code = searchValue.toLowerCase().charCodeAt(0);
+ var idxChar = searchValue.substr(0, 1).toLowerCase();
+ if ( 0xD800 <= code && code <= 0xDBFF && searchValue > 1) // surrogate pair
+ {
+ idxChar = searchValue.substr(0, 2);
+ }
+
+ var resultsPage;
+ var resultsPageWithSearch;
+ var hasResultsPage;
+
+ var idx = indexSectionsWithContent[this.searchIndex].indexOf(idxChar);
+ if (idx!=-1)
+ {
+ var hexCode=idx.toString(16);
+ resultsPage = this.resultsPath + '/' + indexSectionNames[this.searchIndex] + '_' + hexCode + '.html';
+ resultsPageWithSearch = resultsPage+'?'+escape(searchValue);
+ hasResultsPage = true;
+ }
+ else // nothing available for this search term
+ {
+ resultsPage = this.resultsPath + '/nomatches.html';
+ resultsPageWithSearch = resultsPage;
+ hasResultsPage = false;
+ }
+
+ window.frames.MSearchResults.location = resultsPageWithSearch;
+ var domPopupSearchResultsWindow = this.DOMPopupSearchResultsWindow();
+
+ if (domPopupSearchResultsWindow.style.display!='block')
+ {
+ var domSearchBox = this.DOMSearchBox();
+ this.DOMSearchClose().style.display = 'inline';
+ if (this.insideFrame)
+ {
+ var domPopupSearchResults = this.DOMPopupSearchResults();
+ domPopupSearchResultsWindow.style.position = 'relative';
+ domPopupSearchResultsWindow.style.display = 'block';
+ var width = document.body.clientWidth - 8; // the -8 is for IE :-(
+ domPopupSearchResultsWindow.style.width = width + 'px';
+ domPopupSearchResults.style.width = width + 'px';
+ }
+ else
+ {
+ var domPopupSearchResults = this.DOMPopupSearchResults();
+ var left = getXPos(domSearchBox) + 150; // domSearchBox.offsetWidth;
+ var top = getYPos(domSearchBox) + 20; // domSearchBox.offsetHeight + 1;
+ domPopupSearchResultsWindow.style.display = 'block';
+ left -= domPopupSearchResults.offsetWidth;
+ domPopupSearchResultsWindow.style.top = top + 'px';
+ domPopupSearchResultsWindow.style.left = left + 'px';
+ }
+ }
+
+ this.lastSearchValue = searchValue;
+ this.lastResultsPage = resultsPage;
+ }
+
+ // -------- Activation Functions
+
+ // Activates or deactivates the search panel, resetting things to
+ // their default values if necessary.
+ this.Activate = function(isActive)
+ {
+ if (isActive || // open it
+ this.DOMPopupSearchResultsWindow().style.display == 'block'
+ )
+ {
+ this.DOMSearchBox().className = 'MSearchBoxActive';
+
+ var searchField = this.DOMSearchField();
+
+ if (searchField.value == this.searchLabel) // clear "Search" term upon entry
+ {
+ searchField.value = '';
+ this.searchActive = true;
+ }
+ }
+ else if (!isActive) // directly remove the panel
+ {
+ this.DOMSearchBox().className = 'MSearchBoxInactive';
+ this.DOMSearchField().value = this.searchLabel;
+ this.searchActive = false;
+ this.lastSearchValue = ''
+ this.lastResultsPage = '';
+ }
+ }
+}
+
+// -----------------------------------------------------------------------
+
+// The class that handles everything on the search results page.
+function SearchResults(name)
+{
+ // The number of matches from the last run of .
+ this.lastMatchCount = 0;
+ this.lastKey = 0;
+ this.repeatOn = false;
+
+ // Toggles the visibility of the passed element ID.
+ this.FindChildElement = function(id)
+ {
+ var parentElement = document.getElementById(id);
+ var element = parentElement.firstChild;
+
+ while (element && element!=parentElement)
+ {
+ if (element.nodeName == 'DIV' && element.className == 'SRChildren')
+ {
+ return element;
+ }
+
+ if (element.nodeName == 'DIV' && element.hasChildNodes())
+ {
+ element = element.firstChild;
+ }
+ else if (element.nextSibling)
+ {
+ element = element.nextSibling;
+ }
+ else
+ {
+ do
+ {
+ element = element.parentNode;
+ }
+ while (element && element!=parentElement && !element.nextSibling);
+
+ if (element && element!=parentElement)
+ {
+ element = element.nextSibling;
+ }
+ }
+ }
+ }
+
+ this.Toggle = function(id)
+ {
+ var element = this.FindChildElement(id);
+ if (element)
+ {
+ if (element.style.display == 'block')
+ {
+ element.style.display = 'none';
+ }
+ else
+ {
+ element.style.display = 'block';
+ }
+ }
+ }
+
+ // Searches for the passed string. If there is no parameter,
+ // it takes it from the URL query.
+ //
+ // Always returns true, since other documents may try to call it
+ // and that may or may not be possible.
+ this.Search = function(search)
+ {
+ if (!search) // get search word from URL
+ {
+ search = window.location.search;
+ search = search.substring(1); // Remove the leading '?'
+ search = unescape(search);
+ }
+
+ search = search.replace(/^ +/, ""); // strip leading spaces
+ search = search.replace(/ +$/, ""); // strip trailing spaces
+ search = search.toLowerCase();
+ search = convertToId(search);
+
+ var resultRows = document.getElementsByTagName("div");
+ var matches = 0;
+
+ var i = 0;
+ while (i < resultRows.length)
+ {
+ var row = resultRows.item(i);
+ if (row.className == "SRResult")
+ {
+ var rowMatchName = row.id.toLowerCase();
+ rowMatchName = rowMatchName.replace(/^sr\d*_/, ''); // strip 'sr123_'
+
+ if (search.length<=rowMatchName.length &&
+ rowMatchName.substr(0, search.length)==search)
+ {
+ row.style.display = 'block';
+ matches++;
+ }
+ else
+ {
+ row.style.display = 'none';
+ }
+ }
+ i++;
+ }
+ document.getElementById("Searching").style.display='none';
+ if (matches == 0) // no results
+ {
+ document.getElementById("NoMatches").style.display='block';
+ }
+ else // at least one result
+ {
+ document.getElementById("NoMatches").style.display='none';
+ }
+ this.lastMatchCount = matches;
+ return true;
+ }
+
+ // return the first item with index index or higher that is visible
+ this.NavNext = function(index)
+ {
+ var focusItem;
+ while (1)
+ {
+ var focusName = 'Item'+index;
+ focusItem = document.getElementById(focusName);
+ if (focusItem && focusItem.parentNode.parentNode.style.display=='block')
+ {
+ break;
+ }
+ else if (!focusItem) // last element
+ {
+ break;
+ }
+ focusItem=null;
+ index++;
+ }
+ return focusItem;
+ }
+
+ this.NavPrev = function(index)
+ {
+ var focusItem;
+ while (1)
+ {
+ var focusName = 'Item'+index;
+ focusItem = document.getElementById(focusName);
+ if (focusItem && focusItem.parentNode.parentNode.style.display=='block')
+ {
+ break;
+ }
+ else if (!focusItem) // last element
+ {
+ break;
+ }
+ focusItem=null;
+ index--;
+ }
+ return focusItem;
+ }
+
+ this.ProcessKeys = function(e)
+ {
+ if (e.type == "keydown")
+ {
+ this.repeatOn = false;
+ this.lastKey = e.keyCode;
+ }
+ else if (e.type == "keypress")
+ {
+ if (!this.repeatOn)
+ {
+ if (this.lastKey) this.repeatOn = true;
+ return false; // ignore first keypress after keydown
+ }
+ }
+ else if (e.type == "keyup")
+ {
+ this.lastKey = 0;
+ this.repeatOn = false;
+ }
+ return this.lastKey!=0;
+ }
+
+ this.Nav = function(evt,itemIndex)
+ {
+ var e = (evt) ? evt : window.event; // for IE
+ if (e.keyCode==13) return true;
+ if (!this.ProcessKeys(e)) return false;
+
+ if (this.lastKey==38) // Up
+ {
+ var newIndex = itemIndex-1;
+ var focusItem = this.NavPrev(newIndex);
+ if (focusItem)
+ {
+ var child = this.FindChildElement(focusItem.parentNode.parentNode.id);
+ if (child && child.style.display == 'block') // children visible
+ {
+ var n=0;
+ var tmpElem;
+ while (1) // search for last child
+ {
+ tmpElem = document.getElementById('Item'+newIndex+'_c'+n);
+ if (tmpElem)
+ {
+ focusItem = tmpElem;
+ }
+ else // found it!
+ {
+ break;
+ }
+ n++;
+ }
+ }
+ }
+ if (focusItem)
+ {
+ focusItem.focus();
+ }
+ else // return focus to search field
+ {
+ parent.document.getElementById("MSearchField").focus();
+ }
+ }
+ else if (this.lastKey==40) // Down
+ {
+ var newIndex = itemIndex+1;
+ var focusItem;
+ var item = document.getElementById('Item'+itemIndex);
+ var elem = this.FindChildElement(item.parentNode.parentNode.id);
+ if (elem && elem.style.display == 'block') // children visible
+ {
+ focusItem = document.getElementById('Item'+itemIndex+'_c0');
+ }
+ if (!focusItem) focusItem = this.NavNext(newIndex);
+ if (focusItem) focusItem.focus();
+ }
+ else if (this.lastKey==39) // Right
+ {
+ var item = document.getElementById('Item'+itemIndex);
+ var elem = this.FindChildElement(item.parentNode.parentNode.id);
+ if (elem) elem.style.display = 'block';
+ }
+ else if (this.lastKey==37) // Left
+ {
+ var item = document.getElementById('Item'+itemIndex);
+ var elem = this.FindChildElement(item.parentNode.parentNode.id);
+ if (elem) elem.style.display = 'none';
+ }
+ else if (this.lastKey==27) // Escape
+ {
+ parent.searchBox.CloseResultsWindow();
+ parent.document.getElementById("MSearchField").focus();
+ }
+ else if (this.lastKey==13) // Enter
+ {
+ return true;
+ }
+ return false;
+ }
+
+ this.NavChild = function(evt,itemIndex,childIndex)
+ {
+ var e = (evt) ? evt : window.event; // for IE
+ if (e.keyCode==13) return true;
+ if (!this.ProcessKeys(e)) return false;
+
+ if (this.lastKey==38) // Up
+ {
+ if (childIndex>0)
+ {
+ var newIndex = childIndex-1;
+ document.getElementById('Item'+itemIndex+'_c'+newIndex).focus();
+ }
+ else // already at first child, jump to parent
+ {
+ document.getElementById('Item'+itemIndex).focus();
+ }
+ }
+ else if (this.lastKey==40) // Down
+ {
+ var newIndex = childIndex+1;
+ var elem = document.getElementById('Item'+itemIndex+'_c'+newIndex);
+ if (!elem) // last child, jump to parent next parent
+ {
+ elem = this.NavNext(itemIndex+1);
+ }
+ if (elem)
+ {
+ elem.focus();
+ }
+ }
+ else if (this.lastKey==27) // Escape
+ {
+ parent.searchBox.CloseResultsWindow();
+ parent.document.getElementById("MSearchField").focus();
+ }
+ else if (this.lastKey==13) // Enter
+ {
+ return true;
+ }
+ return false;
+ }
+}
+
+function setKeyActions(elem,action)
+{
+ elem.setAttribute('onkeydown',action);
+ elem.setAttribute('onkeypress',action);
+ elem.setAttribute('onkeyup',action);
+}
+
+function setClassAttr(elem,attr)
+{
+ elem.setAttribute('class',attr);
+ elem.setAttribute('className',attr);
+}
+
+function createResults()
+{
+ var results = document.getElementById("SRResults");
+ for (var e=0; e
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
+
Loading...
+
+
+
Searching...
+
No Matches
+
+
xlnt: xlnt/worksheet/selection.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
26 #include <xlnt/xlnt_config.hpp> 27 #include <xlnt/cell/cell_reference.hpp> 28 #include <xlnt/worksheet/pane.hpp> 29 #include <xlnt/worksheet/range_reference.hpp> 49 : active_cell_(active_cell), sqref_(
range_reference (active_cell, active_cell)), pane_(quadrant)
58 : active_cell_(active_cell), sqref_(selected), pane_(quadrant)
67 return active_cell_.is_set();
75 return active_cell_.get();
91 return sqref_.is_set();
140 return active_cell_ == rhs.active_cell_
141 && sqref_ == rhs.sqref_
142 && pane_ == rhs.pane_;
void sqref(const range_reference &ref)
Sets the range encompassed by this selection.
Definition: selection.hpp:105
+
bool has_sqref() const
Returns true if this selection has a defined sqref.
Definition: selection.hpp:89
+
pane_corner pane() const
Returns the sheet quadrant of this selection.
Definition: selection.hpp:121
+
void pane(pane_corner corner)
Sets the sheet quadrant of this selection to corner.
Definition: selection.hpp:129
+
The selected area of a worksheet.
Definition: selection.hpp:36
+
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
selection(pane_corner quadrant, cell_reference active_cell, range_reference selected)
ctor with selected range sqref must contain active_cell
Definition: selection.hpp:57
+
range_reference sqref() const
Returns the range encompassed by this selection.
Definition: selection.hpp:97
+
An object used to refer to a cell. References have two parts, the column and the row. In Excel, the reference string A1 refers to the top-left-most cell. A cell_reference can be initialized from a string of this form or a 1-indexed ordered pair of the form column, row.
Definition: cell_reference.hpp:59
+
void active_cell(const cell_reference &ref)
Sets the active cell to that pointed to by ref.
Definition: selection.hpp:81
+
pane_corner
Enumeration of the four quadrants of a worksheet
Definition: pane.hpp:46
+
Many settings in xlnt are allowed to not have a value set. This class encapsulates a value which may ...
Definition: format.hpp:43
+
bool has_active_cell() const
Returns true if this selection has a defined active cell.
Definition: selection.hpp:65
+
bool operator==(const selection &rhs) const
Returns true if this selection is equal to rhs based on its active cell, sqref, and pane...
Definition: selection.hpp:138
+
selection(pane_corner quadrant, cell_reference active_cell)
ctor when no range selected sqref == active_cell
Definition: selection.hpp:48
+
void sqref(const std::string &ref)
Sets the range encompassed by this selection.
Definition: selection.hpp:113
+
A range_reference describes a rectangular area of a worksheet with positive width and height defined ...
Definition: range_reference.hpp:35
+
cell_reference active_cell() const
Returns the cell reference of the active cell.
Definition: selection.hpp:73
+
xlnt: xlnt/worksheet/sheet_format_properties.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
26 #include <xlnt/xlnt_config.hpp> 27 #include <xlnt/utils/numeric.hpp> 28 #include <xlnt/utils/optional.hpp> 46 double default_row_height = 15.0;
+
+
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
bool operator==(std::nullptr_t, const cell &cell)
Returns true if this cell is uninitialized.
+
+
+
+
+
xlnt: xlnt/worksheet/sheet_pr.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
28 #include <xlnt/xlnt_config.hpp> 29 #include <xlnt/cell/cell_reference.hpp> 30 #include <xlnt/utils/optional.hpp> optional< bool > filter_mode
worksheet has one or more autofilters or advanced filters on
Definition: sheet_pr.hpp:74
+
optional< bool > sync_horizontal
is horizontally synced to the anchor point
Definition: sheet_pr.hpp:39
+
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
bool operator==(std::nullptr_t, const cell &cell)
Returns true if this cell is uninitialized.
+
optional< bool > transition_entry
Lotus compatibility option
Definition: sheet_pr.hpp:59
+
optional< bool > enable_format_condition_calculation
whether the conditional formatting calculations shall be evaluated
Definition: sheet_pr.hpp:79
+
optional< bool > transition_evaluation
Lotus compatibility option
Definition: sheet_pr.hpp:54
+
+
optional< cell_reference > sync_ref
Anchor point for worksheet's window
Definition: sheet_pr.hpp:49
+
optional< bool > published
worksheet is published
Definition: sheet_pr.hpp:64
+
Definition: sheet_pr.hpp:34
+
optional< std::string > code_name
stable name of the sheet
Definition: sheet_pr.hpp:69
+
optional< bool > sync_vertical
is vertically synced to the anchor point
Definition: sheet_pr.hpp:44
+
xlnt: xlnt/worksheet/sheet_protection.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
29 #include <xlnt/xlnt_config.hpp> 44 static std::string hash_password(
const std::string &password);
49 void password(
const std::string &password);
54 std::string hashed_password()
const ;
60 std::string hashed_password_;
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
Protection applied to a particular worksheet to prevent it from being modified.
Definition: sheet_protection.hpp:38
+
xlnt: xlnt/worksheet/sheet_view.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
27 #include <xlnt/xlnt_config.hpp> 28 #include <xlnt/utils/optional.hpp> 29 #include <xlnt/worksheet/pane.hpp> 30 #include <xlnt/worksheet/selection.hpp> 54 void id (std::size_t new_id)
62 std::size_t
id ()
const 72 return pane_.is_set();
112 return !selections_.empty();
120 selections_.push_back(new_selection);
144 return selections_.at(index);
152 show_grid_lines_ = show;
160 return show_grid_lines_;
168 default_grid_color_ = is_default;
176 return default_grid_color_;
200 return top_left_cell_.is_set();
208 top_left_cell_.set(ref);
216 return top_left_cell_.get();
225 return id_ == rhs.id_
226 && show_grid_lines_ == rhs.show_grid_lines_
227 && default_grid_color_ == rhs.default_grid_color_
228 && pane_ == rhs.pane_
229 && selections_ == rhs.selections_
230 && top_left_cell_ == rhs.top_left_cell_;
242 bool show_grid_lines_ =
true ;
247 bool default_grid_color_ =
true ;
267 std::vector<xlnt::selection> selections_;
void clear_selections()
Removes all selections.
Definition: sheet_view.hpp:126
+
void top_left_cell(const cell_reference &ref)
Sets the top left cell of this view.
Definition: sheet_view.hpp:206
+
bool show_grid_lines() const
Returns true if grid lines will be shown for sheets using this view.
Definition: sheet_view.hpp:158
+
class xlnt::selection & selection(std::size_t index)
Returns the selection at the given index.
Definition: sheet_view.hpp:142
+
struct pane & pane()
Returns a reference to this view's pane.
Definition: sheet_view.hpp:78
+
std::size_t id() const
Returns the ID of this view.
Definition: sheet_view.hpp:62
+
void add_selection(const class selection &new_selection)
Adds the given selection to the collection of selections.
Definition: sheet_view.hpp:118
+
bool has_top_left_cell() const
has a top left cell?
Definition: sheet_view.hpp:198
+
void pane(const struct pane &new_pane)
Sets the pane of this view to new_pane.
Definition: sheet_view.hpp:102
+
cell_reference top_left_cell() const
Returns the top left cell of this view.
Definition: sheet_view.hpp:214
+
sheet_view_type type() const
Returns the type of this view.
Definition: sheet_view.hpp:190
+
The selected area of a worksheet.
Definition: selection.hpp:36
+
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
void show_grid_lines(bool show)
If show is true, grid lines will be shown for sheets using this view.
Definition: sheet_view.hpp:150
+
sheet_view_type
Enumeration of possible types of sheet views
Definition: sheet_view.hpp:37
+
bool has_selections() const
Returns true if this view has any selections.
Definition: sheet_view.hpp:110
+
bool operator==(const sheet_view &rhs) const
Returns true if this view is equal to rhs based on its id, grid lines setting, default grid color...
Definition: sheet_view.hpp:223
+
An object used to refer to a cell. References have two parts, the column and the row. In Excel, the reference string A1 refers to the top-left-most cell. A cell_reference can be initialized from a string of this form or a 1-indexed ordered pair of the form column, row.
Definition: cell_reference.hpp:59
+
std::vector< xlnt::selection > selections() const
Returns the collection of selections as a vector.
Definition: sheet_view.hpp:134
+
Describes a view of a worksheet. Worksheets can have multiple views which show the data differently...
Definition: sheet_view.hpp:48
+
void default_grid_color(bool is_default)
If is_default is true, the default grid color will be used.
Definition: sheet_view.hpp:166
+
bool has_pane() const
Returns true if this view has a pane defined.
Definition: sheet_view.hpp:70
+
void type(sheet_view_type new_type)
Sets the type of this view.
Definition: sheet_view.hpp:182
+
A fixed portion of a worksheet.
Definition: pane.hpp:57
+
void clear_pane()
Removes the defined pane from this view.
Definition: sheet_view.hpp:94
+
+
void id(std::size_t new_id)
Sets the ID of this view to new_id.
Definition: sheet_view.hpp:54
+
const struct pane & pane() const
Returns a reference to this view's pane.
Definition: sheet_view.hpp:86
+
bool default_grid_color() const
Returns true if the default grid color will be used.
Definition: sheet_view.hpp:174
+
xlnt: xlnt/drawing/spreadsheet_drawing.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
26 #include <xlnt/xlnt_config.hpp> 49 void serialize(xml::serializer &serializer);
51 std::vector<std::string> get_embed_ids();
54 std::string serialized_value_;
55 std::vector<std::string> embed_ids_;
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
The spreadsheet_drawing class encapsulates the information captured from objects within the spreadshe...
Definition: spreadsheet_drawing.hpp:45
+
Definition: spreadsheet_drawing.hpp:30
+
xlnt: xlnt/workbook/streaming_workbook_reader.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
32 #include <xlnt/xlnt_config.hpp> 74 bool has_worksheet(
const std::string &name);
80 void begin_worksheet(
const std::string &name);
93 void open(
const std::vector<std::uint8_t> &data);
99 void open(
const std::string &filename);
102 void open(
const std::wstring &filename);
113 void open(
const path &filename);
119 void open(std::istream &stream);
125 void open(std::unique_ptr<std::streambuf> &&buffer);
130 std::vector<std::string> sheet_titles();
133 std::string worksheet_rel_id_;
134 std::unique_ptr<detail::xlsx_consumer> consumer_;
135 std::unique_ptr<workbook> workbook_;
136 std::unique_ptr<std::istream> stream_;
137 std::unique_ptr<std::streambuf> stream_buffer_;
138 std::unique_ptr<std::istream> part_stream_;
139 std::unique_ptr<std::streambuf> part_stream_buffer_;
140 std::unique_ptr<xml::parser> parser_;
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
A worksheet is a 2D array of cells starting with cell A1 in the top-left corner and extending indefin...
Definition: worksheet.hpp:76
+
Definition: spreadsheet_drawing.hpp:30
+
Describes a unit of data in a worksheet at a specific coordinate and its associated properties...
Definition: cell.hpp:83
+
Encapsulates a path that points to location in a filesystem.
Definition: path.hpp:37
+
workbook is the container for all other parts of the document.
Definition: streaming_workbook_reader.hpp:54
+
xlnt: xlnt/workbook/streaming_workbook_writer.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
31 #include <xlnt/xlnt_config.hpp> 74 worksheet add_worksheet(
const std::string &title);
80 void open(std::vector<std::uint8_t> &data);
86 void open(
const std::string &filename);
89 void open(
const std::wstring &filename);
105 void open(std::ostream &stream);
107 std::unique_ptr<xlnt::detail::xlsx_producer> producer_;
108 std::unique_ptr<workbook> workbook_;
109 std::unique_ptr<std::ostream> stream_;
110 std::unique_ptr<std::streambuf> stream_buffer_;
111 std::unique_ptr<std::ostream> part_stream_;
112 std::unique_ptr<std::streambuf> part_stream_buffer_;
113 std::unique_ptr<xml::serializer> serializer_;
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
workbook is the container for all other parts of the document.
Definition: streaming_workbook_writer.hpp:50
+
A worksheet is a 2D array of cells starting with cell A1 in the top-left corner and extending indefin...
Definition: worksheet.hpp:76
+
Definition: spreadsheet_drawing.hpp:30
+
An object used to refer to a cell. References have two parts, the column and the row. In Excel, the reference string A1 refers to the top-left-most cell. A cell_reference can be initialized from a string of this form or a 1-indexed ordered pair of the form column, row.
Definition: cell_reference.hpp:59
+
Describes a unit of data in a worksheet at a specific coordinate and its associated properties...
Definition: cell.hpp:83
+
Encapsulates a path that points to location in a filesystem.
Definition: path.hpp:37
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for std::hash< xlnt::cell_reference > , including all inherited members.
+
xlnt: std::hash< xlnt::cell_reference > Struct Template Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
The documentation for this struct was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for std::hash< xlnt::column_t > , including all inherited members.
+
xlnt: std::hash< xlnt::column_t > Struct Template Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Template specialization to allow xlnt::column_t to be used as a key in a std container.
+ More...
+
+
#include <index_types.hpp >
+
+
+
template<>
+
+
Template specialization to allow xlnt::column_t to be used as a key in a std container.
+
+
+
◆
+
+
+
+
+
Returns the result of hashing column k.
+
+
+
+
The documentation for this struct was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for std::hash< xlnt::path > , including all inherited members.
+
xlnt: std::hash< xlnt::path > Struct Template Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Template specialization to allow xlnt:path to be used as a key in a std container.
+ More...
+
+
#include <path.hpp >
+
+
+
template<>
+
+
Template specialization to allow xlnt:path to be used as a key in a std container.
+
+
+
◆
+
+
+
+
+
Returns a hashed represenation of the given path.
+
+
+
+
The documentation for this struct was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::cell_reference_hash , including all inherited members.
+
xlnt: xlnt::cell_reference_hash Struct Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Functor for hashing a cell reference. Allows for use of std::unordered_set<cell_reference, cel_reference_hash> and similar.
+ More...
+
+
#include <cell_reference.hpp >
+
+
+
Functor for hashing a cell reference. Allows for use of std::unordered_set<cell_reference, cel_reference_hash> and similar.
+
+
+
◆
+
+
+
+
+
+ std::size_t xlnt::cell_reference_hash::operator()
+ (
+ const cell_reference &
+ k )
+ const
+
+
+
+
+
The documentation for this struct was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::column_hash , including all inherited members.
+
xlnt: xlnt::column_hash Struct Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Functor for hashing a column. Allows for use of std::unordered_set<column_t, column_hash> and similar.
+ More...
+
+
#include <index_types.hpp >
+
+
+
Functor for hashing a column. Allows for use of std::unordered_set<column_t, column_hash> and similar.
+
+
+
◆
+
+
+
+
+
+ std::size_t xlnt::column_hash::operator()
+ (
+ const column_t &
+ k )
+ const
+
+
+
+
+
Returns the result of hashing column k.
+
+
+
+
The documentation for this struct was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::date , including all inherited members.
+
xlnt: xlnt::date Struct Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
A date is a specific day specified in terms of a year, month, and day. It can also be initialized as a number of days since a base date using date::from_number .
+ More...
+
+
#include <date.hpp >
+
+ date (int year_, int month_, int day_) Constructs a data from a given year, month, and day. More... int to_number (calendar base_date) const Return the number of days between this date and base_date. More... int weekday () const Calculates and returns the day of the week that this date represents in the range 0 to 6 where 0 represents Sunday. More... bool operator== (const date &comparand) const Return true if this date is equal to comparand. More... bool operator!= (const date &comparand) const Return true if this date is equal to comparand. More...
+static date today () Return the current date according to the system time. More... static date from_number (int days_since_base_year, calendar base_date) Return a date by adding days_since_base_year to base_date. This includes leap years. More...
+
+
A date is a specific day specified in terms of a year, month, and day. It can also be initialized as a number of days since a base date using date::from_number .
+
+
+
◆
+
+
+
+
+
+ xlnt::date::date
+ (
+ int
+ year_ ,
+
+ int
+ month_ ,
+
+ int
+ day_
+
+ )
+
+
+
+
+
Constructs a data from a given year, month, and day.
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static date xlnt::date::from_number
+ (
+ int
+ days_since_base_year ,
+
+ calendar base_date
+
+ )
+
+
+
+
+static
+
+
+
+
+
Return a date by adding days_since_base_year to base_date. This includes leap years.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::date::operator!=
+ (
+ const date &
+ comparand )
+ const
+
+
+
+
+
Return true if this date is equal to comparand.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::date::operator==
+ (
+ const date &
+ comparand )
+ const
+
+
+
+
+
Return true if this date is equal to comparand.
+
+
+
+
+
◆
+
+
+
+
+
+ int xlnt::date::to_number
+ (
+ calendar base_date )
+ const
+
+
+
+
+
Return the number of days between this date and base_date.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static date xlnt::date::today
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Return the current date according to the system time.
+
+
+
+
+
◆
+
+
+
+
+
+ int xlnt::date::weekday
+ (
+ )
+ const
+
+
+
+
+
Calculates and returns the day of the week that this date represents in the range 0 to 6 where 0 represents Sunday.
+
+
+
+
+
+
◆
+
+
+
+
+
+ int xlnt::date::day
+
+
+
+
+
+
◆
+
+
+
+
+
+ int xlnt::date::month
+
+
+
+
+
+
◆
+
+
+
+
+
+ int xlnt::date::year
+
+
+
+
+
The documentation for this struct was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::datetime , including all inherited members.
+
xlnt: xlnt::datetime Struct Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
A datetime is a combination of a date and a time.
+ More...
+
+
#include <datetime.hpp >
+
+ datetime (const date &d, const time &t) Constructs a datetime from a date and a time. More... datetime (int year_, int month_, int day_, int hour_=0, int minute_=0, int second_=0, int microsecond_=0) Constructs a datetime from a year, month, and day plus optional hour, minute, second, and microsecond. More... std::string to_string () const Returns a string represenation of this date and time. More... std::string to_iso_string () const Returns an ISO-formatted string representation of this date and time. More... double to_number (calendar base_date) const Returns this datetime as a number of seconds since 1900 or 1904 (depending on base_date provided). More... bool operator== (const datetime &comparand) const Returns true if this datetime is equivalent to comparand. More... int weekday () const Calculates and returns the day of the week that this date represents in the range 0 to 6 where 0 represents Sunday. More...
+
+
A datetime is a combination of a date and a time.
+
+
+
◆ [1/2]
+
+
+
+
+
+ xlnt::datetime::datetime
+ (
+ const date &
+ d ,
+
+ const time &
+ t
+
+ )
+
+
+
+
+
Constructs a datetime from a date and a time.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ xlnt::datetime::datetime
+ (
+ int
+ year_ ,
+
+ int
+ month_ ,
+
+ int
+ day_ ,
+
+ int
+ hour_ = 0,
+
+ int
+ minute_ = 0,
+
+ int
+ second_ = 0,
+
+ int
+ microsecond_ = 0
+
+ )
+
+
+
+
+
Constructs a datetime from a year, month, and day plus optional hour, minute, second, and microsecond.
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static datetime xlnt::datetime::from_iso_string
+ (
+ const std::string &
+ iso_string )
+
+
+
+
+static
+
+
+
+
+
Returns a datetime equivalent to the ISO-formatted string iso_string.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static datetime xlnt::datetime::from_number
+ (
+ double
+ number ,
+
+ calendar base_date
+
+ )
+
+
+
+
+static
+
+
+
+
+
Returns a datetime from number by converting the integer part into a date and the fractional part into a time according to date::from_number and time::from_number .
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static datetime xlnt::datetime::now
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Returns the current date and time according to the system time.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::datetime::operator==
+ (
+ const datetime &
+ comparand )
+ const
+
+
+
+
+
Returns true if this datetime is equivalent to comparand.
+
+
+
+
+
◆
+
+
+
+
+
+ std::string xlnt::datetime::to_iso_string
+ (
+ )
+ const
+
+
+
+
+
Returns an ISO-formatted string representation of this date and time.
+
+
+
+
+
◆
+
+
+
+
+
+ double xlnt::datetime::to_number
+ (
+ calendar base_date )
+ const
+
+
+
+
+
Returns this datetime as a number of seconds since 1900 or 1904 (depending on base_date provided).
+
+
+
+
+
◆
+
+
+
+
+
+ std::string xlnt::datetime::to_string
+ (
+ )
+ const
+
+
+
+
+
Returns a string represenation of this date and time.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static datetime xlnt::datetime::today
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Returns the current date and time according to the system time. This is equivalent to datetime::now() .
+
+
+
+
+
◆
+
+
+
+
+
+ int xlnt::datetime::weekday
+ (
+ )
+ const
+
+
+
+
+
Calculates and returns the day of the week that this date represents in the range 0 to 6 where 0 represents Sunday.
+
+
+
+
+
+
◆
+
+
+
+
+
+ int xlnt::datetime::day
+
+
+
+
+
+
◆
+
+
+
+
+
+ int xlnt::datetime::hour
+
+
+
+
+
+
◆
+
+
+
+
+
+ int xlnt::datetime::microsecond
+
+
+
+
+
+
◆
+
+
+
+
+
+ int xlnt::datetime::minute
+
+
+
+
+
+
◆
+
+
+
+
+
+ int xlnt::datetime::month
+
+
+
+
+
+
◆
+
+
+
+
+
+ int xlnt::datetime::second
+
+
+
+
+
+
◆
+
+
+
+
+
+ int xlnt::datetime::year
+
+
+
+
+
The documentation for this struct was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::document_security::lock_verifier , including all inherited members.
+
xlnt: xlnt::document_security::lock_verifier Struct Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Holds data describing the verifier that locks revisions or a workbook.
+ More...
+
+
#include <document_security.hpp >
+
+std::string hash_algorithm The algorithm used to create and verify this lock. More... std::string salt The initial salt combined with the password used to prevent rainbow table attacks More... std::string hash The actual hash value represented as a string More... std::size_t spin_count The number of times the hash should be applied to the password combined with the salt. This allows the difficulty of the hash to be increased as computing power increases. More...
+
+
Holds data describing the verifier that locks revisions or a workbook.
+
+
+
◆
+
+
+
+
+
+ std::string xlnt::document_security::lock_verifier::hash
+
+
+
+
+
The actual hash value represented as a string
+
+
+
+
+
◆
+
+
+
+
+
+ std::string xlnt::document_security::lock_verifier::hash_algorithm
+
+
+
+
+
The algorithm used to create and verify this lock.
+
+
+
+
+
◆
+
+
+
+
+
+ std::string xlnt::document_security::lock_verifier::salt
+
+
+
+
+
The initial salt combined with the password used to prevent rainbow table attacks
+
+
+
+
+
◆
+
+
+
+
+
+ std::size_t xlnt::document_security::lock_verifier::spin_count
+
+
+
+
+
The number of times the hash should be applied to the password combined with the salt. This allows the difficulty of the hash to be increased as computing power increases.
+
+
+
+
The documentation for this struct was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::ext_list::ext , including all inherited members.
+
xlnt: xlnt::ext_list::ext Struct Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ext (xml::parser &parser, const std::string &ns) ext (const uri &ID, const std::string &serialised) serialise (xml::serializer &serialiser, const std::string &ns)
+uri extension_ID_ serialised_value_
+
The documentation for this struct was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::page_setup , including all inherited members.
+
xlnt: xlnt::page_setup Struct Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Describes how a worksheet will be converted into a page during printing.
+ More...
+
+
#include <page_setup.hpp >
+
+
+
Describes how a worksheet will be converted into a page during printing.
+
+
+
◆
+
+
+
+
+
+ xlnt::page_setup::page_setup
+ (
+ )
+
+
+
+
+
Default constructor.
+
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ bool xlnt::page_setup::fit_to_height
+ (
+ )
+ const
+
+
+
+
+
Returns true if the height of this worksheet should be scaled to fit on a printed page.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::page_setup::fit_to_height
+ (
+ bool
+ fit_to_height )
+
+
+
+
+
Sets whether the height of the page should be scaled to fit on a printed page.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ bool xlnt::page_setup::fit_to_page
+ (
+ )
+ const
+
+
+
+
+
Returns true if this worksheet should be scaled to fit on a single page during printing.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::page_setup::fit_to_page
+ (
+ bool
+ fit_to_page )
+
+
+
+
+
If true, forces the worksheet to be scaled to fit on a single page during printing.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ bool xlnt::page_setup::fit_to_width
+ (
+ )
+ const
+
+
+
+
+
Returns true if the width of this worksheet should be scaled to fit on a printed page.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::page_setup::fit_to_width
+ (
+ bool
+ fit_to_width )
+
+
+
+
+
Sets whether the width of the page should be scaled to fit on a printed page.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::page_setup::has_paper_size
+ (
+ )
+ const
+
+
+
+
+
Check if current paper setting has paper size setting
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::page_setup::has_rel_id
+ (
+ )
+ const
+
+
+
+
+
Check if current paper setting has a reference relationship
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::page_setup::has_scale
+ (
+ )
+ const
+
+
+
+
+
Check if current paper setting has scale setting
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Returns the page break.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Sets the page break to b.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Returns the paper size which should be used to print the worksheet using this page setup.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::page_setup::paper_size
+ (
+ xlnt::paper_size paper_size )
+
+
+
+
+
Sets the paper size of this page setup.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ const std::string& xlnt::page_setup::rel_id
+ (
+ )
+ const
+
+
+
+
+
Gets reference relationship Id
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ void xlnt::page_setup::rel_id
+ (
+ const std::string &
+ val )
+
+
+
+
+
Sets reference relationship Id
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
+ void xlnt::page_setup::scale
+ (
+ double
+ scale )
+
+
+
+
+
Sets the factor by which the page should be scaled during printing.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ double xlnt::page_setup::scale
+ (
+ )
+ const
+
+
+
+
+
Returns the factor by which the page should be scaled during printing.
+
+
+
+
+
◆ [1/2]
+
+
+
+
+
Returns the current sheet state of this page setup.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
Sets the sheet state to sheet_state.
+
+
+
+
+
+
◆
+
+
+
+
+
The horizontal dpi
+
+
+
+
+
◆
+
+
+
+
◆
+
+
+
The documentation for this struct was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::pane , including all inherited members.
+
xlnt: xlnt::pane Struct Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
A fixed portion of a worksheet.
+ More...
+
+
#include <pane.hpp >
+
+bool operator== (const pane &rhs) const Returns true if this pane is equal to rhs based on its top-left cell, state, active pane, and x/y split location. More...
+
+
A fixed portion of a worksheet.
+
+
+
◆
+
+
+
+
+
+
+
+
+ bool xlnt::pane::operator==
+ (
+ const pane &
+ rhs )
+ const
+
+
+
+
+inline
+
+
+
+
+
Returns true if this pane is equal to rhs based on its top-left cell, state, active pane, and x/y split location.
+
+
+
+
+
+
◆
+
+
+
+
+
+ pane_corner xlnt::pane::active_pane = pane_corner::top_left
+
+
+
+
The pane which contains the active cell
+
+
+
+
+
◆
+
+
+
+
+
+ pane_state xlnt::pane::state = pane_state::split
+
+
+
+
The state of the pane
+
+
+
+
+
◆
+
+
+
+
+
The optional top left cell
+
+
+
+
+
◆
+
+
+
+
+
+ column_t xlnt::pane::x_split = 1
+
+
+
+
The column where the split should take place
+
+
+
+
+
◆
+
+
+
+
+
+ row_t xlnt::pane::y_split = 1
+
+
+
+
The row where the split should take place
+
+
+
+
The documentation for this struct was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::phonetic_run , including all inherited members.
+
xlnt: xlnt::phonetic_run Struct Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Encapsulates a run of text that
+ More...
+
+
#include <phonetic_run.hpp >
+
+text start end preserve_space
+
+
Encapsulates a run of text that
+
The documentation for this struct was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::print_options , including all inherited members.
+
xlnt: xlnt::print_options Struct Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ optional <bool> xlnt::print_options::grid_lines_set
+
+
+
+
if both print grid lines and this are true, grid lines are printed
+
+
+
+
+
◆
+
+
+
+
+
+ optional <bool> xlnt::print_options::horizontal_centered
+
+
+
+
center on page horizontally
+
+
+
+
+
◆
+
+
+
+
+
+ optional <bool> xlnt::print_options::print_grid_lines
+
+
+
+
if both grid_lines_set and this are true, grid lines are printed
+
+
+
+
+
◆
+
+
+
+
+
+ optional <bool> xlnt::print_options::print_headings
+
+
+
+
print row and column headings
+
+
+
+
+
◆
+
+
+
+
+
+ optional <bool> xlnt::print_options::vertical_centered
+
+
+
+
center on page vertically
+
+
+
+
The documentation for this struct was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::rich_text_run , including all inherited members.
+
xlnt: xlnt::rich_text_run Struct Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Typedef a rich_text_run as a pair of string and optional font.
+ More...
+
+
#include <rich_text_run.hpp >
+
+first optional < font > second preserve_space
+
+
Typedef a rich_text_run as a pair of string and optional font.
+
The documentation for this struct was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::scoped_enum_hash< Enum > , including all inherited members.
+
xlnt: xlnt::scoped_enum_hash< Enum > Struct Template Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Allows a scoped enum (aka "enum class") to be used as a key in a std::unordered_map.
+ More...
+
+
#include <scoped_enum_hash.hpp >
+
+std::size_t operator() (Enum e) const Cast the enumeration e to a std::size_t and hash that value using std::hash. More...
+
+
template<typename Enum>
+
+
Allows a scoped enum (aka "enum class") to be used as a key in a std::unordered_map.
+
+
+
◆
+
+
+
+
+template<typename Enum >
+
+
+
+
Cast the enumeration e to a std::size_t and hash that value using std::hash.
+
+
+
+
The documentation for this struct was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::sheet_pr , including all inherited members.
+
xlnt: xlnt::sheet_pr Struct Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
◆
+
+
+
+
+
+ optional <std::string> xlnt::sheet_pr::code_name
+
+
+
+
stable name of the sheet
+
+
+
+
+
◆
+
+
+
+
+
+ optional <bool> xlnt::sheet_pr::enable_format_condition_calculation
+
+
+
+
whether the conditional formatting calculations shall be evaluated
+
+
+
+
+
◆
+
+
+
+
+
+ optional <bool> xlnt::sheet_pr::filter_mode
+
+
+
+
worksheet has one or more autofilters or advanced filters on
+
+
+
+
+
◆
+
+
+
+
+
+ optional <bool> xlnt::sheet_pr::published
+
+
+
+
worksheet is published
+
+
+
+
+
◆
+
+
+
+
+
+ optional <bool> xlnt::sheet_pr::sync_horizontal
+
+
+
+
is horizontally synced to the anchor point
+
+
+
+
+
◆
+
+
+
+
+
Anchor point for worksheet's window
+
+
+
+
+
◆
+
+
+
+
+
+ optional <bool> xlnt::sheet_pr::sync_vertical
+
+
+
+
is vertically synced to the anchor point
+
+
+
+
+
◆
+
+
+
+
+
+ optional <bool> xlnt::sheet_pr::transition_entry
+
+
+
+
Lotus compatibility option
+
+
+
+
+
◆
+
+
+
+
+
+ optional <bool> xlnt::sheet_pr::transition_evaluation
+
+
+
+
Lotus compatibility option
+
+
+
+
The documentation for this struct was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::time , including all inherited members.
+
xlnt: xlnt::time Struct Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
A time is a specific time of the day specified in terms of an hour, minute, second, and microsecond (0-999999). It can also be initialized as a fraction of a day using time::from_number .
+ More...
+
+
#include <time.hpp >
+
+ time (int hour_=0, int minute_=0, int second_=0, int microsecond_=0) Constructs a time object from an optional hour, minute, second, and microsecond. More... time (const std::string &time_string) Constructs a time object from a string representing the time. More... double to_number () const Returns a numeric representation of the time in the range 0-1 where the value is equal to the fraction of the day elapsed. More... bool operator== (const time &comparand) const Returns true if this time is equivalent to comparand. More...
+static time now () Return the current time according to the system time. More... static time from_number (double number ) Return a time from a number representing a fraction of a day. The integer part of number will be ignored. 0.5 would return time(12, 0, 0, 0) or noon, halfway through the day. More...
+
+
A time is a specific time of the day specified in terms of an hour, minute, second, and microsecond (0-999999). It can also be initialized as a fraction of a day using time::from_number .
+
+
+
◆ [1/2]
+
+
+
+
+
+
+
+
+ xlnt::time::time
+ (
+ int
+ hour_ = 0,
+
+ int
+ minute_ = 0,
+
+ int
+ second_ = 0,
+
+ int
+ microsecond_ = 0
+
+ )
+
+
+
+
+explicit
+
+
+
+
+
Constructs a time object from an optional hour, minute, second, and microsecond.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+
+
+
+ xlnt::time::time
+ (
+ const std::string &
+ time_string )
+
+
+
+
+explicit
+
+
+
+
+
Constructs a time object from a string representing the time.
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static time xlnt::time::from_number
+ (
+ double
+ number )
+
+
+
+
+static
+
+
+
+
+
Return a time from a number representing a fraction of a day. The integer part of number will be ignored. 0.5 would return time(12, 0, 0, 0) or noon, halfway through the day.
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static time xlnt::time::now
+ (
+ )
+
+
+
+
+static
+
+
+
+
+
Return the current time according to the system time.
+
+
+
+
+
◆
+
+
+
+
+
+ bool xlnt::time::operator==
+ (
+ const time &
+ comparand )
+ const
+
+
+
+
+
Returns true if this time is equivalent to comparand.
+
+
+
+
+
◆
+
+
+
+
+
+ double xlnt::time::to_number
+ (
+ )
+ const
+
+
+
+
+
Returns a numeric representation of the time in the range 0-1 where the value is equal to the fraction of the day elapsed.
+
+
+
+
+
+
◆
+
+
+
+
+
+ int xlnt::time::hour
+
+
+
+
+
+
◆
+
+
+
+
+
+ int xlnt::time::microsecond
+
+
+
+
+
+
◆
+
+
+
+
+
+ int xlnt::time::minute
+
+
+
+
+
+
◆
+
+
+
+
+
+ int xlnt::time::second
+
+
+
+
+
The documentation for this struct was generated from the following file:
+
xlnt: Member List
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
This is the complete list of members for xlnt::timedelta , including all inherited members.
+
xlnt: xlnt::timedelta Struct Reference
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Represents a span of time between two datetimes. This is not fully supported yet throughout the library.
+ More...
+
+
#include <timedelta.hpp >
+
+ timedelta () Constructs a timedelta equal to zero. More... timedelta (int days_, int hours_, int minutes_, int seconds_, int microseconds_) Constructs a timedelta from a number of days, hours, minutes, seconds, and microseconds. More... double to_number () const Returns a numeric representation of this timedelta as a fractional number of days. More...
+
+
Represents a span of time between two datetimes. This is not fully supported yet throughout the library.
+
+
+
◆ [1/2]
+
+
+
+
+
+ xlnt::timedelta::timedelta
+ (
+ )
+
+
+
+
+
Constructs a timedelta equal to zero.
+
+
+
+
+
◆ [2/2]
+
+
+
+
+
+ xlnt::timedelta::timedelta
+ (
+ int
+ days_ ,
+
+ int
+ hours_ ,
+
+ int
+ minutes_ ,
+
+ int
+ seconds_ ,
+
+ int
+ microseconds_
+
+ )
+
+
+
+
+
Constructs a timedelta from a number of days, hours, minutes, seconds, and microseconds.
+
+
+
+
+
+
◆
+
+
+
+
+
+
+
+
+ static timedelta xlnt::timedelta::from_number
+ (
+ double
+ number )
+
+
+
+
+static
+
+
+
+
+
Returns a timedelta from a number representing the factional number of days elapsed.
+
+
+
+
+
◆
+
+
+
+
+
+ double xlnt::timedelta::to_number
+ (
+ )
+ const
+
+
+
+
+
Returns a numeric representation of this timedelta as a fractional number of days.
+
+
+
+
+
+
◆
+
+
+
+
+
+ int xlnt::timedelta::days
+
+
+
+
+
+
◆
+
+
+
+
+
+ int xlnt::timedelta::hours
+
+
+
+
+
+
◆
+
+
+
+
+
+ int xlnt::timedelta::microseconds
+
+
+
+
+
+
◆
+
+
+
+
+
+ int xlnt::timedelta::minutes
+
+
+
+
+
+
◆
+
+
+
+
+
+ int xlnt::timedelta::seconds
+
+
+
+
+
The documentation for this struct was generated from the following file:
+
xlnt: xlnt/styles/style.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
30 #include <xlnt/xlnt_config.hpp> 31 #include <xlnt/utils/optional.hpp> 71 std::string name()
const ;
76 style name(
const std::string &name);
88 style hidden(
bool value);
94 bool custom_builtin()
const ;
101 std::size_t builtin_id()
const ;
106 bool builtin()
const ;
119 bool alignment_applied()
const ;
131 class border border() const;
136 bool border_applied()
const ;
148 class fill fill() const;
153 bool fill_applied()
const ;
165 class font font() const;
170 bool font_applied()
const ;
187 bool number_format_applied()
const ;
204 bool protection_applied()
const ;
216 bool pivot_button()
const ;
222 void pivot_button(
bool show);
227 bool quote_prefix()
const ;
234 void quote_prefix(
bool quote);
247 friend struct detail::stylesheet;
248 friend class detail::xlsx_consumer;
253 style (detail::style_impl *d);
258 detail::style_impl *d_;
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
Describes the font style of a particular cell.
Definition: font.hpp:40
+
Describes the fill style of a particular cell.
Definition: fill.hpp:298
+
Describes the border style of a particular cell.
Definition: border.hpp:93
+
bool operator==(std::nullptr_t, const cell &cell)
Returns true if this cell is uninitialized.
+
+
+
Alignment options that determine how text should be displayed within a cell.
Definition: alignment.hpp:62
+
bool operator!=(const std::string &reference_string, const range_reference &ref)
Returns true if the string representation of the range is not equivalent to ref.
+
Describes the protection style of a particular cell.
Definition: protection.hpp:37
+
Describes a style which has a name and can be applied to multiple individual formats. In Excel this is a "Cell Style".
Definition: style.hpp:55
+
xlnt: xlnt/workbook/theme.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
26 #include <xlnt/xlnt_config.hpp> Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
bool operator==(std::nullptr_t, const cell &cell)
Returns true if this cell is uninitialized.
+
A theme is a combination of fonts, colors, and effects. This isn't really supported yet...
Definition: theme.hpp:34
+
xlnt: xlnt/utils/time.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
28 #include <xlnt/xlnt_config.hpp> 54 explicit time (
int hour_ = 0,
int minute_ = 0,
int second_ = 0,
int microsecond_ = 0);
59 explicit time (
const std::string &time_string);
65 double to_number()
const ;
+
int microsecond
The microsecond
Definition: time.hpp:90
+
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
int second
The second
Definition: time.hpp:85
+
A time is a specific time of the day specified in terms of an hour, minute, second, and microsecond (0-999999). It can also be initialized as a fraction of a day using time::from_number.
Definition: time.hpp:37
+
bool operator==(std::nullptr_t, const cell &cell)
Returns true if this cell is uninitialized.
+
int hour
The hour
Definition: time.hpp:75
+
int minute
The minute
Definition: time.hpp:80
+
xlnt: xlnt/utils/timedelta.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
28 #include <xlnt/xlnt_config.hpp> 51 timedelta (
int days_,
int hours_,
int minutes_,
int seconds_,
int microseconds_);
56 double to_number()
const ;
+
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
int minutes
The minutes
Definition: timedelta.hpp:71
+
Represents a span of time between two datetimes. This is not fully supported yet throughout the libra...
Definition: timedelta.hpp:36
+
int days
The days
Definition: timedelta.hpp:61
+
int hours
The hours
Definition: timedelta.hpp:66
+
int seconds
The seconds
Definition: timedelta.hpp:76
+
int microseconds
The microseconds
Definition: timedelta.hpp:81
+
xlnt: xlnt/packaging/uri.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
28 #include <xlnt/xlnt_config.hpp> 29 #include <xlnt/utils/path.hpp> 48 uri (
const uri &base,
const uri &relative);
58 uri (
const std::string &uri_string);
63 bool is_relative()
const ;
68 bool is_absolute()
const ;
74 std::string scheme()
const ;
80 std::string authority()
const ;
85 bool has_authentication()
const ;
91 std::string authentication()
const ;
97 std::string username()
const ;
103 std::string password()
const ;
109 std::string host()
const ;
114 bool has_port()
const ;
120 std::size_t port()
const ;
131 bool has_query()
const ;
137 std::string query()
const ;
142 bool has_fragment()
const ;
148 std::string fragment()
const ;
153 std::string to_string()
const ;
159 uri make_absolute(
const uri &base);
165 uri make_reference(
const uri &base);
176 bool absolute_ =
false ;
186 bool has_authentication_ =
false ;
191 std::string username_;
196 std::string password_;
206 bool has_port_ =
false ;
211 std::size_t port_ = 0;
216 bool has_query_ =
false ;
226 bool has_fragment_ =
false ;
231 std::string fragment_;
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
Encapsulates a uniform resource identifier (URI) as described by RFC 3986.
Definition: uri.hpp:37
+
bool operator==(std::nullptr_t, const cell &cell)
Returns true if this cell is uninitialized.
+
Encapsulates a path that points to location in a filesystem.
Definition: path.hpp:37
+
xlnt: xlnt/utils/variant.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
29 #include <xlnt/xlnt_config.hpp> 91 variant (
const std::string &value);
116 variant (
const std::initializer_list<std::int32_t> &value);
121 variant (
const std::vector<std::int32_t> &value);
126 variant (
const std::initializer_list<const char *> &value);
131 variant (
const std::vector<const char *> &value);
136 variant (
const std::initializer_list<std::string> &value);
141 variant (
const std::vector<std::string> &value);
146 variant (
const std::vector<variant> &value);
151 bool is(
type t)
const ;
157 template <
typename T>
163 type value_type()
const ;
169 std::vector<variant> vector_value_;
170 std::int32_t i4_value_;
171 std::string lpstr_value_;
type
The possible types a variant can hold.
Definition: variant.hpp:46
+
Represents an object that can have variable type.
Definition: variant.hpp:38
+
T get() const
Returns the value of this variant as type T. An exception will be thrown if the types are not convert...
+
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
bool operator==(std::nullptr_t, const cell &cell)
Returns true if this cell is uninitialized.
+
value is an ISO 8601 formatted date
+
A datetime is a combination of a date and a time.
Definition: datetime.hpp:39
+
+
xlnt: xlnt/workbook/workbook.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
32 #include <unordered_map> 36 #include <xlnt/xlnt_config.hpp> 37 #include <xlnt/cell/rich_text.hpp> 48 class calculation_properties;
52 class const_worksheet_iterator;
58 class metadata_property;
65 class range_reference;
67 class streaming_workbook_reader;
69 class style_serializer;
74 class worksheet_iterator;
152 workbook (std::istream &data,
const std::string &password);
181 worksheet create_sheet(std::size_t index);
210 void active_sheet(std::size_t index);
217 worksheet sheet_by_title(
const std::string &title);
224 const worksheet sheet_by_title(
const std::string &title)
const ;
230 worksheet sheet_by_index(std::size_t index);
236 const worksheet sheet_by_index(std::size_t index)
const ;
248 const worksheet sheet_by_id(std::size_t
id )
const ;
255 bool sheet_hidden_by_index(std::size_t index)
const ;
260 bool contains(
const std::string &title)
const ;
321 void apply_to_cells(std::function<
void (
cell )> f);
327 std::vector<std::string> sheet_titles()
const ;
332 std::size_t sheet_count()
const ;
345 std::vector<xlnt::core_property> core_properties()
const ;
366 std::vector<xlnt::extended_property> extended_properties()
const ;
381 bool has_custom_property(
const std::string &property_name)
const ;
387 std::vector<std::string> custom_properties()
const ;
392 variant custom_property(
const std::string &property_name)
const ;
397 void custom_property(
const std::string &property_name,
const variant &value);
415 bool has_title()
const ;
420 std::string title()
const ;
425 void title(
const std::string &title);
430 void abs_path(
const std::string &
path );
435 void arch_id_flags(
const std::size_t flags);
442 std::vector<xlnt::named_range> named_ranges()
const ;
452 void create_named_range(
const std::string &name,
worksheet worksheet ,
const std::string &reference_string);
457 bool has_named_range(
const std::string &name)
const ;
467 void remove_named_range(const std::string &name);
475 void save(std::vector<std::uint8_t> &data) const;
481 void save(std::vector<std::uint8_t> &data, const std::string &password) const;
487 void save(const std::string &filename) const;
493 void save(const std::string &filename, const std::string &password) const;
496 void save(const std::wstring &filename) const;
506 void save(const std::wstring &filename, const std::string &password) const;
513 void save(const xlnt::path &filename) const;
519 void save(const xlnt::path &filename, const std::string &password) const;
524 void save(std::ostream &stream) const;
530 void save(std::ostream &stream, const std::string &password) const;
536 void load(const std::vector<std::uint8_t> &data);
542 void load(const std::vector<std::uint8_t> &data, const std::string &password);
548 void load(const std::string &filename);
554 void load(const std::string &filename, const std::string &password);
557 void load(const std::wstring &filename);
567 void load(const std::wstring &filename, const std::string &password);
574 void load(const xlnt::path &filename);
580 void load(const xlnt::path &filename, const std::string &password);
586 void load(std::istream &stream);
592 void load(std::istream &stream, const std::string &password);
599 bool has_view() const;
609 void view(const workbook_view &view);
616 bool has_code_name() const;
621 std::string code_name() const;
626 void code_name(const std::string &code_name);
631 bool has_file_version() const;
636 std::string app_name() const;
641 std::size_t last_edited() const;
646 std::size_t lowest_edited() const;
651 std::size_t rup_build() const;
658 bool has_theme() const;
668 void
theme (const class theme &value);
687 xlnt::format create_format(bool default_format = false);
693 void clear_formats();
700 bool has_style(const std::string &name) const;
710 const class
style style (const std::string &name) const;
715 class
style create_style(const std::string &name);
720 class
style create_builtin_style(std::size_t builtin_id);
732 void default_slicer_style(const std::string &value);
737 std::string default_slicer_style() const;
742 void enable_known_fonts();
747 void disable_known_fonts();
752 bool known_fonts_enabled() const;
774 std::size_t add_shared_string(const rich_text &shared, bool allow_duplicates = false);
779 const
rich_text &shared_strings(std::size_t index) const;
785 std::vector<rich_text> &shared_strings();
791 const std::vector<rich_text> &shared_strings() const;
799 void thumbnail(const std::vector<std::uint8_t> &thumbnail,
800 const std::string &extension, const std::string &content_type);
805 const std::vector<std::uint8_t> &thumbnail() const;
810 const std::unordered_map<std::string, std::vector<std::uint8_t>>& binaries() const;
817 bool has_calculation_properties() const;
835 workbook &operator=(workbook other);
840 worksheet operator[](const std::string &name);
851 bool operator==(const workbook &rhs) const;
857 bool operator!=(const workbook &rhs) const;
862 friend class detail::xlsx_consumer;
863 friend class detail::xlsx_producer;
869 workbook (detail::workbook_impl *impl);
875 detail::workbook_impl &impl();
881 const detail::workbook_impl &impl() const;
888 void register_package_part(relationship_type type);
896 void register_workbook_part(relationship_type type);
904 void register_worksheet_part(worksheet ws, relationship_type type);
909 void garbage_collect_formulae();
914 void update_sheet_properties();
919 void swap(workbook &other);
924 void reorder_relationships();
929 std::unique_ptr<detail::workbook_impl> d_;
core_property
Every core property in a workbook must be one of these types.
Definition: metadata_property.hpp:33
+
A range is a 2D collection of cells with defined extens that can be iterated upon.
Definition: range.hpp:54
+
Represents an association between a source Package or part, and a target object which can be a part o...
Definition: relationship.hpp:102
+
Represents an object that can have variable type.
Definition: variant.hpp:38
+
Definition: cell_reference.hpp:261
+
A workbook can be opened in multiple windows with different views. This class represents a particular...
Definition: workbook_view.hpp:36
+
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
extended_property
Every extended property in a workbook must be one of these types.
Definition: metadata_property.hpp:55
+
std::reverse_iterator< iterator > reverse_iterator
typedef for the iterator used for iterating through this workbook (non-const) in a range-based for lo...
Definition: workbook.hpp:111
+
A worksheet is a 2D array of cells starting with cell A1 in the top-left corner and extending indefin...
Definition: worksheet.hpp:76
+
A theme is a combination of fonts, colors, and effects. This isn't really supported yet...
Definition: theme.hpp:34
+
Describes a unit of data in a worksheet at a specific coordinate and its associated properties...
Definition: cell.hpp:83
+
Encapsulates zero or more formatted text runs where a text run is a string of text with the same defi...
Definition: rich_text.hpp:40
+
An iterator which is used to iterate over the worksheets in a workbook.
Definition: worksheet_iterator.hpp:43
+
Encapsulates a path that points to location in a filesystem.
Definition: path.hpp:37
+
relationship_type
All package relationships must be one of these defined types.
Definition: relationship.hpp:53
+
Workbook file properties relating to calculations.
Definition: calculation_properties.hpp:33
+
+
An iterator which is used to iterate over the worksheets in a const workbook.
Definition: worksheet_iterator.hpp:153
+
A 2D range of cells in a worksheet that is referred to by name. ws->range("A1:B2") could be replaced ...
Definition: named_range.hpp:41
+
+
workbook is the container for all other parts of the document.
Definition: streaming_workbook_reader.hpp:54
+
The manifest keeps track of all files in the OOXML package and their type and relationships.
Definition: manifest.hpp:40
+
A range_reference describes a rectangular area of a worksheet with positive width and height defined ...
Definition: range_reference.hpp:35
+
Describes a style which has a name and can be applied to multiple individual formats. In Excel this is a "Cell Style".
Definition: style.hpp:55
+
std::reverse_iterator< const_iterator > const_reverse_iterator
typedef for the iterator used for iterating through this workbook (const) in a range-based for loop i...
Definition: workbook.hpp:118
+
workbook is the container for all other parts of the document.
Definition: workbook.hpp:91
+
calendar
An enumeration of possible base dates. Dates in Excel are stored as days since this base date...
Definition: calendar.hpp:34
+
xlnt: xlnt/workbook/workbook_view.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
27 #include <xlnt/xlnt_config.hpp> 28 #include <xlnt/utils/optional.hpp> 42 bool auto_filter_date_grouping =
true ;
47 bool minimized =
false ;
52 bool show_horizontal_scroll =
true ;
57 bool show_sheet_tabs =
true ;
62 bool show_vertical_scroll =
true ;
optional< std::size_t > active_tab
The optional index to the active sheet in this view.
Definition: workbook_view.hpp:72
+
optional< int > y_window
The distance of the workbook window from the top of the screen in twips.
Definition: workbook_view.hpp:102
+
bool visible
If true, the workbook window will be visible.
Definition: workbook_view.hpp:67
+
bool show_vertical_scroll
If true, the vertical scroll bar will be displayed.
Definition: workbook_view.hpp:62
+
A workbook can be opened in multiple windows with different views. This class represents a particular...
Definition: workbook_view.hpp:36
+
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
bool show_horizontal_scroll
If true, the horizontal scroll bar will be displayed.
Definition: workbook_view.hpp:52
+
bool operator==(std::nullptr_t, const cell &cell)
Returns true if this cell is uninitialized.
+
bool minimized
If true, the view will be minimized.
Definition: workbook_view.hpp:47
+
bool auto_filter_date_grouping
If true, dates will be grouped when presenting the user with filtering options.
Definition: workbook_view.hpp:42
+
optional< int > x_window
The distance of the workbook window from the left side of the screen in twips.
Definition: workbook_view.hpp:97
+
bool show_sheet_tabs
If true, the sheet tabs will be displayed.
Definition: workbook_view.hpp:57
+
optional< std::size_t > window_height
The height of the workbook window in twips.
Definition: workbook_view.hpp:92
+
optional< std::size_t > window_width
The width of the workbook window in twips.
Definition: workbook_view.hpp:87
+
+
optional< std::size_t > tab_ratio
The optional ratio between the tabs bar and the horizontal scroll bar.
Definition: workbook_view.hpp:82
+
optional< std::size_t > first_sheet
The optional index to the first sheet in this view.
Definition: workbook_view.hpp:77
+
xlnt: xlnt/worksheet/worksheet.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
30 #include <unordered_map> 33 #include <xlnt/xlnt_config.hpp> 34 #include <xlnt/cell/index_types.hpp> 35 #include <xlnt/packaging/relationship.hpp> 36 #include <xlnt/worksheet/page_margins.hpp> 37 #include <xlnt/worksheet/page_setup.hpp> 38 #include <xlnt/worksheet/sheet_view.hpp> 45 class column_properties;
48 class conditional_format;
49 class const_range_iterator;
54 class range_reference;
57 class sheet_format_properties;
68 struct worksheet_impl;
123 void garbage_collect();
131 std::size_t id()
const ;
137 void id(std::size_t
id );
142 std::string title()
const ;
147 void title(
const std::string &title);
159 void freeze_panes(
cell top_left_cell);
169 void unfreeze_panes();
174 bool has_frozen_panes()
const ;
217 const class
range range (const std::string &reference_string) const;
222 class
range range (const range_reference &reference);
227 const class
range range (const range_reference &reference) const;
235 class
range rows(bool skip_null = true);
243 const class
range rows(bool skip_null = true) const;
251 class
range columns(bool skip_null = true);
259 const class
range columns(bool skip_null = true) const;
270 void clear_cell(const cell_reference &ref);
275 void clear_row(row_t row);
280 void insert_rows(row_t row, std::uint32_t amount);
285 void insert_columns(column_t column, std::uint32_t amount);
290 void delete_rows(row_t row, std::uint32_t amount);
295 void delete_columns(column_t column, std::uint32_t amount);
312 bool has_column_properties(column_t column) const;
317 void add_column_properties(column_t column, const class column_properties &props);
323 double column_width(column_t column) const;
338 bool has_row_properties(row_t row) const;
343 void add_row_properties(row_t row, const class row_properties &props);
349 double row_height(row_t row) const;
363 void create_named_range(const std::string &name, const std::string &reference_string);
368 void create_named_range(const std::string &name, const range_reference &reference);
373 bool has_named_range(const std::string &name) const;
390 void remove_named_range(const std::string &name);
397 row_t lowest_row() const;
402 row_t lowest_row_or_props() const;
407 row_t highest_row() const;
412 row_t highest_row_or_props() const;
417 row_t next_row() const;
427 column_t lowest_column_or_props() const;
437 column_t highest_column_or_props() const;
445 range_reference calculate_dimension(bool skip_null=true, bool skip_row_props=false) const;
452 void merge_cells(const std::string &reference_string);
457 void merge_cells(const range_reference &reference);
462 void unmerge_cells(const std::string &reference_string);
467 void unmerge_cells(const range_reference &reference);
472 std::vector<range_reference> merged_ranges() const;
479 bool operator==(const worksheet &other) const;
484 bool operator!=(const worksheet &other) const;
489 bool operator==(std::nullptr_t) const;
494 bool operator!=(std::nullptr_t) const;
499 void operator=(const worksheet &other);
504 class
cell operator[](const cell_reference &reference);
509 const class
cell operator[](const cell_reference &reference) const;
515 bool compare(const worksheet &other, bool reference) const;
522 bool has_page_setup() const;
532 void
page_setup (const struct page_setup &setup);
537 bool has_page_margins() const;
559 void auto_filter(const std::string &range_string);
564 void auto_filter(const xlnt::range &range);
569 void auto_filter(const range_reference &reference);
574 void clear_auto_filter();
579 bool has_auto_filter() const;
585 void reserve(std::size_t n);
590 bool has_phonetic_properties() const;
600 void phonetic_properties(const phonetic_pr &phonetic_props);
605 bool has_header_footer() const;
615 void
header_footer (const class header_footer &new_header_footer);
660 void print_title_rows(row_t start, row_t end);
665 optional <std::pair<row_t, row_t>> print_title_rows() const;
670 void print_title_cols(column_t start, column_t end);
675 optional <std::pair<column_t, column_t>> print_title_cols() const;
680 bool has_print_titles() const;
685 void clear_print_titles();
690 void print_area(const std::string &print_area);
695 void clear_print_area();
705 bool has_print_area() const;
710 bool has_view() const;
715 sheet_view &view(std::size_t index = 0) const;
720 void add_view(const sheet_view &new_view);
725 void active_cell(const cell_reference &ref);
730 bool has_active_cell() const;
743 void clear_page_breaks();
748 const std::vector<row_t> &page_break_rows() const;
753 void page_break_at_row(row_t row);
758 const std::vector<column_t> &page_break_columns() const;
763 void page_break_at_column(column_t column);
788 void format_properties(const sheet_format_properties &properties);
793 bool has_drawing() const;
799 bool is_empty() const;
806 friend class detail::xlsx_consumer;
807 friend class detail::xlsx_producer;
817 void register_comments_in_manifest();
822 void register_calc_chain_in_manifest();
827 void garbage_collect_formulae();
832 void parent(class workbook &wb);
838 void move_cells(std::uint32_t index, std::uint32_t amount, row_or_col_t row_or_col, bool reverse = false);
843 detail::worksheet_impl *d_;
A range is a 2D collection of cells with defined extens that can be iterated upon.
Definition: range.hpp:54
+
A const version of range_iterator which does not allow modification to the dereferenced cell_vector...
Definition: range_iterator.hpp:162
+
Represents an association between a source Package or part, and a target object which can be a part o...
Definition: relationship.hpp:102
+
std::uint32_t row_t
All rows should be referred to by an instance of this type.
Definition: index_types.hpp:40
+
Definition: cell_reference.hpp:261
+
Describes the margins around a worksheet for printing.
Definition: page_margins.hpp:34
+
+
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
+
The properties of a row in a worksheet.
Definition: row_properties.hpp:34
+
A worksheet is a 2D array of cells starting with cell A1 in the top-left corner and extending indefin...
Definition: worksheet.hpp:76
+
An object used to refer to a cell. References have two parts, the column and the row. In Excel, the reference string A1 refers to the top-left-most cell. A cell_reference can be initialized from a string of this form or a 1-indexed ordered pair of the form column, row.
Definition: cell_reference.hpp:59
+
Describes a unit of data in a worksheet at a specific coordinate and its associated properties...
Definition: cell.hpp:83
+
sheet_state
Defines how a worksheet appears in the workbook. A workbook must have at least one sheet which is vis...
Definition: page_setup.hpp:74
+
Describes a view of a worksheet. Worksheets can have multiple views which show the data differently...
Definition: sheet_view.hpp:48
+
std::reverse_iterator< const_iterator > const_reverse_iterator
Iterate in reverse order over a const worksheet with an iterator of this type.
Definition: worksheet.hpp:97
+
value is an ISO 8601 formatted date
+
Encapsulates a path that points to location in a filesystem.
Definition: path.hpp:37
+
Many settings in xlnt are allowed to not have a value set. This class encapsulates a value which may ...
Definition: format.hpp:43
+
An iterator used by worksheet and range for traversing a 2D grid of cells by row/column then across t...
Definition: range_iterator.hpp:42
+
Columns can be referred to as a string A,B,...Z,AA,AB,..,ZZ,AAA,...,ZZZ or as a 1-indexed index...
Definition: index_types.hpp:47
+
A 2D range of cells in a worksheet that is referred to by name. ws->range("A1:B2") could be replaced ...
Definition: named_range.hpp:41
+
Describes how a worksheet will be converted into a page during printing.
Definition: page_setup.hpp:84
+
+
Properties applied to a column in a worksheet. Columns can have a size and a style.
Definition: column_properties.hpp:35
+
std::reverse_iterator< iterator > reverse_iterator
Iterate in reverse over a non-const worksheet with an iterator of this type.
Definition: worksheet.hpp:92
+
A range_reference describes a rectangular area of a worksheet with positive width and height defined ...
Definition: range_reference.hpp:35
+
workbook is the container for all other parts of the document.
Definition: workbook.hpp:91
+
Phonetic properties Element provides a collection of properties that affect display of East Asian Lan...
Definition: phonetic_pr.hpp:38
+
xlnt: xlnt/workbook/worksheet_iterator.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
29 #include <xlnt/xlnt_config.hpp> 51 using difference_type = std::ptrdiff_t;
147 std::size_t index_ = 0;
161 using difference_type = std::ptrdiff_t;
250 std::size_t index_ = 0;
Enumerates the possible types a cell can be determined by it's current value.
Definition: cell.hpp:36
+
std::bidirectional_iterator_tag iterator_category
iterator tags required for use with standard algorithms and adapters
Definition: worksheet_iterator.hpp:159
+
A worksheet is a 2D array of cells starting with cell A1 in the top-left corner and extending indefin...
Definition: worksheet.hpp:76
+
bool operator==(std::nullptr_t, const cell &cell)
Returns true if this cell is uninitialized.
+
An iterator which is used to iterate over the worksheets in a workbook.
Definition: worksheet_iterator.hpp:43
+
An iterator which is used to iterate over the worksheets in a const workbook.
Definition: worksheet_iterator.hpp:153
+
std::bidirectional_iterator_tag iterator_category
iterator tags required for use with standard algorithms and adapters
Definition: worksheet_iterator.hpp:49
+
bool operator!=(const std::string &reference_string, const range_reference &ref)
Returns true if the string representation of the range is not equivalent to ref.
+
workbook is the container for all other parts of the document.
Definition: workbook.hpp:91
+
xlnt: xlnt/xlnt.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
26 #include <xlnt/xlnt_config.hpp> 29 #include <xlnt/cell/cell.hpp> 30 #include <xlnt/cell/cell_reference.hpp> 31 #include <xlnt/cell/cell_type.hpp> 32 #include <xlnt/cell/comment.hpp> 33 #include <xlnt/cell/hyperlink.hpp> 34 #include <xlnt/cell/index_types.hpp> 35 #include <xlnt/cell/rich_text.hpp> 36 #include <xlnt/cell/rich_text_run.hpp> 39 #include <xlnt/packaging/manifest.hpp> 40 #include <xlnt/packaging/relationship.hpp> 41 #include <xlnt/packaging/uri.hpp> 44 #include <xlnt/styles/alignment.hpp> 45 #include <xlnt/styles/border.hpp> 46 #include <xlnt/styles/color.hpp> 47 #include <xlnt/styles/fill.hpp> 48 #include <xlnt/styles/font.hpp> 49 #include <xlnt/styles/format.hpp> 50 #include <xlnt/styles/number_format.hpp> 51 #include <xlnt/styles/protection.hpp> 52 #include <xlnt/styles/style.hpp> 55 #include <xlnt/utils/calendar.hpp> 56 #include <xlnt/utils/date.hpp> 57 #include <xlnt/utils/datetime.hpp> 58 #include <xlnt/utils/exceptions.hpp> 59 #include <xlnt/utils/path.hpp> 60 #include <xlnt/utils/time.hpp> 61 #include <xlnt/utils/timedelta.hpp> 62 #include <xlnt/utils/variant.hpp> 65 #include <xlnt/workbook/document_security.hpp> 66 #include <xlnt/workbook/external_book.hpp> 67 #include <xlnt/workbook/metadata_property.hpp> 68 #include <xlnt/workbook/named_range.hpp> 69 #include <xlnt/workbook/streaming_workbook_reader.hpp> 70 #include <xlnt/workbook/streaming_workbook_writer.hpp> 71 #include <xlnt/workbook/theme.hpp> 72 #include <xlnt/workbook/workbook.hpp> 73 #include <xlnt/workbook/worksheet_iterator.hpp> 76 #include <xlnt/worksheet/cell_iterator.hpp> 77 #include <xlnt/worksheet/cell_vector.hpp> 78 #include <xlnt/worksheet/column_properties.hpp> 79 #include <xlnt/worksheet/header_footer.hpp> 80 #include <xlnt/worksheet/major_order.hpp> 81 #include <xlnt/worksheet/page_margins.hpp> 82 #include <xlnt/worksheet/page_setup.hpp> 83 #include <xlnt/worksheet/pane.hpp> 84 #include <xlnt/worksheet/range.hpp> 85 #include <xlnt/worksheet/range_iterator.hpp> 86 #include <xlnt/worksheet/range_reference.hpp> 87 #include <xlnt/worksheet/row_properties.hpp> 88 #include <xlnt/worksheet/selection.hpp> 89 #include <xlnt/worksheet/sheet_format_properties.hpp> 90 #include <xlnt/worksheet/sheet_protection.hpp> 91 #include <xlnt/worksheet/sheet_view.hpp> 92 #include <xlnt/worksheet/worksheet.hpp> xlnt: xlnt/xlnt_config.hpp Source File
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
27 #if !defined(XLNT_STATIC) && defined(_MSC_VER) 29 #define XLNT_API __declspec(dllexport) 33 #pragma warning(disable : 4251) 34 #pragma warning(disable : 4275) 35 #define XLNT_API __declspec(dllimport)
+
+
+ 
+
+ 
Public Member Functions inherited from xlnt::exception
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
