writeexcel 0.5.0 → 0.6.0

data/examples/formula_result.rb

@@ -1,30 +1,30 @@
-#!/usr/bin/ruby -w
-# -*- coding: utf-8 -*-
-
-#######################################################################
-#
-# Example of how to write Spreadsheet::WriteExcel formulas with a user
-# specified result.
-#
-# This is generally only required when writing a spreadsheet for an
-# application other than Excel where the formula isn't evaluated.
-#
-# reverse('©'), August 2005, John McNamara, jmcnamara@cpan.org
-#
-# original written in Perl by John McNamara
-# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
-#
-
-require 'writeexcel'
-
-workbook  = WriteExcel.new('formula_result.xls')
-worksheet = workbook.add_worksheet()
-format    = workbook.add_format(:color => 'blue')
-
-worksheet.write('A1', '=1+2')
-worksheet.write('A2', '=1+2',                     format, 4)
-worksheet.write('A3', '="ABC"',                   nil,    'DEF')
-worksheet.write('A4', '=IF(A1 > 1, TRUE, FALSE)', nil,    'TRUE')
-worksheet.write('A5', '=1/0',                     nil,    '#DIV/0!')
-
-workbook.close
+#!/usr/bin/ruby -w
+# -*- coding: utf-8 -*-
+
+#######################################################################
+#
+# Example of how to write Spreadsheet::WriteExcel formulas with a user
+# specified result.
+#
+# This is generally only required when writing a spreadsheet for an
+# application other than Excel where the formula isn't evaluated.
+#
+# reverse('©'), August 2005, John McNamara, jmcnamara@cpan.org
+#
+# original written in Perl by John McNamara
+# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'writeexcel'
+
+workbook  = WriteExcel.new('formula_result.xls')
+worksheet = workbook.add_worksheet()
+format    = workbook.add_format(:color => 'blue')
+
+worksheet.write('A1', '=1+2')
+worksheet.write('A2', '=1+2',                     format, 4)
+worksheet.write('A3', '="ABC"',                   nil,    'DEF')
+worksheet.write('A4', '=IF(A1 > 1, TRUE, FALSE)', nil,    'TRUE')
+worksheet.write('A5', '=1/0',                     nil,    '#DIV/0!')
+
+workbook.close

data/examples/header.rb

