writeexcel 0.3.3 → 0.3.4

data/README.rdoc

@@ -4,6 +4,10 @@ Write to a cross-platform Excel binary file.
 
 == Recent Changes
 
+v0.3.4
+* Bug fix. add_comment doesn't work.
+* convert examples.(chess, colors, comment1, comment2)
+
 v0.3.3
 * add recent change in this document.
 

data/VERSION

@@ -1 +1 @@
-0.3.3
+0.3.4

data/examples/chess.rb

@@ -0,0 +1,141 @@
+#!/usr/bin/ruby -w
+
+########################################################################
+#
+# Example of formatting using the Spreadsheet::WriteExcel module via
+# property hashes.
+#
+# Setting format properties via hashes of values is useful when you have
+# to deal with a large number of similar formats. Consider for example a
+# chess board pattern with black squares, white unformatted squares and
+# a border.
+#
+# This relatively simple example requires 14 separate Format
+# objects although there are only 5 different properties: black
+# background, top border, bottom border, left border and right border.
+#
+# Using property hashes it is possible to define these 5 sets of
+# properties and then add them together to create the 14 Format
+# configurations.
+#
+# reverse('©'), July 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 'writeexcel'
+
+workbook  = WriteExcel.new("chess.xls")
+worksheet = workbook.add_worksheet()
+
+# Some row and column formatting
+worksheet.set_column('B:I', 10)
+
+(1..8).each { |i| worksheet.set_row(i, 50) }
+
+# Define the property hashes
+#
+black = {
+          'fg_color'  => 'black',
+          'pattern'   => 1,
+        }
+
+top     = { 'top'    => 6 }
+bottom  = { 'bottom' => 6 }
+left    = { 'left'   => 6 }
+right   = { 'right'  => 6 }
+
+# Define the formats
+#
+format01 = workbook.add_format(top.merge(left))
+format02 = workbook.add_format(top.merge(black))
+format03 = workbook.add_format(top)
+format04 = workbook.add_format(top.merge(right).merge(black))
+
+format05 = workbook.add_format(left)
+format06 = workbook.add_format(black)
+format07 = workbook.add_format
+format08 = workbook.add_format(right.merge(black))
+format09 = workbook.add_format(right)
+format10 = workbook.add_format(left.merge(black))
+
+format11 = workbook.add_format(bottom.merge(left).merge(black))
+format12 = workbook.add_format(bottom)
+format13 = workbook.add_format(bottom.merge(black))
+format14 = workbook.add_format(bottom.merge(right))
+
+
+# Draw the pattern
+worksheet.write('B2', '', format01)
+worksheet.write('C2', '', format02)
+worksheet.write('D2', '', format03)
+worksheet.write('E2', '', format02)
+worksheet.write('F2', '', format03)
+worksheet.write('G2', '', format02)
+worksheet.write('H2', '', format03)
+worksheet.write('I2', '', format04)
+
+worksheet.write('B3', '', format10)
+worksheet.write('C3', '', format07)
+worksheet.write('D3', '', format06)
+worksheet.write('E3', '', format07)
+worksheet.write('F3', '', format06)
+worksheet.write('G3', '', format07)
+worksheet.write('H3', '', format06)
+worksheet.write('I3', '', format09)
+
+worksheet.write('B4', '', format05)
+worksheet.write('C4', '', format06)
+worksheet.write('D4', '', format07)
+worksheet.write('E4', '', format06)
+worksheet.write('F4', '', format07)
+worksheet.write('G4', '', format06)
+worksheet.write('H4', '', format07)
+worksheet.write('I4', '', format08)
+
+worksheet.write('B5', '', format10)
+worksheet.write('C5', '', format07)
+worksheet.write('D5', '', format06)
+worksheet.write('E5', '', format07)
+worksheet.write('F5', '', format06)
+worksheet.write('G5', '', format07)
+worksheet.write('H5', '', format06)
+worksheet.write('I5', '', format09)
+
+worksheet.write('B6', '', format05)
+worksheet.write('C6', '', format06)
+worksheet.write('D6', '', format07)
+worksheet.write('E6', '', format06)
+worksheet.write('F6', '', format07)
+worksheet.write('G6', '', format06)
+worksheet.write('H6', '', format07)
+worksheet.write('I6', '', format08)
+
+worksheet.write('B7', '', format10)
+worksheet.write('C7', '', format07)
+worksheet.write('D7', '', format06)
+worksheet.write('E7', '', format07)
+worksheet.write('F7', '', format06)
+worksheet.write('G7', '', format07)
+worksheet.write('H7', '', format06)
+worksheet.write('I7', '', format09)
+
+worksheet.write('B8', '', format05)
+worksheet.write('C8', '', format06)
+worksheet.write('D8', '', format07)
+worksheet.write('E8', '', format06)
+worksheet.write('F8', '', format07)
+worksheet.write('G8', '', format06)
+worksheet.write('H8', '', format07)
+worksheet.write('I8', '', format08)
+
+worksheet.write('B9', '', format11)
+worksheet.write('C9', '', format12)
+worksheet.write('D9', '', format13)
+worksheet.write('E9', '', format12)
+worksheet.write('F9', '', format13)
+worksheet.write('G9', '', format12)
+worksheet.write('H9', '', format13)
+worksheet.write('I9', '', format14)
+
+workbook.close

