fast_excel 0.2.1 → 0.3.0

data/libxlsxwriter/include/xlsxwriter/workbook.h

@@ -1,7 +1,7 @@
 /*
  * libxlsxwriter
  *
- * Copyright 2014-2017, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
+ * Copyright 2014-2019, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
  */
 
 /**
@@ -46,6 +46,7 @@
 #include <errno.h>
 
 #include "worksheet.h"
+#include "chartsheet.h"
 #include "chart.h"
 #include "shared_strings.h"
 #include "hash_table.h"
@@ -55,12 +56,27 @@
 
 /* Define the tree.h RB structs for the red-black head types. */
 RB_HEAD(lxw_worksheet_names, lxw_worksheet_name);
+RB_HEAD(lxw_chartsheet_names, lxw_chartsheet_name);
 
 /* Define the queue.h structs for the workbook lists. */
+STAILQ_HEAD(lxw_sheets, lxw_sheet);
 STAILQ_HEAD(lxw_worksheets, lxw_worksheet);
+STAILQ_HEAD(lxw_chartsheets, lxw_chartsheet);
 STAILQ_HEAD(lxw_charts, lxw_chart);
 TAILQ_HEAD(lxw_defined_names, lxw_defined_name);
 
+/* TODO */
+typedef struct lxw_sheet {
+    uint8_t is_chartsheet;
+
+    union {
+        lxw_worksheet *worksheet;
+        lxw_chartsheet *chartsheet;
+    } u;
+
+    STAILQ_ENTRY (lxw_sheet) list_pointers;
+} lxw_sheet;
+
 /* Struct to represent a worksheet name/pointer pair. */
 typedef struct lxw_worksheet_name {
     const char *name;
@@ -69,18 +85,37 @@ typedef struct lxw_worksheet_name {
     RB_ENTRY (lxw_worksheet_name) tree_pointers;
 } lxw_worksheet_name;
 
+/* Struct to represent a chartsheet name/pointer pair. */
+typedef struct lxw_chartsheet_name {
+    const char *name;
+    lxw_chartsheet *chartsheet;
+
+    RB_ENTRY (lxw_chartsheet_name) tree_pointers;
+} lxw_chartsheet_name;
+
 /* Wrapper around RB_GENERATE_STATIC from tree.h to avoid unused function
  * warnings and to avoid portability issues with the _unused attribute. */
-#define LXW_RB_GENERATE_NAMES(name, type, field, cmp)     \
-    RB_GENERATE_INSERT_COLOR(name, type, field, static)   \
-    RB_GENERATE_REMOVE_COLOR(name, type, field, static)   \
-    RB_GENERATE_INSERT(name, type, field, cmp, static)    \
-    RB_GENERATE_REMOVE(name, type, field, static)         \
-    RB_GENERATE_FIND(name, type, field, cmp, static)      \
-    RB_GENERATE_NEXT(name, type, field, static)           \
-    RB_GENERATE_MINMAX(name, type, field, static)         \
-    /* Add unused struct to allow adding a semicolon */   \
-    struct lxw_rb_generate_names{int unused;}
+#define LXW_RB_GENERATE_WORKSHEET_NAMES(name, type, field, cmp)  \
+    RB_GENERATE_INSERT_COLOR(name, type, field, static)          \
+    RB_GENERATE_REMOVE_COLOR(name, type, field, static)          \
+    RB_GENERATE_INSERT(name, type, field, cmp, static)           \
+    RB_GENERATE_REMOVE(name, type, field, static)                \
+    RB_GENERATE_FIND(name, type, field, cmp, static)             \
+    RB_GENERATE_NEXT(name, type, field, static)                  \
+    RB_GENERATE_MINMAX(name, type, field, static)                \
+    /* Add unused struct to allow adding a semicolon */          \
+    struct lxw_rb_generate_worksheet_names{int unused;}
+
+#define LXW_RB_GENERATE_CHARTSHEET_NAMES(name, type, field, cmp) \
+    RB_GENERATE_INSERT_COLOR(name, type, field, static)          \
+    RB_GENERATE_REMOVE_COLOR(name, type, field, static)          \
+    RB_GENERATE_INSERT(name, type, field, cmp, static)           \
+    RB_GENERATE_REMOVE(name, type, field, static)                \
+    RB_GENERATE_FIND(name, type, field, cmp, static)             \
+    RB_GENERATE_NEXT(name, type, field, static)                  \
+    RB_GENERATE_MINMAX(name, type, field, static)                \
+    /* Add unused struct to allow adding a semicolon */          \
+    struct lxw_rb_generate_charsheet_names{int unused;}
 
 /**
  * @brief Macro to loop over all the worksheets in a workbook.
@@ -168,27 +203,40 @@ typedef struct lxw_doc_properties {
  *
  * The following properties are supported:
  *
- * - `constant_memory`: Reduces the amount of data stored in memory so that
- *   large files can be written efficiently.
- *
- *   @note In this mode a row of data is written and then discarded when a
- *   cell in a new row is added via one of the `worksheet_write_*()`
- *   functions. Therefore, once this option is active, data should be written in
- *   sequential row order. For this reason the `worksheet_merge_range()`
- *   doesn't work in this mode. See also @ref ww_mem_constant.
+ * - `constant_memory`: This option reduces the amount of data stored in
+ *   memory so that large files can be written efficiently. This option is off
+ *   by default. See the note below for limitations when this mode is on.
  *
- * - `tmpdir`: libxlsxwriter stores workbook data in temporary files prior
- *   to assembling the final XLSX file. The temporary files are created in the
+ * - `tmpdir`: libxlsxwriter stores workbook data in temporary files prior to
+ *   assembling the final XLSX file. The temporary files are created in the
  *   system's temp directory. If the default temporary directory isn't
  *   accessible to your application, or doesn't contain enough space, you can
- *   specify an alternative location using the `tempdir` option.
+ *   specify an alternative location using the `tmpdir` option.
+ *
+ * - `use_zip64`: Make the zip library use ZIP64 extensions when writing very
+ *   large xlsx files to allow the zip container, or individual XML files
+ *   within it, to be greater than 4 GB. See [ZIP64 on Wikipedia][zip64_wiki]
+ *   for more information. This option is off by default.
+ *
+ *   [zip64_wiki]: https://en.wikipedia.org/wiki/Zip_(file_format)#ZIP64
+ *
+ * @note In `constant_memory` mode a row of data is written and then discarded
+ * when a cell in a new row is added via one of the `worksheet_write_*()`
+ * functions. Therefore, once this option is active, data should be written in
+ * sequential row order. For this reason the `worksheet_merge_range()` doesn't
+ * work in this mode. See also @ref ww_mem_constant.
+ *
  */
 typedef struct lxw_workbook_options {
-    /** Optimize the workbook to use constant memory for worksheets */
+    /** Optimize the workbook to use constant memory for worksheets. */
     uint8_t constant_memory;
 
     /** Directory to use for the temporary files created by libxlsxwriter. */
     char *tmpdir;
+
+    /** Allow ZIP64 extensions when creating the xlsx file zip container. */
+    uint8_t use_zip64;
+
 } lxw_workbook_options;
 
 /**
@@ -201,8 +249,11 @@ typedef struct lxw_workbook_options {
 typedef struct lxw_workbook {
 
     FILE *file;
+    struct lxw_sheets *sheets;
     struct lxw_worksheets *worksheets;
+    struct lxw_chartsheets *chartsheets;
     struct lxw_worksheet_names *worksheet_names;
+    struct lxw_chartsheet_names *chartsheet_names;
     struct lxw_charts *charts;
     struct lxw_charts *ordered_charts;
     struct lxw_formats *formats;
@@ -215,6 +266,8 @@ typedef struct lxw_workbook {
     lxw_workbook_options options;
 
     uint16_t num_sheets;
+    uint16_t num_worksheets;
+    uint16_t num_chartsheets;
     uint16_t first_sheet;
     uint16_t active_sheet;
     uint16_t num_xf_formats;
@@ -232,6 +285,9 @@ typedef struct lxw_workbook {
 
     lxw_hash_table *used_xf_formats;
 
+    char *vba_project;
+    char *vba_codename;
+
 } lxw_workbook;
 
 
@@ -273,30 +329,37 @@ lxw_workbook *workbook_new(const char *filename);
  * additional options to be set.
  *
  * @code
- *    lxw_workbook_options options = {.constant_memory = 1,
- *                                    .tmpdir = "C:\\Temp"};
+ *    lxw_workbook_options options = {.constant_memory = LXW_TRUE,
+ *                                    .tmpdir = "C:\\Temp",
+ *                                    .use_zip64 = LXW_FALSE};
  *
  *    lxw_workbook  *workbook  = workbook_new_opt("filename.xlsx", &options);
  * @endcode
  *
  * The options that can be set via #lxw_workbook_options are:
  *
- * - `constant_memory`: Reduces the amount of data stored in memory so that
- *   large files can be written efficiently.
- *
- *   @note In this mode a row of data is written and then discarded when a
- *   cell in a new row is added via one of the `worksheet_write_*()`
- *   functions. Therefore, once this option is active, data should be written in
- *   sequential row order. For this reason the `worksheet_merge_range()`
- *   doesn't work in this mode. See also @ref ww_mem_constant.
+ * - `constant_memory`: This option reduces the amount of data stored in
+ *   memory so that large files can be written efficiently. This option is off
+ *   by default. See the note below for limitations when this mode is on.
  *
- * - `tmpdir`: libxlsxwriter stores workbook data in temporary files prior
- *   to assembling the final XLSX file. The temporary files are created in the
+ * - `tmpdir`: libxlsxwriter stores workbook data in temporary files prior to
+ *   assembling the final XLSX file. The temporary files are created in the
  *   system's temp directory. If the default temporary directory isn't
  *   accessible to your application, or doesn't contain enough space, you can
- *   specify an alternative location using the `tempdir` option.*
+ *   specify an alternative location using the `tmpdir` option.
  *
- * See @ref working_with_memory for more details.
+ * - `use_zip64`: Make the zip library use ZIP64 extensions when writing very
+ *   large xlsx files to allow the zip container, or individual XML files
+ *   within it, to be greater than 4 GB. See [ZIP64 on Wikipedia][zip64_wiki]
+ *   for more information. This option is off by default.
+ *
+ *   [zip64_wiki]: https://en.wikipedia.org/wiki/Zip_(file_format)#ZIP64
+ *
+ * @note In `constant_memory` mode a row of data is written and then discarded
+ * when a cell in a new row is added via one of the `worksheet_write_*()`
+ * functions. Therefore, once this option is active, data should be written in
+ * sequential row order. For this reason the `worksheet_merge_range()` doesn't
+ * work in this mode. See also @ref ww_mem_constant.
  *
  */
 lxw_workbook *workbook_new_opt(const char *filename,
@@ -317,7 +380,7 @@ lxw_workbook *new_workbook_opt(const char *filename,
  *
  * @return A lxw_worksheet object.
  *
- * The `%workbook_add_worksheet()` function adds a new worksheet to a workbook:
+ * The `%workbook_add_worksheet()` function adds a new worksheet to a workbook.
  *
  * At least one worksheet should be added to a new workbook: The @ref
  * worksheet.h "Worksheet" object is used to write data and configure a
@@ -336,18 +399,65 @@ lxw_workbook *new_workbook_opt(const char *filename,
  *
  * @image html workbook02.png
  *
- * The worksheet name must be a valid Excel worksheet name, i.e. it must be
- * less than 32 character and it cannot contain any of the characters:
+ * The worksheet name must be a valid Excel worksheet name, i.e:
  *
- *     / \ [ ] : * ?
- *
- * In addition, you cannot use the same, case insensitive, `sheetname` for more
- * than one worksheet.
+ * - The name is less than or equal to 31 UTF-8 characters.
+ * - The name doesn't contain any of the characters: ` [ ] : * ? / \ `
+ * - The name doesn't start or end with an apostrophe.
+ * - The name isn't "History", which is reserved by Excel. (Case insensitive).
+ * - The name isn't already in use. (Case insensitive).
  *
+ * If any of these errors are encountered the function will return NULL.
+ * You can check for valid name using the `workbook_validate_sheet_name()`
+ * function.
  */
 lxw_worksheet *workbook_add_worksheet(lxw_workbook *workbook,
                                       const char *sheetname);
 
+/**
+ * @brief Add a new chartsheet to a workbook.
+ *
+ * @param workbook  Pointer to a lxw_workbook instance.
+ * @param sheetname Optional chartsheet name, defaults to Chart1, etc.
+ *
+ * @return A lxw_chartsheet object.
+ *
+ * The `%workbook_add_chartsheet()` function adds a new chartsheet to a
+ * workbook. The @ref chartsheet.h "Chartsheet" object is like a worksheet
+ * except it displays a chart instead of cell data.
+ *
+ * @image html chartsheet.png
+ *
+ * The `sheetname` parameter is optional. If it is `NULL` the default
+ * Excel convention will be followed, i.e. Chart1, Chart2, etc.:
+ *
+ * @code
+ *     chartsheet = workbook_add_chartsheet(workbook, NULL  );     // Chart1
+ *     chartsheet = workbook_add_chartsheet(workbook, "My Chart"); // My Chart
+ *     chartsheet = workbook_add_chartsheet(workbook, NULL  );     // Chart3
+ *
+ * @endcode
+ *
+ * The chartsheet name must be a valid Excel worksheet name, i.e.:
+ *
+ * - The name is less than or equal to 31 UTF-8 characters.
+ * - The name doesn't contain any of the characters: ` [ ] : * ? / \ `
+ * - The name doesn't start or end with an apostrophe.
+ * - The name isn't "History", which is reserved by Excel. (Case insensitive).
+ * - The name isn't already in use. (Case insensitive).
+ *
+ * If any of these errors are encountered the function will return NULL.
+ * You can check for valid name using the `workbook_validate_sheet_name()`
+ * function.
+ *
+ * At least one worksheet should be added to a new workbook when creating a
+ * chartsheet in order to provide data for the chart. The @ref worksheet.h
+ * "Worksheet" object is used to write data and configure a worksheet in the
+ * workbook.
+ */
+lxw_chartsheet *workbook_add_chartsheet(lxw_workbook *workbook,
+                                        const char *sheetname);
+
 /**
  * @brief Create a new @ref format.h "Format" object to formats cells in
  *        worksheets.
@@ -677,8 +787,8 @@ lxw_error workbook_define_name(lxw_workbook *workbook, const char *name,
 /**
  * @brief Get a worksheet object from its name.
  *
- * @param workbook
- * @param name
+ * @param workbook Pointer to a lxw_workbook instance.
+ * @param name     Worksheet name.
  *
  * @return A lxw_worksheet object.
  *
@@ -693,31 +803,98 @@ lxw_worksheet *workbook_get_worksheet_by_name(lxw_workbook *workbook,
                                               const char *name);
 
 /**
- * @brief Validate a worksheet name.
+ * @brief Get a chartsheet object from its name.
+ *
+ * @param workbook Pointer to a lxw_workbook instance.
+ * @param name     chartsheet name.
+ *
+ * @return A lxw_chartsheet object.
+ *
+ * This function returns a lxw_chartsheet object reference based on its name:
+ *
+ * @code
+ *     chartsheet = workbook_get_chartsheet_by_name(workbook, "Chart1");
+ * @endcode
+ *
+ */
+lxw_chartsheet *workbook_get_chartsheet_by_name(lxw_workbook *workbook,
+                                                const char *name);
+
+/**
+ * @brief Validate a worksheet or chartsheet name.
  *
  * @param workbook  Pointer to a lxw_workbook instance.
- * @param sheetname Worksheet name to validate.
+ * @param sheetname Sheet name to validate.
  *
  * @return A #lxw_error.
  *
- * This function is used to validate a worksheet name according to the rules
- * used by Excel:
+ * This function is used to validate a worksheet or chartsheet name according
+ * to the rules used by Excel:
  *
  * - The name is less than or equal to 31 UTF-8 characters.
  * - The name doesn't contain any of the characters: ` [ ] : * ? / \ `
- * - The name isn't already in use.
+ * - The name doesn't start or end with an apostrophe.
+ * - The name isn't "History", which is reserved by Excel. (Case insensitive).
+ * - The name isn't already in use. (Case insensitive, see the note below).
  *
  * @code
- *     lxw_error err = workbook_validate_worksheet_name(workbook, "Foglio");
+ *     lxw_error err = workbook_validate_sheet_name(workbook, "Foglio");
  * @endcode
  *
- * This function is called by `workbook_add_worksheet()` but it can be
- * explicitly called by the user beforehand to ensure that the worksheet
- * name is valid.
+ * This function is called by `workbook_add_worksheet()` and
+ * `workbook_add_chartsheet()` but it can be explicitly called by the user
+ * beforehand to ensure that the sheet name is valid.
+ *
+ * @note This function does an ASCII lowercase string comparison to determine
+ * if the sheet name is already in use. It doesn't take UTF-8 characters into
+ * account. Thus it would flag "Café" and "café" as a duplicate (just like
+ * Excel) but it wouldn't catch "CAFÉ". If you need a full UTF-8 case
+ * insensitive check you should use a third party library to implement it.
+ *
+ */
+lxw_error workbook_validate_sheet_name(lxw_workbook *workbook,
+                                       const char *sheetname);
+
+/**
+ * @brief Add a vbaProject binary to the Excel workbook.
+ *
+ * @param workbook Pointer to a lxw_workbook instance.
+ * @param filename The path/filename of the vbaProject.bin file.
  *
+ * The `%workbook_add_vba_project()` function can be used to add macros or
+ * functions to a workbook using a binary VBA project file that has been
+ * extracted from an existing Excel xlsm file:
+ *
+ * @code
+ *     workbook_add_vba_project(workbook, "vbaProject.bin");
+ * @endcode
+ *
+ * Only one `vbaProject.bin file` can be added per workbook.
+ *
+ * @return A #lxw_error.
+ */
+lxw_error workbook_add_vba_project(lxw_workbook *workbook,
+                                   const char *filename);
+
+/**
+ * @brief Set the VBA name for the workbook.
+ *
+ * @param workbook Pointer to a lxw_workbook instance.
+ * @param name     Name of the workbook used by VBA.
+ *
+ * The `workbook_set_vba_name()` function can be used to set the VBA name for
+ * the workbook. This is sometimes required when a vbaProject macro included
+ * via `workbook_add_vba_project()` refers to the workbook.
+ *
+ * @code
+ *     workbook_set_vba_name(workbook, "MyWorkbook");
+ * @endcode
+ *
+ * The most common Excel VBA name for a workbook is `ThisWorkbook`.
+ *
+ * @return A #lxw_error.
  */
-lxw_error workbook_validate_worksheet_name(lxw_workbook *workbook,
-                                           const char *sheetname);
+lxw_error workbook_set_vba_name(lxw_workbook *workbook, const char *name);
 
 void lxw_workbook_free(lxw_workbook *workbook);
 void lxw_workbook_assemble_xml_file(lxw_workbook *workbook);

data/libxlsxwriter/include/xlsxwriter/worksheet.h

@@ -1,7 +1,7 @@
 /*
  * libxlsxwriter
  *
- * Copyright 2014-2017, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
+ * Copyright 2014-2019, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
  */
 
 /**
@@ -53,18 +53,19 @@
 #include "drawing.h"
 #include "common.h"
 #include "format.h"
+#include "styles.h"
 #include "utility.h"
 
-#define LXW_ROW_MAX 1048576
-#define LXW_COL_MAX 16384
-#define LXW_COL_META_MAX 128
+#define LXW_ROW_MAX           1048576
+#define LXW_COL_MAX           16384
+#define LXW_COL_META_MAX      128
 #define LXW_HEADER_FOOTER_MAX 255
-#define LXW_MAX_NUMBER_URLS 65530
-#define LXW_PANE_NAME_LENGTH 12 /* bottomRight + 1 */
+#define LXW_MAX_NUMBER_URLS   65530
+#define LXW_PANE_NAME_LENGTH  12        /* bottomRight + 1 */
 
 /* The Excel 2007 specification says that the maximum number of page
  * breaks is 1026. However, in practice it is actually 1023. */
-#define LXW_BREAKS_MAX 1023
+#define LXW_BREAKS_MAX        1023
 
 /** Default column width in Excel */
 #define LXW_DEF_COL_WIDTH (double)8.43
@@ -76,18 +77,136 @@
 enum lxw_gridlines {
     /** Hide screen and print gridlines. */
     LXW_HIDE_ALL_GRIDLINES = 0,
+
     /** Show screen gridlines. */
     LXW_SHOW_SCREEN_GRIDLINES,
+
     /** Show print gridlines. */
     LXW_SHOW_PRINT_GRIDLINES,
+
     /** Show screen and print gridlines. */
     LXW_SHOW_ALL_GRIDLINES
 };
 
+/** Data validation property values. */
+enum lxw_validation_boolean {
+    LXW_VALIDATION_DEFAULT,
+
+    /** Turn a data validation property off. */
+    LXW_VALIDATION_OFF,
+
+    /** Turn a data validation property on. Data validation properties are
+     * generally on by default. */
+    LXW_VALIDATION_ON
+};
+
+/** Data validation types. */
+enum lxw_validation_types {
+    LXW_VALIDATION_TYPE_NONE,
+
+    /** Restrict cell input to whole/integer numbers only. */
+    LXW_VALIDATION_TYPE_INTEGER,
+
+    /** Restrict cell input to whole/integer numbers only, using a cell
+     *  reference. */
+    LXW_VALIDATION_TYPE_INTEGER_FORMULA,
+
+    /** Restrict cell input to decimal numbers only. */
+    LXW_VALIDATION_TYPE_DECIMAL,
+
+    /** Restrict cell input to decimal numbers only, using a cell
+     * reference. */
+    LXW_VALIDATION_TYPE_DECIMAL_FORMULA,
+
+    /** Restrict cell input to a list of strings in a dropdown. */
+    LXW_VALIDATION_TYPE_LIST,
+
+    /** Restrict cell input to a list of strings in a dropdown, using a
+     * cell range. */
+    LXW_VALIDATION_TYPE_LIST_FORMULA,
+
+    /** Restrict cell input to date values only, using a lxw_datetime type. */
+    LXW_VALIDATION_TYPE_DATE,
+
+    /** Restrict cell input to date values only, using a cell reference. */
+    LXW_VALIDATION_TYPE_DATE_FORMULA,
+
+    /* Restrict cell input to date values only, as a serial number.
+     * Undocumented. */
+    LXW_VALIDATION_TYPE_DATE_NUMBER,
+
+    /** Restrict cell input to time values only, using a lxw_datetime type. */
+    LXW_VALIDATION_TYPE_TIME,
+
+    /** Restrict cell input to time values only, using a cell reference. */
+    LXW_VALIDATION_TYPE_TIME_FORMULA,
+
+    /* Restrict cell input to time values only, as a serial number.
+     * Undocumented. */
+    LXW_VALIDATION_TYPE_TIME_NUMBER,
+
+    /** Restrict cell input to strings of defined length, using a cell
+     * reference. */
+    LXW_VALIDATION_TYPE_LENGTH,
+
+    /** Restrict cell input to strings of defined length, using a cell
+     * reference. */
+    LXW_VALIDATION_TYPE_LENGTH_FORMULA,
+
+    /** Restrict cell to input controlled by a custom formula that returns
+     * `TRUE/FALSE`. */
+    LXW_VALIDATION_TYPE_CUSTOM_FORMULA,
+
+    /** Allow any type of input. Mainly only useful for pop-up messages. */
+    LXW_VALIDATION_TYPE_ANY
+};
+
+/** Data validation criteria uses to control the selection of data. */
+enum lxw_validation_criteria {
+    LXW_VALIDATION_CRITERIA_NONE,
+
+    /** Select data between two values. */
+    LXW_VALIDATION_CRITERIA_BETWEEN,
+
+    /** Select data that is not between two values. */
+    LXW_VALIDATION_CRITERIA_NOT_BETWEEN,
+
+    /** Select data equal to a value. */
+    LXW_VALIDATION_CRITERIA_EQUAL_TO,
+
+    /** Select data not equal to a value. */
+    LXW_VALIDATION_CRITERIA_NOT_EQUAL_TO,
+
+    /** Select data greater than a value. */
+    LXW_VALIDATION_CRITERIA_GREATER_THAN,
+
+    /** Select data less than a value. */
+    LXW_VALIDATION_CRITERIA_LESS_THAN,
+
+    /** Select data greater than or equal to a value. */
+    LXW_VALIDATION_CRITERIA_GREATER_THAN_OR_EQUAL_TO,
+
+    /** Select data less than or equal to a value. */
+    LXW_VALIDATION_CRITERIA_LESS_THAN_OR_EQUAL_TO
+};
+
+/** Data validation error types for pop-up messages. */
+enum lxw_validation_error_types {
+    /** Show a "Stop" data validation pop-up message. This is the default. */
+    LXW_VALIDATION_ERROR_TYPE_STOP,
+
+    /** Show an "Error" data validation pop-up message. */
+    LXW_VALIDATION_ERROR_TYPE_WARNING,
+
+    /** Show an "Information" data validation pop-up message. */
+    LXW_VALIDATION_ERROR_TYPE_INFORMATION
+};
+
 enum cell_types {
     NUMBER_CELL = 1,
     STRING_CELL,
     INLINE_STRING_CELL,
+    INLINE_RICH_STRING_CELL,
     FORMULA_CELL,
     ARRAY_FORMULA_CELL,
     BLANK_CELL,
@@ -140,6 +259,7 @@ struct lxw_table_rows {
 
 STAILQ_HEAD(lxw_merged_ranges, lxw_merged_range);
 STAILQ_HEAD(lxw_selections, lxw_selection);
+STAILQ_HEAD(lxw_data_validations, lxw_data_validation);
 STAILQ_HEAD(lxw_image_data, lxw_image_options);
 STAILQ_HEAD(lxw_chart_data, lxw_image_options);
 
@@ -149,12 +269,14 @@ STAILQ_HEAD(lxw_chart_data, lxw_image_options);
  * Options struct for the worksheet_set_column() and worksheet_set_row()
  * functions.
  *
- * It has the following members but currently only the `hidden` property is
- * supported:
+ * It has the following members:
  *
  * * `hidden`
  * * `level`
  * * `collapsed`
+ *
+ * The members of this struct are explained in @ref ww_outlines_grouping.
+ *
  */
 typedef struct lxw_row_col_options {
     /** Hide the row/column */
@@ -229,6 +351,180 @@ typedef struct lxw_selection {
 
 } lxw_selection;
 
+/**
+ * @brief Worksheet data validation options.
+ */
+typedef struct lxw_data_validation {
+
+    /**
+     * Set the validation type. Should be a #lxw_validation_types value.
+     */
+    uint8_t validate;
+
+    /**
+     * Set the validation criteria type to select the data. Should be a
+     * #lxw_validation_criteria value.
+     */
+    uint8_t criteria;
+
+    /** Controls whether a data validation is not applied to blank data in the
+     * cell. Should be a #lxw_validation_boolean value. It is on by
+     * default.
+     */
+    uint8_t ignore_blank;
+
+    /**
+     * This parameter is used to toggle on and off the 'Show input message
+     * when cell is selected' option in the Excel data validation dialog. When
+     * the option is off an input message is not displayed even if it has been
+     * set using input_message. Should be a #lxw_validation_boolean value. It
+     * is on by default.
+     */
+    uint8_t show_input;
+
+    /**
+     * This parameter is used to toggle on and off the 'Show error alert
+     * after invalid data is entered' option in the Excel data validation
+     * dialog. When the option is off an error message is not displayed even
+     * if it has been set using error_message. Should be a
+     * #lxw_validation_boolean value. It is on by default.
+     */
+    uint8_t show_error;
+
+    /**
+     * This parameter is used to specify the type of error dialog that is
+     * displayed. Should be a #lxw_validation_error_types value.
+     */
+    uint8_t error_type;
+
+    /**
+     * This parameter is used to toggle on and off the 'In-cell dropdown'
+     * option in the Excel data validation dialog. When the option is on a
+     * dropdown list will be shown for list validations. Should be a
+     * #lxw_validation_boolean value. It is on by default.
+     */
+    uint8_t dropdown;
+
+    uint8_t is_between;
+
+    /**
+     * This parameter is used to set the limiting value to which the criteria
+     * is applied using a whole or decimal number.
+     */
+    double value_number;
+
+    /**
+     * This parameter is used to set the limiting value to which the criteria
+     * is applied using a cell reference. It is valid for any of the
+     * `_FORMULA` validation types.
+     */
+    char *value_formula;
+
+    /**
+     * This parameter is used to set a list of strings for a drop down list.
+     * The list should be a `NULL` terminated array of char* strings:
+     *
+     * @code
+     *    char *list[] = {"open", "high", "close", NULL};
+     *
+     *    data_validation->validate   = LXW_VALIDATION_TYPE_LIST;
+     *    data_validation->value_list = list;
+     * @endcode
+     *
+     * The `value_formula` parameter can also be used to specify a list from
+     * an Excel cell range.
+     *
+     * Note, the string list is restricted by Excel to 255 characters,
+     * including comma separators.
+     */
+    char **value_list;
+
+    /**
+     * This parameter is used to set the limiting value to which the date or
+     * time criteria is applied using a #lxw_datetime struct.
+     */
+    lxw_datetime value_datetime;
+
+    /**
+     * This parameter is the same as `value_number` but for the minimum value
+     * when a `BETWEEN` criteria is used.
+     */
+    double minimum_number;
+
+    /**
+     * This parameter is the same as `value_formula` but for the minimum value
+     * when a `BETWEEN` criteria is used.
+     */
+    char *minimum_formula;
+
+    /**
+     * This parameter is the same as `value_datetime` but for the minimum value
+     * when a `BETWEEN` criteria is used.
+     */
+    lxw_datetime minimum_datetime;
+
+    /**
+     * This parameter is the same as `value_number` but for the maximum value
+     * when a `BETWEEN` criteria is used.
+     */
+    double maximum_number;
+
+    /**
+     * This parameter is the same as `value_formula` but for the maximum value
+     * when a `BETWEEN` criteria is used.
+     */
+    char *maximum_formula;
+
+    /**
+     * This parameter is the same as `value_datetime` but for the maximum value
+     * when a `BETWEEN` criteria is used.
+     */
+    lxw_datetime maximum_datetime;
+
+    /**
+     * The input_title parameter is used to set the title of the input message
+     * that is displayed when a cell is entered. It has no default value and
+     * is only displayed if the input message is displayed. See the
+     * `input_message` parameter below.
+     *
+     * The maximum title length is 32 characters.
+     */
+    char *input_title;
+
+    /**
+     * The input_message parameter is used to set the input message that is
+     * displayed when a cell is entered. It has no default value.
+     *
+     * The message can be split over several lines using newlines. The maximum
+     * message length is 255 characters.
+     */
+    char *input_message;
+
+    /**
+     * The error_title parameter is used to set the title of the error message
+     * that is displayed when the data validation criteria is not met. The
+     * default error title is 'Microsoft Excel'. The maximum title length is
+     * 32 characters.
+     */
+    char *error_title;
+
+    /**
+     * The error_message parameter is used to set the error message that is
+     * displayed when a cell is entered. The default error message is "The
+     * value you entered is not valid. A user has restricted values that can
+     * be entered into the cell".
+     *
+     * The message can be split over several lines using newlines. The maximum
+     * message length is 255 characters.
+     */
+    char *error_message;
+
+    char sqref[LXW_MAX_CELL_RANGE_LENGTH];
+
+    STAILQ_ENTRY (lxw_data_validation) list_pointers;
+
+} lxw_data_validation;
+
 /**
  * @brief Options for inserted images
  *
@@ -252,6 +548,7 @@ typedef struct lxw_image_options {
     lxw_row_t row;
     lxw_col_t col;
     char *filename;
+    char *description;
     char *url;
     char *tip;
     uint8_t anchor;
@@ -259,9 +556,11 @@ typedef struct lxw_image_options {
     /* Internal metadata. */
     FILE *stream;
     uint8_t image_type;
+    uint8_t is_image_buffer;
+    unsigned char *image_buffer;
+    size_t image_buffer_size;
     double width;
     double height;
-    char *short_name;
     char *extension;
     double x_dpi;
     double y_dpi;
@@ -329,15 +628,39 @@ typedef struct lxw_protection {
     /** Protect scenarios. */
     uint8_t scenarios;
 
-    /** Protect drawing objects. */
+    /** Protect drawing objects. Worksheets only. */
     uint8_t objects;
 
+    /** Turn off chartsheet content protection. */
+    uint8_t no_content;
+
+    /** Turn off chartsheet objects. */
+    uint8_t no_objects;
+
     uint8_t no_sheet;
-    uint8_t content;
     uint8_t is_configured;
     char hash[5];
 } lxw_protection;
 
+/**
+ * @brief Struct to represent a rich string format/string pair.
+ *
+ * Arrays of this struct are used to define "rich" multi-format strings that
+ * are passed to `worksheet_write_rich_string()`. Each struct represents a
+ * fragment of the rich multi-format string with a lxw_format to define the
+ * format for the string part. If the string fragment is unformatted then
+ * `NULL` can be used for the format.
+ */
+typedef struct lxw_rich_string_tuple {
+
+    /** The format for a string fragment in a rich string. NULL if the string
+     *  isn't formatted. */
+    lxw_format *format;
+
+    /** The string fragment. */
+    char *string;
+} lxw_rich_string_tuple;
+
 /**
  * @brief Struct to represent an Excel worksheet.
  *
@@ -354,6 +677,7 @@ typedef struct lxw_worksheet {
     struct lxw_cell **array;
     struct lxw_merged_ranges *merged_ranges;
     struct lxw_selections *selections;
+    struct lxw_data_validations *data_validations;
     struct lxw_image_data *image_data;
     struct lxw_chart_data *chart_data;
 
@@ -373,6 +697,7 @@ typedef struct lxw_worksheet {
     uint8_t hidden;
     uint16_t *active_sheet;
     uint16_t *first_sheet;
+    uint8_t is_chartsheet;
 
     lxw_col_options **col_options;
     uint16_t col_options_max;
@@ -403,6 +728,9 @@ typedef struct lxw_worksheet {
     uint8_t orientation;
     uint8_t outline_changed;
     uint8_t outline_on;
+    uint8_t outline_style;
+    uint8_t outline_below;
+    uint8_t outline_right;
     uint8_t page_order;
     uint8_t page_setup_changed;
     uint8_t page_view;
@@ -413,9 +741,10 @@ typedef struct lxw_worksheet {
     uint8_t right_to_left;
     uint8_t screen_gridlines;
     uint8_t show_zeros;
-    uint8_t vba_codename;
     uint8_t vcenter;
     uint8_t zoom_scale_normal;
+    uint8_t num_validations;
+    char *vba_codename;
 
     lxw_color_t tab_color;
 
@@ -431,6 +760,8 @@ typedef struct lxw_worksheet {
     uint32_t default_col_pixels;
     uint8_t default_row_zeroed;
     uint8_t default_row_set;
+    uint8_t outline_row_level;
+    uint8_t outline_col_level;
 
     uint8_t header_footer_changed;
     char header[LXW_HEADER_FOOTER_MAX];
@@ -561,6 +892,10 @@ extern "C" {
  *
  * @image html write_number02.png
  *
+ * @note Excel doesn't support `NaN`, `Inf` or `-Inf` as a number value. If
+ * you are writing data that contains these values then your application
+ * should convert them to a string or handle them in some other way.
+ *
  */
 lxw_error worksheet_write_number(lxw_worksheet *worksheet,
                                  lxw_row_t row,
@@ -661,6 +996,7 @@ lxw_error worksheet_write_string(lxw_worksheet *worksheet,
  *     worksheet_write_formula(worksheet, 1, 0, "=SUM(1; 2; 3)", NULL);
  * @endcode
  *
+ * See also @ref working_with_formulas.
  */
 lxw_error worksheet_write_formula(lxw_worksheet *worksheet,
                                   lxw_row_t row,
@@ -669,7 +1005,7 @@ lxw_error worksheet_write_formula(lxw_worksheet *worksheet,
 /**
  * @brief Write an array formula to a worksheet cell.
  *
- * @param worksheet
+ * @param worksheet pointer to a lxw_worksheet instance to be updated.
  * @param first_row   The first row of the range. (All zero indexed.)
  * @param first_col   The first column of the range.
  * @param last_row    The last row of the range.
@@ -874,7 +1210,7 @@ lxw_error worksheet_write_url_opt(lxw_worksheet *worksheet,
  * @endcode
  *
  *
- * Alternatively, you can use Windows style forward slashes. These are
+ * Alternatively, you can use Unix style forward slashes. These are
  * translated internally to backslashes:
  *
  * @code
@@ -991,6 +1327,7 @@ lxw_error worksheet_write_blank(lxw_worksheet *worksheet,
  * worksheet_write_formula() function is the recommended way of writing
  * formulas.
  *
+ * See also @ref working_with_formulas.
  */
 lxw_error worksheet_write_formula_num(lxw_worksheet *worksheet,
                                       lxw_row_t row,
@@ -998,6 +1335,81 @@ lxw_error worksheet_write_formula_num(lxw_worksheet *worksheet,
                                       const char *formula,
                                       lxw_format *format, double result);
 
+/**
+ * @brief Write a "Rich" multi-format string to a worksheet cell.
+ *
+ * @param worksheet   pointer to a lxw_worksheet instance to be updated.
+ * @param row         The zero indexed row number.
+ * @param col         The zero indexed column number.
+ * @param rich_string An array of format/string lxw_rich_string_tuple fragments.
+ * @param format      A pointer to a Format instance or NULL.
+ *
+ * @return A #lxw_error code.
+ *
+ * The `%worksheet_write_rich_string()` function is used to write strings with
+ * multiple formats. For example to write the string 'This is **bold**
+ * and this is *italic*' you would use the following:
+ *
+ * @code
+ *     lxw_format *bold = workbook_add_format(workbook);
+ *     format_set_bold(bold);
+ *
+ *     lxw_format *italic = workbook_add_format(workbook);
+ *     format_set_italic(italic);
+ *
+ *     lxw_rich_string_tuple fragment11 = {.format = NULL,   .string = "This is "     };
+ *     lxw_rich_string_tuple fragment12 = {.format = bold,   .string = "bold"         };
+ *     lxw_rich_string_tuple fragment13 = {.format = NULL,   .string = " and this is "};
+ *     lxw_rich_string_tuple fragment14 = {.format = italic, .string = "italic"       };
+ *
+ *     lxw_rich_string_tuple *rich_string1[] = {&fragment11, &fragment12,
+ *                                              &fragment13, &fragment14, NULL};
+ *
+ *     worksheet_write_rich_string(worksheet, CELL("A1"), rich_string1, NULL);
+ *
+ * @endcode
+ *
+ * @image html rich_strings_small.png
+ *
+ * The basic rule is to break the string into fragments and put a lxw_format
+ * object before the fragment that you want to format. So if we look at the
+ * above example again:
+ *
+ * This is **bold** and this is *italic*
+ *
+ * The would be broken down into 4 fragments:
+ *
+ *      default: |This is |
+ *      bold:    |bold|
+ *      default: | and this is |
+ *      italic:  |italic|
+ *
+ * This in then converted to the lxw_rich_string_tuple fragments shown in the
+ * example above. For the default format we use `NULL`.
+ *
+ * The fragments are passed to `%worksheet_write_rich_string()` as a `NULL`
+ * terminated array:
+ *
+ * @code
+ *     lxw_rich_string_tuple *rich_string1[] = {&fragment11, &fragment12,
+ *                                              &fragment13, &fragment14, NULL};
+ *
+ *     worksheet_write_rich_string(worksheet, CELL("A1"), rich_string1, NULL);
+ *
+ * @endcode
+ *
+ * **Note**:
+ * Excel doesn't allow the use of two consecutive formats in a rich string or
+ * an empty string fragment. For either of these conditions a warning is
+ * raised and the input to `%worksheet_write_rich_string()` is ignored.
+ *
+ */
+lxw_error worksheet_write_rich_string(lxw_worksheet *worksheet,
+                                      lxw_row_t row,
+                                      lxw_col_t col,
+                                      lxw_rich_string_tuple *rich_string[],
+                                      lxw_format *format);
+
 /**
  * @brief Set the properties for a row of cells.
  *
@@ -1066,7 +1478,7 @@ lxw_error worksheet_set_row(lxw_worksheet *worksheet,
  *  `worksheet_set_row()` with an additional `options` parameter.
  *
  * The `options` parameter is a #lxw_row_col_options struct. It has the
- * following members but currently only the `hidden` property is supported:
+ * following members:
  *
  * - `hidden`
  * - `level`
@@ -1076,12 +1488,41 @@ lxw_error worksheet_set_row(lxw_worksheet *worksheet,
  * example, to hide intermediary steps in a complicated calculation:
  *
  * @code
- *     lxw_row_col_options options = {.hidden = 1, .level = 0, .collapsed = 0};
+ *     lxw_row_col_options options1 = {.hidden = 1, .level = 0, .collapsed = 0};
+ *
+ *     // Hide the fourth and fifth (zero indexed) rows.
+ *     worksheet_set_row_opt(worksheet, 3,  LXW_DEF_ROW_HEIGHT, NULL, &options1);
+ *     worksheet_set_row_opt(worksheet, 4,  LXW_DEF_ROW_HEIGHT, NULL, &options1);
  *
- *     // Hide the fourth row.
- *     worksheet_set_row(worksheet, 3, 20, NULL, &options);
  * @endcode
  *
+ * @image html hide_row_col2.png
+ *
+ * The `"hidden"`, `"level"`,  and `"collapsed"`, options can also be used to
+ * create Outlines and Grouping. See @ref working_with_outlines.
+ *
+ * @code
+ *     // The option structs with the outline level set.
+ *     lxw_row_col_options options1 = {.hidden = 0, .level = 2, .collapsed = 0};
+ *     lxw_row_col_options options2 = {.hidden = 0, .level = 1, .collapsed = 0};
+ *
+ *
+ *     // Set the row options with the outline level.
+ *     worksheet_set_row_opt(worksheet, 1,  LXW_DEF_ROW_HEIGHT, NULL, &options1);
+ *     worksheet_set_row_opt(worksheet, 2,  LXW_DEF_ROW_HEIGHT, NULL, &options1);
+ *     worksheet_set_row_opt(worksheet, 3,  LXW_DEF_ROW_HEIGHT, NULL, &options1);
+ *     worksheet_set_row_opt(worksheet, 4,  LXW_DEF_ROW_HEIGHT, NULL, &options1);
+ *     worksheet_set_row_opt(worksheet, 5,  LXW_DEF_ROW_HEIGHT, NULL, &options2);
+ *
+ *     worksheet_set_row_opt(worksheet, 6,  LXW_DEF_ROW_HEIGHT, NULL, &options1);
+ *     worksheet_set_row_opt(worksheet, 7,  LXW_DEF_ROW_HEIGHT, NULL, &options1);
+ *     worksheet_set_row_opt(worksheet, 8,  LXW_DEF_ROW_HEIGHT, NULL, &options1);
+ *     worksheet_set_row_opt(worksheet, 9,  LXW_DEF_ROW_HEIGHT, NULL, &options1);
+ *     worksheet_set_row_opt(worksheet, 10, LXW_DEF_ROW_HEIGHT, NULL, &options2);
+ * @endcode
+ *
+ * @image html outline1.png
+ *
  */
 lxw_error worksheet_set_row_opt(lxw_worksheet *worksheet,
                                 lxw_row_t row,
@@ -1151,7 +1592,7 @@ lxw_error worksheet_set_row_opt(lxw_worksheet *worksheet,
  *     format_set_bold(bold);
  *
  *     // Set the first column to bold.
- *     worksheet_set_column(worksheet, 0, 0, LXW_DEF_COL_HEIGHT, bold);
+ *     worksheet_set_column(worksheet, 0, 0, LXW_DEF_COL_WIDTH, bold);
  * @endcode
  *
  * The `format` parameter will be applied to any cells in the column that
@@ -1189,36 +1630,48 @@ lxw_error worksheet_set_column(lxw_worksheet *worksheet,
                                lxw_col_t last_col,
                                double width, lxw_format *format);
 
- /**
-  * @brief Set the properties for one or more columns of cells with options.
-  *
-  * @param worksheet Pointer to a lxw_worksheet instance to be updated.
-  * @param first_col The zero indexed first column.
-  * @param last_col  The zero indexed last column.
-  * @param width     The width of the column(s).
-  * @param format    A pointer to a Format instance or NULL.
-  * @param options   Optional row parameters: hidden, level, collapsed.
-  *
-  * The `%worksheet_set_column_opt()` function  is the same as
-  * `worksheet_set_column()` with an additional `options` parameter.
-  *
-  * The `options` parameter is a #lxw_row_col_options struct. It has the
-  * following members but currently only the `hidden` property is supported:
-  *
-  * - `hidden`
-  * - `level`
-  * - `collapsed`
-  *
-  * The `"hidden"` option is used to hide a column. This can be used, for
-  * example, to hide intermediary steps in a complicated calculation:
-  *
-  * @code
-  *     lxw_row_col_options options = {.hidden = 1, .level = 0, .collapsed = 0};
-  *
-  *     worksheet_set_column_opt(worksheet, COLS("A:A"), 8.43, NULL, &options);
-  * @endcode
-  *
-  */
+/**
+ * @brief Set the properties for one or more columns of cells with options.
+ *
+ * @param worksheet Pointer to a lxw_worksheet instance to be updated.
+ * @param first_col The zero indexed first column.
+ * @param last_col  The zero indexed last column.
+ * @param width     The width of the column(s).
+ * @param format    A pointer to a Format instance or NULL.
+ * @param options   Optional row parameters: hidden, level, collapsed.
+ *
+ * The `%worksheet_set_column_opt()` function  is the same as
+ * `worksheet_set_column()` with an additional `options` parameter.
+ *
+ * The `options` parameter is a #lxw_row_col_options struct. It has the
+ * following members:
+ *
+ * - `hidden`
+ * - `level`
+ * - `collapsed`
+ *
+ * The `"hidden"` option is used to hide a column. This can be used, for
+ * example, to hide intermediary steps in a complicated calculation:
+ *
+ * @code
+ *     lxw_row_col_options options1 = {.hidden = 1, .level = 0, .collapsed = 0};
+ *
+ *     worksheet_set_column_opt(worksheet, COLS("D:E"),  LXW_DEF_COL_WIDTH, NULL, &options1);
+ * @endcode
+ *
+ * @image html hide_row_col3.png
+ *
+ * The `"hidden"`, `"level"`,  and `"collapsed"`, options can also be used to
+ * create Outlines and Grouping. See @ref working_with_outlines.
+ *
+ * @code
+ *     lxw_row_col_options options1 = {.hidden = 0, .level = 1, .collapsed = 0};
+ *
+ *     worksheet_set_column_opt(worksheet, COLS("B:G"),  5, NULL, &options1);
+ * @endcode
+ *
+ * @image html outline8.png
+ */
 lxw_error worksheet_set_column_opt(lxw_worksheet *worksheet,
                                    lxw_col_t first_col,
                                    lxw_col_t last_col,
@@ -1295,6 +1748,77 @@ lxw_error worksheet_insert_image_opt(lxw_worksheet *worksheet,
                                      lxw_row_t row, lxw_col_t col,
                                      const char *filename,
                                      lxw_image_options *options);
+
+/**
+ * @brief Insert an image in a worksheet cell, from a memory buffer.
+ *
+ * @param worksheet    Pointer to a lxw_worksheet instance to be updated.
+ * @param row          The zero indexed row number.
+ * @param col          The zero indexed column number.
+ * @param image_buffer Pointer to an array of bytes that holds the image data.
+ * @param image_size   The size of the array of bytes.
+ *
+ * @return A #lxw_error code.
+ *
+ * This function can be used to insert a image into a worksheet from a memory
+ * buffer:
+ *
+ * @code
+ *     worksheet_insert_image_buffer(worksheet, CELL("B3"), image_buffer, image_size);
+ * @endcode
+ *
+ * @image html image_buffer.png
+ *
+ * The buffer should be a pointer to an array of unsigned char data with a
+ * specified size.
+ *
+ * See `worksheet_insert_image()` for details about the supported image
+ * formats, and other image features.
+ */
+lxw_error worksheet_insert_image_buffer(lxw_worksheet *worksheet,
+                                        lxw_row_t row,
+                                        lxw_col_t col,
+                                        const unsigned char *image_buffer,
+                                        size_t image_size);
+
+/**
+ * @brief Insert an image in a worksheet cell, from a memory buffer.
+ *
+ * @param worksheet    Pointer to a lxw_worksheet instance to be updated.
+ * @param row          The zero indexed row number.
+ * @param col          The zero indexed column number.
+ * @param image_buffer Pointer to an array of bytes that holds the image data.
+ * @param image_size   The size of the array of bytes.
+ * @param options      Optional image parameters.
+ *
+ * @return A #lxw_error code.
+ *
+ * The `%worksheet_insert_image_buffer_opt()` function is like
+ * `worksheet_insert_image_buffer()` function except that it takes an optional
+ * #lxw_image_options struct to scale and position the image:
+ *
+ * @code
+ *     lxw_image_options options = {.x_offset = 32, .y_offset = 4,
+ *                                  .x_scale  = 2,  .y_scale  = 1};
+ *
+ *     worksheet_insert_image_buffer_opt(worksheet, CELL("B3"), image_buffer, image_size, &options);
+ * @endcode
+ *
+ * @image html image_buffer_opt.png
+ *
+ * The buffer should be a pointer to an array of unsigned char data with a
+ * specified size.
+ *
+ * See `worksheet_insert_image_buffer_opt()` for details about the supported
+ * image formats, and other image options.
+ */
+lxw_error worksheet_insert_image_buffer_opt(lxw_worksheet *worksheet,
+                                            lxw_row_t row,
+                                            lxw_col_t col,
+                                            const unsigned char *image_buffer,
+                                            size_t image_size,
+                                            lxw_image_options *options);
+
 /**
  * @brief Insert a chart object into a worksheet.
  *
@@ -1305,8 +1829,8 @@ lxw_error worksheet_insert_image_opt(lxw_worksheet *worksheet,
  *
  * @return A #lxw_error code.
  *
- * The `%worksheet_insert_chart()` can be used to insert a chart into a
- * worksheet. The chart object must be created first using the
+ * The `%worksheet_insert_chart()` function can be used to insert a chart into
+ * a worksheet. The chart object must be created first using the
  * `workbook_add_chart()` function and configured using the @ref chart.h
  * functions.
  *
@@ -1317,13 +1841,12 @@ lxw_error worksheet_insert_image_opt(lxw_worksheet *worksheet,
  *     // Add a data series to the chart.
  *     chart_add_series(chart, NULL, "=Sheet1!$A$1:$A$6");
  *
- *     // Insert the chart into the worksheet
+ *     // Insert the chart into the worksheet.
  *     worksheet_insert_chart(worksheet, 0, 2, chart);
  * @endcode
  *
  * @image html chart_working.png
  *
- *
  * **Note:**
  *
  * A chart may only be inserted into a worksheet once. If several similar
@@ -1470,6 +1993,87 @@ lxw_error worksheet_autofilter(lxw_worksheet *worksheet, lxw_row_t first_row,
                                lxw_col_t first_col, lxw_row_t last_row,
                                lxw_col_t last_col);
 
+/**
+ * @brief Add a data validation to a cell.
+ *
+ * @param worksheet  Pointer to a lxw_worksheet instance to be updated.
+ * @param row        The zero indexed row number.
+ * @param col        The zero indexed column number.
+ * @param validation A #lxw_data_validation object to control the validation.
+ *
+ * @return A #lxw_error code.
+ *
+ * The `%worksheet_data_validation_cell()` function is used to construct an
+ * Excel data validation or to limit the user input to a dropdown list of
+ * values:
+ *
+ * @code
+ *
+ *    lxw_data_validation *data_validation = calloc(1, sizeof(lxw_data_validation));
+ *
+ *    data_validation->validate       = LXW_VALIDATION_TYPE_INTEGER;
+ *    data_validation->criteria       = LXW_VALIDATION_CRITERIA_BETWEEN;
+ *    data_validation->minimum_number = 1;
+ *    data_validation->maximum_number = 10;
+ *
+ *    worksheet_data_validation_cell(worksheet, 2, 1, data_validation);
+ *
+ *    // Same as above with the CELL() macro.
+ *    worksheet_data_validation_cell(worksheet, CELL("B3"), data_validation);
+ *
+ * @endcode
+ *
+ * @image html data_validate4.png
+ *
+ * Data validation and the various options of #lxw_data_validation are
+ * described in more detail in @ref working_with_data_validation.
+ */
+lxw_error worksheet_data_validation_cell(lxw_worksheet *worksheet,
+                                         lxw_row_t row, lxw_col_t col,
+                                         lxw_data_validation *validation);
+
+/**
+ * @brief Add a data validation to a range cell.
+ *
+ * @param worksheet  Pointer to a lxw_worksheet instance to be updated.
+ * @param first_row  The first row of the range. (All zero indexed.)
+ * @param first_col  The first column of the range.
+ * @param last_row   The last row of the range.
+ * @param last_col   The last col of the range.
+ * @param validation A #lxw_data_validation object to control the validation.
+ *
+ * @return A #lxw_error code.
+ *
+ * The `%worksheet_data_validation_range()` function is the same as the
+ * `%worksheet_data_validation_cell()`, see above,  except the data validation
+ * is applied to a range of cells:
+ *
+ * @code
+ *
+ *    lxw_data_validation *data_validation = calloc(1, sizeof(lxw_data_validation));
+ *
+ *    data_validation->validate       = LXW_VALIDATION_TYPE_INTEGER;
+ *    data_validation->criteria       = LXW_VALIDATION_CRITERIA_BETWEEN;
+ *    data_validation->minimum_number = 1;
+ *    data_validation->maximum_number = 10;
+ *
+ *    worksheet_data_validation_range(worksheet, 2, 1, 4, 1, data_validation);
+ *
+ *    // Same as above with the RANGE() macro.
+ *    worksheet_data_validation_range(worksheet, RANGE("B3:B5"), data_validation);
+ *
+ * @endcode
+ *
+ * Data validation and the various options of #lxw_data_validation are
+ * described in more detail in @ref working_with_data_validation.
+ */
+lxw_error worksheet_data_validation_range(lxw_worksheet *worksheet,
+                                          lxw_row_t first_row,
+                                          lxw_col_t first_col,
+                                          lxw_row_t last_row,
+                                          lxw_col_t last_col,
+                                          lxw_data_validation *validation);
+
  /**
   * @brief Make a worksheet the active, i.e., visible worksheet.
   *
@@ -1853,26 +2457,26 @@ void worksheet_set_margins(lxw_worksheet *worksheet, double left,
  * @code
  *     worksheet_set_header(worksheet, "&LHello");
  *
- *      ---------------------------------------------------------------
- *     |                                                               |
- *     | Hello                                                         |
- *     |                                                               |
+ *     //     ---------------------------------------------------------------
+ *     //    |                                                               |
+ *     //    | Hello                                                         |
+ *     //    |                                                               |
  *
  *
  *     worksheet_set_header(worksheet, "&CHello");
  *
- *      ---------------------------------------------------------------
- *     |                                                               |
- *     |                          Hello                                |
- *     |                                                               |
+ *     //     ---------------------------------------------------------------
+ *     //    |                                                               |
+ *     //    |                          Hello                                |
+ *     //    |                                                               |
  *
  *
  *     worksheet_set_header(worksheet, "&RHello");
  *
- *      ---------------------------------------------------------------
- *     |                                                               |
- *     |                                                         Hello |
- *     |                                                               |
+ *     //     ---------------------------------------------------------------
+ *     //    |                                                               |
+ *     //    |                                                         Hello |
+ *     //    |                                                               |
  *
  *
  * @endcode
@@ -1884,10 +2488,10 @@ void worksheet_set_margins(lxw_worksheet *worksheet, double left,
  * @code
  *     worksheet_set_header(worksheet, "Hello");
  *
- *      ---------------------------------------------------------------
- *     |                                                               |
- *     |                          Hello                                |
- *     |                                                               |
+ *     //     ---------------------------------------------------------------
+ *     //    |                                                               |
+ *     //    |                          Hello                                |
+ *     //    |                                                               |
  *
  * @endcode
  *
@@ -1896,10 +2500,10 @@ void worksheet_set_margins(lxw_worksheet *worksheet, double left,
  * @code
  *     worksheet_set_header(worksheet, "&LCiao&CBello&RCielo");
  *
- *      ---------------------------------------------------------------
- *     |                                                               |
- *     | Ciao                     Bello                          Cielo |
- *     |                                                               |
+ *     //     ---------------------------------------------------------------
+ *     //    |                                                               |
+ *     //    | Ciao                     Bello                          Cielo |
+ *     //    |                                                               |
  *
  * @endcode
  *
@@ -1910,17 +2514,17 @@ void worksheet_set_margins(lxw_worksheet *worksheet, double left,
  * @code
  *     worksheet_set_header(worksheet, "&CPage &P of &N");
  *
- *      ---------------------------------------------------------------
- *     |                                                               |
- *     |                        Page 1 of 6                            |
- *     |                                                               |
+ *     //     ---------------------------------------------------------------
+ *     //    |                                                               |
+ *     //    |                        Page 1 of 6                            |
+ *     //    |                                                               |
  *
  *     worksheet_set_header(worksheet, "&CUpdated at &T");
  *
- *      ---------------------------------------------------------------
- *     |                                                               |
- *     |                    Updated at 12:30 PM                        |
- *     |                                                               |
+ *     //     ---------------------------------------------------------------
+ *     //    |                                                               |
+ *     //    |                    Updated at 12:30 PM                        |
+ *     //    |                                                               |
  *
  * @endcode
  *
@@ -2460,8 +3064,8 @@ void worksheet_hide_zero(lxw_worksheet *worksheet);
  * @param worksheet Pointer to a lxw_worksheet instance to be updated.
  * @param color     The tab color.
  *
- * The `%worksheet_set_tab_color()` function is used to change the color of the worksheet
- * tab:
+ * The `%worksheet_set_tab_color()` function is used to change the color of
+ * the worksheet tab:
  *
  * @code
  *      worksheet_set_tab_color(worksheet1, LXW_COLOR_RED);
@@ -2544,15 +3148,62 @@ void worksheet_set_tab_color(lxw_worksheet *worksheet, lxw_color_t color);
  *
  * See also the format_set_unlocked() and format_set_hidden() format functions.
  *
- * **Note:** Worksheet level passwords in Excel offer **very** weak
+ * **Note:** Sheet level passwords in Excel offer **very** weak
  * protection. They don't encrypt your data and are very easy to
  * deactivate. Full workbook encryption is not supported by `libxlsxwriter`
- * since it requires a completely different file format and would take several
- * man months to implement.
+ * since it requires a completely different file format.
  */
 void worksheet_protect(lxw_worksheet *worksheet, const char *password,
                        lxw_protection *options);
 
+/**
+ * @brief Set the Outline and Grouping display properties.
+ *
+ * @param worksheet      Pointer to a lxw_worksheet instance to be updated.
+ * @param visible        Outlines are visible. Optional, defaults to True.
+ * @param symbols_below  Show row outline symbols below the outline bar.
+ * @param symbols_right  Show column outline symbols to the right of outline.
+ * @param auto_style     Use Automatic outline style.
+ *
+ * The `%worksheet_outline_settings()` method is used to control the
+ * appearance of outlines in Excel. Outlines are described the section on
+ * @ref working_with_outlines.
+ *
+ * The `visible` parameter is used to control whether or not outlines are
+ * visible. Setting this parameter to False will cause all outlines on the
+ * worksheet to be hidden. They can be un-hidden in Excel by means of the
+ * "Show Outline Symbols" command button. The default Excel setting is True
+ * for visible outlines.
+ *
+ * The `symbols_below` parameter is used to control whether the row outline
+ * symbol will appear above or below the outline level bar. The default Excel
+ * setting is True for symbols to appear below the outline level bar.
+ *
+ * The `symbols_right` parameter is used to control whether the column outline
+ * symbol will appear to the left or the right of the outline level bar. The
+ * default Excel setting is True for symbols to appear to the right of the
+ * outline level bar.
+ *
+ * The `auto_style` parameter is used to control whether the automatic outline
+ * generator in Excel uses automatic styles when creating an outline. This has
+ * no effect on a file generated by XlsxWriter but it does have an effect on
+ * how the worksheet behaves after it is created. The default Excel setting is
+ * False for "Automatic Styles" to be turned off.
+ *
+ * The default settings for all of these parameters in libxlsxwriter
+ * correspond to Excel's default parameters and are shown below:
+ *
+ * @code
+ *     worksheet_outline_settings(worksheet1, LXW_TRUE, LXW_TRUE, LXW_TRUE, LXW_FALSE);
+ * @endcode
+ *
+ * The worksheet parameters controlled by `worksheet_outline_settings()` are
+ * rarely used.
+ */
+void worksheet_outline_settings(lxw_worksheet *worksheet, uint8_t visible,
+                                uint8_t symbols_below, uint8_t symbols_right,
+                                uint8_t auto_style);
+
 /**
  * @brief Set the default row properties.
  *
@@ -2584,22 +3235,58 @@ void worksheet_protect(lxw_worksheet *worksheet, const char *password,
 void worksheet_set_default_row(lxw_worksheet *worksheet, double height,
                                uint8_t hide_unused_rows);
 
+/**
+ * @brief Set the VBA name for the worksheet.
+ *
+ * @param worksheet Pointer to a lxw_worksheet instance.
+ * @param name      Name of the worksheet used by VBA.
+ *
+ * The `worksheet_set_vba_name()` function can be used to set the VBA name for
+ * the worksheet. This is sometimes required when a vbaProject macro included
+ * via `workbook_add_vba_project()` refers to the worksheet.
+ *
+ * @code
+ *     workbook_set_vba_name (workbook,  "MyWorkbook");
+ *     worksheet_set_vba_name(worksheet, "MySheet1");
+ * @endcode
+ *
+ * In general Excel uses the worksheet name such as "Sheet1" as the VBA name.
+ * However, this can be changed in the VBA environment or if the the macro was
+ * extracted from a foreign language version of Excel.
+ *
+ * @return A #lxw_error.
+ */
+lxw_error worksheet_set_vba_name(lxw_worksheet *worksheet, const char *name);
+
 lxw_worksheet *lxw_worksheet_new(lxw_worksheet_init_data *init_data);
 void lxw_worksheet_free(lxw_worksheet *worksheet);
 void lxw_worksheet_assemble_xml_file(lxw_worksheet *worksheet);
 void lxw_worksheet_write_single_row(lxw_worksheet *worksheet);
 
 void lxw_worksheet_prepare_image(lxw_worksheet *worksheet,
-                                 uint16_t image_ref_id, uint16_t drawing_id,
+                                 uint32_t image_ref_id, uint32_t drawing_id,
                                  lxw_image_options *image_data);
 
 void lxw_worksheet_prepare_chart(lxw_worksheet *worksheet,
-                                 uint16_t chart_ref_id, uint16_t drawing_id,
-                                 lxw_image_options *image_data);
+                                 uint32_t chart_ref_id, uint32_t drawing_id,
+                                 lxw_image_options *image_data,
+                                 uint8_t is_chartsheet);
 
 lxw_row *lxw_worksheet_find_row(lxw_worksheet *worksheet, lxw_row_t row_num);
 lxw_cell *lxw_worksheet_find_cell(lxw_row *row, lxw_col_t col_num);
 
+/*
+ * External functions to call intern XML methods shared with chartsheet.
+ */
+void lxw_worksheet_write_sheet_views(lxw_worksheet *worksheet);
+void lxw_worksheet_write_page_margins(lxw_worksheet *worksheet);
+void lxw_worksheet_write_drawings(lxw_worksheet *worksheet);
+void lxw_worksheet_write_sheet_protection(lxw_worksheet *worksheet,
+                                          lxw_protection *protect);
+void lxw_worksheet_write_sheet_pr(lxw_worksheet *worksheet);
+void lxw_worksheet_write_page_setup(lxw_worksheet *worksheet);
+void lxw_worksheet_write_header_footer(lxw_worksheet *worksheet);
+
 /* Declarations required for unit testing. */
 #ifdef TESTING
 
@@ -2629,7 +3316,9 @@ STATIC void _worksheet_write_header_footer(lxw_worksheet *worksheet);
 STATIC void _worksheet_write_print_options(lxw_worksheet *worksheet);
 STATIC void _worksheet_write_sheet_pr(lxw_worksheet *worksheet);
 STATIC void _worksheet_write_tab_color(lxw_worksheet *worksheet);
-STATIC void _worksheet_write_sheet_protection(lxw_worksheet *worksheet);
+STATIC void _worksheet_write_sheet_protection(lxw_worksheet *worksheet,
+                                              lxw_protection *protect);
+STATIC void _worksheet_write_data_validations(lxw_worksheet *self);
 #endif /* TESTING */
 
 /* *INDENT-OFF* */