xlsxwriter 0.2.1.pre.2 → 0.2.3.pre.1

data/ext/xlsxwriter/libxlsxwriter/include/xlsxwriter/worksheet.h

@@ -1,7 +1,7 @@
 /*
  * libxlsxwriter
  *
- * Copyright 2014-2019, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
+ * Copyright 2014-2020, John McNamara, jmcnamara@cpan.org. See LICENSE.txt.
  */
 
 /**
@@ -46,7 +46,6 @@
 #include <stdio.h>
 #include <stdlib.h>
 #include <stdint.h>
-#include <string.h>
 
 #include "shared_strings.h"
 #include "chart.h"
@@ -55,13 +54,16 @@
 #include "format.h"
 #include "styles.h"
 #include "utility.h"
+#include "relationships.h"
 
-#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_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_IMAGE_BUFFER_SIZE      	1024
+#define LXW_HEADER_FOOTER_OBJS_MAX 	6       /* Header/footer image objs. */
 
 /* The Excel 2007 specification says that the maximum number of page
  * breaks is 1026. However, in practice it is actually 1023. */
@@ -202,6 +204,391 @@ enum lxw_validation_error_types {
     LXW_VALIDATION_ERROR_TYPE_INFORMATION
 };
 
+/** Set the display type for a cell comment. This is hidden by default but
+ *  can be set to visible with the `worksheet_show_comments()` function. */
+enum lxw_comment_display_types {
+    /** Default to the worksheet default which can be hidden or visible.*/
+    LXW_COMMENT_DISPLAY_DEFAULT,
+
+    /** Hide the cell comment. Usually the default. */
+    LXW_COMMENT_DISPLAY_HIDDEN,
+
+    /** Show the cell comment. Can also be set for the worksheet with the
+     *  `worksheet_show_comments()` function.*/
+    LXW_COMMENT_DISPLAY_VISIBLE
+};
+
+/** @brief Type definitions for conditional formats.
+ *
+ * Values used to set the "type" field of conditional format.
+ */
+enum lxw_conditional_format_types {
+    LXW_CONDITIONAL_TYPE_NONE,
+
+    /** The Cell type is the most common conditional formatting type. It is
+     *  used when a format is applied to a cell based on a simple
+     *  criterion.  */
+    LXW_CONDITIONAL_TYPE_CELL,
+
+    /** The Text type is used to specify Excel's "Specific Text" style
+     *  conditional format. */
+    LXW_CONDITIONAL_TYPE_TEXT,
+
+    /** The Time Period type is used to specify Excel's "Dates Occurring"
+     *  style conditional format. */
+    LXW_CONDITIONAL_TYPE_TIME_PERIOD,
+
+    /** The Average type is used to specify Excel's "Average" style
+     *  conditional format. */
+    LXW_CONDITIONAL_TYPE_AVERAGE,
+
+    /** The Duplicate type is used to highlight duplicate cells in a range. */
+    LXW_CONDITIONAL_TYPE_DUPLICATE,
+
+    /** The Unique type is used to highlight unique cells in a range. */
+    LXW_CONDITIONAL_TYPE_UNIQUE,
+
+    /** The Top type is used to specify the top n values by number or
+     *  percentage in a range. */
+    LXW_CONDITIONAL_TYPE_TOP,
+
+    /** The Bottom type is used to specify the bottom n values by number or
+     *  percentage in a range. */
+    LXW_CONDITIONAL_TYPE_BOTTOM,
+
+    /** The Blanks type is used to highlight blank cells in a range. */
+    LXW_CONDITIONAL_TYPE_BLANKS,
+
+    /** The No Blanks type is used to highlight non blank cells in a range. */
+    LXW_CONDITIONAL_TYPE_NO_BLANKS,
+
+    /** The Errors type is used to highlight error cells in a range. */
+    LXW_CONDITIONAL_TYPE_ERRORS,
+
+    /** The No Errors type is used to highlight non error cells in a range. */
+    LXW_CONDITIONAL_TYPE_NO_ERRORS,
+
+    /** The Formula type is used to specify a conditional format based on a
+     *  user defined formula. */
+    LXW_CONDITIONAL_TYPE_FORMULA,
+
+    /** The 2 Color Scale type is used to specify Excel's "2 Color Scale"
+     *  style conditional format. */
+    LXW_CONDITIONAL_2_COLOR_SCALE,
+
+    /** The 3 Color Scale type is used to specify Excel's "3 Color Scale"
+     *  style conditional format. */
+    LXW_CONDITIONAL_3_COLOR_SCALE,
+
+    /** The Data Bar type is used to specify Excel's "Data Bar" style
+     *  conditional format. */
+    LXW_CONDITIONAL_DATA_BAR,
+
+    /** The Icon Set type is used to specify a conditional format with a set
+     *  of icons such as traffic lights or arrows. */
+    LXW_CONDITIONAL_TYPE_ICON_SETS,
+
+    LXW_CONDITIONAL_TYPE_LAST
+};
+
+/** @brief The criteria used in a conditional format.
+ *
+ * Criteria used to define how a conditional format works.
+ */
+enum lxw_conditional_criteria {
+    LXW_CONDITIONAL_CRITERIA_NONE,
+
+    /** Format cells equal to a value. */
+    LXW_CONDITIONAL_CRITERIA_EQUAL_TO,
+
+    /** Format cells not equal to a value. */
+    LXW_CONDITIONAL_CRITERIA_NOT_EQUAL_TO,
+
+    /** Format cells greater than a value. */
+    LXW_CONDITIONAL_CRITERIA_GREATER_THAN,
+
+    /** Format cells less than a value. */
+    LXW_CONDITIONAL_CRITERIA_LESS_THAN,
+
+    /** Format cells greater than or equal to a value. */
+    LXW_CONDITIONAL_CRITERIA_GREATER_THAN_OR_EQUAL_TO,
+
+    /** Format cells less than or equal to a value. */
+    LXW_CONDITIONAL_CRITERIA_LESS_THAN_OR_EQUAL_TO,
+
+    /** Format cells between two values. */
+    LXW_CONDITIONAL_CRITERIA_BETWEEN,
+
+    /** Format cells that is not between two values. */
+    LXW_CONDITIONAL_CRITERIA_NOT_BETWEEN,
+
+    /** Format cells that contain the specified text. */
+    LXW_CONDITIONAL_CRITERIA_TEXT_CONTAINING,
+
+    /** Format cells that don't contain the specified text. */
+    LXW_CONDITIONAL_CRITERIA_TEXT_NOT_CONTAINING,
+
+    /** Format cells that begin with the specified text. */
+    LXW_CONDITIONAL_CRITERIA_TEXT_BEGINS_WITH,
+
+    /** Format cells that end with the specified text. */
+    LXW_CONDITIONAL_CRITERIA_TEXT_ENDS_WITH,
+
+    /** Format cells with a date of yesterday. */
+    LXW_CONDITIONAL_CRITERIA_TIME_PERIOD_YESTERDAY,
+
+    /** Format cells with a date of today. */
+    LXW_CONDITIONAL_CRITERIA_TIME_PERIOD_TODAY,
+
+    /** Format cells with a date of tomorrow. */
+    LXW_CONDITIONAL_CRITERIA_TIME_PERIOD_TOMORROW,
+
+    /** Format cells with a date in the last 7 days. */
+    LXW_CONDITIONAL_CRITERIA_TIME_PERIOD_LAST_7_DAYS,
+
+    /** Format cells with a date in the last week. */
+    LXW_CONDITIONAL_CRITERIA_TIME_PERIOD_LAST_WEEK,
+
+    /** Format cells with a date in the current week. */
+    LXW_CONDITIONAL_CRITERIA_TIME_PERIOD_THIS_WEEK,
+
+    /** Format cells with a date in the next week. */
+    LXW_CONDITIONAL_CRITERIA_TIME_PERIOD_NEXT_WEEK,
+
+    /** Format cells with a date in the last month. */
+    LXW_CONDITIONAL_CRITERIA_TIME_PERIOD_LAST_MONTH,
+
+    /** Format cells with a date in the current month. */
+    LXW_CONDITIONAL_CRITERIA_TIME_PERIOD_THIS_MONTH,
+
+    /** Format cells with a date in the next month. */
+    LXW_CONDITIONAL_CRITERIA_TIME_PERIOD_NEXT_MONTH,
+
+    /** Format cells above the average for the range. */
+    LXW_CONDITIONAL_CRITERIA_AVERAGE_ABOVE,
+
+    /** Format cells below the average for the range. */
+    LXW_CONDITIONAL_CRITERIA_AVERAGE_BELOW,
+
+    /** Format cells above or equal to the average for the range. */
+    LXW_CONDITIONAL_CRITERIA_AVERAGE_ABOVE_OR_EQUAL,
+
+    /** Format cells below or equal to the average for the range. */
+    LXW_CONDITIONAL_CRITERIA_AVERAGE_BELOW_OR_EQUAL,
+
+    /** Format cells 1 standard deviation above the average for the range. */
+    LXW_CONDITIONAL_CRITERIA_AVERAGE_1_STD_DEV_ABOVE,
+
+    /** Format cells 1 standard deviation below the average for the range. */
+    LXW_CONDITIONAL_CRITERIA_AVERAGE_1_STD_DEV_BELOW,
+
+    /** Format cells 2 standard deviation above the average for the range. */
+    LXW_CONDITIONAL_CRITERIA_AVERAGE_2_STD_DEV_ABOVE,
+
+    /** Format cells 2 standard deviation below the average for the range. */
+    LXW_CONDITIONAL_CRITERIA_AVERAGE_2_STD_DEV_BELOW,
+
+    /** Format cells 3 standard deviation above the average for the range. */
+    LXW_CONDITIONAL_CRITERIA_AVERAGE_3_STD_DEV_ABOVE,
+
+    /** Format cells 3 standard deviation below the average for the range. */
+    LXW_CONDITIONAL_CRITERIA_AVERAGE_3_STD_DEV_BELOW,
+
+    /** Format cells in the top of bottom percentage. */
+    LXW_CONDITIONAL_CRITERIA_TOP_OR_BOTTOM_PERCENT
+};
+
+/** @brief Conditional format rule types.
+ *
+ * Conditional format rule types that apply to Color Scale and Data Bars.
+ */
+enum lxw_conditional_format_rule_types {
+    LXW_CONDITIONAL_RULE_TYPE_NONE,
+
+    /** Conditional format rule type: matches the minimum values in the
+     *  range. Can only be applied to min_rule_type.*/
+    LXW_CONDITIONAL_RULE_TYPE_MINIMUM,
+
+    /** Conditional format rule type: use a number to set the bound.*/
+    LXW_CONDITIONAL_RULE_TYPE_NUMBER,
+
+    /** Conditional format rule type: use a percentage to set the bound.*/
+    LXW_CONDITIONAL_RULE_TYPE_PERCENT,
+
+    /** Conditional format rule type: use a percentile to set the bound.*/
+    LXW_CONDITIONAL_RULE_TYPE_PERCENTILE,
+
+    /** Conditional format rule type: use a formula to set the bound.*/
+    LXW_CONDITIONAL_RULE_TYPE_FORMULA,
+
+    /** Conditional format rule type: matches the maximum values in the
+     *  range. Can only be applied to max_rule_type.*/
+    LXW_CONDITIONAL_RULE_TYPE_MAXIMUM,
+
+    /* Used internally for Excel2010 bars. Not documented. */
+    LXW_CONDITIONAL_RULE_TYPE_AUTO_MIN,
+
+    /* Used internally for Excel2010 bars. Not documented. */
+    LXW_CONDITIONAL_RULE_TYPE_AUTO_MAX
+};
+
+/** @brief Conditional format data bar directions.
+ *
+ * Values used to set the bar direction of a conditional format data bar.
+ */
+enum lxw_conditional_format_bar_direction {
+
+    /** Data bar direction is set by Excel based on the context of the data
+     *  displayed. */
+    LXW_CONDITIONAL_BAR_DIRECTION_CONTEXT,
+
+    /** Data bar direction is from right to left. */
+    LXW_CONDITIONAL_BAR_DIRECTION_RIGHT_TO_LEFT,
+
+    /** Data bar direction is from left to right. */
+    LXW_CONDITIONAL_BAR_DIRECTION_LEFT_TO_RIGHT
+};
+
+/** @brief Conditional format data bar axis options.
+ *
+ * Values used to set the position of the axis in a conditional format data
+ * bar.
+ */
+enum lxw_conditional_bar_axis_position {
+
+    /** Data bar axis position is set by Excel based on the context of the
+     *  data displayed. */
+    LXW_CONDITIONAL_BAR_AXIS_AUTOMATIC,
+
+    /** Data bar axis position is set at the midpoint. */
+    LXW_CONDITIONAL_BAR_AXIS_MIDPOINT,
+
+    /** Data bar axis is turned off. */
+    LXW_CONDITIONAL_BAR_AXIS_NONE
+};
+
+/** @brief Icon types used in the #lxw_conditional_format icon_style field.
+ *
+ * Definitions of icon styles used with Icon Set conditional formats.
+ */
+enum lxw_conditional_icon_types {
+
+    /** Icon style: 3 colored arrows showing up, sideways and down. */
+    LXW_CONDITIONAL_ICONS_3_ARROWS_COLORED,
+
+    /** Icon style: 3 gray arrows showing up, sideways and down. */
+    LXW_CONDITIONAL_ICONS_3_ARROWS_GRAY,
+
+    /** Icon style: 3 colored flags in red, yellow and green. */
+    LXW_CONDITIONAL_ICONS_3_FLAGS,
+
+    /** Icon style: 3 traffic lights - rounded. */
+    LXW_CONDITIONAL_ICONS_3_TRAFFIC_LIGHTS_UNRIMMED,
+
+    /** Icon style: 3 traffic lights with a rim - squarish. */
+    LXW_CONDITIONAL_ICONS_3_TRAFFIC_LIGHTS_RIMMED,
+
+    /** Icon style: 3 colored shapes - a circle, triangle and diamond. */
+    LXW_CONDITIONAL_ICONS_3_SIGNS,
+
+    /** Icon style: 3 circled symbols with tick mark, exclamation and
+     *  cross. */
+    LXW_CONDITIONAL_ICONS_3_SYMBOLS_CIRCLED,
+
+    /** Icon style: 3 symbols with tick mark, exclamation and cross. */
+    LXW_CONDITIONAL_ICONS_3_SYMBOLS_UNCIRCLED,
+
+    /** Icon style: 3 colored arrows showing up, diagonal up, diagonal down
+     *  and down. */
+    LXW_CONDITIONAL_ICONS_4_ARROWS_COLORED,
+
+    /** Icon style: 3 gray arrows showing up, diagonal up, diagonal down and
+     * down. */
+    LXW_CONDITIONAL_ICONS_4_ARROWS_GRAY,
+
+    /** Icon style: 4 circles in 4 colors going from red to black. */
+    LXW_CONDITIONAL_ICONS_4_RED_TO_BLACK,
+
+    /** Icon style: 4 histogram ratings. */
+    LXW_CONDITIONAL_ICONS_4_RATINGS,
+
+    /** Icon style: 4 traffic lights. */
+    LXW_CONDITIONAL_ICONS_4_TRAFFIC_LIGHTS,
+
+    /** Icon style: 5 colored arrows showing up, diagonal up, sideways,
+     * diagonal down and down. */
+    LXW_CONDITIONAL_ICONS_5_ARROWS_COLORED,
+
+    /** Icon style: 5 gray arrows showing up, diagonal up, sideways, diagonal
+     *  down and down. */
+    LXW_CONDITIONAL_ICONS_5_ARROWS_GRAY,
+
+    /** Icon style: 5 histogram ratings. */
+    LXW_CONDITIONAL_ICONS_5_RATINGS,
+
+    /** Icon style: 5 quarters, from 0 to 4 quadrants filled. */
+    LXW_CONDITIONAL_ICONS_5_QUARTERS
+};
+
+/** Options to control the positioning of worksheet objects such as images
+ *  or charts. See @ref working_with_object_positioning. */
+enum lxw_object_position {
+
+    /** Default positioning for the object. */
+    LXW_OBJECT_POSITION_DEFAULT,
+
+    /** Move and size with the worksheet object with the cells. */
+    LXW_OBJECT_MOVE_AND_SIZE,
+
+    /** Move but don't size with the worksheet object with the cells. */
+    LXW_OBJECT_MOVE_DONT_SIZE,
+
+    /** Don't move or size the worksheet object with the cells. */
+    LXW_OBJECT_DONT_MOVE_DONT_SIZE,
+
+    /** Same as #LXW_OBJECT_MOVE_AND_SIZE except libxlsxwriter applies hidden
+     *  cells after the object is inserted. */
+    LXW_OBJECT_MOVE_AND_SIZE_AFTER
+};
+
+/** Options for ignoring worksheet errors/warnings. See worksheet_ignore_errors(). */
+enum lxw_ignore_errors {
+
+    /** Turn off errors/warnings for numbers stores as text. */
+    LXW_IGNORE_NUMBER_STORED_AS_TEXT = 1,
+
+    /** Turn off errors/warnings for formula errors (such as divide by
+     *  zero). */
+    LXW_IGNORE_EVAL_ERROR,
+
+    /** Turn off errors/warnings for formulas that differ from surrounding
+     *  formulas. */
+    LXW_IGNORE_FORMULA_DIFFERS,
+
+    /** Turn off errors/warnings for formulas that omit cells in a range. */
+    LXW_IGNORE_FORMULA_RANGE,
+
+    /** Turn off errors/warnings for unlocked cells that contain formulas. */
+    LXW_IGNORE_FORMULA_UNLOCKED,
+
+    /** Turn off errors/warnings for formulas that refer to empty cells. */
+    LXW_IGNORE_EMPTY_CELL_REFERENCE,
+
+    /** Turn off errors/warnings for cells in a table that do not comply with
+     *  applicable data validation rules. */
+    LXW_IGNORE_LIST_DATA_VALIDATION,
+
+    /** Turn off errors/warnings for cell formulas that differ from the column
+     *  formula. */
+    LXW_IGNORE_CALCULATED_COLUMN,
+
+    /** Turn off errors/warnings for formulas that contain a two digit text
+     *  representation of a year. */
+    LXW_IGNORE_TWO_DIGIT_TEXT_YEAR,
+
+    LXW_IGNORE_LAST_OPTION
+};
+
 enum cell_types {
     NUMBER_CELL = 1,
     STRING_CELL,
@@ -211,6 +598,7 @@ enum cell_types {
     ARRAY_FORMULA_CELL,
     BLANK_CELL,
     BOOLEAN_CELL,
+    COMMENT,
     HYPERLINK_URL,
     HYPERLINK_INTERNAL,
     HYPERLINK_EXTERNAL
@@ -223,8 +611,20 @@ enum pane_types {
     FREEZE_SPLIT_PANES
 };
 
+enum lxw_image_position {
+    HEADER_LEFT = 0,
+    HEADER_CENTER,
+    HEADER_RIGHT,
+    FOOTER_LEFT,
+    FOOTER_CENTER,
+    FOOTER_RIGHT
+};
+
 /* Define the tree.h RB structs for the red-black head types. */
 RB_HEAD(lxw_table_cells, lxw_cell);
+RB_HEAD(lxw_drawing_rel_ids, lxw_drawing_rel_id);
+RB_HEAD(lxw_vml_drawing_rel_ids, lxw_drawing_rel_id);
+RB_HEAD(lxw_cond_format_hash, lxw_cond_format_hash_element);
 
 /* Define a RB_TREE struct manually to add extra members. */
 struct lxw_table_rows {
@@ -257,11 +657,46 @@ struct lxw_table_rows {
     /* Add unused struct to allow adding a semicolon */   \
     struct lxw_rb_generate_cell{int unused;}
 
+#define LXW_RB_GENERATE_DRAWING_REL_IDS(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_drawing_rel_ids{int unused;}
+
+#define LXW_RB_GENERATE_VML_DRAWING_REL_IDS(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_vml_drawing_rel_ids{int unused;}
+
+#define LXW_RB_GENERATE_COND_FORMAT_HASH(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_cond_format_hash{int unused;}
+
 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);
+STAILQ_HEAD(lxw_data_validations, lxw_data_val_obj);
+STAILQ_HEAD(lxw_cond_format_list, lxw_cond_format_obj);
+STAILQ_HEAD(lxw_image_props, lxw_object_properties);
+STAILQ_HEAD(lxw_chart_props, lxw_object_properties);
+STAILQ_HEAD(lxw_comment_objs, lxw_vml_obj);
 
 /**
  * @brief Options for rows and columns.
@@ -279,9 +714,13 @@ STAILQ_HEAD(lxw_chart_data, lxw_image_options);
  *
  */
 typedef struct lxw_row_col_options {
-    /** Hide the row/column */
+    /** Hide the row/column. @ref ww_outlines_grouping.*/
     uint8_t hidden;
+
+    /** Outline level. See @ref ww_outlines_grouping.*/
     uint8_t level;
+
+    /** Set the outline row as collapsed. See @ref ww_outlines_grouping.*/
     uint8_t collapsed;
 } lxw_row_col_options;
 
@@ -405,8 +844,6 @@ typedef struct lxw_data_validation {
      */
     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.
@@ -519,14 +956,307 @@ typedef struct lxw_data_validation {
      */
     char *error_message;
 
+} lxw_data_validation;
+
+/* A copy of lxw_data_validation which is used internally and which contains
+ * some additional fields.
+ */
+typedef struct lxw_data_val_obj {
+    uint8_t validate;
+    uint8_t criteria;
+    uint8_t ignore_blank;
+    uint8_t show_input;
+    uint8_t show_error;
+    uint8_t error_type;
+    uint8_t dropdown;
+    double value_number;
+    char *value_formula;
+    char **value_list;
+    double minimum_number;
+    char *minimum_formula;
+    lxw_datetime minimum_datetime;
+    double maximum_number;
+    char *maximum_formula;
+    lxw_datetime maximum_datetime;
+    char *input_title;
+    char *input_message;
+    char *error_title;
+    char *error_message;
     char sqref[LXW_MAX_CELL_RANGE_LENGTH];
 
-    STAILQ_ENTRY (lxw_data_validation) list_pointers;
+    STAILQ_ENTRY (lxw_data_val_obj) list_pointers;
+} lxw_data_val_obj;
 
-} lxw_data_validation;
+/**
+ * @brief Worksheet conditional formatting options.
+ *
+ * The fields/options in the the lxw_conditional_format are used to define a
+ * worksheet conditional format. It is used in conjunction with
+ * `worksheet_conditional_format()`.
+ *
+ */
+typedef struct lxw_conditional_format {
+
+    /** The type of conditional format such as #LXW_CONDITIONAL_TYPE_CELL or
+     *  #LXW_CONDITIONAL_DATA_BAR. Should be a #lxw_conditional_format_types
+     *  value.*/
+    uint8_t type;
+
+    /** The criteria parameter is used to set the criteria by which the cell
+     *  data will be evaluated. For example in the expression `a > 5 the
+     *  criteria is `>` or, in libxlsxwriter terms,
+     *  #LXW_CONDITIONAL_CRITERIA_GREATER_THAN. The criteria that are
+     *  applicable depend on the conditional format type.  The criteria
+     *  options are defined in #lxw_conditional_criteria. */
+    uint8_t criteria;
+
+    /** The number value to which the condition refers. For example in the
+     * expression `a > 5`, the value is 5.*/
+    double value;
+
+    /** The string value to which the condition refers, such as `"=A1"`. If a
+     *  value_string exists in the struct then the number value is
+     *  ignored. Note, if the condition refers to a text string then it must
+     *  be double quoted like this `"foo"`. */
+    char *value_string;
+
+    /** The format field is used to specify the #lxw_format format that will
+     *  be applied to the cell when the conditional formatting criterion is
+     *  met. The #lxw_format is created using the `workbook_add_format()`
+     *  method in the same way as cell formats.
+     *
+     *  @note In Excel, a conditional format is superimposed over the existing
+     *  cell format and not all cell format properties can be
+     *  modified. Properties that @b cannot be modified, in Excel, by a
+     *  conditional format are: font name, font size, superscript and
+     *  subscript, diagonal borders, all alignment properties and all
+     *  protection properties. */
+    lxw_format *format;
+
+    /** The minimum value used for Cell, Color Scale and Data Bar conditional
+     *  formats. For Cell types this is usually used with a "Between" style criteria. */
+    double min_value;
+
+    /** The minimum string value used for Cell, Color Scale and Data Bar conditional
+     *  formats. Usually used to set ranges like `=A1`. */
+    char *min_value_string;
+
+    /** The rule used for the minimum condition in Color Scale and Data Bar
+     *  conditional formats. The rule types are defined in
+     *  #lxw_conditional_format_rule_types. */
+    uint8_t min_rule_type;
+
+    /** The color used for the minimum Color Scale conditional format.
+     *  See @ref working_with_colors. */
+    lxw_color_t min_color;
+
+    /** The middle value used for Color Scale and Data Bar conditional
+     *  formats.  */
+    double mid_value;
+
+    /** The middle string value used for Color Scale and Data Bar conditional
+     *  formats. Usually used to set ranges like `=A1`. */
+    char *mid_value_string;
+
+    /** The rule used for the middle condition in Color Scale and Data Bar
+     *  conditional formats. The rule types are defined in
+     *  #lxw_conditional_format_rule_types. */
+    uint8_t mid_rule_type;
+
+    /** The color used for the middle Color Scale conditional format.
+     *  See @ref working_with_colors. */
+    lxw_color_t mid_color;
+
+    /** The maximum value used for Cell, Color Scale and Data Bar conditional
+     *  formats. For Cell types this is usually used with a "Between" style
+     *  criteria. */
+    double max_value;
+
+    /** The maximum string value used for Cell, Color Scale and Data Bar conditional
+     *  formats. Usually used to set ranges like `=A1`. */
+    char *max_value_string;
+
+    /** The rule used for the maximum condition in Color Scale and Data Bar
+     *  conditional formats. The rule types are defined in
+     *  #lxw_conditional_format_rule_types. */
+    uint8_t max_rule_type;
+
+    /** The color used for the maximum Color Scale conditional format.
+     *  See @ref working_with_colors. */
+    lxw_color_t max_color;
+
+    /** The bar_color field sets the fill color for data bars. See @ref
+     *  working_with_colors. */
+    lxw_color_t bar_color;
+
+    /** The bar_only field sets The bar_only field displays a bar data but
+     *  not the data in the cells. */
+    uint8_t bar_only;
+
+    /** In Excel 2010 additional data bar properties were added such as solid
+     *  (non-gradient) bars and control over how negative values are
+     *  displayed. These properties can shown below.
+     *
+     *  The data_bar_2010 field sets Excel 2010 style data bars even when
+     *  Excel 2010 specific properties aren't used. */
+    uint8_t data_bar_2010;
+
+    /** The bar_solid field turns on a solid (non-gradient) fill for data
+     *  bars. Set to LXW_TRUE to turn on. Excel 2010 only. */
+    uint8_t bar_solid;
+
+    /** The bar_negative_color field sets the color fill for the negative
+     *  portion of a data bar. See @ref working_with_colors. Excel 2010 only. */
+    lxw_color_t bar_negative_color;
+
+    /** The bar_border_color field sets the color for the border line of a
+     *  data bar. See @ref working_with_colors. Excel 2010 only. */
+    lxw_color_t bar_border_color;
+
+    /** The bar_negative_border_color field sets the color for the border of
+     *  the negative portion of a data bar. See @ref
+     *  working_with_colors. Excel 2010 only. */
+    lxw_color_t bar_negative_border_color;
+
+    /** The bar_negative_color_same field sets the fill color for the negative
+     *  portion of a data bar to be the same as the fill color for the
+     *  positive portion of the data bar. Set to LXW_TRUE to turn on. Excel
+     *  2010 only. */
+    uint8_t bar_negative_color_same;
+
+    /** The bar_negative_border_color_same field sets the border color for the
+     *  negative portion of a data bar to be the same as the border color for
+     *  the positive portion of the data bar. Set to LXW_TRUE to turn
+     *  on. Excel 2010 only. */
+    uint8_t bar_negative_border_color_same;
+
+    /** The bar_no_border field turns off the border for data bars. Set to
+     *  LXW_TRUE to enable. Excel 2010 only. */
+    uint8_t bar_no_border;
+
+    /** The bar_direction field sets the direction for data bars. This
+     *  property can be either left for left-to-right or right for
+     *  right-to-left. If the property isn't set then Excel will adjust the
+     *  position automatically based on the context. Should be a
+     *  #lxw_conditional_format_bar_direction value. Excel 2010 only. */
+    uint8_t bar_direction;
+
+    /** The bar_axis_position field sets the position within the cells for the
+     *  axis that is shown in data bars when there are negative values to
+     *  display. The property can be either middle or none. If the property
+     *  isn't set then Excel will position the axis based on the range of
+     *  positive and negative values. Should be a
+     *  lxw_conditional_bar_axis_position value. Excel 2010 only. */
+    uint8_t bar_axis_position;
+
+    /** The bar_axis_color field sets the color for the axis that is shown
+     *  in data bars when there are negative values to display. See @ref
+     *  working_with_colors. Excel 2010 only. */
+    lxw_color_t bar_axis_color;
+
+    /** The Icons Sets style is specified by the icon_style parameter. Should
+     *  be a #lxw_conditional_icon_types. */
+    uint8_t icon_style;
+
+    /** The order of Icon Sets icons can be reversed by setting reverse_icons
+     *  to LXW_TRUE.  */
+    uint8_t reverse_icons;
+
+    /** The icons can be displayed without the cell value by settings the
+     *  icons_only parameter to LXW_TRUE.  */
+    uint8_t icons_only;
+
+    /** The multi_range field is used to extend a conditional format over
+     *  non-contiguous ranges.
+     *
+     *  It is possible to apply the conditional format to different cell
+     *  ranges in a worksheet using multiple calls to
+     *  `worksheet_conditional_format()`. However, as a minor optimization it
+     *  is also possible in Excel to apply the same conditional format to
+     *  different non-contiguous cell ranges.
+     *
+     *  This is replicated in `worksheet_conditional_format()` using the
+     *  multi_range option. The range must contain the primary range for the
+     *  conditional format and any others separated by spaces. For example
+     *  `"A1 C1:C5 E2 G1:G100"`.
+     */
+    char *multi_range;
+
+    /** The stop_if_true parameter can be used to set the "stop if true"
+     *  feature of a conditional formatting rule when more than one rule is
+     *  applied to a cell or a range of cells. When this parameter is set then
+     *  subsequent rules are not evaluated if the current rule is true. Set to
+     *  LXW_TRUE to turn on. */
+    uint8_t stop_if_true;
+
+} lxw_conditional_format;
+
+/* Internal */
+typedef struct lxw_cond_format_obj {
+    uint8_t type;
+    uint8_t criteria;
+
+    double min_value;
+    char *min_value_string;
+    uint8_t min_rule_type;
+    lxw_color_t min_color;
+
+    double mid_value;
+    char *mid_value_string;
+    uint8_t mid_value_type;
+    uint8_t mid_rule_type;
+    lxw_color_t mid_color;
+
+    double max_value;
+    char *max_value_string;
+    uint8_t max_value_type;
+    uint8_t max_rule_type;
+    lxw_color_t max_color;
+
+    uint8_t data_bar_2010;
+    uint8_t auto_min;
+    uint8_t auto_max;
+    uint8_t bar_only;
+    uint8_t bar_solid;
+    uint8_t bar_negative_color_same;
+    uint8_t bar_negative_border_color_same;
+    uint8_t bar_no_border;
+    uint8_t bar_direction;
+    uint8_t bar_axis_position;
+    lxw_color_t bar_color;
+    lxw_color_t bar_negative_color;
+    lxw_color_t bar_border_color;
+    lxw_color_t bar_negative_border_color;
+    lxw_color_t bar_axis_color;
+
+    uint8_t icon_style;
+    uint8_t reverse_icons;
+    uint8_t icons_only;
+
+    uint8_t stop_if_true;
+    uint8_t has_max;
+    char *type_string;
+    char *guid;
+
+    int32_t dxf_index;
+    uint32_t dxf_priority;
+
+    char first_cell[LXW_MAX_CELL_NAME_LENGTH];
+    char sqref[LXW_MAX_ATTRIBUTE_LENGTH];
+
+    STAILQ_ENTRY (lxw_cond_format_obj) list_pointers;
+} lxw_cond_format_obj;
+
+typedef struct lxw_cond_format_hash_element {
+    char sqref[LXW_MAX_ATTRIBUTE_LENGTH];
+
+    struct lxw_cond_format_list *cond_formats;
+
+    RB_ENTRY (lxw_cond_format_hash_element) tree_pointers;
+} lxw_cond_format_hash_element;
 
 /**
- * @brief Options for inserted images
+ * @brief Options for inserted images.
  *
  * Options for modifying images inserted via `worksheet_insert_image_opt()`.
  *
@@ -545,15 +1275,64 @@ typedef struct lxw_image_options {
     /** Y scale of the image as a decimal. */
     double y_scale;
 
+    /** Object position - use one of the values of #lxw_object_position.
+     *  See @ref working_with_object_positioning.*/
+    uint8_t object_position;
+
+    /** Optional description of the image. Defaults to the image filename
+     *  as in Excel. Set to "" to ignore the description field. */
+    char *description;
+
+    /** Add an optional hyperlink to the image. Follows the same URL rules
+     *  and types as `worksheet_write_url()`. */
+    char *url;
+
+    /** Add an optional mouseover tip for a hyperlink to the image. */
+    char *tip;
+
+} lxw_image_options;
+
+/**
+ * @brief Options for inserted charts.
+ *
+ * Options for modifying charts inserted via `worksheet_insert_chart_opt()`.
+ *
+ */
+typedef struct lxw_chart_options {
+
+    /** Offset from the left of the cell in pixels. */
+    int32_t x_offset;
+
+    /** Offset from the top of the cell in pixels. */
+    int32_t y_offset;
+
+    /** X scale of the chart as a decimal. */
+    double x_scale;
+
+    /** Y scale of the chart as a decimal. */
+    double y_scale;
+
+    /** Object position - use one of the values of #lxw_object_position.
+     *  See @ref working_with_object_positioning.*/
+    uint8_t object_position;
+
+} lxw_chart_options;
+
+/* Internal struct to represent lxw_image_options and lxw_chart_options
+ * values as well as internal metadata.
+ */
+typedef struct lxw_object_properties {
+    int32_t x_offset;
+    int32_t y_offset;
+    double x_scale;
+    double y_scale;
     lxw_row_t row;
     lxw_col_t col;
     char *filename;
     char *description;
     char *url;
     char *tip;
-    uint8_t anchor;
-
-    /* Internal metadata. */
+    uint8_t object_position;
     FILE *stream;
     uint8_t image_type;
     uint8_t is_image_buffer;
@@ -565,21 +1344,153 @@ typedef struct lxw_image_options {
     double x_dpi;
     double y_dpi;
     lxw_chart *chart;
+    uint8_t is_duplicate;
+    char *md5;
+    char *image_position;
 
-    STAILQ_ENTRY (lxw_image_options) list_pointers;
+    STAILQ_ENTRY (lxw_object_properties) list_pointers;
+} lxw_object_properties;
 
-} lxw_image_options;
+/**
+ * @brief Options for inserted comments.
+ *
+ * Options for modifying comments inserted via `worksheet_write_comment_opt()`.
+ *
+ */
+typedef struct lxw_comment_options {
+
+    /** This option is used to make a cell comment visible when the worksheet
+     *  is opened. The default behavior in Excel is that comments are
+     *  initially hidden. However, it is also possible in Excel to make
+     *  individual comments or all comments visible.  You can make all
+     *  comments in the worksheet visible using the
+     *  `worksheet_show_comments()` function. Defaults to
+     *  LXW_COMMENT_DISPLAY_DEFAULT. See also @ref ww_comments_visible. */
+    uint8_t visible;
+
+    /** This option is used to indicate the author of the cell comment. Excel
+     *  displays the author in the status bar at the bottom of the
+     *  worksheet. The default author for all cell comments in a worksheet can
+     *  be set using the `worksheet_set_comments_author()` function. Set to
+     *  NULL if not required.  See also @ref ww_comments_author. */
+    char *author;
+
+    /** This option is used to set the width of the cell comment box
+     *  explicitly in pixels. The default width is 128 pixels. See also @ref
+     *  ww_comments_width. */
+    uint16_t width;
+
+    /** This option is used to set the height of the cell comment box
+     *  explicitly in pixels. The default height is 74 pixels.  See also @ref
+     *  ww_comments_height. */
+    uint16_t height;
+
+    /** X scale of the comment as a decimal. See also
+     * @ref ww_comments_x_scale. */
+    double x_scale;
+
+    /** Y scale of the comment as a decimal. See also
+     * @ref ww_comments_y_scale. */
+    double y_scale;
+
+    /** This option is used to set the background color of cell comment
+     *  box. The color should be an RGB integer value, see @ref
+     *  working_with_colors. See also @ref ww_comments_color. */
+    lxw_color_t color;
+
+    /** This option is used to set the font for the comment. The default font
+     *  is 'Tahoma'.  See also @ref ww_comments_font_name. */
+    char *font_name;
+
+     /** This option is used to set the font size for the comment. The default
+      * is 8. See also @ref ww_comments_font_size. */
+    double font_size;
+
+    /** This option is used to set the font family number for the comment.
+     *  Not required very often. Set to 0. */
+    uint8_t font_family;
+
+    /** This option is used to set the row in which the comment will
+     *  appear. By default Excel displays comments one cell to the right and
+     *  one cell above the cell to which the comment relates. The `start_row`
+     *  and `start_col` options should both be set to 0 if not used.  See also
+     *  @ref ww_comments_start_row. */
+    lxw_row_t start_row;
+
+    /** This option is used to set the column in which the comment will
+     *   appear. See the `start_row` option for more information and see also
+     *   @ref ww_comments_start_col. */
+    lxw_col_t start_col;
+
+    /** Offset from the left of the cell in pixels. See also
+     * @ref ww_comments_x_offset. */
+    int32_t x_offset;
+
+    /** Offset from the top of the cell in pixels. See also
+     * @ref ww_comments_y_offset. */
+    int32_t y_offset;
+
+} lxw_comment_options;
+
+/* Internal structure for VML object options. */
+typedef struct lxw_vml_obj {
+
+    lxw_row_t row;
+    lxw_col_t col;
+    lxw_row_t start_row;
+    lxw_col_t start_col;
+    int32_t x_offset;
+    int32_t y_offset;
+    uint32_t col_absolute;
+    uint32_t row_absolute;
+    uint32_t width;
+    uint32_t height;
+    double x_dpi;
+    double y_dpi;
+    lxw_color_t color;
+    uint8_t font_family;
+    uint8_t visible;
+    uint32_t author_id;
+    uint32_t rel_index;
+    double font_size;
+    struct lxw_drawing_coords from;
+    struct lxw_drawing_coords to;
+    char *author;
+    char *font_name;
+    char *text;
+    char *image_position;
+    char *name;
+    STAILQ_ENTRY (lxw_vml_obj) list_pointers;
+
+} lxw_vml_obj;
 
 /**
  * @brief Header and footer options.
  *
- * Optional parameters used in the worksheet_set_header_opt() and
+ * Optional parameters used in the `worksheet_set_header_opt()` and
  * worksheet_set_footer_opt() functions.
  *
  */
 typedef struct lxw_header_footer_options {
-    /** Header or footer margin in inches. Excel default is 0.3. */
+    /** Header or footer margin in inches. Excel default is 0.3. Must by
+     *  larger than 0.0.  See `worksheet_set_header_opt()`. */
     double margin;
+
+    /** The left header image filename, with path if required. This should
+     * have a corresponding `&G/&[Picture]` placeholder in the `&L` section of
+     * the header/footer string. See `worksheet_set_header_opt()`. */
+    char *image_left;
+
+    /** The center header image filename, with path if required. This should
+     * have a corresponding `&G/&[Picture]` placeholder in the `&C` section of
+     * the header/footer string. See `worksheet_set_header_opt()`. */
+    char *image_center;
+
+    /** The right header image filename, with path if required. This should
+     * have a corresponding `&G/&[Picture]` placeholder in the `&R` section of
+     * the header/footer string. See `worksheet_set_header_opt()`. */
+    char *image_right;
+
 } lxw_header_footer_options;
 
 /**
@@ -637,10 +1548,31 @@ typedef struct lxw_protection {
     /** Turn off chartsheet objects. */
     uint8_t no_objects;
 
+} lxw_protection;
+
+/* Internal struct to copy lxw_protection options and internal metadata. */
+typedef struct lxw_protection_obj {
+    uint8_t no_select_locked_cells;
+    uint8_t no_select_unlocked_cells;
+    uint8_t format_cells;
+    uint8_t format_columns;
+    uint8_t format_rows;
+    uint8_t insert_columns;
+    uint8_t insert_rows;
+    uint8_t insert_hyperlinks;
+    uint8_t delete_columns;
+    uint8_t delete_rows;
+    uint8_t sort;
+    uint8_t autofilter;
+    uint8_t pivot_tables;
+    uint8_t scenarios;
+    uint8_t objects;
+    uint8_t no_content;
+    uint8_t no_objects;
     uint8_t no_sheet;
     uint8_t is_configured;
     char hash[5];
-} lxw_protection;
+} lxw_protection_obj;
 
 /**
  * @brief Struct to represent a rich string format/string pair.
@@ -674,12 +1606,18 @@ typedef struct lxw_worksheet {
     FILE *optimize_tmpfile;
     struct lxw_table_rows *table;
     struct lxw_table_rows *hyperlinks;
+    struct lxw_table_rows *comments;
     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;
+    struct lxw_cond_format_hash *conditional_formats;
+    struct lxw_image_props *image_props;
+    struct lxw_chart_props *chart_data;
+    struct lxw_drawing_rel_ids *drawing_rel_ids;
+    struct lxw_vml_drawing_rel_ids *vml_drawing_rel_ids;
+    struct lxw_comment_objs *comment_objs;
+    struct lxw_comment_objs *header_image_objs;
 
     lxw_row_t dim_rowmin;
     lxw_row_t dim_rowmax;
@@ -773,21 +1711,62 @@ typedef struct lxw_worksheet {
     struct lxw_autofilter autofilter;
 
     uint16_t merged_range_count;
+    uint16_t max_url_length;
 
     lxw_row_t *hbreaks;
     lxw_col_t *vbreaks;
     uint16_t hbreaks_count;
     uint16_t vbreaks_count;
 
+    uint32_t drawing_rel_id;
+    uint32_t vml_drawing_rel_id;
     struct lxw_rel_tuples *external_hyperlinks;
     struct lxw_rel_tuples *external_drawing_links;
     struct lxw_rel_tuples *drawing_links;
+    struct lxw_rel_tuples *vml_drawing_links;
 
     struct lxw_panes panes;
 
-    struct lxw_protection protection;
+    struct lxw_protection_obj protection;
 
     lxw_drawing *drawing;
+    lxw_format *default_url_format;
+
+    uint8_t has_vml;
+    uint8_t has_comments;
+    uint8_t has_header_vml;
+    lxw_rel_tuple *external_vml_comment_link;
+    lxw_rel_tuple *external_comment_link;
+    lxw_rel_tuple *external_vml_header_link;
+    char *comment_author;
+    char *vml_data_id_str;
+    char *vml_header_id_str;
+    uint32_t vml_shape_id;
+    uint32_t vml_header_id;
+    uint32_t dxf_priority;
+    uint8_t comment_display_default;
+    uint32_t data_bar_2010_index;
+
+    uint8_t has_ignore_errors;
+    char *ignore_number_stored_as_text;
+    char *ignore_eval_error;
+    char *ignore_formula_differs;
+    char *ignore_formula_range;
+    char *ignore_formula_unlocked;
+    char *ignore_empty_cell_reference;
+    char *ignore_list_data_validation;
+    char *ignore_calculated_column;
+    char *ignore_two_digit_text_year;
+
+    uint16_t excel_version;
+
+    lxw_object_properties **header_footer_objs[LXW_HEADER_FOOTER_OBJS_MAX];
+    lxw_object_properties *header_left_object_props;
+    lxw_object_properties *header_center_object_props;
+    lxw_object_properties *header_right_object_props;
+    lxw_object_properties *footer_left_object_props;
+    lxw_object_properties *footer_center_object_props;
+    lxw_object_properties *footer_right_object_props;
 
     STAILQ_ENTRY (lxw_worksheet) list_pointers;
 
@@ -806,6 +1785,8 @@ typedef struct lxw_worksheet_init_data {
     char *name;
     char *quoted_name;
     char *tmpdir;
+    lxw_format *default_url_format;
+    uint16_t max_url_length;
 
 } lxw_worksheet_init_data;
 
@@ -820,6 +1801,7 @@ typedef struct lxw_row {
     uint8_t row_changed;
     uint8_t data_changed;
     uint8_t height_changed;
+
     struct lxw_table_cells *cells;
 
     /* tree management pointers for tree.h. */