data/examples/colors.rb

@@ -0,0 +1,128 @@
+#!/usr/bin/ruby -w
+
+################################################################################
+#
+# Demonstrates Spreadsheet::WriteExcel's named colors and the Excel color
+# palette.
+#
+# The set_custom_color() Worksheet method can be used to override one of the
+# built-in palette values with a more suitable colour. See the main docs.
+#
+# 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 'writeexcel'
+
+workbook = WriteExcel.new("colors.xls")
+
+# Some common formats
+center  = workbook.add_format(:align => 'center')
+heading = workbook.add_format(:align => 'center', :bold => 1)
+
+######################################################################
+#
+# Demonstrate the named colors.
+#
+
+order = [
+  0x21,
+  0x0B,
+  0x35,
+  0x11,
+  0x16,
+  0x12,
+  0x0D,
+  0x10,
+  0x17,
+  0x09,
+  0x0C,
+  0x0F,
+  0x0E,
+  0x14,
+  0x08,
+  0x0A
+]
+
+colors = {
+                0x08 => 'black',
+                0x0C => 'blue',
+                0x10 => 'brown',
+                0x0F => 'cyan',
+                0x17 => 'gray',
+                0x11 => 'green',
+                0x0B => 'lime',
+                0x0E => 'magenta',
+                0x12 => 'navy',
+                0x35 => 'orange',
+                0x21 => 'pink',
+                0x14 => 'purple',
+                0x0A => 'red',
+                0x16 => 'silver',
+                0x09 => 'white',
+                0x0D => 'yellow',
+        }
+
+worksheet1 = workbook.add_worksheet('Named colors')
+
+worksheet1.set_column(0, 3, 15)
+
+worksheet1.write(0, 0, "Index", heading)
+worksheet1.write(0, 1, "Index", heading)
+worksheet1.write(0, 2, "Name",  heading)
+worksheet1.write(0, 3, "Color", heading)
+
+i = 1
+
+# original was colors.each....
+# order unmatch between perl and ruby (of cource, it's hash!)
+# so i use order array to match perl's xls order.
+#
+order.each do |index|
+  format = workbook.add_format(
+      :fg_color => colors[index],
+      :pattern  => 1,
+      :border   => 1
+  )
+
+  worksheet1.write(i + 1, 0, index,                    center)
+  worksheet1.write(i + 1, 1, sprintf("0x%02X", index), center)
+  worksheet1.write(i + 1, 2, colors[index],            center)
+  worksheet1.write(i + 1, 3, '',                       format)
+  i += 1
+end
+
+######################################################################
+#
+# Demonstrate the standard Excel colors in the range 8..63.
+#
+
+worksheet2 = workbook.add_worksheet('Standard colors')
+
+worksheet2.set_column(0, 3, 15)
+
+worksheet2.write(0, 0, "Index", heading)
+worksheet2.write(0, 1, "Index", heading)
+worksheet2.write(0, 2, "Color", heading)
+worksheet2.write(0, 3, "Name",  heading)
+
+(8..63).each do |i|
+  format = workbook.add_format(
+      :fg_color => i,
+      :pattern  => 1,
+      :border   => 1
+  )
+
+  worksheet2.write((i - 7), 0, i,                    center)
+  worksheet2.write((i - 7), 1, sprintf("0x%02X", i), center)
+  worksheet2.write((i - 7), 2, '',                   format)
+
+  # Add the  color names
+  if colors.has_key?(i)
+    worksheet2.write((i - 7), 3, colors[i], center)
+  end
+end
+
+workbook.close