@@ -1,137 +1,137 @@
-#!/usr/bin/ruby -w
-# -*- coding: utf-8 -*-
-
-######################################################################
-#
-# This program shows several examples of how to set up headers and
-# footers with WriteExcel.
-#
-# The control characters used in the header/footer strings are:
-#
-#   Control             Category            Description
-#   =======             ========            ===========
-#   &L                  Justification       Left
-#   &C                                      Center
-#   &R                                      Right
-#
-#   &P                  Information         Page number
-#   &N                                      Total number of pages
-#   &D                                      Date
-#   &T                                      Time
-#   &F                                      File name
-#   &A                                      Worksheet name
-#
-#   &fontsize           Font                Font size
-#   &"font,style"                           Font name and style
-#   &U                                      Single underline
-#   &E                                      Double underline
-#   &S                                      Strikethrough
-#   &X                                      Superscript
-#   &Y                                      Subscript
-#
-#   &&                  Miscellaneous       Literal ampersand &
-#
-#
-# reverse('©'), March 2002, John McNamara, jmcnamara@cpan.org
-#
-# original written in Perl by John McNamara
-# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
-#
-
-require 'rubygems'
-require 'writeexcel'
-
-workbook  = WriteExcel.new("headers.xls")
-preview   = "Select Print Preview to see the header and footer"
-
-
-######################################################################
-#
-# A simple example to start
-#
-worksheet1  = workbook.add_worksheet('Simple')
-
-header1     = '&CHere is some centred text.'
-
-footer1     = '&LHere is some left aligned text.'
-
-
-worksheet1.set_header(header1)
-worksheet1.set_footer(footer1)
-
-worksheet1.set_column('A:A', 50)
-worksheet1.write('A1', preview)
-
-
-######################################################################
-#
-# This is an example of some of the header/footer variables.
-#
-worksheet2  = workbook.add_worksheet('Variables')
-
-header2     = '&LPage &P of &N'+
-                  '&CFilename: &F' +
-                  '&RSheetname: &A'
-
-footer2     = '&LCurrent date: &D'+
-                  '&RCurrent time: &T'
-
-worksheet2.set_header(header2)
-worksheet2.set_footer(footer2)
-
-
-worksheet2.set_column('A:A', 50)
-worksheet2.write('A1', preview)
-worksheet2.write('A21', "Next sheet")
-worksheet2.set_h_pagebreaks(20)
-
-
-######################################################################
-#
-# This example shows how to use more than one font
-#
-worksheet3 = workbook.add_worksheet('Mixed fonts')
-
-header3    = '&C' +
-                 '&"Courier New,Bold"Hello ' +
-                 '&"Arial,Italic"World'
-
-footer3    = '&C' +
-                 '&"Symbol"e' +
-                 '&"Arial" = mc&X2'
-
-worksheet3.set_header(header3)
-worksheet3.set_footer(footer3)
-
-worksheet3.set_column('A:A', 50)
-worksheet3.write('A1', preview)
-
-
-######################################################################
-#
-# Example of line wrapping
-#
-worksheet4 = workbook.add_worksheet('Word wrap')
-
-header4    = "&CHeading 1\nHeading 2\nHeading 3"
-
-worksheet4.set_header(header4)
-
-worksheet4.set_column('A:A', 50)
-worksheet4.write('A1', preview)
-
-
-######################################################################
-#
-# Example of inserting a literal ampersand &
-#
-worksheet5 = workbook.add_worksheet('Ampersand')
-
-header5    = "&CCuriouser && Curiouser - Attorneys at Law"
-
-worksheet5.set_header(header5)
-
-worksheet5.set_column('A:A', 50)
-worksheet5.write('A1', preview)
-
-workbook.close
+#!/usr/bin/ruby -w
+# -*- coding: utf-8 -*-
+
+######################################################################
+#
+# This program shows several examples of how to set up headers and
+# footers with WriteExcel.
+#
+# The control characters used in the header/footer strings are:
+#
+#   Control             Category            Description
+#   =======             ========            ===========
+#   &L                  Justification       Left
+#   &C                                      Center
+#   &R                                      Right
+#
+#   &P                  Information         Page number
+#   &N                                      Total number of pages
+#   &D                                      Date
+#   &T                                      Time
+#   &F                                      File name
+#   &A                                      Worksheet name
+#
+#   &fontsize           Font                Font size
+#   &"font,style"                           Font name and style
+#   &U                                      Single underline
+#   &E                                      Double underline
+#   &S                                      Strikethrough
+#   &X                                      Superscript
+#   &Y                                      Subscript
+#
+#   &&                  Miscellaneous       Literal ampersand &
+#
+#
+# reverse('©'), March 2002, John McNamara, jmcnamara@cpan.org
+#
+# original written in Perl by John McNamara
+# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'rubygems'
+require 'writeexcel'
+
+workbook  = WriteExcel.new("headers.xls")
+preview   = "Select Print Preview to see the header and footer"
+
+
+######################################################################
+#
+# A simple example to start
+#
+worksheet1  = workbook.add_worksheet('Simple')
+
+header1     = '&CHere is some centred text.'
+
+footer1     = '&LHere is some left aligned text.'
+
+
+worksheet1.set_header(header1)
+worksheet1.set_footer(footer1)
+
+worksheet1.set_column('A:A', 50)
+worksheet1.write('A1', preview)
+
+
+######################################################################
+#
+# This is an example of some of the header/footer variables.
+#
+worksheet2  = workbook.add_worksheet('Variables')
+
+header2     = '&LPage &P of &N'+
+                  '&CFilename: &F' +
+                  '&RSheetname: &A'
+
+footer2     = '&LCurrent date: &D'+
+                  '&RCurrent time: &T'
+
+worksheet2.set_header(header2)
+worksheet2.set_footer(footer2)
+
+
+worksheet2.set_column('A:A', 50)
+worksheet2.write('A1', preview)
+worksheet2.write('A21', "Next sheet")
+worksheet2.set_h_pagebreaks(20)
+
+
+######################################################################
+#
+# This example shows how to use more than one font
+#
+worksheet3 = workbook.add_worksheet('Mixed fonts')
+
+header3    = '&C' +
+                 '&"Courier New,Bold"Hello ' +
+                 '&"Arial,Italic"World'
+
+footer3    = '&C' +
+                 '&"Symbol"e' +
+                 '&"Arial" = mc&X2'
+
+worksheet3.set_header(header3)
+worksheet3.set_footer(footer3)
+
+worksheet3.set_column('A:A', 50)
+worksheet3.write('A1', preview)
+
+
+######################################################################
+#
+# Example of line wrapping
+#
+worksheet4 = workbook.add_worksheet('Word wrap')
+
+header4    = "&CHeading 1\nHeading 2\nHeading 3"
+
+worksheet4.set_header(header4)
+
+worksheet4.set_column('A:A', 50)
+worksheet4.write('A1', preview)
+
+
+######################################################################
+#
+# Example of inserting a literal ampersand &
+#
+worksheet5 = workbook.add_worksheet('Ampersand')
+
+header5    = "&CCuriouser && Curiouser - Attorneys at Law"
+
+worksheet5.set_header(header5)
+
+worksheet5.set_column('A:A', 50)
+worksheet5.write('A1', preview)
+
+workbook.close

