Added worksheet_print_row_col_headers() function.

Changes.txt

@@ -10,6 +10,9 @@
 - Added `worksheet_center_horizontally()` and `worksheet_center_vertically()`
   functions to center worksheet on the printed page.
 
+- Added `worksheet_print_row_col_headers()` function to enable printing of row
+  and column headers.
+
 
 ## 0.0.8 March 8 2015
 

include/xlsxwriter/worksheet.h

@@ -801,7 +801,7 @@ uint8_t worksheet_merge_range(lxw_worksheet *worksheet, lxw_row_t first_row,
   *
   * @param worksheet Pointer to a lxw_worksheet instance to be updated.
   *
-  * The `activate()` method is used to specify which worksheet is initially
+  * The `activate()` function is used to specify which worksheet is initially
   * visible in a multi-sheet workbook:
   *
   * @code
@@ -814,7 +814,7 @@ uint8_t worksheet_merge_range(lxw_worksheet *worksheet, lxw_row_t first_row,
   *
   * @image html worksheet_activate.png
   *
-  * More than one worksheet can be selected via the `select()` method, see
+  * More than one worksheet can be selected via the `select()` function, see
   * below, however only one worksheet can be active.
   *
   * The default active worksheet is the first worksheet.
@@ -827,7 +827,7 @@ void worksheet_activate(lxw_worksheet *worksheet);
   *
   * @param worksheet Pointer to a lxw_worksheet instance to be updated.
   *
-  * The `select()` method is used to indicate that a worksheet is selected in
+  * The `select()` function is used to indicate that a worksheet is selected in
   * a multi-sheet workbook:
   *
   * @code
@@ -840,7 +840,7 @@ void worksheet_activate(lxw_worksheet *worksheet);
   * A selected worksheet has its tab highlighted. Selecting worksheets is a
   * way of grouping them together so that, for example, several worksheets
   * could be printed in one go. A worksheet that has been activated via the
-  * `activate()` method will also appear as selected.
+  * `activate()` function will also appear as selected.
   *
   */
 void worksheet_select(lxw_worksheet *worksheet);
@@ -1292,6 +1292,25 @@ void worksheet_center_horizontally(lxw_worksheet *worksheet);
  */
 void worksheet_center_vertically(lxw_worksheet *worksheet);
 
+/**
+ * @brief Set the option to print the row and column headers on the printed
+ *        page.
+ *
+ * @param worksheet Pointer to a lxw_worksheet instance to be updated.
+ *
+ * When printing a worksheet from Excel the row and column headers (the row
+ * numbers on the left and the column letters at the top) aren't printed by
+ * default.
+ *
+ * This function sets the printer option to print these headers:
+ *
+ * @code
+ *    worksheet_print_row_col_headers(worksheet);
+ * @endcode
+ *
+ */
+void worksheet_print_row_col_headers(lxw_worksheet *worksheet);
+
 lxw_worksheet *_new_worksheet(lxw_worksheet_init_data *init_data);
 void _free_worksheet(lxw_worksheet *worksheet);
 void _worksheet_assemble_xml_file(lxw_worksheet *worksheet);

src/worksheet.c

@@ -2026,3 +2026,13 @@ worksheet_center_vertically(lxw_worksheet *self)
     self->print_options_changed = 1;
     self->vcenter = 1;
 }
+
+/*
+ * Set the option to print the row and column headers on the printed page.
+ */
+void
+worksheet_print_row_col_headers(lxw_worksheet *self)
+{
+    self->print_headers = 1;
+    self->print_options_changed = 1;
+}

test/functional/src/test_gridlines01.c

@@ -1,7 +1,7 @@
 /*****************************************************************************
  * Test cases for libxlsxwriter.
  *
- * Test to comparse output againsst Excel files.
+ * Test to compare output against Excel files.
  *
  * Copyright 2014-2015, John McNamara, jmcnamara@cpan.org
  *

test/functional/src/test_print_options01.c

@@ -1,7 +1,7 @@
 /*****************************************************************************
  * Test cases for libxlsxwriter.
  *
- * Test to comparse output againsst Excel files.
+ * Test to compare output against Excel files.
  *
  * Copyright 2014-2015, John McNamara, jmcnamara@cpan.org
  *

test/functional/src/test_print_options02.c

@@ -1,7 +1,7 @@
 /*****************************************************************************
  * Test cases for libxlsxwriter.
  *
- * Test to comparse output againsst Excel files.
+ * Test to compare output against Excel files.
  *
  * Copyright 2014-2015, John McNamara, jmcnamara@cpan.org
  *

test/functional/src/test_print_options03.c

@@ -1,7 +1,7 @@
 /*****************************************************************************
  * Test cases for libxlsxwriter.
  *
- * Test to comparse output againsst Excel files.
+ * Test to compare output against Excel files.
  *
  * Copyright 2014-2015, John McNamara, jmcnamara@cpan.org
  *

test/functional/src/test_print_options04.c

@@ -0,0 +1,25 @@
+/*****************************************************************************
+ * Test cases for libxlsxwriter.
+ *
+ * Test to compare output against Excel files.
+ *
+ * Copyright 2014-2015, John McNamara, jmcnamara@cpan.org
+ *
+ */
+
+#include "xlsxwriter.h"
+
+int main() {
+
+    lxw_workbook  *workbook  = new_workbook("test_print_options04.xlsx");
+    lxw_worksheet *worksheet = workbook_add_worksheet(workbook, NULL);
+
+    worksheet_set_paper(worksheet, 9);
+    worksheet->vertical_dpi = 200;
+
+    worksheet_print_row_col_headers(worksheet);
+
+    worksheet_write_string(worksheet, CELL("A1"), "Foo" , NULL);
+
+    return workbook_close(workbook);
+}

test/functional/src/test_print_options05.c

@@ -0,0 +1,28 @@
+/*****************************************************************************
+ * Test cases for libxlsxwriter.
+ *
+ * Test to compare output against Excel files.
+ *
+ * Copyright 2014-2015, John McNamara, jmcnamara@cpan.org
+ *
+ */
+
+#include "xlsxwriter.h"
+
+int main() {
+
+    lxw_workbook  *workbook  = new_workbook("test_print_options05.xlsx");
+    lxw_worksheet *worksheet = workbook_add_worksheet(workbook, NULL);
+
+    worksheet_set_paper(worksheet, 9);
+    worksheet->vertical_dpi = 200;
+
+    worksheet_gridlines(worksheet, LXW_SHOW_PRINT_GRIDLINES);
+    worksheet_print_row_col_headers(worksheet);
+    worksheet_center_horizontally(worksheet);
+    worksheet_center_vertically(worksheet);
+
+    worksheet_write_string(worksheet, CELL("A1"), "Foo" , NULL);
+
+    return workbook_close(workbook);
+}

test/functional/test_print_options.py

@@ -25,4 +25,12 @@ class TestCompareXLSXFiles(base_test_class.XLSXBaseTest):
         self.ignore_elements = {'xl/worksheets/sheet1.xml': ['<pageMargins']}
         self.run_exe_test('test_print_options03')
 
+    def test_print_options04(self):
+        self.ignore_elements = {'xl/worksheets/sheet1.xml': ['<pageMargins']}
+        self.run_exe_test('test_print_options04')
+
+    def test_print_options05(self):
+        self.ignore_elements = {'xl/worksheets/sheet1.xml': ['<pageMargins']}
+        self.run_exe_test('test_print_options05')
+