data/examples/comments1.rb

@@ -0,0 +1,26 @@
+#!/usr/bin/ruby -w
+
+###############################################################################
+#
+# This example demonstrates writing cell comments.
+#
+# A cell comment is indicated in Excel by a small red triangle in the upper
+# right-hand corner of the cell.
+#
+# For more advanced comment options see comments2.pl.
+#
+# reverse('©'), November 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("comments1.xls")
+worksheet = workbook.add_worksheet
+
+worksheet.write('A1', 'Hello')
+worksheet.write_comment('A1', 'This is a comment')
+
+workbook.close

data/examples/comments2.rb

@@ -0,0 +1,351 @@
+#!/usr/bin/ruby -w
+
+###############################################################################
+#
+# This example demonstrates writing cell comments.
+#
+# A cell comment is indicated in Excel by a small red triangle in the upper
+# right-hand corner of the cell.
+#
+# Each of the worksheets demonstrates different features of cell comments.
+#
+# reverse('©'), November 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("comments2.xls")
+text_wrap  = workbook.add_format(:text_wrap => 1, :valign => 'top')
+worksheet1 = workbook.add_worksheet
+worksheet2 = workbook.add_worksheet
+worksheet3 = workbook.add_worksheet
+worksheet4 = workbook.add_worksheet
+worksheet5 = workbook.add_worksheet
+worksheet6 = workbook.add_worksheet
+worksheet7 = workbook.add_worksheet
+worksheet8 = workbook.add_worksheet
+
+# Variables that we will use in each example.
+cell_text = ''
+comment   = ''
+
+###############################################################################
+#
+# Example 1. Demonstrates a simple cell comment without formatting and Unicode
+#            comments encoded as UTF-16 and as UTF-8.
+#
+
+# Set up some formatting.
+worksheet1.set_column('C:C', 25)
+worksheet1.set_row(2, 50)
+worksheet1.set_row(5, 50)
+
+# Simple ascii string.
+cell_text = 'Hold the mouse over this cell to see the comment.'
+
+comment   = 'This is a comment.'
+
+worksheet1.write('C3', cell_text, text_wrap)
+worksheet1.write_comment('C3', comment)
+
+# UTF-16 string.
+cell_text = 'This is a UTF-16 comment.'
+
+comment   = [0x263a].pack("n")
+
+worksheet1.write('C6', cell_text, text_wrap)
+worksheet1.write_comment('C6', comment, :encoding => 1)
+
+# UTF-8 string in perl 5.8.
+worksheet1.set_row(8, 50)
+cell_text = 'This is a UTF-8 string.'
+comment   = '☺'  # chr 0x263a in perl.
+
+worksheet1.write('C9', cell_text, text_wrap)
+worksheet1.write_comment('C9', comment)
+
+###############################################################################
+#
+# Example 2. Demonstrates visible and hidden comments.
+#
+
+# Set up some formatting.
+worksheet2.set_column('C:C', 25)
+worksheet2.set_row(2, 50)
+worksheet2.set_row(5, 50)
+
+
+cell_text = 'This cell comment is visible.'
+
+comment   = 'Hello.'
+
+worksheet2.write('C3', cell_text, text_wrap)
+worksheet2.write_comment('C3', comment, :visible => 1)
+
+
+cell_text = "This cell comment isn't visible (the default)."
+
+comment   = 'Hello.'
+
+worksheet2.write('C6', cell_text, text_wrap)
+worksheet2.write_comment('C6', comment)
+
+###############################################################################
+#
+# Example 3. Demonstrates visible and hidden comments set at the worksheet
+#            level.
+#
+
+# Set up some formatting.
+worksheet3.set_column('C:C', 25)
+worksheet3.set_row(2, 50)
+worksheet3.set_row(5, 50)
+worksheet3.set_row(8, 50)
+
+# Make all comments on the worksheet visible.
+worksheet3.show_comments
+
+cell_text = 'This cell comment is visible, explicitly.'
+
+comment   = 'Hello.'
+
+worksheet3.write('C3', cell_text, text_wrap)
+worksheet3.write_comment('C3', comment, :visible => 1)
+
+
+cell_text = 'This cell comment is also visible because ' +
+            'we used show_comments().'
+
+comment   = 'Hello.'
+
+worksheet3.write('C6', cell_text, text_wrap)
+worksheet3.write_comment('C6', comment)
+
+
+cell_text = 'However, we can still override it locally.'
+
+comment   = 'Hello.'
+
+worksheet3.write('C9', cell_text, text_wrap)
+worksheet3.write_comment('C9', comment, :visible => 0)
+
+###############################################################################
+#
+# Example 4. Demonstrates changes to the comment box dimensions.
+#
+
+# Set up some formatting.
+worksheet4.set_column('C:C', 25)
+worksheet4.set_row(2,  50)
+worksheet4.set_row(5,  50)
+worksheet4.set_row(8,  50)
+worksheet4.set_row(15, 50)
+
+worksheet4.show_comments
+
+cell_text = 'This cell comment is default size.'
+
+comment   = 'Hello.'
+
+worksheet4.write('C3', cell_text, text_wrap)
+worksheet4.write_comment('C3', comment)
+
+
+cell_text = 'This cell comment is twice as wide.'
+
+comment   = 'Hello.'
+
+worksheet4.write('C6', cell_text, text_wrap)
+worksheet4.write_comment('C6', comment, :x_scale => 2)
+
+
+cell_text = 'This cell comment is twice as high.'
+
+comment   = 'Hello.'
+
+worksheet4.write('C9', cell_text, text_wrap)
+worksheet4.write_comment('C9', comment, :y_scale => 2)
+
+
+cell_text = 'This cell comment is scaled in both directions.'
+
+comment   = 'Hello.'
+
+worksheet4.write('C16', cell_text, text_wrap)
+worksheet4.write_comment('C16', comment, :x_scale => 1.2, :y_scale => 0.8)
+
+
+cell_text = 'This cell comment has width and height specified in pixels.'
+
+comment   = 'Hello.'
+
+worksheet4.write('C19', cell_text, text_wrap)
+worksheet4.write_comment('C19', comment, :width => 200, :height => 20)
+
+###############################################################################
+#
+# Example 5. Demonstrates changes to the cell comment position.
+#
+
+worksheet5.set_column('C:C', 25)
+worksheet5.set_row(2, 50)
+worksheet5.set_row(5, 50)
+worksheet5.set_row(8, 50)
+worksheet5.set_row(11, 50)
+
+worksheet5.show_comments
+
+cell_text = 'This cell comment is in the default position.'
+
+comment   = 'Hello.'
+
+worksheet5.write('C3', cell_text, text_wrap)
+worksheet5.write_comment('C3', comment)
+
+
+cell_text = 'This cell comment has been moved to another cell.'
+
+comment   = 'Hello.'
+
+worksheet5.write('C6', cell_text, text_wrap)
+worksheet5.write_comment('C6', comment, :start_cell => 'E4')
+
+
+cell_text = 'This cell comment has been moved to another cell.'
+
+comment   = 'Hello.'
+
+worksheet5.write('C9', cell_text, text_wrap)
+worksheet5.write_comment('C9', comment, :start_row => 8, :start_col => 4)
+
+
+cell_text = 'This cell comment has been shifted within its default cell.'
+
+comment   = 'Hello.'
+
+worksheet5.write('C12', cell_text, text_wrap)
+worksheet5.write_comment('C12', comment, :x_offset => 30, :y_offset => 12)
+
+###############################################################################
+#
+# Example 6. Demonstrates changes to the comment background colour.
+#
+
+worksheet6.set_column('C:C', 25)
+worksheet6.set_row(2, 50)
+worksheet6.set_row(5, 50)
+worksheet6.set_row(8, 50)
+
+worksheet6.show_comments
+
+cell_text = 'This cell comment has a different colour.'
+
+comment   = 'Hello.'
+
+worksheet6.write('C3', cell_text, text_wrap)
+worksheet6.write_comment('C3', comment, :color => 'green')
+
+
+cell_text = 'This cell comment has the default colour.'
+
+comment   = 'Hello.'
+
+worksheet6.write('C6', cell_text, text_wrap)
+worksheet6.write_comment('C6', comment)
+
+cell_text = 'This cell comment has a different colour.'
+
+comment   = 'Hello.'
+
+worksheet6.write('C9', cell_text, text_wrap)
+worksheet6.write_comment('C9', comment, :color => 0x35)
+
+###############################################################################
+#
+# Example 7. Demonstrates how to set the cell comment author.
+#
+
+worksheet7.set_column('C:C', 30)
+worksheet7.set_row(2,  50)
+worksheet7.set_row(5,  50)
+worksheet7.set_row(8,  50)
+worksheet7.set_row(11, 50)
+
+author = ''
+cell   = 'C3'
+
+cell_text = "Move the mouse over this cell and you will see 'Cell commented "+
+            "by #{author}' (blank) in the status bar at the bottom"
+
+comment   = 'Hello.'
+
+worksheet7.write(cell, cell_text, text_wrap)
+worksheet7.write_comment(cell, comment)
+
+author    = 'Perl'
+cell      = 'C6'
+cell_text = "Move the mouse over this cell and you will see 'Cell commented " +
+            "by #{author}' in the status bar at the bottom"
+
+comment   = 'Hello.'
+
+worksheet7.write(cell, cell_text, text_wrap)
+worksheet7.write_comment(cell, comment, :author => author)
+
+author    = [0x20AC].pack("n")  # UTF-16 Euro
+cell      = 'C9'
+cell_text = "Move the mouse over this cell and you will see 'Cell commented " +
+            "by Euro' in the status bar at the bottom"
+
+comment   = 'Hello.'
+
+worksheet7.write(cell, cell_text, text_wrap)
+worksheet7.write_comment(cell, comment, :author  => author,
+                                        :author_encoding => 1)
+
+# UTF-8 string in perl 5.8.
+author    = '☺'    # smiley
+cell      = 'C12'
+cell_text = "Move the mouse over this cell and you will see 'Cell commented " +
+            "by #{author}' in the status bar at the bottom"
+comment   = 'Hello.'
+
+worksheet7.write(cell, cell_text, text_wrap)
+worksheet7.write_comment(cell, comment, :author => author)
+
+###############################################################################
+#
+# Example 8. Demonstrates the need to explicitly set the row height.
+#
+
+# Set up some formatting.
+worksheet8.set_column('C:C', 25)
+worksheet8.set_row(2, 80)
+
+worksheet8.show_comments
+
+cell_text = 'The height of this row has been adjusted explicitly using '  +
+            'set_row(). The size of the comment box is adjusted '         +
+            'accordingly by WriteExcel.'
+
+comment   = 'Hello.'
+
+worksheet8.write('C3', cell_text, text_wrap)
+worksheet8.write_comment('C3', comment)
+
+cell_text = 'The height of this row has been adjusted by Excel due to the '  +
+            'text wrap property being set. Unfortunately this means that '   +
+            'the height of the row is unknown to WriteExcel at run time '    +
+            "and thus the comment box is stretched as well.\n\n"             +
+            'Use set_row() to specify the row height explicitly to avoid '     +
+            'this problem.'
+
+comment   = 'Hello.'
+
+worksheet8.write('C6', cell_text, text_wrap)
+worksheet8.write_comment('C6', comment)
+
+workbook.close