-
$_1904
-
Flag for 1904 date system (0 => base date is 1900, 1 => base date is 1904)
-
$_activesheet
-
The active worksheet of the workbook (0 indexed)
-
$_active_pane
-
The active pane for the worksheet
-
$_bg_color
-
The cell's background color.
-
$_biffsize
-
The BIFF file size for the workbook.
-
$_BIFF_version
-
The BIFF/Excel version (5).
-
$_BIFF_version
-
The BIFF version for the workbook
-
$_blank
-
-
$_bold
-
Bold style
-
$_bottom
-
Style of the bottom border of the cell
-
$_bottom_color
-
Color of the bottom border of the cell.
-
$_byte_order
-
The byte order. 1 => big endian, 0 => little endian.
-
$_byte_order
-
The byte order of this architecture. 0 => little endian, 1 => big endian
-
$_codepage
-
The codepage indicates the text encoding used for strings
-
$_colinfo
-
Array containing format information for columns
-
$_color
-
Index to the cell's color
-
$_country_code
-
The country code used for localization
-
$_current_char
-
The index of the character we are currently looking at
-
$_current_token
-
The token we are working on.
-
$_data
-
The string containing the data of the BIFF stream
-
$_datasize
-
The size of the data in bytes. Should be the same as strlen($this->_data)
-
$_descr_error
-
-
$_descr_prompt
-
-
$_dim_colmax
-
Last column for the DIMENSIONS record
-
$_dim_colmin
-
First column for the DIMENSIONS record
-
$_dim_rowmax
-
Last row for the DIMENSIONS record
-
$_dim_rowmin
-
First row for the DIMENSIONS record
-
$_ext_sheets
-
Array of external sheets
-
$_fg_color
-
The cell's foreground color.
-
$_fileclosed
-
Flag for preventing close from being called twice.
-
$_filehandle
-
Filehandle to the temporary file for storing data
-
$_filename
-
Filename for the Workbook
-
$_firstsheet
-
1st displayed worksheet in the workbook (0 indexed)
-
$_fit_height
-
Number of pages to fit high
-
$_fit_page
-
Whether to fit to page when printing or not.
-
$_fit_width
-
Number of pages to fit wide
-
$_fixedList
-
-
$_font_charset
-
Byte specifiying the font charset.
-
$_font_family
-
Byte specifiying the font family.
-
$_font_name
-
The font name (ASCII).
-
$_font_outline
-
Bit specifiying if the font has outline.
-
$_font_script
-
2 bytes specifiying the script type for the font.
-
$_font_shadow
-
Bit specifiying if the font has shadow.
-
$_font_strikeout
-
Bit specifiying if the font has strikeout.
-
$_footer
-
The page footer caption
-
$_formats
-
Array containing references to all of this workbook's formats
-
$_formula
-
The formula to parse
-
$_formula1
-
-
$_formula2
-
-
$_frozen
-
Bit specifying if panes are frozen
-
$_hcenter
-
The horizontal centering value for the page
-
$_header
-
The page header caption
-
$_hidden
-
Bit specifying if formulas are hidden.
-
$_incell
-
-
$_italic
-
Bit specifiying if the font is italic.
-
$_left
-
Style of the left border of the cell
-
$_left_color
-
Color of the left border of the cell.
-
$_limit
-
The maximun length for a BIFF record. See _addContinue()
-
$_locked
-
Bit specifying if the cell is locked.
-
$_lookahead
-
The character ahead of the current char
-
$_margin_bottom
-
The bottom margin for the worksheet in inches
-
$_margin_foot
-
The margin for the footer
-
$_margin_head
-
The margin for the header
-
$_margin_left
-
The left margin for the worksheet in inches
-
$_margin_right
-
The right margin for the worksheet in inches
-
$_margin_top
-
The top margin for the worksheet in inches
-
$_merged_ranges
-
Merged cell ranges
-
$_num_format
-
An index (2 bytes) to a FORMAT record (number format).
-
$_operator
-
-
$_orientation
-
Bit specifying paper orientation (for printing). 0 => landscape, 1 => portrait
-
$_outline_below
-
Whether to have outline summary below.
-
$_outline_on
-
Whether to use outline.
-
$_outline_right
-
Whether to have outline summary at the right.
-
$_outline_row_level
-
Outline row level.
-
$_outline_style
-
Auto outline styles.
-
$_palette
-
Array containing the colour palette
-
$_panes
-
Array containing the panes for the worksheet
-
$_paper_size
-
The paper size (for printing) (DOCUMENT!!!)
-
$_parser
-
Formula parser
-
$_parser
-
Reference to the parser used for parsing formulas
-
$_parser
-
The parser from the workbook. Used to parse validation formulas also
-
$_parse_tree
-
The parse tree to be generated
-
$_pattern
-
The cell's background fill pattern.
-
$_references
-
Array of sheet references in the form of REF structures
-
$_right
-
Style of the right border of the cell
-
$_right_color
-
Color of the right border of the cell.
-
$_rotation
-
The two bits specifying the text rotation.
-
$_selected
-
Number of workbook tabs selected
-
$_selection
-
Array containing the selected area for the worksheet
-
$_sheetname
-
The default sheetname for all sheets created.
-
$_sheetnames
-
Array of sheetnames for creating the EXTERNSHEET records
-
$_showerror
-
-
$_showprompt
-
-
$_size
-
Height of font (1/20 of a point)
-
$_string_sizeinfo_size
-
number of bytes for sizeinfo of strings
-
$_str_table
-
Reference to the array containing all the unique strings in the workbook
-
$_str_total
-
Reference to the total number of strings in the workbook
-
$_str_unique
-
Reference to the number of unique strings in the workbook
-
$_style
-
-
$_text_h_align
-
The three bits specifying the text horizontal alignment.
-
$_text_justlast
-
1 bit, apparently not used.
-
$_text_v_align
-
The three bits specifying the text vertical alignment.
-
$_text_wrap
-
Bit specifying if the text is wrapped at the right border.
-
$_title_error
-
-
$_title_prompt
-
-
$_tmp_dir
-
The temporary dir for storing the OLE file
-
$_tmp_format
-
The default XF format.
-
$_top
-
Style of the top border of the cell
-
$_top_color
-
Color of the top border of the cell.
-
$_type
-
-
$_underline
-
The text underline property
-
$_url_format
-
Reference to the (default) Format object for URLs
-
$_url_format
-
The default format for URLs.
-
$_using_tmpfile
-
Boolean indicating if we are using a temporary file for storing data
-
$_vcenter
-
The vertical centering value for the page
-
$_worksheets
-
Array containing references to all of this workbook's worksheets
-
$_xf_index
-
Index for creating adding new formats to the workbook
-
$_xf_index
-
The index given by the workbook when creating a new format.
-
$_xls_colmax
-
Maximum number of columns for an Excel spreadsheet (BIFF5)
-
$_xls_rowmax
-
Maximum number of rows for an Excel spreadsheet (BIFF5)
-
$_xls_strmax
-
Maximum number of characters for a string (LABEL record in BIFF5)
-
_addContinue
-
Excel limits the size of BIFF records. In Excel 5 the limit is 2084 bytes. In Excel 97 the limit is 8228 bytes. Records that are longer than these limits must be split up into CONTINUE blocks.
-
_advance
-
Advance to the next valid token.
-
_append
-
Store Worksheet data in memory using the parent's class append() or to a temporary file, the default.
-
_append
-
General storage function
-
_calcSheetOffsets
-
Calculate offsets for Worksheet BOF records.
-
_calculateSharedStringsSizes
-
Calculate
-
_cellToPackedRowcol
-
pack() row and column into the required 3 or 4 byte format.
-
_cellToRowcol
-
Convert an Excel cell reference such as A1 or $B2 or C$3 or $D$4 to a zero indexed row and column number. Also returns two (0,1) values to indicate whether the row or column are relative references.
-
_cellToRowcol
-
Convert an Excel cell reference in A1 notation to a zero based row and column reference; converts C1 to (0, 2).
-
_checkRowCol
-
Check row and col before writing to a cell, and update the sheet's dimensions accordingly
-
_condition
-
It parses a condition. It assumes the following rule: Cond -> Expr [(">" | "<") Expr]
-
_convert
-
Convert a token to the proper ptg value.
-
_convertFunction
-
Convert a function to a ptgFunc or ptgFuncVarV depending on the number of args that it takes.
-
_convertNumber
-
Convert a number token to ptgInt or ptgNum
-
_convertRange2d
-
Convert an Excel range such as A1:D4 to a ptgRefV.
-
_convertRange3d
-
Convert an Excel 3d range such as "Sheet1!A1:D4" or "Sheet1:Sheet2!A1:D4" to a ptgArea3d.
-
_convertRef2d
-
Convert an Excel reference such as A1, $B2, C$3 or $D$4 to a ptgRefV.
-
_convertRef3d
-
Convert an Excel 3d reference such as "Sheet1!A1" or "Sheet1:Sheet2!A1" to a ptgRef3d.
-
_convertString
-
Convert a string token to ptgStr
-
_createTree
-
Creates a tree. In fact an array which may have one or two arrays (sub-trees) as elements.
-
_encodePassword
-
Based on the algorithm provided by Daniel Rentz of OpenOffice.
-
_expression
-
It parses a expression. It assumes the following rule:
-
_fact
-
It parses a factor. It assumes the following rule:
-
_func
-
It parses a function call. It assumes the following rule: Func -> ( Expr [,Expr]* )
-
_getColor
-
Used in conjunction with the set_xxx_color methods to convert a color string into a number. Color range is 0..63 but we will restrict it to 8..63 to comply with Gnumeric. Colors 0..7 are repeated in 8..15.
-
_getData
-
-
_getOptions
-
-
_getRefIndex
-
Look up the REF index that corresponds to an external sheet name (or range). If it doesn't exist yet add it to the workbook's references array. It assumes all sheet names given must exist.
-
_getSheetIndex
-
Look up the index that corresponds to an external sheet name. The hash of sheet names is updated by the addworksheet() method of the Spreadsheet_Excel_Writer_Workbook class.
-
_initialize
-
Open a tmp file to store the majority of the Worksheet data. If this fails, for example due to write permissions, store the data in memory. This can be slow for large files.
-
_initializeHashes
-
Initialize the ptg and function hashes.
-
_match
-
Checks if it's a valid token.
-
_packExtRef
-
Convert the sheet name part of an external reference, for example "Sheet1" or "Sheet1:Sheet2", to a packed structure.
-
_parenthesizedExpression
-
This function just introduces a ptgParen element in the tree, so that Excel doesn't get confused when working with a parenthesized formula afterwards.
-
_positionImage
-
Calculate the vertices that define the position of the image as required by the OBJ record.
-
_prepend
-
General storage function
-
_processBitmap
-
Convert a 24 bit bitmap into the modified internal format used by Windows.
-
_rangeToPackedRange
-
pack() row range into the required 3 or 4 byte format.
-
_setByteOrder
-
Determine the byte order and store it as class data to avoid recalculating it for each call to new().
-
_setPaletteXl97
-
Sets the colour palette to the Excel 97+ default.
-
_sizeCol
-
Convert the width of a cell from user's units to pixels. By interpolation the relationship is: y = 7x +5. If the width hasn't been set by the user we use the default value. If the col is hidden we use a value of zero.
-
_sizeRow
-
Convert the height of a cell from user's units to pixels. By interpolation the relationship is: y = 4/3x. If the height hasn't been set by the user we use the default value. If the row is hidden we use a value of zero. (Not possible to hide row yet).
-
_storeAllFonts
-
Store the Excel FONT records.
-
_storeAllNumFormats
-
Store user defined numerical formats i.e. FORMAT records
-
_storeAllStyles
-
Write all STYLE records.
-
_storeAllXfs
-
Write all XF records.
-
_storeBof
-
Writes Excel BOF record to indicate the beginning of a stream or sub-stream in the BIFF file.
-
_storeBoundsheet
-
Writes Excel BIFF BOUNDSHEET record.
-
_storeCodepage
-
Stores the CODEPAGE biff record.
-
_storeColinfo
-
Write BIFF record COLINFO to define column widths
-
_storeCountry
-
Stores the COUNTRY record for localization
-
_storeDataValidity
-
Store the DVAL and DV records.
-
_storeDatemode
-
Write DATEMODE record to indicate the date system in use (1904 or 1900).
-
_storeDefcol
-
Write BIFF record DEFCOLWIDTH if COLINFO records are in use.
-
_storeDimensions
-
Writes Excel DIMENSIONS to define the area in which there is data.
-
_storeEof
-
Writes Excel EOF record to indicate the end of a BIFF stream.
-
_storeExterncount
-
Write BIFF record EXTERNCOUNT to indicate the number of external sheet references in a worksheet.
-
_storeExterncount
-
Write BIFF record EXTERNCOUNT to indicate the number of external sheet references in the workbook.
-
_storeExterns
-
Write the EXTERNCOUNT and EXTERNSHEET records. These are used as indexes for the NAME records.
-
_storeExternsheet
-
Writes the Excel BIFF EXTERNSHEET record. These references are used by formulas. A formula references a sheet name via an index. Since we store a reference to all of the external worksheets the EXTERNSHEET index is the same as the worksheet index.
-
_storeExternsheet
-
Writes the Excel BIFF EXTERNSHEET record. These references are used by formulas. NAME record is required to define the print area and the repeat rows and columns.
-
_storeExternsheetBiff8
-
Writes the Excel BIFF EXTERNSHEET record. These references are used by formulas.
-
_storeFooter
-
Store the footer caption BIFF record.
-
_storeGridset
-
Write the GRIDSET BIFF record. Must be used in conjunction with the PRINTGRIDLINES record.
-
_storeGuts
-
Write the GUTS BIFF record. This is used to configure the gutter margins where Excel outline symbols are displayed. The visibility of the gutters is controlled by a flag in WSBOOL.
-
_storeHbreak
-
Write the HORIZONTALPAGEBREAKS BIFF record.
-
_storeHcenter
-
Store the horizontal centering HCENTER BIFF record.
-
_storeHeader
-
Store the header caption BIFF record.
-
_storeMarginBottom
-
Store the BOTTOMMARGIN BIFF record.
-
_storeMarginLeft
-
Store the LEFTMARGIN BIFF record.
-
_storeMarginRight
-
Store the RIGHTMARGIN BIFF record.
-
_storeMarginTop
-
Store the TOPMARGIN BIFF record.
-
_storeMergedCells
-
Store the MERGEDCELLS record for all ranges of merged cells
-
_storeNameLong
-
Store the NAME record in the long format that is used for storing the repeat rows and columns when both are specified. This shares a lot of code with _storeNameShort() but we use a separate method to keep the code clean.
-
_storeNames
-
Write the NAME record to define the print area and the repeat rows and cols.
-
_storeNameShort
-
Store the NAME record in the short format that is used for storing the print area, repeat rows only and repeat columns only.
-
_storeNumFormat
-
Writes Excel FORMAT record for non "built-in" numerical formats.
-
_storeObjPicture
-
Store the OBJ record that precedes an IMDATA record. This could be generalise to support other Excel objects.
-
_storeOLEFile
-
Store the workbook in an OLE container
-
_storePalette
-
Stores the PALETTE biff record.
-
_storePanes
-
Writes the Excel BIFF PANE record.
-
_storePassword
-
Write the worksheet PASSWORD record.
-
_storePrintGridlines
-
Write the PRINTGRIDLINES BIFF record. Must be used in conjunction with the GRIDSET record.
-
_storePrintHeaders
-
Write the PRINTHEADERS BIFF record.
-
_storeProtect
-
Set the Biff PROTECT record to indicate that the worksheet is protected.
-
_storeSelection
-
Write BIFF record SELECTION.
-
_storeSetup
-
Store the page setup SETUP BIFF record.
-
_storeSharedStringsTable
-
Write all of the workbooks strings into an indexed array.
-
_storeStyle
-
Write Excel BIFF STYLE records.
-
_storeSupbookInternal
-
Write Internal SUPBOOK record
-
_storeVbreak
-
Write the VERTICALPAGEBREAKS BIFF record.
-
_storeVcenter
-
Store the vertical centering VCENTER BIFF record.
-
_storeWindow1
-
Write Excel BIFF WINDOW1 record.
-
_storeWindow2
-
Write BIFF record Window2.
-
_storeWorkbook
-
Assemble worksheets into a workbook and send the BIFF data to an OLE storage.
-
_storeWsbool
-
Write the WSBOOL BIFF record, mainly for fit-to-page. Used in conjunction with the SETUP record.
-
_storeZoom
-
Store the window zoom factor. This should be a reduced fraction but for simplicity we will store all fractions with a numerator of 100.
-
_substituteCellref
-
Substitute an Excel cell reference in A1 notation for zero based row and column values in an argument list.
-
_term
-
It parses a term. It assumes the following rule: Term -> Fact [("*" | "/") Fact]
-
_writeUrlExternal
-
Write links to external directory names such as 'c:\foo.xls', c:\foo.xls#Sheet1!A1', '../../foo.xls'. and '../../foo.xls#Sheet1!A1'.
-
_writeUrlInternal
-
Used to write internal reference hyperlinks such as "Sheet1!A1".
-
_writeUrlRange
-
This is the more general form of writeUrl(). It allows a hyperlink to be written to a range of cells. This function also decides the type of hyperlink to be written. These are either, Web (http, ftp, mailto), Internal (Sheet1!A1) or external ('c:\temp\foo.xls#Sheet1!A1').
-
_writeUrlWeb
-
Used to write http, ftp and mailto hyperlinks.
-
_XF
-
Returns an index to the XF record in the workbook
-
$selected
-
Bit specifying if the worksheet is selected
-
select
-
Set this worksheet as a selected worksheet, i.e. the worksheet has its tab highlighted.
-
send
-
Send HTTP headers for the Excel file.
-
setAlign
-
Set cell alignment.
-
setBgColor
-
Sets the cell's background color
-
setBold
-
Sets the boldness of the text.
-
setBorder
-
Set cells borders to the same style
-
setBorderColor
-
Sets all the cell's borders to the same color
-
setBottom
-
Sets the width for the bottom border of the cell
-
setBottomColor
-
Sets the cell's bottom border color
-
setColor
-
Sets the cell's color
-
setColumn
-
Set the width of a single column or a range of columns.
-
setCountry
-
Set the country identifier for the workbook
-
setCustomColor
-
Change the RGB components of the elements in the colour palette.
-
setError
-
-
setExtSheet
-
This method is used to update the array of sheet names. It is called by the addWorksheet() method of the Spreadsheet_Excel_Writer_Workbook class.
-
setFgColor
-
Sets the cell's foreground color
-
setFirstSheet
-
Set this worksheet as the first visible sheet.
-
setFontFamily
-
Sets the font family name.
-
setFooter
-
Set the page footer caption and optional margin.
-
setFormula1
-
-
setFormula2
-
-
setHeader
-
Set the page header caption and optional margin.
-
setHPagebreaks
-
Store the horizontal page breaks on a worksheet (for printing).
-
setItalic
-
Sets the font style as italic
-
setLandscape
-
Set the page orientation as landscape.
-
setLeft
-
Sets the width for the left border of the cell
-
setLeftColor
-
Sets the cell's left border color
-
setLocked
-
Locks a cell.
-
setMarginBottom
-
Set the bottom margin in inches.
-
setMarginLeft
-
Set the left margin in inches.
-
setMarginRight
-
Set the right margin in inches.
-
setMargins
-
Set all the page margins to the same value in inches.
-
setMargins_LR
-
Set the left and right margins to the same value in inches.
-
setMargins_TB
-
Set the top and bottom margins to the same value in inches.
-
setMarginTop
-
Set the top margin in inches.
-
setMerge
-
Sets a merged cell range
-
setMerge
-
This is an alias for the unintuitive setAlign('merge')
-
setNumFormat
-
Sets the numeric format.
-
setOutLine
-
Sets outlining for a font.
-
setOutline
-
This method sets the properties for outlining and grouping. The defaults correspond to Excel's defaults.
-
setPaper
-
Set the paper type. Ex. 1 = US Letter, 9 = A4
-
setPattern
-
Sets the fill pattern attribute of a cell
-
setPortrait
-
Set the page orientation as portrait.
-
setPrintScale
-
Set the scale factor for the printed page.
-
setPrompt
-
-
setRight
-
Sets the width for the right border of the cell
-
setRightColor
-
Sets the cell's right border color
-
setRow
-
This method is used to set the height and format for a row.
-
setScript
-
Sets the script type of the text
-
setSelection
-
Set which cell or cells are selected in a worksheet
-
setShadow
-
Sets font as shadow.
-
setSize
-
Sets the font size
-
setStrikeOut
-
Sets font as strikeout.
-
setTempDir
-
Sets the temp dir used for storing the OLE file
-
setTextRotation
-
Sets the orientation of the text
-
setTextWrap
-
Sets text wrapping
-
setTop
-
Sets the width for the top border of the cell
-
setTopColor
-
Sets the cell's top border color
-
setUnderline
-
Sets the underline of the text
-
setUnLocked
-
Unlocks a cell. Useful for unprotecting particular cells of a protected sheet.
-
setValidation
-
FIXME: add comments
-
setVersion
-
Sets the BIFF version.
-
setVPagebreaks
-
Store the vertical page breaks on a worksheet (for printing).
-
setZoom
-
Set the worksheet zoom factor.
-
sheets
-
An accessor for the _worksheets[] array Returns an array of the worksheet objects in a workbook It actually calls to worksheets()
-
Spreadsheet_Excel_Writer
-
The constructor. It just creates a Workbook
-
Spreadsheet_Excel_Writer
-
Class for writing Excel Spreadsheets. This class should change COMPLETELY.
-
SPREADSHEET_EXCEL_WRITER_ADD
-
-
Spreadsheet_Excel_Writer_BIFFwriter
-
Constructor
-
Spreadsheet_Excel_Writer_BIFFwriter
-
Class for writing Excel BIFF records.
-
SPREADSHEET_EXCEL_WRITER_CLOSE
-
-
SPREADSHEET_EXCEL_WRITER_COMA
-
-
SPREADSHEET_EXCEL_WRITER_DIV
-
-
SPREADSHEET_EXCEL_WRITER_EQ
-
-
Spreadsheet_Excel_Writer_Format
-
Class for generating Excel XF records (formats)
-
Spreadsheet_Excel_Writer_Format
-
Constructor
-
SPREADSHEET_EXCEL_WRITER_GE
-
-
SPREADSHEET_EXCEL_WRITER_GT
-
-
SPREADSHEET_EXCEL_WRITER_LE
-
-
SPREADSHEET_EXCEL_WRITER_LT
-
-
SPREADSHEET_EXCEL_WRITER_MUL
-
-
SPREADSHEET_EXCEL_WRITER_NE
-
-
SPREADSHEET_EXCEL_WRITER_OPEN
-
-
Spreadsheet_Excel_Writer_Parser
-
Class for parsing Excel formulas
-
Spreadsheet_Excel_Writer_Parser
-
The class constructor
-
SPREADSHEET_EXCEL_WRITER_SEMICOLON
-
-
SPREADSHEET_EXCEL_WRITER_SUB
-
-
Spreadsheet_Excel_Writer_Validator
-
Baseclass for generating Excel DV records (validations)
-
Spreadsheet_Excel_Writer_Validator
-
-
Spreadsheet_Excel_Writer_Workbook
-
Class for generating Excel Spreadsheets
-
Spreadsheet_Excel_Writer_Workbook
-
Class constructor
-
Spreadsheet_Excel_Writer_Worksheet
-
Class for generating Excel Spreadsheets
-
Spreadsheet_Excel_Writer_Worksheet
-
Constructor