data/examples/hide_sheet.rb

@@ -1,29 +1,29 @@
-#!/usr/bin/ruby -w
-# -*- coding: utf-8 -*-
-
-#######################################################################
-#
-# Example of how to hide a worksheet with WriteExcel.
-#
-# reverse('©'), April 2005, John McNamara, jmcnamara@cpan.org
-#
-# original written in Perl by John McNamara
-# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
-#
-require 'rubygems'
-require 'writeexcel'
-
-
-workbook   = WriteExcel.new('hidden.xls')
-worksheet1 = workbook.add_worksheet
-worksheet2 = workbook.add_worksheet
-worksheet3 = workbook.add_worksheet
-
-# Sheet2 won't be visible until it is unhidden in Excel.
-worksheet2.hide
-
-worksheet1.write(0, 0, 'Sheet2 is hidden')
-worksheet2.write(0, 0, 'How did you find me?')
-worksheet3.write(0, 0, 'Sheet2 is hidden')
-
-workbook.close
+#!/usr/bin/ruby -w
+# -*- coding: utf-8 -*-
+
+#######################################################################
+#
+# Example of how to hide a worksheet with WriteExcel.
+#
+# reverse('©'), April 2005, John McNamara, jmcnamara@cpan.org
+#
+# original written in Perl by John McNamara
+# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
+#
+require 'rubygems'
+require 'writeexcel'
+
+
+workbook   = WriteExcel.new('hidden.xls')
+worksheet1 = workbook.add_worksheet
+worksheet2 = workbook.add_worksheet
+worksheet3 = workbook.add_worksheet
+
+# Sheet2 won't be visible until it is unhidden in Excel.
+worksheet2.hide
+
+worksheet1.write(0, 0, 'Sheet2 is hidden')
+worksheet2.write(0, 0, 'How did you find me?')
+worksheet3.write(0, 0, 'Sheet2 is hidden')
+
+workbook.close

data/examples/hyperlink.rb