@@ -832,6 +1814,7 @@ typedef struct lxw_cell {
     lxw_col_t col_num;
     enum cell_types type;
     lxw_format *format;
+    lxw_vml_obj *comment;
 
     union {
         double number;
@@ -848,6 +1831,16 @@ typedef struct lxw_cell {
     RB_ENTRY (lxw_cell) tree_pointers;
 } lxw_cell;
 
+/* Struct to represent a drawing Target/ID pair. */
+typedef struct lxw_drawing_rel_id {
+    uint32_t id;
+    char *target;
+
+    RB_ENTRY (lxw_drawing_rel_id) tree_pointers;
+} lxw_drawing_rel_id;
+
+
+
 /* *INDENT-OFF* */
 #ifdef __cplusplus
 extern "C" {
@@ -857,7 +1850,7 @@ extern "C" {
 /**
  * @brief Write a number to a worksheet cell.
  *
- * @param worksheet pointer to a lxw_worksheet instance to be updated.
+ * @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 number    The number to write to the cell.
@@ -904,7 +1897,7 @@ lxw_error worksheet_write_number(lxw_worksheet *worksheet,
 /**
  * @brief Write a string to a worksheet cell.
  *
- * @param worksheet pointer to a lxw_worksheet instance to be updated.
+ * @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 string    String to write to cell.
@@ -952,7 +1945,7 @@ lxw_error worksheet_write_string(lxw_worksheet *worksheet,
 /**
  * @brief Write a formula to a worksheet cell.
  *
- * @param worksheet pointer to a lxw_worksheet instance to be updated.
+ * @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 formula   Formula string to write to cell.
@@ -1005,7 +1998,7 @@ lxw_error worksheet_write_formula(lxw_worksheet *worksheet,
 /**
  * @brief Write an array formula to a worksheet cell.
  *
- * @param worksheet pointer to a lxw_worksheet instance to be updated.
+ * @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.
@@ -1064,7 +2057,7 @@ lxw_error worksheet_write_array_formula_num(lxw_worksheet *worksheet,
 /**
  * @brief Write a date or time to a worksheet cell.
  *
- * @param worksheet pointer to a lxw_worksheet instance to be updated.
+ * @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 datetime  The datetime to write to the cell.
@@ -1093,14 +2086,9 @@ lxw_error worksheet_write_datetime(lxw_worksheet *worksheet,
                                    lxw_col_t col, lxw_datetime *datetime,
                                    lxw_format *format);
 
-lxw_error worksheet_write_url_opt(lxw_worksheet *worksheet,
-                                  lxw_row_t row_num,
-                                  lxw_col_t col_num, const char *url,
-                                  lxw_format *format, const char *string,
-                                  const char *tooltip);
 /**
  *
- * @param worksheet pointer to a lxw_worksheet instance to be updated.
+ * @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 url       The url to write to the cell.
@@ -1113,21 +2101,22 @@ lxw_error worksheet_write_url_opt(lxw_worksheet *worksheet,
  * worksheet cell specified by `row` and `column`.
  *
  * @code
- *     worksheet_write_url(worksheet, 0, 0, "http://libxlsxwriter.github.io", url_format);
+ *     worksheet_write_url(worksheet, 0, 0, "http://libxlsxwriter.github.io", NULL);
  * @endcode
  *
  * @image html hyperlinks_short.png
  *
  * The `format` parameter is used to apply formatting to the cell. This
- * parameter can be `NULL` to indicate no formatting or it can be a @ref
- * format.h "Format" object. The typical worksheet format for a hyperlink is a
- * blue underline:
+ * parameter can be `NULL`, in which case the default Excel blue underlined
+ * hyperlink style will be used. If required a user defined @ref format.h
+ * "Format" object can be used:
+ * underline:
  *
  * @code
  *    lxw_format *url_format   = workbook_add_format(workbook);
  *
  *    format_set_underline (url_format, LXW_UNDERLINE_SINGLE);
- *    format_set_font_color(url_format, LXW_COLOR_BLUE);
+ *    format_set_font_color(url_format, LXW_COLOR_RED);
  *
  * @endcode
  *
@@ -1135,10 +2124,10 @@ lxw_error worksheet_write_url_opt(lxw_worksheet *worksheet,
  * and `mailto:` :
  *
  * @code
- *     worksheet_write_url(worksheet, 0, 0, "ftp://www.python.org/",     url_format);
- *     worksheet_write_url(worksheet, 1, 0, "http://www.python.org/",    url_format);
- *     worksheet_write_url(worksheet, 2, 0, "https://www.python.org/",   url_format);
- *     worksheet_write_url(worksheet, 3, 0, "mailto:jmcnamara@cpan.org", url_format);
+ *     worksheet_write_url(worksheet, 0, 0, "ftp://www.python.org/",     NULL);
+ *     worksheet_write_url(worksheet, 1, 0, "http://www.python.org/",    NULL);
+ *     worksheet_write_url(worksheet, 2, 0, "https://www.python.org/",   NULL);
+ *     worksheet_write_url(worksheet, 3, 0, "mailto:jmcnamara@cpan.org", NULL);
  *
  * @endcode
  *
@@ -1147,13 +2136,18 @@ lxw_error worksheet_write_url_opt(lxw_worksheet *worksheet,
  * link. However, it is possible to overwrite it with any other
  * `libxlsxwriter` type using the appropriate `worksheet_write_*()`
  * function. The most common case is to overwrite the displayed link text with
- * another string:
+ * another string. To do this we must also match the default URL format using
+ * `workbook_get_default_url_format()`:
  *
  * @code
- *  // Write a hyperlink but overwrite the displayed string.
- *  worksheet_write_url   (worksheet, 2, 0, "http://libxlsxwriter.github.io", url_format);
- *  worksheet_write_string(worksheet, 2, 0, "Read the documentation.",        url_format);
+ *     // Write a hyperlink with the default blue underline format.
+ *     worksheet_write_url(worksheet, 2, 0, "http://libxlsxwriter.github.io", NULL);
+ *
+ *     // Get the default url format.
+ *     lxw_format *url_format = workbook_get_default_url_format(workbook);
  *
+ *     // Overwrite the hyperlink with a user defined string and default format.
+ *     worksheet_write_string(worksheet, 2, 0, "Read the documentation.", url_format);
  * @endcode
  *
  * @image html hyperlinks_short2.png
@@ -1163,15 +2157,15 @@ lxw_error worksheet_write_url_opt(lxw_worksheet *worksheet,
  * worksheet references:
  *
  * @code
- *     worksheet_write_url(worksheet, 0, 0, "internal:Sheet2!A1",                url_format);
- *     worksheet_write_url(worksheet, 1, 0, "internal:Sheet2!B2",                url_format);
- *     worksheet_write_url(worksheet, 2, 0, "internal:Sheet2!A1:B2",             url_format);
- *     worksheet_write_url(worksheet, 3, 0, "internal:'Sales Data'!A1",          url_format);
- *     worksheet_write_url(worksheet, 4, 0, "external:c:\\temp\\foo.xlsx",       url_format);
- *     worksheet_write_url(worksheet, 5, 0, "external:c:\\foo.xlsx#Sheet2!A1",   url_format);
- *     worksheet_write_url(worksheet, 6, 0, "external:..\\foo.xlsx",             url_format);
- *     worksheet_write_url(worksheet, 7, 0, "external:..\\foo.xlsx#Sheet2!A1",   url_format);
- *     worksheet_write_url(worksheet, 8, 0, "external:\\\\NET\\share\\foo.xlsx", url_format);
+ *     worksheet_write_url(worksheet, 0, 0, "internal:Sheet2!A1",                NULL);
+ *     worksheet_write_url(worksheet, 1, 0, "internal:Sheet2!B2",                NULL);
+ *     worksheet_write_url(worksheet, 2, 0, "internal:Sheet2!A1:B2",             NULL);
+ *     worksheet_write_url(worksheet, 3, 0, "internal:'Sales Data'!A1",          NULL);
+ *     worksheet_write_url(worksheet, 4, 0, "external:c:\\temp\\foo.xlsx",       NULL);
+ *     worksheet_write_url(worksheet, 5, 0, "external:c:\\foo.xlsx#Sheet2!A1",   NULL);
+ *     worksheet_write_url(worksheet, 6, 0, "external:..\\foo.xlsx",             NULL);
+ *     worksheet_write_url(worksheet, 7, 0, "external:..\\foo.xlsx#Sheet2!A1",   NULL);
+ *     worksheet_write_url(worksheet, 8, 0, "external:\\\\NET\\share\\foo.xlsx", NULL);
  *
  * @endcode
  *
@@ -1183,7 +2177,7 @@ lxw_error worksheet_write_url_opt(lxw_worksheet *worksheet,
  * `#` character:
  *
  * @code
- *     worksheet_write_url(worksheet, 0, 0, "external:c:\\foo.xlsx#Sheet2!A1",   url_format);
+ *     worksheet_write_url(worksheet, 0, 0, "external:c:\\foo.xlsx#Sheet2!A1",   NULL);
  * @endcode
  *
  * You can also link to a named range in the target worksheet: For example say
@@ -1191,7 +2185,7 @@ lxw_error worksheet_write_url_opt(lxw_worksheet *worksheet,
  * you could link to it as follows:
  *
  * @code
- *     worksheet_write_url(worksheet, 0, 0, "external:c:\\temp\\foo.xlsx#my_name", url_format);
+ *     worksheet_write_url(worksheet, 0, 0, "external:c:\\temp\\foo.xlsx#my_name", NULL);
  *
  * @endcode
  *
@@ -1199,14 +2193,14 @@ lxw_error worksheet_write_url_opt(lxw_worksheet *worksheet,
  * characters are single quoted as follows:
  *
  * @code
- *     worksheet_write_url(worksheet, 0, 0, "internal:'Sales Data'!A1", url_format);
+ *     worksheet_write_url(worksheet, 0, 0, "internal:'Sales Data'!A1", NULL);
  * @endcode
  *
  * Links to network files are also supported. Network files normally begin
  * with two back slashes as follows `\\NETWORK\etc`. In order to represent
  * this in a C string literal the backslashes should be escaped:
  * @code
- *     worksheet_write_url(worksheet, 0, 0, "external:\\\\NET\\share\\foo.xlsx", url_format);
+ *     worksheet_write_url(worksheet, 0, 0, "external:\\\\NET\\share\\foo.xlsx", NULL);
  * @endcode
  *
  *
@@ -1214,8 +2208,8 @@ lxw_error worksheet_write_url_opt(lxw_worksheet *worksheet,
  * translated internally to backslashes:
  *
  * @code
- *     worksheet_write_url(worksheet, 0, 0, "external:c:/temp/foo.xlsx",     url_format);
- *     worksheet_write_url(worksheet, 1, 0, "external://NET/share/foo.xlsx", url_format);
+ *     worksheet_write_url(worksheet, 0, 0, "external:c:/temp/foo.xlsx",     NULL);
+ *     worksheet_write_url(worksheet, 1, 0, "external://NET/share/foo.xlsx", NULL);
  *
  * @endcode
  *
@@ -1223,20 +2217,33 @@ lxw_error worksheet_write_url_opt(lxw_worksheet *worksheet,
  * **Note:**
  *
  *    libxlsxwriter will escape the following characters in URLs as required
- *    by Excel: `\s " < > \ [ ]  ^ { }` unless the URL already contains `%%xx`
- *    style escapes. In which case it is assumed that the URL was escaped
- *    correctly by the user and will by passed directly to Excel.
+ *    by Excel: `\s " < > \ [ ]  ^ { }`. Existing URL `%%xx` style escapes in
+ *    the string are ignored to allow for user-escaped strings.
+ *
+ * **Note:**
  *
+ *    The maximum allowable URL length in recent versions of Excel is 2079
+ *    characters. In older versions of Excel (and libxlsxwriter <= 0.8.8) the
+ *    limit was 255 characters.
  */
 lxw_error worksheet_write_url(lxw_worksheet *worksheet,
                               lxw_row_t row,
                               lxw_col_t col, const char *url,
                               lxw_format *format);
 
+ /* Don't document for now since the string option can be achieved by a
+  * subsequent cell worksheet_write() as shown in the docs, and the
+  * tooltip option isn't very useful. */
+lxw_error worksheet_write_url_opt(lxw_worksheet *worksheet,
+                                  lxw_row_t row_num,
+                                  lxw_col_t col_num, const char *url,
+                                  lxw_format *format, const char *string,
+                                  const char *tooltip);
+
 /**
  * @brief Write a formatted boolean worksheet cell.
  *
- * @param worksheet pointer to a lxw_worksheet instance to be updated.
+ * @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 value     The boolean value to write to the cell.
@@ -1258,7 +2265,7 @@ lxw_error worksheet_write_boolean(lxw_worksheet *worksheet,
 /**
  * @brief Write a formatted blank worksheet cell.
  *
- * @param worksheet pointer to a lxw_worksheet instance to be updated.
+ * @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 format    A pointer to a Format instance or NULL.
@@ -1287,20 +2294,21 @@ lxw_error worksheet_write_blank(lxw_worksheet *worksheet,
                                 lxw_format *format);
 
 /**
- * @brief Write a formula to a worksheet cell with a user defined result.
+ * @brief Write a formula to a worksheet cell with a user defined numeric
+ *        result.
  *
- * @param worksheet pointer to a lxw_worksheet instance to be updated.
+ * @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 formula   Formula string to write to cell.
  * @param format    A pointer to a Format instance or NULL.
- * @param result    A user defined result for a formula.
+ * @param result    A user defined numeric result for the formula.
  *
  * @return A #lxw_error code.
  *
  * The `%worksheet_write_formula_num()` function writes a formula or Excel
  * function to the cell specified by `row` and `column` with a user defined
- * result:
+ * numeric result:
  *
  * @code
  *     // Required as a workaround only.
@@ -1335,10 +2343,55 @@ lxw_error worksheet_write_formula_num(lxw_worksheet *worksheet,
                                       const char *formula,
                                       lxw_format *format, double result);
 
+/**
+ * @brief Write a formula to a worksheet cell with a user defined string
+ *        result.
+ *
+ * @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 formula   Formula string to write to cell.
+ * @param format    A pointer to a Format instance or NULL.
+ * @param result    A user defined string result for the formula.
+ *
+ * @return A #lxw_error code.
+ *
+ * The `%worksheet_write_formula_str()` function writes a formula or Excel
+ * function to the cell specified by `row` and `column` with a user defined
+ * string result:
+ *
+ * @code
+ *     // The example formula is A & B -> AB.
+ *     worksheet_write_formula_str(worksheet, 0, 0, "=\"A\" & \"B\"", NULL, "AB");
+ * @endcode
+ *
+ * The `%worksheet_write_formula_str()` function is similar to the
+ * `%worksheet_write_formula_num()` function except it writes a string result
+ * instead or a numeric result. See `worksheet_write_formula_num()`  for more
+ * details on why/when these functions are required.
+ *
+ * One place where the `%worksheet_write_formula_str()` function may be required
+ * is to specify an empty result which will force a recalculation of the formula
+ * when loaded in LibreOffice.
+ *
+ * @code
+ *     worksheet_write_formula_str(worksheet, 0, 0, "=Sheet1!$A$1", NULL, "");
+ * @endcode
+ *
+ * See the FAQ @ref faq_formula_zero.
+ *
+ * See also @ref working_with_formulas.
+ */
+lxw_error worksheet_write_formula_str(lxw_worksheet *worksheet,
+                                      lxw_row_t row,
+                                      lxw_col_t col,
+                                      const char *formula,
+                                      lxw_format *format, const char *result);
+
 /**
  * @brief Write a "Rich" multi-format string to a worksheet cell.
  *
- * @param worksheet   pointer to a lxw_worksheet instance to be updated.
+ * @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.
@@ -1410,6 +2463,88 @@ lxw_error worksheet_write_rich_string(lxw_worksheet *worksheet,
                                       lxw_rich_string_tuple *rich_string[],
                                       lxw_format *format);
 
+/**
+ * @brief Write a comment 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 string      The comment string to be written.
+ *
+ * @return A #lxw_error code.
+ *
+ * The `%worksheet_write_comment()` function is used to add a comment to a
+ * cell. A comment is indicated in Excel by a small red triangle in the upper
+ * right-hand corner of the cell. Moving the cursor over the red triangle will
+ * reveal the comment.
+ *
+ * The following example shows how to add a comment to a cell:
+ *
+ * @code
+ *     worksheet_write_comment(worksheet, 0, 0, "This is a comment");
+ * @endcode
+ *
+ * @image html comments1.png
+ *
+ * See also @ref working_with_comments
+ *
+ */
+lxw_error worksheet_write_comment(lxw_worksheet *worksheet,
+                                  lxw_row_t row, lxw_col_t col,
+                                  const char *string);
+
+/**
+ * @brief Write a comment to a worksheet cell with options.
+ *
+ * @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 string      The comment string to be written.
+ * @param options     #lxw_comment_options to control position and format
+ *                    of the comment.
+ *
+ * @return A #lxw_error code.
+ *
+ * The `%worksheet_write_comment_opt()` function is used to add a comment to a
+ * cell with option that control the position, format and metadata of the
+ * comment. A comment is indicated in Excel by a small red triangle in the
+ * upper right-hand corner of the cell. Moving the cursor over the red
+ * triangle will reveal the comment.
+ *
+ * The following example shows how to add a comment to a cell with options:
+ *
+ * @code
+ *     lxw_comment_options options = {.visible = LXW_COMMENT_DISPLAY_VISIBLE};
+ *
+ *     worksheet_write_comment_opt(worksheet, CELL("C6"), "Hello.", &options);
+ * @endcode
+ *
+ * The following options are available in #lxw_comment_options:
+ *
+ * - `author`
+ * - `visible`
+ * - `width`
+ * - `height`
+ * - `x_scale`
+ * - `y_scale`
+ * - `color`
+ * - `font_name`
+ * - `font_size`
+ * - `start_row`
+ * - `start_col`
+ * - `x_offset`
+ * - `y_offset`
+ *
+ * @image html comments2.png
+ *
+ * Comment options are explained in detail in the @ref ww_comments_properties
+ * section of the docs.
+ */
+lxw_error worksheet_write_comment_opt(lxw_worksheet *worksheet,
+                                      lxw_row_t row, lxw_col_t col,
+                                      const char *string,
+                                      lxw_comment_options *options);
+
 /**
  * @brief Set the properties for a row of cells.
  *
@@ -1706,7 +2841,7 @@ lxw_error worksheet_set_column_opt(lxw_worksheet *worksheet,
  * default height changed due to a font that is larger than the default font
  * size or that has text wrapping turned on. To avoid this you should
  * explicitly set the height of the row using `worksheet_set_row()` if it
- * crosses an inserted image.
+ * crosses an inserted image. See @ref working_with_object_positioning.
  *
  * BMP images are only supported for backward compatibility. In general it is
  * best to avoid BMP images since they aren't compressed. If used, BMP images
@@ -1732,15 +2867,37 @@ lxw_error worksheet_insert_image(lxw_worksheet *worksheet,
  * #lxw_image_options struct to scale and position the image:
  *
  * @code
- *    lxw_image_options options = {.x_offset = 30,  .y_offset = 10,
+ *     lxw_image_options options = {.x_offset = 30,  .y_offset = 10,
  *                                 .x_scale  = 0.5, .y_scale  = 0.5};
  *
- *    worksheet_insert_image_opt(worksheet, 2, 1, "logo.png", &options);
+ *     worksheet_insert_image_opt(worksheet, 2, 1, "logo.png", &options);
  *
  * @endcode
  *
  * @image html insert_image_opt.png
  *
+ * The `url` field of lxw_image_options can be use to used to add a hyperlink
+ * to an image:
+ *
+ * @code
+ *     lxw_image_options options = {.url = "https://github.com/jmcnamara"};
+ *
+ *     worksheet_insert_image_opt(worksheet, 3, 1, "logo.png", &options);
+ * @endcode
+ *
+ * The supported URL formats are the same as those supported by the
+ * `worksheet_write_url()` method and the same rules/limits apply.
+ *
+ * The `tip` field of lxw_image_options can be use to used to add a mouseover
+ * tip to the hyperlink:
+ *
+ * @code
+ *      lxw_image_options options = {.url = "https://github.com/jmcnamara",
+                                     .tip = "GitHub"};
+ *
+ *     worksheet_insert_image_opt(worksheet, 4, 1, "logo.png", &options);
+ * @endcode
+ *
  * @note See the notes about row scaling and BMP images in
  * `worksheet_insert_image()` above.
  */
@@ -1871,10 +3028,10 @@ lxw_error worksheet_insert_chart(lxw_worksheet *worksheet,
  *
  * The `%worksheet_insert_chart_opt()` function is like
  * `worksheet_insert_chart()` function except that it takes an optional
- * #lxw_image_options struct to scale and position the image of the chart:
+ * #lxw_chart_options struct to scale and position the chart:
  *
  * @code
- *    lxw_image_options options = {.x_offset = 30,  .y_offset = 10,
+ *    lxw_chart_options options = {.x_offset = 30,  .y_offset = 10,
  *                                 .x_scale  = 0.5, .y_scale  = 0.75};
  *
  *    worksheet_insert_chart_opt(worksheet, 0, 2, chart, &options);
@@ -1883,14 +3040,11 @@ lxw_error worksheet_insert_chart(lxw_worksheet *worksheet,
  *
  * @image html chart_line_opt.png
  *
- * The #lxw_image_options struct is the same struct used in
- * `worksheet_insert_image_opt()` to position and scale images.
- *
  */
 lxw_error worksheet_insert_chart_opt(lxw_worksheet *worksheet,
                                      lxw_row_t row, lxw_col_t col,
                                      lxw_chart *chart,
-                                     lxw_image_options *user_options);
+                                     lxw_chart_options *user_options);
 
 /**
  * @brief Merge a range of cells.
@@ -1949,7 +3103,7 @@ lxw_error worksheet_insert_chart_opt(lxw_worksheet *worksheet,
  *    worksheet_write_number(worksheet, 1, 1, 123, format);
  * @endcode
  *
- * @note Merged ranges generally don’t work in libxlsxwriter when the Workbook
+ * @note Merged ranges generally don't work in libxlsxwriter when the Workbook
  * #lxw_workbook_options `constant_memory` mode is enabled.
  */
 lxw_error worksheet_merge_range(lxw_worksheet *worksheet, lxw_row_t first_row,
@@ -2033,7 +3187,7 @@ lxw_error worksheet_data_validation_cell(lxw_worksheet *worksheet,
                                          lxw_data_validation *validation);
 
 /**
- * @brief Add a data validation to a range cell.
+ * @brief Add a data validation to a range.
  *
  * @param worksheet  Pointer to a lxw_worksheet instance to be updated.
  * @param first_row  The first row of the range. (All zero indexed.)
@@ -2074,6 +3228,85 @@ lxw_error worksheet_data_validation_range(lxw_worksheet *worksheet,
                                           lxw_col_t last_col,
                                           lxw_data_validation *validation);
 
+/**
+ * @brief Add a conditional format 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 conditional_format  A #lxw_conditional_format object to control the
+ *                            conditional format.
+ *
+ * @return A #lxw_error code.
+ *
+ * The `%worksheet_conditional_format_cell()` function is used to set a
+ * conditional format for a cell in a worksheet:
+ *
+ * @code
+ *     conditional_format->type     = LXW_CONDITIONAL_TYPE_CELL;
+ *     conditional_format->criteria = LXW_CONDITIONAL_CRITERIA_GREATER_THAN_OR_EQUAL_TO;
+ *     conditional_format->value    = 50;
+ *     conditional_format->format   = format1;
+ *     worksheet_conditional_format_cell(worksheet, CELL("A1"), conditional_format);
+ * @endcode
+ *
+ * The conditional format parameters is specified in #lxw_conditional_format.
+ *
+ * See @ref working_with_conditional_formatting for full details.
+ */
+lxw_error worksheet_conditional_format_cell(lxw_worksheet *worksheet,
+                                            lxw_row_t row,
+                                            lxw_col_t col,
+                                            lxw_conditional_format
+                                            *conditional_format);
+
+/**
+ * @brief Add a conditional format to a worksheet range.
+ *
+ * @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 conditional_format  A #lxw_conditional_format object to control the
+ *                            conditional format.
+ *
+ * @return A #lxw_error code.
+ *
+ * The `%worksheet_conditional_format_cell()` function is used to set a
+ * conditional format for a range of cells in a worksheet:
+ *
+ * @code
+ *     conditional_format->type     = LXW_CONDITIONAL_TYPE_CELL;
+ *     conditional_format->criteria = LXW_CONDITIONAL_CRITERIA_GREATER_THAN_OR_EQUAL_TO;
+ *     conditional_format->value    = 50;
+ *     conditional_format->format   = format1;
+ *     worksheet_conditional_format_range(worksheet1, RANGE("B3:K12"), conditional_format);
+ *
+ *     conditional_format->type     = LXW_CONDITIONAL_TYPE_CELL;
+ *     conditional_format->criteria = LXW_CONDITIONAL_CRITERIA_LESS_THAN;
+ *     conditional_format->value    = 50;
+ *     conditional_format->format   = format2;
+ *     worksheet_conditional_format_range(worksheet1, RANGE("B3:K12"), conditional_format);
+ * @endcode
+ *
+ * Output:
+ *
+ * @image html conditional_format1.png
+ *
+ *
+ * The conditional format parameters is specified in #lxw_conditional_format.
+ *
+ * See @ref working_with_conditional_formatting for full details.
+ */
+lxw_error worksheet_conditional_format_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_conditional_format
+                                             *conditional_format);
+
  /**
   * @brief Make a worksheet the active, i.e., visible worksheet.
   *
@@ -2251,7 +3484,7 @@ void worksheet_split_panes_opt(lxw_worksheet *worksheet,
 /**
  * @brief Set the selected cell or cells in a worksheet:
  *
- * @param worksheet   Pointer to a lxw_worksheet instance to be updated.
+ * @param worksheet   A 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.
@@ -2446,7 +3679,11 @@ void worksheet_set_margins(lxw_worksheet *worksheet, double left,
  *   | `&S`            |               | Strikethrough         |
  *   | `&X`            |               | Superscript           |
  *   | `&Y`            |               | Subscript             |
+ *   | `&[Picture]`    | Images        | Image placeholder     |
+ *   | `&G`            |               | Same as `&[Picture]`  |
+ *   | `&&`            | Miscellaneous | Literal ampersand &   |
  *
+ * Note: inserting images requires the `worksheet_set_header_opt()` function.
  *
  * Text in headers and footers can be justified (aligned) to the left, center
  * and right by prefixing the text with the control characters `&L`, `&C` and
@@ -2570,17 +3807,14 @@ void worksheet_set_margins(lxw_worksheet *worksheet, double left,
  * @code
  *
  *    $ unzip myfile.xlsm -d myfile
- *    $ xmllint --format `find myfile -name "*.xml" | xargs` | egrep "Header|Footer"
+ *    $ xmllint --format `find myfile -name "*.xml" | xargs` | egrep "Header|Footer" | sed 's/&amp;/\&/g'
  *
  *      <headerFooter scaleWithDoc="0">
- *        <oddHeader>&amp;L&amp;P</oddHeader>
+ *        <oddHeader>&L&P</oddHeader>
  *      </headerFooter>
  *
  * @endcode
  *
- * Note that in this case you need to unescape the Html. In the above example
- * the header string would be `&L&P`.
- *
  * To include a single literal ampersand `&` in a header or footer you should
  * use a double ampersand `&&`:
  *
@@ -2588,8 +3822,8 @@ void worksheet_set_margins(lxw_worksheet *worksheet, double left,
  *     worksheet_set_header(worksheet, "&CCuriouser && Curiouser - Attorneys at Law");
  * @endcode
  *
- * Note, the header or footer string must be less than 255 characters. Strings
- * longer than this will not be written.
+ * Note, Excel requires that the header or footer string must be less than 255
+ * characters. Strings longer than this will not be written.
  *
  */
 lxw_error worksheet_set_header(lxw_worksheet *worksheet, const char *string);
@@ -2616,19 +3850,43 @@ lxw_error worksheet_set_footer(lxw_worksheet *worksheet, const char *string);
  *
  * @return A #lxw_error code.
  *
- * The syntax of this function is the same as worksheet_set_header() with an
+ * The syntax of this function is the same as `worksheet_set_header()` with an
  * additional parameter to specify options for the header.
  *
- * Currently, the only available option is the header margin:
+ * The #lxw_header_footer_options options are:
+ *
+ * - `margin`: Header or footer margin in inches. The value must by larger
+ *   than 0.0. The Excel default is 0.3.
+ *
+ * - `image_left`: The left header image filename, with path if required. This
+ *   should have a corresponding `&G/&[Picture]` placeholder in the `&L`
+ *   section of the header/footer string.
+ *
+ * - `image_center`: The center header image filename, with path if
+ *   required. This should have a corresponding `&G/&[Picture]` placeholder in
+ *   the `&C` section of the header/footer string.
+ *
+ * - `image_right`: The right header image filename, with path if
+ *   required. This should have a corresponding `&G/&[Picture]` placeholder in
+ *   the `&R` section of the header/footer string.
  *
  * @code
+ *     lxw_header_footer_options header_options = { .margin = 0.2 };
  *
- *    lxw_header_footer_options header_options = { 0.2 };
+ *     worksheet_set_header_opt(worksheet, "Some text", &header_options);
+ * @endcode
+ *
+ * Images can be inserted in the header by specifying the `&[Picture]`
+ * placeholder and a filename/path to the image:
  *
- *    worksheet_set_header_opt(worksheet, "Some text", &header_options);
+ * @code
+ *     lxw_header_footer_options header_options = {.image_left = "logo.png"};
  *
+ *    worksheet_set_header_opt(worksheet, "&L&[Picture]", &header_options);
  * @endcode
  *
+ * @image html headers_footers.png
+ *
  */
 lxw_error worksheet_set_header_opt(lxw_worksheet *worksheet,
                                    const char *string,
@@ -2643,7 +3901,7 @@ lxw_error worksheet_set_header_opt(lxw_worksheet *worksheet,
  *
  * @return A #lxw_error code.
  *
- * The syntax of this function is the same as worksheet_set_header_opt().
+ * The syntax of this function is the same as `worksheet_set_header_opt()`.
  *
  */
 lxw_error worksheet_set_footer_opt(lxw_worksheet *worksheet,
@@ -3241,6 +4499,8 @@ void worksheet_set_default_row(lxw_worksheet *worksheet, double height,
  * @param worksheet Pointer to a lxw_worksheet instance.
  * @param name      Name of the worksheet used by VBA.
  *
+ * @return A #lxw_error.
+ *
  * 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 by a name other
@@ -3256,10 +4516,147 @@ void worksheet_set_default_row(lxw_worksheet *worksheet, double height,
  * extracted from a foreign language version of Excel.
  *
  * See also @ref working_with_macros
+ */
+lxw_error worksheet_set_vba_name(lxw_worksheet *worksheet, const char *name);
+
+/**
+ * @brief Make all comments in the worksheet visible.
+ *
+ * @param worksheet Pointer to a lxw_worksheet instance.
+ *
+ * This `%worksheet_show_comments()` function is used to make all cell
+ * comments visible when a worksheet is opened:
+ *
+ * @code
+ *     worksheet_show_comments(worksheet);
+ * @endcode
+ *
+ * Individual comments can be made visible or hidden using the `visible`
+ * option of the #lxw_comment_options struct and the `worksheet_write_comment_opt()`
+ * function (see above and @ref ww_comments_visible).
+ */
+void worksheet_show_comments(lxw_worksheet *worksheet);
+
+/**
+ * @brief Set the default author of the cell comments.
+ *
+ * @param worksheet Pointer to a lxw_worksheet instance.
+ * @param author    The name of the comment author.
+ *
+ * This `%worksheet_set_comments_author()` function is used to set the
+ * default author of all cell comments:
+ *
+ * @code
+ *     worksheet_set_comments_author(worksheet, "Jane Gloriana Villanueva")
+ * @endcode
+ *
+ * Individual authors can be set using the `author` option of the
+ * #lxw_comment_options struct and the `worksheet_write_comment_opt()`
+ * function (see above and @ref ww_comments_author).
+ */
+void worksheet_set_comments_author(lxw_worksheet *worksheet,
+                                   const char *author);
+
+/**
+ * @brief Ignore various Excel errors/warnings in a worksheet for user
+ *        defined ranges.
+ *
+ * @param worksheet Pointer to a lxw_worksheet instance.
+ * @param type      The type of error/warning to ignore. See #lxw_ignore_errors.
+ * @param range     The range(s) for which the error/warning should be ignored.
  *
  * @return A #lxw_error.
+ *
+ *
+ * The `%worksheet_ignore_errors()` function can be used to ignore various
+ * worksheet cell errors/warnings. For example the following code writes a string
+ * that looks like a number:
+ *
+ * @code
+ *     worksheet_write_string(worksheet, CELL("D2"), "123", NULL);
+ * @endcode
+ *
+ * This causes Excel to display a small green triangle in the top left hand
+ * corner of the cell to indicate an error/warning:
+ *
+ * @image html ignore_errors1.png
+ *
+ * Sometimes these warnings are useful indicators that there is an issue in
+ * the spreadsheet but sometimes it is preferable to turn them off. Warnings
+ * can be turned off at the Excel level for all workbooks and worksheets by
+ * using the using "Excel options -> Formulas -> Error checking
+ * rules". Alternatively you can turn them off for individual cells in a
+ * worksheet, or ranges of cells, using the `%worksheet_ignore_errors()`
+ * function with different #lxw_ignore_errors options and ranges like this:
+ *
+ * @code
+ *     worksheet_ignore_errors(worksheet, LXW_IGNORE_NUMBER_STORED_AS_TEXT, "C3");
+ *     worksheet_ignore_errors(worksheet, LXW_IGNORE_EVAL_ERROR,            "C6");
+ * @endcode
+ *
+ * The range can be a single cell, a range of cells, or multiple cells and ranges
+ * separated by spaces:
+ *
+ * @code
+ *     // Single cell.
+ *     worksheet_ignore_errors(worksheet, LXW_IGNORE_NUMBER_STORED_AS_TEXT, "C6");
+ *
+ *     // Or a single range:
+ *     worksheet_ignore_errors(worksheet, LXW_IGNORE_NUMBER_STORED_AS_TEXT, "C6:G8");
+ *
+ *     // Or multiple cells and ranges:
+ *     worksheet_ignore_errors(worksheet, LXW_IGNORE_NUMBER_STORED_AS_TEXT, "C6 E6 G1:G20 J2:J6");
+ * @endcode
+ *
+ * @note Calling `%worksheet_ignore_errors()` more than once for the same
+ * #lxw_ignore_errors type will overwrite the previous range.
+ *
+ * You can turn off warnings for an entire column by specifying the range from
+ * the first cell in the column to the last cell in the column:
+ *
+ * @code
+ *     worksheet_ignore_errors(worksheet, LXW_IGNORE_NUMBER_STORED_AS_TEXT, "A1:A1048576");
+ * @endcode
+ *
+ * Or for the entire worksheet by specifying the range from the first cell in
+ * the worksheet to the last cell in the worksheet:
+ *
+ * @code
+ *     worksheet_ignore_errors(worksheet, LXW_IGNORE_NUMBER_STORED_AS_TEXT, "A1:XFD1048576");
+ * @endcode
+ *
+ * The worksheet errors/warnings that can be ignored are:
+ *
+ * - #LXW_IGNORE_NUMBER_STORED_AS_TEXT: Turn off errors/warnings for numbers
+ *    stores as text.
+ *
+ * - #LXW_IGNORE_EVAL_ERROR: Turn off errors/warnings for formula errors (such
+ *    as divide by zero).
+ *
+ * - #LXW_IGNORE_FORMULA_DIFFERS: Turn off errors/warnings for formulas that
+ *    differ from surrounding formulas.
+ *
+ * - #LXW_IGNORE_FORMULA_RANGE: Turn off errors/warnings for formulas that
+ *    omit cells in a range.
+ *
+ * - #LXW_IGNORE_FORMULA_UNLOCKED: Turn off errors/warnings for unlocked cells
+ *    that contain formulas.
+ *
+ * - #LXW_IGNORE_EMPTY_CELL_REFERENCE: Turn off errors/warnings for formulas
+ *    that refer to empty cells.
+ *
+ * - #LXW_IGNORE_LIST_DATA_VALIDATION: Turn off errors/warnings for cells in a
+ *    table that do not comply with applicable data validation rules.
+ *
+ * - #LXW_IGNORE_CALCULATED_COLUMN: Turn off errors/warnings for cell formulas
+ *    that differ from the column formula.
+ *
+ * - #LXW_IGNORE_TWO_DIGIT_TEXT_YEAR: Turn off errors/warnings for formulas
+ *    that contain a two digit text representation of a year.
+ *
  */
-lxw_error worksheet_set_vba_name(lxw_worksheet *worksheet, const char *name);
+lxw_error worksheet_ignore_errors(lxw_worksheet *worksheet, uint8_t type,
+                                  const char *range);
 
 lxw_worksheet *lxw_worksheet_new(lxw_worksheet_init_data *init_data);
 void lxw_worksheet_free(lxw_worksheet *worksheet);
@@ -3268,24 +4665,37 @@ void lxw_worksheet_write_single_row(lxw_worksheet *worksheet);
 
 void lxw_worksheet_prepare_image(lxw_worksheet *worksheet,
                                  uint32_t image_ref_id, uint32_t drawing_id,
-                                 lxw_image_options *image_data);
+                                 lxw_object_properties *object_props);
+
+void lxw_worksheet_prepare_header_image(lxw_worksheet *worksheet,
+                                        uint32_t image_ref_id,
+                                        lxw_object_properties *object_props);
 
 void lxw_worksheet_prepare_chart(lxw_worksheet *worksheet,
                                  uint32_t chart_ref_id, uint32_t drawing_id,
-                                 lxw_image_options *image_data,
+                                 lxw_object_properties *object_props,
                                  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);
+uint32_t lxw_worksheet_prepare_vml_objects(lxw_worksheet *worksheet,
+                                           uint32_t vml_data_id,
+                                           uint32_t vml_shape_id,
+                                           uint32_t vml_drawing_id,
+                                           uint32_t comment_id);
+
+void lxw_worksheet_prepare_header_vml_objects(lxw_worksheet *self,
+                                              uint32_t vml_header_id,
+                                              uint32_t vml_drawing_id);
 
+lxw_row *lxw_worksheet_find_row(lxw_worksheet *worksheet, lxw_row_t row_num);
+lxw_cell *lxw_worksheet_find_cell_in_row(lxw_row *row, lxw_col_t col_num);
 /*
- * External functions to call intern XML methods shared with chartsheet.
+ * External functions to call intern XML functions 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);
+                                          lxw_protection_obj *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);
@@ -3320,7 +4730,7 @@ 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,
-                                              lxw_protection *protect);
+                                              lxw_protection_obj *protect);
 STATIC void _worksheet_write_data_validations(lxw_worksheet *self);
 #endif /* TESTING */