@@ -1,43 +1,43 @@
-#!/usr/bin/ruby -w
-# -*- coding: utf-8 -*-
-###############################################################################
-#
-# Example of how to use the WriteExcel module to write hyperlinks
-#
-# See also hyperlink2.pl for worksheet URL examples.
-#
-# reverse('©'), March 2001, John McNamara, jmcnamara@cpan.org
-#
-# original written in Perl by John McNamara
-# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
-#
-require 'rubygems'
-require 'writeexcel'
-
-# Create a new workbook and add a worksheet
-workbook  = WriteExcel.new("hyperlink.xls")
-worksheet = workbook.add_worksheet('Hyperlinks')
-
-# Format the first column
-worksheet.set_column('A:A', 30)
-worksheet.set_selection('B1')
-
-
-# Add a sample format
-format = workbook.add_format
-format.set_size(12)
-format.set_bold
-format.set_color('red')
-format.set_underline
-
-
-# Write some hyperlinks
-worksheet.write('A1', 'http://www.perl.com/'                )
-worksheet.write('A3', 'http://www.perl.com/', 'Perl home'   )
-worksheet.write('A5', 'http://www.perl.com/', nil, format)
-worksheet.write('A7', 'mailto:jmcnamara@cpan.org', 'Mail me')
-
-# Write a URL that isn't a hyperlink
-worksheet.write_string('A9', 'http://www.perl.com/')
-
-workbook.close
+#!/usr/bin/ruby -w
+# -*- coding: utf-8 -*-
+###############################################################################
+#
+# Example of how to use the WriteExcel module to write hyperlinks
+#
+# See also hyperlink2.pl for worksheet URL examples.
+#
+# reverse('©'), March 2001, John McNamara, jmcnamara@cpan.org
+#
+# original written in Perl by John McNamara
+# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
+#
+require 'rubygems'
+require 'writeexcel'
+
+# Create a new workbook and add a worksheet
+workbook  = WriteExcel.new("hyperlink.xls")
+worksheet = workbook.add_worksheet('Hyperlinks')
+
+# Format the first column
+worksheet.set_column('A:A', 30)
+worksheet.set_selection('B1')
+
+
+# Add a sample format
+format = workbook.add_format
+format.set_size(12)
+format.set_bold
+format.set_color('red')
+format.set_underline
+
+
+# Write some hyperlinks
+worksheet.write('A1', 'http://www.perl.com/'                )
+worksheet.write('A3', 'http://www.perl.com/', 'Perl home'   )
+worksheet.write('A5', 'http://www.perl.com/', nil, format)
+worksheet.write('A7', 'mailto:jmcnamara@cpan.org', 'Mail me')
+
+# Write a URL that isn't a hyperlink
+worksheet.write_string('A9', 'http://www.perl.com/')
+
+workbook.close

data/examples/images.rb

@@ -1,63 +1,63 @@
-#!/usr/bin/ruby -w
-# -*- coding: utf-8 -*-
-
-#######################################################################
-#
-# Example of how to insert images into an Excel worksheet using the
-# WriteExcel insert_image() method.
-#
-# reverse('©'), October 2001, John McNamara, jmcnamara@cpan.org
-#
-# original written in Perl by John McNamara
-# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
-#
-
-require 'rubygems'
-require 'writeexcel'
-
-# Create a new workbook called simple.xls and add a worksheet
-workbook   = WriteExcel.new("images.xls")
-worksheet1 = workbook.add_worksheet('Image 1')
-worksheet2 = workbook.add_worksheet('Image 2')
-worksheet3 = workbook.add_worksheet('Image 3')
-worksheet4 = workbook.add_worksheet('Image 4')
-bp=1
-
-# Insert a basic image
-worksheet1.write('A10', "Image inserted into worksheet.")
-worksheet1.insert_image('A1',
-  File.join(File.dirname(File.expand_path(__FILE__)), 'republic.png')
-)
-
-
-# Insert an image with an offset
-worksheet2.write('A10', "Image inserted with an offset.")
-worksheet2.insert_image('A1',
-  File.join(File.dirname(File.expand_path(__FILE__)), 'republic.png'),
-  32, 10
-)
-
-# Insert a scaled image
-worksheet3.write('A10', "Image scaled: width x 2, height x 0.8.")
-worksheet3.insert_image('A1',
-  File.join(File.dirname(File.expand_path(__FILE__)), 'republic.png'),
-  0, 0, 2, 0.8
-)
-
-# Insert an image over varied column and row sizes
-# This does not require any additional work
-
-# Set the cols and row sizes
-# NOTE: you must do this before you call insert_image()
-worksheet4.set_column('A:A', 5)
-worksheet4.set_column('B:B', nil, nil, 1) # Hidden
-worksheet4.set_column('C:D', 10)
-worksheet4.set_row(0, 30)
-worksheet4.set_row(3, 5)
-
-worksheet4.write('A10', "Image inserted over scaled rows and columns.")
-worksheet4.insert_image('A1',
-  File.join(File.dirname(File.expand_path(__FILE__)), 'republic.png')
-)
-
-workbook.close
+#!/usr/bin/ruby -w
+# -*- coding: utf-8 -*-
+
+#######################################################################
+#
+# Example of how to insert images into an Excel worksheet using the
+# WriteExcel insert_image() method.
+#
+# reverse('©'), October 2001, John McNamara, jmcnamara@cpan.org
+#
+# original written in Perl by John McNamara
+# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'rubygems'
+require 'writeexcel'
+
+# Create a new workbook called simple.xls and add a worksheet
+workbook   = WriteExcel.new("images.xls")
+worksheet1 = workbook.add_worksheet('Image 1')
+worksheet2 = workbook.add_worksheet('Image 2')
+worksheet3 = workbook.add_worksheet('Image 3')
+worksheet4 = workbook.add_worksheet('Image 4')
+bp=1
+
+# Insert a basic image
+worksheet1.write('A10', "Image inserted into worksheet.")
+worksheet1.insert_image('A1',
+  File.join(File.dirname(File.expand_path(__FILE__)), 'republic.png')
+)
+
+
+# Insert an image with an offset
+worksheet2.write('A10', "Image inserted with an offset.")
+worksheet2.insert_image('A1',
+  File.join(File.dirname(File.expand_path(__FILE__)), 'republic.png'),
+  32, 10
+)
+
+# Insert a scaled image
+worksheet3.write('A10', "Image scaled: width x 2, height x 0.8.")
+worksheet3.insert_image('A1',
+  File.join(File.dirname(File.expand_path(__FILE__)), 'republic.png'),
+  0, 0, 2, 0.8
+)
+
+# Insert an image over varied column and row sizes
+# This does not require any additional work
+
+# Set the cols and row sizes
+# NOTE: you must do this before you call insert_image()
+worksheet4.set_column('A:A', 5)
+worksheet4.set_column('B:B', nil, nil, 1) # Hidden
+worksheet4.set_column('C:D', 10)
+worksheet4.set_row(0, 30)
+worksheet4.set_row(3, 5)
+
+worksheet4.write('A10', "Image inserted over scaled rows and columns.")
+worksheet4.insert_image('A1',
+  File.join(File.dirname(File.expand_path(__FILE__)), 'republic.png')
+)
+
+workbook.close

data/examples/indent.rb

@@ -1,31 +1,31 @@
-#!/usr/bin/ruby -w
-# -*- coding: utf-8 -*-
-
-##############################################################################
-#
-# A simple formatting example using Spreadsheet::WriteExcel.
-#
-# This program demonstrates the indentation cell format.
-#
-# reverse('©'), May 2004, John McNamara, jmcnamara@cpan.org
-#
-# original written in Perl by John McNamara
-# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
-#
-
-
-require 'writeexcel'
-
-workbook  = WriteExcel.new('indent.xls')
-
-worksheet = workbook.add_worksheet()
-indent1   = workbook.add_format(:indent => 1)
-indent2   = workbook.add_format(:indent => 2)
-
-worksheet.set_column('A:A', 40)
-
-
-worksheet.write('A1', "This text is indented 1 level",  indent1)
-worksheet.write('A2', "This text is indented 2 levels", indent2)
-
-workbook.close
+#!/usr/bin/ruby -w
+# -*- coding: utf-8 -*-
+
+##############################################################################
+#
+# A simple formatting example using Spreadsheet::WriteExcel.
+#
+# This program demonstrates the indentation cell format.
+#
+# reverse('©'), May 2004, John McNamara, jmcnamara@cpan.org
+#
+# original written in Perl by John McNamara
+# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
+#
+
+
+require 'writeexcel'
+
+workbook  = WriteExcel.new('indent.xls')
+
+worksheet = workbook.add_worksheet()
+indent1   = workbook.add_format(:indent => 1)
+indent2   = workbook.add_format(:indent => 2)
+
+worksheet.set_column('A:A', 40)
+
+
+worksheet.write('A1', "This text is indented 1 level",  indent1)
+worksheet.write('A2', "This text is indented 2 levels", indent2)
+
+workbook.close