pascal/lazarus-ccr
1
0
Fork 0
Code Issues Releases Activity

fpspreadsheet: Update chm help file (include fpspreadsheetctrls)

Browse Source 
git-svn-id: https://svn.code.sf.net/p/lazarus-ccr/svn@3709 8e941d3f-bd1b-0410-a28a-d453659cc2b4
This commit is contained in:
wp_xxyyzz
2014-11-08 23:41:35 +00:00
parent a8582a0471
commit cfe9cf68ee
6 changed files with 459 additions and 260 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
components/fpspreadsheet/fpspreadsheet.chm
View File

Binary file not shown.

145
components/fpspreadsheet/fpspreadsheet.pas
View File

@ -1,10 +1,13 @@
{ { fpspreadsheet }
fpspreadsheet.pas
Writes a spreadsheet document {@@ ----------------------------------------------------------------------------
Unit fpspreadsheet reads and writes spreadsheet documents.
AUTHORS: Felipe Monteiro de Carvalho AUTHORS: Felipe Monteiro de Carvalho, Reinier Olislagers, Werner Pamler
}
LICENSE: See the file COPYING.modifiedLGPL.txt, included in the Lazarus
distribution, for details about the license.
-------------------------------------------------------------------------------}
unit fpspreadsheet; unit fpspreadsheet;
{$ifdef fpc} {$ifdef fpc}
@ -33,16 +36,26 @@ type
const const
{ Default extensions } { Default extensions }
{@@ Default binary <b>Excel</b> file extension}
STR_EXCEL_EXTENSION = '.xls'; STR_EXCEL_EXTENSION = '.xls';
{@@ Default xml <b>Excel</b> file extension (>= Excel 2007) }
STR_OOXML_EXCEL_EXTENSION = '.xlsx'; STR_OOXML_EXCEL_EXTENSION = '.xlsx';
{@@ Default <b>OpenDocument</b> spreadsheet file extension }
STR_OPENDOCUMENT_CALC_EXTENSION = '.ods'; STR_OPENDOCUMENT_CALC_EXTENSION = '.ods';
{@@ Default extension of <b>comma-separated-values</b> file }
STR_COMMA_SEPARATED_EXTENSION = '.csv'; STR_COMMA_SEPARATED_EXTENSION = '.csv';
{@@ Default extension of <b>wikitable files</b> in <b>pipes</b> format}
STR_WIKITABLE_PIPES = '.wikitable_pipes'; STR_WIKITABLE_PIPES = '.wikitable_pipes';
{@@ Default extension of <b>wikitable files</b> in <b>wikimedia</b> format }
STR_WIKITABLE_WIKIMEDIA = '.wikitable_wikimedia'; STR_WIKITABLE_WIKIMEDIA = '.wikitable_wikimedia';
{@@ Maximum count of worksheet columns}
MAX_COL_COUNT = 65535; MAX_COL_COUNT = 65535;
{@@ Name of the default font}
DEFAULTFONTNAME = 'Arial'; DEFAULTFONTNAME = 'Arial';
{@@ Size of the default font}
DEFAULTFONTSIZE = 10; DEFAULTFONTSIZE = 10;
type type
@ -57,32 +70,13 @@ type
seHebrew, seHebrew,
seArabic seArabic
); );
(*
{@@ Describes a formula
Supported syntax: {@@ Tokens to identify the <b>elements in an expanded formula</b>.
<pre>
=A1+B1+C1/D2... - Array with simple mathematical operations
=SUM(A1:D1) - SUM operation in a interval
</pre>
}
TsFormula = record
FormulaStr: string;
DoubleValue: double;
end;
*)
{@@ Tokens to identify the elements in an expanded formula.
See http://www.techonthenet.com/excel/formulas/ for an explanation of NOTE: When adding or rearranging items
meaning and parameters of each formula * make sure that the subtypes TOperandTokens and TBasicOperationTokens
NOTE: When adding or rearranging items:
- make sure that the subtypes TOperandTokens, TBasicOperationTokens and TFuncTokens
are complete are complete
- make sure to keep the FEProps table in sync * make sure to keep the table "TokenIDs" in unit xlscommon in sync
- make sure to keep the TokenID table
in TsSpreadBIFFWriter.FormulaElementKindToExcelTokenID, unit xlscommon,
in sync
} }
TFEKind = ( TFEKind = (
{ Basic operands } { Basic operands }
@ -103,12 +97,12 @@ type
{@@ These tokens identify basic operations in RPN formulas. } {@@ These tokens identify basic operations in RPN formulas. }
TBasicOperationTokens = fekAdd..fekParen; TBasicOperationTokens = fekAdd..fekParen;
{@@ Flags to mark the address or a cell or a range of cells to be absolute {@@ Flags to mark the address or a cell or a range of cells to be <b>absolute</b>
or relative. They are used in the set TsRelFlags. } or <b>relative</b>. They are used in the set TsRelFlags. }
TsRelFlag = (rfRelRow, rfRelCol, rfRelRow2, rfRelCol2); TsRelFlag = (rfRelRow, rfRelCol, rfRelRow2, rfRelCol2);
{@@ Flags to mark the address of a cell or a range of cells to be absolute {@@ Flags to mark the address of a cell or a range of cells to be <b>absolute</b>
or relative. It is a set consisting of TsRelFlag elements. } or <b>relative</b>. It is a set consisting of TsRelFlag elements. }
TsRelFlags = set of TsRelFlag; TsRelFlags = set of TsRelFlag;
{@@ Elements of an expanded formula. {@@ Elements of an expanded formula.
@ -116,9 +110,9 @@ type
to signed integers! } to signed integers! }
TsFormulaElement = record TsFormulaElement = record
ElementKind: TFEKind; ElementKind: TFEKind;
Row, Row2: Cardinal; // zero-based Row, Row2: Cardinal; // zero-based
Col, Col2: Cardinal; // zero-based Col, Col2: Cardinal; // zero-based
Param1, Param2: Word; // Extra parameters Param1, Param2: Word; // Extra parameters
DoubleValue: double; DoubleValue: double;
IntValue: Word; IntValue: Word;
StringValue: String; StringValue: String;
@ -131,7 +125,7 @@ type
Simplifies the task of format writers which need RPN } Simplifies the task of format writers which need RPN }
TsRPNFormula = array of TsFormulaElement; TsRPNFormula = array of TsFormulaElement;
{@@ Describes the type of content in a cell of a TsWorksheet } {@@ Describes the <b>type of content</b> in a cell of a TsWorksheet }
TCellContentType = (cctEmpty, cctFormula, cctNumber, cctUTF8String, TCellContentType = (cctEmpty, cctFormula, cctNumber, cctUTF8String,
cctDateTime, cctBool, cctError); cctDateTime, cctBool, cctError);
@ -255,35 +249,68 @@ type
and the names of the color constants may no longer be correct. and the names of the color constants may no longer be correct.
} }
const const
{@@ Index of <b>black</b> color in the standard color palettes }
scBlack = $00; scBlack = $00;
{@@ Index of <b>white</b> color in the standard color palettes }
scWhite = $01; scWhite = $01;
{@@ Index of <b>red</b> color in the standard color palettes }
scRed = $02; scRed = $02;
{@@ Index of <b>green</b> color in the standard color palettes }
scGreen = $03; scGreen = $03;
{@@ Index of <b>blue</b> color in the standard color palettes }
scBlue = $04; scBlue = $04;
{@@ Index of <b>yellow</b> color in the standard color palettes }
scYellow = $05; scYellow = $05;
{@@ Index of <b>magenta</b> color in the standard color palettes }
scMagenta = $06; scMagenta = $06;
{@@ Index of <b>cyan</b> color in the standard color palettes }
scCyan = $07; scCyan = $07;
{@@ Index of <b>dark red</b> color in the standard color palettes }
scDarkRed = $08; scDarkRed = $08;
{@@ Index of <b>dark green</b> color in the standard color palettes }
scDarkGreen = $09; scDarkGreen = $09;
scDarkBlue = $0A; scNavy = $0A; {@@ Index of <b>dark blue</b> color in the standard color palettes }
scDarkBlue = $0A;
{@@ Index of <b>"navy"</b> color (dark blue) in the standard color palettes }
scNavy = $0A;
{@@ Index of <b>olive</b> color in the standard color palettes }
scOlive = $0B; scOlive = $0B;
{@@ Index of <b>purple</b> color in the standard color palettes }
scPurple = $0C; scPurple = $0C;
{@@ Index of <b>teal</b> color in the standard color palettes }
scTeal = $0D; scTeal = $0D;
{@@ Index of <b>silver</b> color in the standard color palettes }
scSilver = $0E; scSilver = $0E;
scGrey = $0F; scGray = $0F; // redefine to allow different spelling {@@ Index of <b>grey</b> color in the standard color palettes }
scGrey10pct = $10; scGray10pct = $10; scGrey = $0F;
scGrey20pct = $11; scGray20pct = $11; {@@ Index of <b>gray</b> color in the standard color palettes }
scGray = $0F; // redefine to allow different spelling
{@@ Index of a <b>10% grey</b> color in the standard color palettes }
scGrey10pct = $10;
{@@ Index of a <b>10% gray</b> color in the standard color palettes }
scGray10pct = $10;
{@@ Index of a <b>20% grey</b> color in the standard color palettes }
scGrey20pct = $11;
{@@ Index of a <b>20% gray</b> color in the standard color palettes }
scGray20pct = $11;
{@@ Index of <b>orange</b> color in the standard color palettes }
scOrange = $12; scOrange = $12;
{@@ Index of <b>dark brown</b> color in the standard color palettes }
scDarkbrown = $13; scDarkbrown = $13;
{@@ Index of <b>brown</b> color in the standard color palettes }
scBrown = $14; scBrown = $14;
{@@ Index of <b>beige</b> color in the standard color palettes }
scBeige = $15; scBeige = $15;
{@@ Index of <b>"wheat"</b> color (yellow-orange) in the standard color palettes }
scWheat = $16; scWheat = $16;
// not sure - but I think the mechanism with scRGBColor is not working... // not sure - but I think the mechanism with scRGBColor is not working...
// Will be removed sooner or later... // Will be removed sooner or later...
scRGBColor = $FFFF; scRGBColor = $FFFF;
{@@ Identifier for transparent color }
scTransparent = $FFFE; scTransparent = $FFFE;
{@@ Identifier for not-defined color }
scNotDefined = $FFFF; scNotDefined = $FFFF;
type type
@ -442,15 +469,13 @@ type
{@@ Pointer to a TCol record } {@@ Pointer to a TCol record }
PCol = ^TCol; PCol = ^TCol;
{@@ Sort options } {@@ Options for sorting }
TsSortOption = (ssoDescending, ssoCaseInsensitive); TsSortOption = (ssoDescending, ssoCaseInsensitive);
{@@ Set of options for sorting }
TsSortOptions = set of TsSortOption; TsSortOptions = set of TsSortOption;
// {@@ Sort order }
// TsSortOrder = (ssoAscending, ssoDescending);
{@@ Sort priority } {@@ Sort priority }
TsSortPriority = (spNumAlpha, spAlphaNum); // NumAlph = "number < alpha" TsSortPriority = (spNumAlpha, spAlphaNum); // spNumAlpha: Number < Text
{@@ Sort key: sorted column or row index and sort direction } {@@ Sort key: sorted column or row index and sort direction }
TsSortKey = record TsSortKey = record
@ -1421,8 +1446,8 @@ end;
{@@ ---------------------------------------------------------------------------- {@@ ----------------------------------------------------------------------------
If a palette is coded as big-endian (e.g. by copying the rgb values from If a palette is coded as big-endian (e.g. by copying the rgb values from
the OpenOffice doc) the palette values can be converted by means of this the OpenOffice documentation) the palette values can be converted by means
procedure to little-endian which is required internally by TsWorkbook. of this procedure to little-endian which is required internally by TsWorkbook.
@param APalette Pointer to the palette to be converted. After conversion, @param APalette Pointer to the palette to be converted. After conversion,
its color values are replaced. its color values are replaced.
@ -1441,8 +1466,8 @@ end;
{@@ ---------------------------------------------------------------------------- {@@ ----------------------------------------------------------------------------
Copies the format of a cell to another one. Copies the format of a cell to another one.
@param AFromCell cell from which the format is to be copied @param AFromCell Cell from which the format is to be copied
@param AToCell cell to which the format is to be copied @param AToCell Cell to which the format is to be copied
-------------------------------------------------------------------------------} -------------------------------------------------------------------------------}
procedure CopyCellFormat(AFromCell, AToCell: PCell); procedure CopyCellFormat(AFromCell, AToCell: PCell);
begin begin
@ -1463,6 +1488,9 @@ end;
{@@ ---------------------------------------------------------------------------- {@@ ----------------------------------------------------------------------------
Checks whether two cells have same border attributes Checks whether two cells have same border attributes
@param ACell1 Pointer to the first one of the two cells to be compared
@param ACell2 Pointer to the second one of the two cells to be compared
-------------------------------------------------------------------------------} -------------------------------------------------------------------------------}
function SameCellBorders(ACell1, ACell2: PCell): Boolean; function SameCellBorders(ACell1, ACell2: PCell): Boolean;
@ -1499,7 +1527,7 @@ begin
end; end;
{@@ ---------------------------------------------------------------------------- {@@ ----------------------------------------------------------------------------
Initalizes a new cell Initalizes a new cell.
@return New cell record @return New cell record
-------------------------------------------------------------------------------} -------------------------------------------------------------------------------}
procedure InitCell(out ACell: TCell); procedure InitCell(out ACell: TCell);
@ -1512,11 +1540,11 @@ end;
{@@ ---------------------------------------------------------------------------- {@@ ----------------------------------------------------------------------------
Initalizes a new cell and presets the row and column fields of the cell record Initalizes a new cell and presets the row and column fields of the cell record
to the parameters passesd to the procedure. to the parameters passed to the procedure.
@param ARow Row index of the new cell @param ARow Row index of the new cell
@param ACol Column index of the new cell @param ACol Column index of the new cell
@return New cell record with row and column fields preset to passed parameters. @return New cell record with row and column fields preset to passed values.
-------------------------------------------------------------------------------} -------------------------------------------------------------------------------}
procedure InitCell(ARow, ACol: Cardinal; out ACell: TCell); procedure InitCell(ARow, ACol: Cardinal; out ACell: TCell);
begin begin
@ -1527,6 +1555,8 @@ end;
{@@ ---------------------------------------------------------------------------- {@@ ----------------------------------------------------------------------------
Returns TRUE if the cell contains a formula (direct or shared, does not matter). Returns TRUE if the cell contains a formula (direct or shared, does not matter).
@param ACell Pointer to the cell checked
-------------------------------------------------------------------------------} -------------------------------------------------------------------------------}
function HasFormula(ACell: PCell): Boolean; function HasFormula(ACell: PCell): Boolean;
begin begin
@ -1603,7 +1633,8 @@ end;
formula. This is needed, for example, when writing a formula to xls biff formula. This is needed, for example, when writing a formula to xls biff
file format. file format.
If the cell belongs to a shared formula the formula is taken from the If the cell belongs to a shared formula the formula is taken from the
shared formula base cell, cell references used are adapted accordingly. shared formula base cell, cell references are adapted accordingly to the
location of the cell.
-------------------------------------------------------------------------------} -------------------------------------------------------------------------------}
function TsWorksheet.BuildRPNFormula(ACell: PCell): TsRPNFormula; function TsWorksheet.BuildRPNFormula(ACell: PCell): TsRPNFormula;
var var
@ -1707,6 +1738,14 @@ end;
{@@ ---------------------------------------------------------------------------- {@@ ----------------------------------------------------------------------------
Calculates all formulas of the worksheet. Calculates all formulas of the worksheet.
Since formulas may reference not-yet-calculated cells, this occurs in
two steps:
1. All formula cells are marked as "not calculated".
2. Cells are calculated. If referenced cells are found as being
"not calculated" they are calculated and then tagged as "calculated".
This results in an iterative calculation procedure. In the end, all cells
are calculated.
-------------------------------------------------------------------------------} -------------------------------------------------------------------------------}
procedure TsWorksheet.CalcFormulas; procedure TsWorksheet.CalcFormulas;
var var

386
components/fpspreadsheet/fpspreadsheetctrls.pas
View File

@ -1,3 +1,24 @@
{ fpspreadsheetctrls }
{@@ ----------------------------------------------------------------------------
Unit fpspreadsheetctrls implements some visual controls which help to create
a spreadsheet application without writing too much code.
AUTHORS: Werner Pamler
LICENSE: See the file COPYING.modifiedLGPL.txt, included in the Lazarus
distribution, for details about the license.
EXAMPLE
* Add a WorkbookSource component to the form.
* Add a WorksheetTabControl
* Add a WorksheetGrid (from unit fpspreadsheetgrid)
* Link their WorkbookSource properties to the added WorkbookSource component
* Set the property FileName of the WorkbookSource to a spreadsheet file.
--> The WorksheetTabControl displays tabs for each worksheet in the file, and
the WorksheetGrid displays the worksheet according to the selected tab.
-------------------------------------------------------------------------------}
unit fpspreadsheetctrls; unit fpspreadsheetctrls;
{$mode objfpc}{$H+} {$mode objfpc}{$H+}
@ -9,15 +30,24 @@ uses
fpspreadsheet, {%H-}fpsAllFormats; fpspreadsheet, {%H-}fpsAllFormats;
type type
{@@ Event handler procedure for displaying a message if an error or
warning occurs during reading of a workbook. }
TsWorkbookSourceErrorEvent = procedure (Sender: TObject; TsWorkbookSourceErrorEvent = procedure (Sender: TObject;
const AMsg: String) of object; const AMsg: String) of object;
{@@ Describes during communication between WorkbookSource and visual controls
which kind of item has changed: the workbook, the worksheet, a cell value,
or a cell formatting }
TsNotificationItem = (lniWorkbook, lniWorksheet, lniCell, lniSelection); TsNotificationItem = (lniWorkbook, lniWorksheet, lniCell, lniSelection);
{@@ This set accompanies the notification between WorkbookSource and visual
controls and describes which items have changed in the spreadsheet. }
TsNotificationItems = set of TsNotificationItem; TsNotificationItems = set of TsNotificationItem;
{ TsWorkbookSource } { TsWorkbookSource }
{@@ TsWorkbookSource links a workbook to the visual spreadsheet controls and
help to display or edit the workbook without written code. }
TsWorkbookSource = class(TComponent) TsWorkbookSource = class(TComponent)
private private
FWorkbook: TsWorkbook; FWorkbook: TsWorkbook;
@ -67,20 +97,36 @@ type
procedure SelectWorksheet(AWorkSheet: TsWorksheet); procedure SelectWorksheet(AWorkSheet: TsWorksheet);
public public
{@@ Workbook linked to the WorkbookSource }
property Workbook: TsWorkbook read FWorkbook; property Workbook: TsWorkbook read FWorkbook;
{@@ Currently selected worksheet of the workbook }
property Worksheet: TsWorksheet read FWorksheet; property Worksheet: TsWorksheet read FWorksheet;
published published
{@@ Automatically detects the fileformat when loading the spreadsheet file
specified by FileName }
property AutoDetectFormat: Boolean read FAutoDetectFormat write FAutoDetectFormat; property AutoDetectFormat: Boolean read FAutoDetectFormat write FAutoDetectFormat;
{@@ File format of the next spreadsheet file to be loaded by means of the
Filename property. Not used when AutoDetecteFormat is TRUE. }
property FileFormat: TsSpreadsheetFormat read FFileFormat write FFileFormat default sfExcel8; property FileFormat: TsSpreadsheetFormat read FFileFormat write FFileFormat default sfExcel8;
{@@ Name of the loaded spreadsheet file which is loaded by assigning a file name
to this property. Format detection is determined by the properties
AutoDetectFormat and FileFormat. }
property FileName: TFileName read FFileName write SetFileName; // using this property loads the file at design-time! property FileName: TFileName read FFileName write SetFileName; // using this property loads the file at design-time!
{@@ A set of options to be transferred to the workbook, for e.g. formula
calculation etc. }
property Options: TsWorkbookOptions read FOptions write SetOptions; property Options: TsWorkbookOptions read FOptions write SetOptions;
{@@ A message box is displayey if an error occurs during loading of a
spreadsheet. This behavior can be replaced by means of the event OnError. }
property OnError: TsWorkbookSourceErrorEvent read FOnError write FOnError; property OnError: TsWorkbookSourceErrorEvent read FOnError write FOnError;
end; end;
{ TsWorkbookTabControl } { TsWorkbookTabControl }
{@@ TsWorkbookTabControl is a tab control which displays the sheets of the
workbook currently loaded by the WorkbookSource in tabs. Selecting another
tab is communicated to other spreadsheet controls via the WorkbookSource. }
TsWorkbookTabControl = class(TTabControl) TsWorkbookTabControl = class(TTabControl)
private private
FWorkbookSource: TsWorkbookSource; FWorkbookSource: TsWorkbookSource;
@ -95,15 +141,20 @@ type
destructor Destroy; override; destructor Destroy; override;
procedure ListenerNotification(AChangedItems: TsNotificationItems; procedure ListenerNotification(AChangedItems: TsNotificationItems;
AData: Pointer = nil); AData: Pointer = nil);
{@@ The worksheet names of this workbook are currently displayed as tabs of the TabControl. }
property Workbook: TsWorkbook read GetWorkbook; property Workbook: TsWorkbook read GetWorkbook;
{@@ Identifies the worksheet which corresponds to the selected tab }
property Worksheet: TsWorksheet read GetWorksheet; property Worksheet: TsWorksheet read GetWorksheet;
published published
{@@ Link to the WorkbookSource which provides the data. }
property WorkbookSource: TsWorkbookSource read FWorkbookSource write SetWorkbookSource; property WorkbookSource: TsWorkbookSource read FWorkbookSource write SetWorkbookSource;
end; end;
{ TsCellEdit } { TsCellEdit }
{@@ TsCellEdit allows to edit the content or formula of the active cell of a
worksheet, simular to Excel's cell editor above the cell grid. }
TsCellEdit = class(TMemo) TsCellEdit = class(TMemo)
private private
FWorkbookSource: TsWorkbookSource; FWorkbookSource: TsWorkbookSource;
@ -120,16 +171,24 @@ type
procedure EditingDone; override; procedure EditingDone; override;
procedure ListenerNotification(AChangedItems: TsNotificationItems; procedure ListenerNotification(AChangedItems: TsNotificationItems;
AData: Pointer = nil); AData: Pointer = nil);
{@@ Pointer to the currently active cell in the workbook. This cell is
displayed in the control and can be edited. }
property SelectedCell: PCell read GetSelectedCell; property SelectedCell: PCell read GetSelectedCell;
{@@ Refers to the underlying workbook to which the edited cell belongs. }
property Workbook: TsWorkbook read GetWorkbook; property Workbook: TsWorkbook read GetWorkbook;
{@@ Refers to the underlying worksheet to which the edited cell belongs. }
property Worksheet: TsWorksheet read GetWorksheet; property Worksheet: TsWorksheet read GetWorksheet;
published published
{@@ Link to the WorkbookSource which provides the workbook and worksheet. }
property WorkbookSource: TsWorkbookSource read FWorkbookSource write SetWorkbookSource; property WorkbookSource: TsWorkbookSource read FWorkbookSource write SetWorkbookSource;
end; end;
{ TsCellIndicator } { TsCellIndicator }
{@@ TsCellIndicator displays the address of the currently active cell of the
worksheet and workbook. Editing the address allows to jump to the corresponding
cell. }
TsCellIndicator = class(TEdit) TsCellIndicator = class(TEdit)
private private
FWorkbookSource: TsWorkbookSource; FWorkbookSource: TsWorkbookSource;
@ -144,17 +203,27 @@ type
procedure EditingDone; override; procedure EditingDone; override;
procedure ListenerNotification(AChangedItems: TsNotificationItems; procedure ListenerNotification(AChangedItems: TsNotificationItems;
AData: Pointer = nil); AData: Pointer = nil);
{@@ Refers to the underlying worksheet to which the edited cell belongs. }
property Workbook: TsWorkbook read GetWorkbook; property Workbook: TsWorkbook read GetWorkbook;
{@@ Refers to the underlying worksheet to which the edited cell belongs. }
property Worksheet: TsWorksheet read GetWorksheet; property Worksheet: TsWorksheet read GetWorksheet;
published published
{@@ Link to the WorkbookSource which provides the workbook and worksheet. }
property WorkbookSource: TsWorkbookSource read FWorkbookSource write SetWorkbookSource; property WorkbookSource: TsWorkbookSource read FWorkbookSource write SetWorkbookSource;
{@@ Inherited from TEdit, overridden to center the text in the control by default }
property Alignment default taCenter; property Alignment default taCenter;
end; end;
{ TsSpreadsheetInspector } { TsSpreadsheetInspector }
{@@ Classification of data displayed by the SpreadsheetInspector. Each item
can be assigned to a tab of a TabControl. }
TsInspectorMode = (imWorkbook, imWorksheet, imCellValue, imCellProperties); TsInspectorMode = (imWorkbook, imWorksheet, imCellValue, imCellProperties);
{@@ TsSpreadsheetInspector displays all properties of a workbook, worksheet,
cell content and cell formatting in a way similar to the Object Inspector
of Lazarus. }
TsSpreadsheetInspector = class(TValueListEditor) TsSpreadsheetInspector = class(TValueListEditor)
private private
FWorkbookSource: TsWorkbookSource; FWorkbookSource: TsWorkbookSource;
@ -175,12 +244,20 @@ type
destructor Destroy; override; destructor Destroy; override;
procedure ListenerNotification(AChangedItems: TsNotificationItems; procedure ListenerNotification(AChangedItems: TsNotificationItems;
AData: Pointer = nil); AData: Pointer = nil);
{@@ Refers to the underlying workbook which is displayed by the inspector. }
property Workbook: TsWorkbook read GetWorkbook; property Workbook: TsWorkbook read GetWorkbook;
{@@ Refers to the underlying worksheet which is displayed by the inspector. }
property Worksheet: TsWorksheet read GetWorksheet; property Worksheet: TsWorksheet read GetWorksheet;
published published
{@@ Refers to the underlying worksheet from which the active cell is taken }
property WorkbookSource: TsWorkbookSource read FWorkbookSource write SetWorkbookSource; property WorkbookSource: TsWorkbookSource read FWorkbookSource write SetWorkbookSource;
{@@ Classification of data displayed by the SpreadsheetInspector. Each mode
can be assigned to a tab of a TabControl. }
property Mode: TsInspectorMode read FMode write SetMode; property Mode: TsInspectorMode read FMode write SetMode;
{@@ inherited from TValueListEditor, activates column titles and automatic
column width adjustment by default }
property DisplayOptions default [doColumnTitles, doAutoColResize]; property DisplayOptions default [doColumnTitles, doAutoColResize];
{@@ inherited from TValueListEditor. Turns of the fixed column by default}
property FixedCols default 0; property FixedCols default 0;
end; end;
@ -211,8 +288,11 @@ end;
{------------------------------------------------------------------------------} {------------------------------------------------------------------------------}
{@@ ---------------------------------------------------------------------------- {@@ ----------------------------------------------------------------------------
Constructor of the workbook source class. Creates the internal list for the Constructor of the WorkbookSource class. Creates the internal list for the
notified ("listening") components, and creates an empty workbook. notified ("listening") components, and creates an empty workbook.
@param AOwner Component which is responsibile for destroying the
WorkbookSource.
-------------------------------------------------------------------------------} -------------------------------------------------------------------------------}
constructor TsWorkbookSource.Create(AOwner: TComponent); constructor TsWorkbookSource.Create(AOwner: TComponent);
begin begin
@ -223,8 +303,8 @@ begin
end; end;
{@@ ---------------------------------------------------------------------------- {@@ ----------------------------------------------------------------------------
Destructor of the workbook source. Cleans up the of listening component list Destructor of the WorkbookSource class.
and destroys the linked workbook. Cleans up the of listening component list and destroys the linked workbook.
-------------------------------------------------------------------------------} -------------------------------------------------------------------------------}
destructor TsWorkbookSource.Destroy; destructor TsWorkbookSource.Destroy;
var var
@ -241,10 +321,10 @@ begin
end; end;
{@@ ---------------------------------------------------------------------------- {@@ ----------------------------------------------------------------------------
Adds a component to the list of listeners. All these components are Adds a component to the listener list. All these components are notified of
notified of changes in the workbook. changes in the workbook.
@param AListener Component to be added to the listener list notified for @param AListener Component to be added to the listener list notified of
changes changes
-------------------------------------------------------------------------------} -------------------------------------------------------------------------------}
procedure TsWorkbookSource.AddListener(AListener: TComponent); procedure TsWorkbookSource.AddListener(AListener: TComponent);
@ -254,7 +334,7 @@ begin
end; end;
{@@ ---------------------------------------------------------------------------- {@@ ----------------------------------------------------------------------------
Event handler for the OnChange event of TsWorksheet which is fired whenver Event handler for the OnChangeCell event of TsWorksheet which is fired whenver
cell content or formatting changes. cell content or formatting changes.
@param Sender Pointer to the worksheet @param Sender Pointer to the worksheet
@ -274,8 +354,8 @@ end;
of the changed selection. of the changed selection.
@param Sender Pointer to the worksheet @param Sender Pointer to the worksheet
@param ARow Row index (in sheet notation) of the cell selected @param ARow Row index (in sheet notation) of the newly selected cell
@param ACol Column index (in sheet notation) of the cell selected @param ACol Column index (in sheet notation) of the newly selected cell
-------------------------------------------------------------------------------} -------------------------------------------------------------------------------}
procedure TsWorkbookSource.CellSelectedHandler(Sender: TObject; procedure TsWorkbookSource.CellSelectedHandler(Sender: TObject;
ARow, ACol: Cardinal); ARow, ACol: Cardinal);
@ -297,9 +377,15 @@ begin
NotifyListeners([lniWorkbook, lniWorksheet, lniSelection]); NotifyListeners([lniWorkbook, lniWorksheet, lniSelection]);
end; end;
{ An error has occured during loading of the workbook. Shows a message box by {@@ ----------------------------------------------------------------------------
An error has occured during loading of the workbook. Shows a message box by
default. But a different behavior can be obtained by means of the OnError default. But a different behavior can be obtained by means of the OnError
event. } event.
@param AErrorMsg Error message text created by the workbook reader and to be
displayed in a messagebox or by means of the OnError
handler.
-------------------------------------------------------------------------------}
procedure TsWorkbookSource.DoShowError(const AErrorMsg: String); procedure TsWorkbookSource.DoShowError(const AErrorMsg: String);
begin begin
if Assigned(FOnError) then if Assigned(FOnError) then
@ -309,7 +395,7 @@ begin
end; end;
{@@ ---------------------------------------------------------------------------- {@@ ----------------------------------------------------------------------------
Helper method which creates a new workbook without sheets Internal helper method which creates a new workbook without sheets
-------------------------------------------------------------------------------} -------------------------------------------------------------------------------}
procedure TsWorkbookSource.InternalCreateNewWorkbook; procedure TsWorkbookSource.InternalCreateNewWorkbook;
begin begin
@ -330,12 +416,13 @@ end;
@param AFilename Name of the spreadsheet file to be loaded @param AFilename Name of the spreadsheet file to be loaded
@param AAutoDetect Instructs the loader to automatically detect the @param AAutoDetect Instructs the loader to automatically detect the
file format from the extension or by temporarily file format from the file extension or by temporarily
opening the file in all available formats. Note that opening the file in all available formats. Note that
an exception is raised in the IDE when an incorrect an exception is raised in the IDE when an incorrect
format is tested. format is tested.
@param AFormat Spreadsheet file format assumed @param AFormat Spreadsheet file format assumed for the loadeder.
@param AWorksheetIndex Index of the worksheet to be loaded from the file Is ignored when AAutoDetect is false.
@param AWorksheetIndex Index of the worksheet to be selected after loading.
-------------------------------------------------------------------------------} -------------------------------------------------------------------------------}
procedure TsWorkbookSource.InternalLoadFromFile(AFileName: string; procedure TsWorkbookSource.InternalLoadFromFile(AFileName: string;
AAutoDetect: Boolean; AFormat: TsSpreadsheetFormat; AWorksheetIndex: Integer = 0); AAutoDetect: Boolean; AFormat: TsSpreadsheetFormat; AWorksheetIndex: Integer = 0);
@ -359,8 +446,10 @@ begin
end; end;
{@@ ---------------------------------------------------------------------------- {@@ ----------------------------------------------------------------------------
Inherited method which is called after loading from the lfm file. Inherited method which is called after reading the WorkbookSource from the lfm
Is overridden here to open a spreadsheet file specified at design-time. file.
Is overridden here to open a spreadsheet file if a file name has been assigned
to the FileName property at design-time.
-------------------------------------------------------------------------------} -------------------------------------------------------------------------------}
procedure TsWorkbookSource.Loaded; procedure TsWorkbookSource.Loaded;
begin begin
@ -374,7 +463,7 @@ end;
@param AFilename Name of the spreadsheet file to be loaded @param AFilename Name of the spreadsheet file to be loaded
@param AFormat Spreadsheet file format assumed for the file @param AFormat Spreadsheet file format assumed for the file
@param AWorksheetIndex Index of the worksheet to be loaded from the file @param AWorksheetIndex Index of the worksheet to be selected after loading.
-------------------------------------------------------------------------------} -------------------------------------------------------------------------------}
procedure TsWorkbookSource.LoadFromSpreadsheetFile(AFileName: string; procedure TsWorkbookSource.LoadFromSpreadsheetFile(AFileName: string;
AFormat: TsSpreadsheetFormat; AWorksheetIndex: Integer = 0); AFormat: TsSpreadsheetFormat; AWorksheetIndex: Integer = 0);
@ -382,15 +471,15 @@ begin
InternalLoadFromFile(AFileName, false, AFormat, AWorksheetIndex); InternalLoadFromFile(AFileName, false, AFormat, AWorksheetIndex);
end; end;
{ ------------------------------------------------------------------------------ {@@ ------------------------------------------------------------------------------
Public spreadsheet loader to be used if file format is not known. The file Public spreadsheet loader to be used if file format is not known. The file
format is determined from the file extension, or - if this is valid for format is determined from the file extension, or - if this is holds for
several formats (such as .xls) - by assuming a format. Note that exceptions several formats (such as .xls) - by assuming a format. Note that exceptions
are raised in the IDE if in incorrect format is tested. This does not occur are raised in the IDE if in incorrect format is tested. This does not occur
outside the IDE: outside the IDE.
@param AFilename Name of the spreadsheet file to be loaded @param AFilename Name of the spreadsheet file to be loaded
@param AWorksheetIndex Index of the worksheet to be loaded from the file @param AWorksheetIndex Index of the worksheet to be selected after loading.
-------------------------------------------------------------------------------} -------------------------------------------------------------------------------}
procedure TsWorkbookSource.LoadFromSpreadsheetFile(AFileName: string; procedure TsWorkbookSource.LoadFromSpreadsheetFile(AFileName: string;
AWorksheetIndex: Integer = 0); AWorksheetIndex: Integer = 0);
@ -406,12 +495,12 @@ end;
Notifies listeners of workbook, worksheet, cell, or selection changes. Notifies listeners of workbook, worksheet, cell, or selection changes.
The changed item is identified by the parameter AChangedItems. The changed item is identified by the parameter AChangedItems.
@param AChangedItems A set containing elements lniWorkbook, lniWorksheet, @param AChangedItems A set of elements lniWorkbook, lniWorksheet,
lniCell, lniSelection which indicate which item has lniCell, lniSelection which indicate which item has
changed. changed.
@param AData Additional data on the change. Is used only for @param AData Additional information on the change. Is used only for
lniCell and points to the cell with changed value or lniCell and points to the cell having a changed value
formatting. or formatting.
-------------------------------------------------------------------------------} -------------------------------------------------------------------------------}
procedure TsWorkbookSource.NotifyListeners(AChangedItems: TsNotificationItems; procedure TsWorkbookSource.NotifyListeners(AChangedItems: TsNotificationItems;
AData: Pointer = nil); AData: Pointer = nil);
@ -445,7 +534,7 @@ end;
Removes a component from the listener list. The component is no longer Removes a component from the listener list. The component is no longer
notified of changes in workbook, worksheet or cells notified of changes in workbook, worksheet or cells
@param AComponent Component to be removed @param AListener Listening component to be removed
-------------------------------------------------------------------------------} -------------------------------------------------------------------------------}
procedure TsWorkbookSource.RemoveListener(AListener: TComponent); procedure TsWorkbookSource.RemoveListener(AListener: TComponent);
var var
@ -479,8 +568,7 @@ begin
end; end;
{@@ ---------------------------------------------------------------------------- {@@ ----------------------------------------------------------------------------
Writes the workbook loaded into the WorkbookSource component to a Writes the workbook of the WorkbookSource component to a spreadsheet file.
spreadsheet file.
@param AFileName Name of the file to which the workbook is to be @param AFileName Name of the file to which the workbook is to be
saved. saved.
@ -498,8 +586,10 @@ begin
end; end;
{@@ ---------------------------------------------------------------------------- {@@ ----------------------------------------------------------------------------
Saves the workbook into a file with the specified file name. If this file Saves the workbook into a file with the specified file name.
name already exists the file is overwritten if AOverwriteExisting is true. The file format is determined automatically from the extension.
If this file name already exists the file is overwritten
if AOverwriteExisting is true.
@param AFileName Name of the file to which the workbook is to be @param AFileName Name of the file to which the workbook is to be
saved saved
@ -518,8 +608,9 @@ end;
{@@ ---------------------------------------------------------------------------- {@@ ----------------------------------------------------------------------------
Usually called by code or from the spreadsheet grid component. The Usually called by code or from the spreadsheet grid component. The
method identifies a cell as "selected". Stores its coordinates in the method identifies a cell to be "selected".
worksheet and notifies the controls Stores its coordinates in the worksheet ("active cell") and notifies the
listening controls
-------------------------------------------------------------------------------} -------------------------------------------------------------------------------}
procedure TsWorkbookSource.SelectCell(ASheetRow, ASheetCol: Cardinal); procedure TsWorkbookSource.SelectCell(ASheetRow, ASheetCol: Cardinal);
begin begin
@ -532,30 +623,23 @@ end;
Selects a worksheet and notifies the controls. This method is usually called Selects a worksheet and notifies the controls. This method is usually called
by code or from the worksheet tabcontrol. by code or from the worksheet tabcontrol.
@param AWorksheet Instsance of the newly selected worksheet. @param AWorksheet Instance of the newly selected worksheet.
-------------------------------------------------------------------------------} -------------------------------------------------------------------------------}
procedure TsWorkbookSource.SelectWorksheet(AWorkSheet: TsWorksheet); procedure TsWorkbookSource.SelectWorksheet(AWorkSheet: TsWorksheet);
begin begin
FWorksheet := AWorksheet; FWorksheet := AWorksheet;
if (FWorkbook <> nil) then if (FWorkbook <> nil) then
FWorkbook.SelectWorksheet(AWorksheet); FWorkbook.SelectWorksheet(AWorksheet);
{
if AWorksheet = nil then
exit;
FWorksheet := AWorkSheet;
FWorksheet.OnChangeCell := @CellChangedHandler;
FWorksheet.OnSelectCell := @CellSelectedHandler;
NotifyListeners([lniWorksheet]);
SelectCell(FWorksheet.ActiveCellRow, FWorksheet.ActiveCellCol);
}
end; end;
{@@ ---------------------------------------------------------------------------- {@@ ----------------------------------------------------------------------------
Setter for the file name property. Loads the spreadsheet file and uses the Setter for the file name property. Loads the spreadsheet file and uses the
values of the properties AutoDetectFormat and FileFormat. values of the properties AutoDetectFormat or FileFormat.
Useful if the spreadsheet is to be loaded at design time. Useful if the spreadsheet is to be loaded already at design time.
But note that an exception can be raised if the file format cannot be But note that an exception can be raised if the file format cannot be
determined from the file extension alone. determined from the file extension alone.
@param AFileName Name of the spreadsheet file to be loaded.
-------------------------------------------------------------------------------} -------------------------------------------------------------------------------}
procedure TsWorkbookSource.SetFileName(const AFileName: TFileName); procedure TsWorkbookSource.SetFileName(const AFileName: TFileName);
begin begin
@ -590,6 +674,9 @@ end;
{@@ ---------------------------------------------------------------------------- {@@ ----------------------------------------------------------------------------
Event handler called whenever a new worksheet is added to the workbook Event handler called whenever a new worksheet is added to the workbook
@param Sender Pointer to the workbook to which a new worksheet has been added
@param ASheet Worksheet which is added to the workbook.
-------------------------------------------------------------------------------} -------------------------------------------------------------------------------}
procedure TsWorkbookSource.WorksheetAddedHandler(Sender: TObject; procedure TsWorkbookSource.WorksheetAddedHandler(Sender: TObject;
ASheet: TsWorksheet); ASheet: TsWorksheet);
@ -599,8 +686,11 @@ begin
end; end;
{@@ ---------------------------------------------------------------------------- {@@ ----------------------------------------------------------------------------
Event handler canned whenever worksheet properties changed. Currently only Event handler canned whenever worksheet properties have changed.
for changing the workbook name. Currently only used for changing the workbook name.
@param Sender Workbook containing the modified worksheet
@param ASheet Worksheet which has been modified
-------------------------------------------------------------------------------} -------------------------------------------------------------------------------}
procedure TsWorkbookSource.WorksheetChangedHandler(Sender: TObject; procedure TsWorkbookSource.WorksheetChangedHandler(Sender: TObject;
ASheet: TsWorksheet); ASheet: TsWorksheet);
@ -613,6 +703,8 @@ end;
Event handler called AFTER a worksheet has been removed (deleted) from Event handler called AFTER a worksheet has been removed (deleted) from
the workbook the workbook
@param Sender Points to the workbook from which the sheet has been
deleted
@param ASheetIndex Index of the sheet that was deleted. The sheet itself @param ASheetIndex Index of the sheet that was deleted. The sheet itself
does not exist any more. does not exist any more.
-------------------------------------------------------------------------------} -------------------------------------------------------------------------------}
@ -642,6 +734,9 @@ end;
{@@ ---------------------------------------------------------------------------- {@@ ----------------------------------------------------------------------------
Event handler called whenever a the workbook makes a worksheet "active". Event handler called whenever a the workbook makes a worksheet "active".
@param Sender Workbook containing the worksheet
@param AWorksheet Worksheet which has been activated
-------------------------------------------------------------------------------} -------------------------------------------------------------------------------}
procedure TsWorkbookSource.WorksheetSelectedHandler(Sender: TObject; procedure TsWorkbookSource.WorksheetSelectedHandler(Sender: TObject;
AWorksheet: TsWorksheet); AWorksheet: TsWorksheet);
@ -663,8 +758,8 @@ end;
{------------------------------------------------------------------------------} {------------------------------------------------------------------------------}
{@@ ---------------------------------------------------------------------------- {@@ ----------------------------------------------------------------------------
Destructor of the WorkbookTabControl. Removes itself from the Destructor of the WorkbookTabControl.
WorkbookSource's listener list. Removes itself from the WorkbookSource's listener list.
-------------------------------------------------------------------------------} -------------------------------------------------------------------------------}
destructor TsWorkbookTabControl.Destroy; destructor TsWorkbookTabControl.Destroy;
begin begin
@ -684,7 +779,8 @@ begin
end; end;
{@@ ---------------------------------------------------------------------------- {@@ ----------------------------------------------------------------------------
Creates a (string) list containing the names of the workbook's sheet names Creates a (string) list containing the names of the workbook's sheet names.
Is called whenever the workbook changes.
-------------------------------------------------------------------------------} -------------------------------------------------------------------------------}
procedure TsWorkbookTabControl.GetSheetList(AList: TStrings); procedure TsWorkbookTabControl.GetSheetList(AList: TStrings);
var var
@ -695,26 +791,7 @@ begin
for i:=0 to Workbook.GetWorksheetCount-1 do for i:=0 to Workbook.GetWorksheetCount-1 do
AList.Add(Workbook.GetWorksheetByIndex(i).Name); AList.Add(Workbook.GetWorksheetByIndex(i).Name);
end; end;
{
procedure TsWorkbookTabControl.GetSheetList(AList: TStrings);
var
i: Integer;
oldTabIndex: Integer;
begin
oldTabIndex := TabIndex;
AList.BeginUpdate;
try
AList.Clear;
if Workbook <> nil then
for i:=0 to Workbook.GetWorksheetCount-1 do
AList.Add(Workbook.GetWorksheetByIndex(i).Name);
finally
AList.EndUpdate;
if oldtabIndex < AList.Count then
TabIndex := oldTabIndex;
end;
end;
}
{@@ ---------------------------------------------------------------------------- {@@ ----------------------------------------------------------------------------
Getter method for property "Workbook" Getter method for property "Workbook"
-------------------------------------------------------------------------------} -------------------------------------------------------------------------------}
@ -743,6 +820,10 @@ end;
Responds to workbook changes by reading the worksheet names into the tabs, Responds to workbook changes by reading the worksheet names into the tabs,
and to worksheet changes by selecting the tab corresponding to the selected and to worksheet changes by selecting the tab corresponding to the selected
worksheet. worksheet.
@param AChangedItems Set with elements identifying whether workbook, worksheet
cell content or cell formatting has changed
@param AData Additional data, not used here
-------------------------------------------------------------------------------} -------------------------------------------------------------------------------}
procedure TsWorkbookTabControl.ListenerNotification( procedure TsWorkbookTabControl.ListenerNotification(
AChangedItems: TsNotificationItems; AData: Pointer = nil); AChangedItems: TsNotificationItems; AData: Pointer = nil);
@ -780,19 +861,6 @@ begin
if i <> TabIndex then if i <> TabIndex then
TabIndex := i; TabIndex := i;
end; end;
{
// Workbook changed
if (lniWorkbook in AChangedItems) then
GetSheetList(Tabs);
// Worksheet changed
if (lniWorksheet in AChangedItems) and (Worksheet <> nil) then
begin
i := Tabs.IndexOf(Worksheet.Name);
if i <> TabIndex then
TabIndex := i;
end;
}
end; end;
{@@ ---------------------------------------------------------------------------- {@@ ----------------------------------------------------------------------------
@ -831,6 +899,8 @@ end;
Constructor of the spreadsheet edit control. Disables RETURN and TAB keys. Constructor of the spreadsheet edit control. Disables RETURN and TAB keys.
RETURN characters can still be entered into the edited text by pressing RETURN characters can still be entered into the edited text by pressing
CTRL+RETURN CTRL+RETURN
@param AOwner Component which is responsible to destroy the CellEdit
-------------------------------------------------------------------------------} -------------------------------------------------------------------------------}
constructor TsCellEdit.Create(AOwner: TComponent); constructor TsCellEdit.Create(AOwner: TComponent);
begin begin
@ -854,8 +924,8 @@ end;
EditingDone is called when the user presses the RETURN key to finish editing, EditingDone is called when the user presses the RETURN key to finish editing,
or the TAB key which removes focus from the control, or clicks somewhere else or the TAB key which removes focus from the control, or clicks somewhere else
The edited text is written to the worksheet which tries to figure out the The edited text is written to the worksheet which tries to figure out the
data type. In particular, if the text begins with an "=" sign then the text data type. In particular, if the text begins with an equal sign ("=") then
is written as a formula. the text is assumed to be a formula.
-------------------------------------------------------------------------------} -------------------------------------------------------------------------------}
procedure TsCellEdit.EditingDone; procedure TsCellEdit.EditingDone;
var var
@ -875,7 +945,7 @@ end;
{@@ ---------------------------------------------------------------------------- {@@ ----------------------------------------------------------------------------
Getter method for the property SelectedCell which points to the currently Getter method for the property SelectedCell which points to the currently
selected cell in the selected worksheet active cell in the selected worksheet
-------------------------------------------------------------------------------} -------------------------------------------------------------------------------}
function TsCellEdit.GetSelectedCell: PCell; function TsCellEdit.GetSelectedCell: PCell;
begin begin
@ -887,7 +957,7 @@ begin
end; end;
{@@ ---------------------------------------------------------------------------- {@@ ----------------------------------------------------------------------------
Getter method for the property Workbook which is currently loaded into the Getter method for the property Workbook which is currently loaded by the
WorkbookSource WorkbookSource
-------------------------------------------------------------------------------} -------------------------------------------------------------------------------}
function TsCellEdit.GetWorkbook: TsWorkbook; function TsCellEdit.GetWorkbook: TsWorkbook;
@ -911,9 +981,14 @@ begin
end; end;
{@@ ---------------------------------------------------------------------------- {@@ ----------------------------------------------------------------------------
Notification message received from the WorkbookSource telling which item of the Notification message received from the WorkbookSource telling which item
spreadsheet has changed. of the spreadsheet has changed.
Responds to selection and cell changes by updating the cell content. Responds to selection and cell changes by updating the cell content.
@param AChangedItems Set with elements identifying whether workbook, worksheet
cell content or cell formatting has changed
@param AData If AChangedItems contains nliCell then AData points to
the modified cell.
-------------------------------------------------------------------------------} -------------------------------------------------------------------------------}
procedure TsCellEdit.ListenerNotification( procedure TsCellEdit.ListenerNotification(
AChangedItems: TsNotificationItems; AData: Pointer = nil); AChangedItems: TsNotificationItems; AData: Pointer = nil);
@ -927,7 +1002,9 @@ begin
ShowCell(SelectedCell); ShowCell(SelectedCell);
end; end;
{ Standard component notification when the workbook link is deleted. } {@@ ----------------------------------------------------------------------------
Standard component notification. Called when the WorkbookSource is deleted.
-------------------------------------------------------------------------------}
procedure TsCellEdit.Notification(AComponent: TComponent; procedure TsCellEdit.Notification(AComponent: TComponent;
Operation: TOperation); Operation: TOperation);
begin begin
@ -954,8 +1031,11 @@ end;
{@@ ---------------------------------------------------------------------------- {@@ ----------------------------------------------------------------------------
Loads the contents of a cell into the editor. Loads the contents of a cell into the editor.
Shows the formula if available. Numbers are displayed in full precision. Shows the formula if available, but not the calculation result.
Numbers are displayed in full precision.
Date and time values are shown in the long formats. Date and time values are shown in the long formats.
@param ACell Pointer to the cell loaded into the cell editor.
-------------------------------------------------------------------------------} -------------------------------------------------------------------------------}
procedure TsCellEdit.ShowCell(ACell: PCell); procedure TsCellEdit.ShowCell(ACell: PCell);
var var
@ -983,10 +1063,15 @@ begin
Clear; Clear;
end; end;
{------------------------------------------------------------------------------} {------------------------------------------------------------------------------}
{ TsCellIndicator } { TsCellIndicator }
{------------------------------------------------------------------------------} {------------------------------------------------------------------------------}
{@@ ----------------------------------------------------------------------------
Constructor of the TsCellIndicator class. Is overridden to set the default
value of the Alignment property to taCenter.
-------------------------------------------------------------------------------}
constructor TsCellIndicator.Create(AOwner: TComponent); constructor TsCellIndicator.Create(AOwner: TComponent);
begin begin
inherited Create(AOwner); inherited Create(AOwner);
@ -1017,6 +1102,10 @@ begin
WorkbookSource.SelectCell(r, c); WorkbookSource.SelectCell(r, c);
end; end;
{@@ ----------------------------------------------------------------------------
Getter method for the property Workbook which is currently loaded by the
WorkbookSource
-------------------------------------------------------------------------------}
function TsCellIndicator.GetWorkbook: TsWorkbook; function TsCellIndicator.GetWorkbook: TsWorkbook;
begin begin
if FWorkbookSource <> nil then if FWorkbookSource <> nil then
@ -1025,6 +1114,10 @@ begin
Result := nil; Result := nil;
end; end;
{@@ ----------------------------------------------------------------------------
Getter method for the property Worksheet which is currently loaded by the
WorkbookSource
-------------------------------------------------------------------------------}
function TsCellIndicator.GetWorksheet: TsWorksheet; function TsCellIndicator.GetWorksheet: TsWorksheet;
begin begin
if FWorkbookSource <> nil then if FWorkbookSource <> nil then
@ -1034,8 +1127,14 @@ begin
end; end;
{@@ ---------------------------------------------------------------------------- {@@ ----------------------------------------------------------------------------
The cell indicator responds to notification that the selection has changed The cell indicator reacts to notification that the selection has changed
and displays the address of the selected cell as editable text. and displays the address of the newly selected cell as editable text.
@param AChangedItems Set with elements identifying whether workbook, worksheet
cell or selection has changed. Only the latter element
is considered by the cell indicator.
@param AData If AChangedItems contains nliCell then AData points to
the modified cell.
-------------------------------------------------------------------------------} -------------------------------------------------------------------------------}
procedure TsCellIndicator.ListenerNotification(AChangedItems: TsNotificationItems; procedure TsCellIndicator.ListenerNotification(AChangedItems: TsNotificationItems;
AData: Pointer = nil); AData: Pointer = nil);
@ -1079,6 +1178,11 @@ end;
{ TsSpreadsheetInspector } { TsSpreadsheetInspector }
{------------------------------------------------------------------------------} {------------------------------------------------------------------------------}
{@@ ----------------------------------------------------------------------------
Constructor of the TsSpreadsheetInspector class.
Is overridden to set the default values of DisplayOptions and FixedCols, and
to define the column captions.
-------------------------------------------------------------------------------}
constructor TsSpreadsheetInspector.Create(AOwner: TComponent); constructor TsSpreadsheetInspector.Create(AOwner: TComponent);
begin begin
inherited Create(AOwner); inherited Create(AOwner);
@ -1133,35 +1237,11 @@ begin
list.Free; list.Free;
end; end;
end; end;
(*
procedure TsSpreadsheetInspector.DoUpdate;
var
cell: PCell;
sheet: TsWorksheet;
book: TsWorkbook;
begin
Strings.Clear;
cell := nil;
sheet := nil;
book := nil;
if FWorkbookSource <> nil then
begin
book := FWorkbookSource.Workbook;
sheet := FWorkbookSource.Worksheet;
if sheet <> nil then
cell := sheet.FindCell(sheet.ActiveCellRow, sheet.ActiveCellCol);
end;
case FMode of
imCellValue : UpdateCellValue(cell);
imCellProperties : UpdateCellProperties(cell);
imWorksheet : UpdateWorksheet(sheet);
imWorkbook : UpdateWorkbook(book);
end;
end;
*)
{@@ ----------------------------------------------------------------------------
Getter method for the property Workbook which is currently loaded by the
WorkbookSource
-------------------------------------------------------------------------------}
function TsSpreadsheetInspector.GetWorkbook: TsWorkbook; function TsSpreadsheetInspector.GetWorkbook: TsWorkbook;
begin begin
if FWorkbookSource <> nil then if FWorkbookSource <> nil then
@ -1170,6 +1250,10 @@ begin
Result := nil; Result := nil;
end; end;
{@@ ----------------------------------------------------------------------------
Getter method for the property Worksheet which is currently loaded by the
WorkbookSource
-------------------------------------------------------------------------------}
function TsSpreadsheetInspector.GetWorksheet: TsWorksheet; function TsSpreadsheetInspector.GetWorksheet: TsWorksheet;
begin begin
if FWorkbookSource <> nil then if FWorkbookSource <> nil then
@ -1178,6 +1262,15 @@ begin
Result := nil; Result := nil;
end; end;
{@@ ----------------------------------------------------------------------------
Notification procedure received whenver "something" changes in the workbook.
Reacts on all events.
@param AChangedItems Set with elements identifying whether workbook, worksheet
cell or selection has changed.
@param AData If AChangedItems contains nliCell then AData points to
the modified cell.
-------------------------------------------------------------------------------}
procedure TsSpreadsheetInspector.ListenerNotification( procedure TsSpreadsheetInspector.ListenerNotification(
AChangedItems: TsNotificationItems; AData: Pointer = nil); AChangedItems: TsNotificationItems; AData: Pointer = nil);
begin begin
@ -1190,19 +1283,12 @@ begin
imCellValue, imCellProperties: imCellValue, imCellProperties:
if ([lniCell, lniSelection]*AChangedItems <> []) then DoUpdate; if ([lniCell, lniSelection]*AChangedItems <> []) then DoUpdate;
end; end;
{
case FMode of
imWorkbook:
if lniWorkbook in AChangedItems then DoUpdate;
imWorksheet:
if lniWorksheet in AChangedItems then DoUpdate;
imCellValue,
imCellProperties:
if ([lniCell, lniSelection]*AChangedItems <> []) then DoUpdate;
end;
}
end; end;
{@@ ----------------------------------------------------------------------------
Standard component notification method called when the WorkbookSource
is deleted.
-------------------------------------------------------------------------------}
procedure TsSpreadsheetInspector.Notification(AComponent: TComponent; procedure TsSpreadsheetInspector.Notification(AComponent: TComponent;
Operation: TOperation); Operation: TOperation);
begin begin
@ -1211,6 +1297,11 @@ begin
SetWorkbookSource(nil); SetWorkbookSource(nil);
end; end;
{@@ ----------------------------------------------------------------------------
Setter method for the Mode property. This property filters groups of properties
for display (workbook-, worksheet-, cell value- or cell formatting-related
data).
-------------------------------------------------------------------------------}
procedure TsSpreadsheetInspector.SetMode(AValue: TsInspectorMode); procedure TsSpreadsheetInspector.SetMode(AValue: TsInspectorMode);
begin begin
if AValue = FMode then if AValue = FMode then
@ -1219,6 +1310,9 @@ begin
DoUpdate; DoUpdate;
end; end;
{@@ ----------------------------------------------------------------------------
Setter method for the WorkbookSource
-------------------------------------------------------------------------------}
procedure TsSpreadsheetInspector.SetWorkbookSource(AValue: TsWorkbookSource); procedure TsSpreadsheetInspector.SetWorkbookSource(AValue: TsWorkbookSource);
begin begin
if AValue = FWorkbookSource then if AValue = FWorkbookSource then
@ -1231,6 +1325,13 @@ begin
ListenerNotification([lniWorkbook, lniWorksheet, lniSelection]); ListenerNotification([lniWorkbook, lniWorksheet, lniSelection]);
end; end;
{@@ ----------------------------------------------------------------------------
Creates a string list containing the formatting properties of a specific cell.
The string list items are name-value pairs in the format "name=value".
The string list is displayed in the inspector's grid.
@param ACell Cell under investigation
-------------------------------------------------------------------------------}
procedure TsSpreadsheetInspector.UpdateCellProperties(ACell: PCell; procedure TsSpreadsheetInspector.UpdateCellProperties(ACell: PCell;
AStrings: TStrings); AStrings: TStrings);
var var
@ -1311,6 +1412,13 @@ begin
end; end;
end; end;
{@@ ----------------------------------------------------------------------------
Creates a string list containing the value data of a specific cell.
The string list items are name-value pairs in the format "name=value".
The string list is displayed in the inspector's grid.
@param ACell Cell under investigation
-------------------------------------------------------------------------------}
procedure TsSpreadsheetInspector.UpdateCellValue(ACell: PCell; AStrings: TStrings); procedure TsSpreadsheetInspector.UpdateCellValue(ACell: PCell; AStrings: TStrings);
begin begin
if ACell = nil then if ACell = nil then
@ -1349,6 +1457,13 @@ begin
end; end;
end; end;
{@@ ----------------------------------------------------------------------------
Creates a string list containing the properties of the workbook.
The string list items are name-value pairs in the format "name=value".
The string list is displayed in the inspector's grid.
@param ACell Cell under investigation
-------------------------------------------------------------------------------}
procedure TsSpreadsheetInspector.UpdateWorkbook(AWorkbook: TsWorkbook; procedure TsSpreadsheetInspector.UpdateWorkbook(AWorkbook: TsWorkbook;
AStrings: TStrings); AStrings: TStrings);
var var
@ -1417,6 +1532,13 @@ begin
end; end;
end; end;
{@@ ----------------------------------------------------------------------------
Creates a string list containing the properties of a worksheet.
The string list items are name-value pairs in the format "name=value".
The string list is displayed in the inspector's grid.
@param ACell Cell under investigation
-------------------------------------------------------------------------------}
procedure TsSpreadsheetInspector.UpdateWorksheet(ASheet: TsWorksheet; procedure TsSpreadsheetInspector.UpdateWorksheet(ASheet: TsWorksheet;
AStrings: TStrings); AStrings: TStrings);
begin begin

23
components/fpspreadsheet/fpspreadsheetgrid.pas
View File

@ -1,21 +1,24 @@
{ { fpspreadsheetgrid }
fpspreadsheetgrid.pas
Grid component which can load and write data from / to FPSpreadsheet documents {@@ ----------------------------------------------------------------------------
Grid component which can load and write data from / to FPSpreadsheet documents.
Can either be used alone or in combination with a TsWorkbookSource component.
The latter case requires less written code.
AUTHORS: Felipe Monteiro de Carvalho, Werner Pamler AUTHORS: Felipe Monteiro de Carvalho, Werner Pamler
}
LICENSE: See the file COPYING.modifiedLGPL.txt, included in the Lazarus
distribution, for details about the license.
-------------------------------------------------------------------------------}
unit fpspreadsheetgrid;
{$mode objfpc}{$H+}
{ To do: { To do:
- When Lazarus 1.4 comes out remove the workaround for the RGB2HLS bug in - When Lazarus 1.4 comes out remove the workaround for the RGB2HLS bug in
FindNearestPaletteIndex. FindNearestPaletteIndex.
- Arial bold is not shown as such if loaded from ods - Arial bold is not shown as such if loaded from ods
- Background color of first cell is ignored. - Background color of first cell is ignored. }
}
unit fpspreadsheetgrid;
{$mode objfpc}{$H+}
interface interface

25
components/fpspreadsheet/fpsrpn.pas
View File

@ -1,5 +1,12 @@
{ Simple creation an RPNFormula array to be used in fpspreadsheet. } {@@ ----------------------------------------------------------------------------
The unit fpsRPN contains methods for simple creation of an RPNFormula array
to be used in fpspreadsheet.
AUTHORS: Werner Pamler
LICENSE: See the file COPYING.modifiedLGPL.txt, included in the Lazarus
distribution, for details about the license.
-------------------------------------------------------------------------------}
unit fpsRPN; unit fpsRPN;
{$ifdef fpc} {$ifdef fpc}
@ -11,9 +18,15 @@ interface
uses uses
SysUtils, fpspreadsheet; SysUtils, fpspreadsheet;
{@@ Helper record for simplification of RPN formula creation }
type type
{@@ Pointer to a TPRNItem record
@see TRPNItem }
PRPNItem = ^TRPNItem; PRPNItem = ^TRPNItem;
{@@ Helper record for simplification of RPN formula creation
@param FE Formula element record stored in the RPN item
@param Next Pointer to the next RPN item of the formula
@see TsFormulaElement }
TRPNItem = record TRPNItem = record
FE: TsFormulaElement; FE: TsFormulaElement;
Next: PRPNItem; Next: PRPNItem;
@ -73,6 +86,8 @@ end;
{@@ ---------------------------------------------------------------------------- {@@ ----------------------------------------------------------------------------
Destroys an RPN item Destroys an RPN item
@param AItem Pointer to the RPN item to be disposed.
-------------------------------------------------------------------------------} -------------------------------------------------------------------------------}
procedure DisposeRPNItem(AItem: PRPNItem); procedure DisposeRPNItem(AItem: PRPNItem);
begin begin
@ -83,8 +98,8 @@ end;
{@@ ---------------------------------------------------------------------------- {@@ ----------------------------------------------------------------------------
Creates a boolean value entry in the RPN array. Creates a boolean value entry in the RPN array.
@param AValue Boolean value to be stored in the RPN item @param AValue Boolean value to be stored in the RPN item
@next ANext Pointer to the next RPN item in the list @param ANext Pointer to the next RPN item in the list
-------------------------------------------------------------------------------} -------------------------------------------------------------------------------}
function RPNBool(AValue: Boolean; ANext: PRPNItem): PRPNItem; function RPNBool(AValue: Boolean; ANext: PRPNItem): PRPNItem;
begin begin
@ -107,7 +122,7 @@ var
flags: TsRelFlags; flags: TsRelFlags;
begin begin
if not ParseCellString(ACellAddress, r, c, flags) then if not ParseCellString(ACellAddress, r, c, flags) then
raise Exception.CreateFmt('"%s" is not a valid cell address.', [ACellAddress]); raise Exception.CreateFmt(rsNoValidCellAddress, [ACellAddress]);
Result := RPNCellValue(r,c, flags, ANext); Result := RPNCellValue(r,c, flags, ANext);
end; end;

140
components/fpspreadsheet/fpsutils.pas
View File

@ -1,13 +1,16 @@
{ {@@ ----------------------------------------------------------------------------
Utility functions and constants from FPSpreadsheet Utility functions and declarations for FPSpreadsheet
}
LICENSE: See the file COPYING.modifiedLGPL.txt, included in the Lazarus
distribution, for details about the license.
-------------------------------------------------------------------------------}
unit fpsutils;
// to do: Remove the patched FormatDateTime when the feature of square brackets // to do: Remove the patched FormatDateTime when the feature of square brackets
// in time format codes is in the rtl // in time format codes is in the rtl
// to do: Remove the declaration UTF8FormatSettings and InitUTF8FormatSettings // to do: Remove the declaration UTF8FormatSettings and InitUTF8FormatSettings
// when this same modification is in LazUtils of Laz stable // when this same modification is in LazUtils of Laz stable
unit fpsutils;
{$mode objfpc}{$H+} {$mode objfpc}{$H+}
@ -27,14 +30,12 @@ type
{@@ Options for the FormatDateTime function to activate time interval strings {@@ Options for the FormatDateTime function to activate time interval strings
with more than 24 hours. with more than 24 hours.
Will be removed when this feature is in the stable release of FPC Will be removed when this feature is in the stable release of FPC }
}
TFormatDateTimeOption = (fdoInterval); TFormatDateTimeOption = (fdoInterval);
{@@ Options for the FormatDateTime function to activate time interval strings {@@ Options for the FormatDateTime function to activate time interval strings
with more than 24 hours. with more than 24 hours.
Will be removed when this feature is in the stable release of FPC Will be removed when this feature is in the stable release of FPC }
}
TFormatDateTimeOptions = set of TFormatDateTimeOption; TFormatDateTimeOptions = set of TFormatDateTimeOption;
const const
@ -161,8 +162,6 @@ procedure AppendToStream(AStream: TStream; const AString: String); inline; overl
procedure AppendToStream(AStream: TStream; const AString1, AString2: String); inline; overload; procedure AppendToStream(AStream: TStream; const AString1, AString2: String); inline; overload;
procedure AppendToStream(AStream: TStream; const AString1, AString2, AString3: String); inline; overload; procedure AppendToStream(AStream: TStream; const AString1, AString2, AString3: String); inline; overload;
function PosInMemory(AMagic: QWord; ABuffer: PByteArray; ABufSize: Integer): Integer;
{ For silencing the compiler... } { For silencing the compiler... }
procedure Unused(const A1); procedure Unused(const A1);
procedure Unused(const A1, A2); procedure Unused(const A1, A2);
@ -172,7 +171,10 @@ procedure Unused(const A1, A2, A3);
procedure DumpFontsToFile(AWorkbook: TsWorkbook; AFileName: String); procedure DumpFontsToFile(AWorkbook: TsWorkbook; AFileName: String);
var var
{@@ Default value for the screen pixel density (pixels per inch). Is needed
for conversion of distances to pixels}
ScreenPixelsPerInch: Integer = 96; ScreenPixelsPerInch: Integer = 96;
{@@ FPC format settings for which all strings have been converted to UTF8 }
UTF8FormatSettings: TFormatSettings; UTF8FormatSettings: TFormatSettings;
implementation implementation
@ -977,7 +979,7 @@ end;
@param ACurrencySymbol Name of the currency, like $ or USD. @param ACurrencySymbol Name of the currency, like $ or USD.
If ? the CurrencyString of the FormatSettings is used. If ? the CurrencyString of the FormatSettings is used.
@return String of formatting codes, such as '"$"#,##0.00;("$"#,##0.00);"EUR"0.00' @return String of formatting codes, such as '"$"#,##0.00;("$"#,##0.00);"$"0.00'
-------------------------------------------------------------------------------} -------------------------------------------------------------------------------}
function BuildCurrencyFormatString(ADialect: TsNumFormatDialect; function BuildCurrencyFormatString(ADialect: TsNumFormatDialect;
ANumberFormat: TsNumberFormat; const AFormatSettings: TFormatSettings; ANumberFormat: TsNumberFormat; const AFormatSettings: TFormatSettings;
@ -1654,7 +1656,6 @@ begin
end; end;
end; end;
{@@ ---------------------------------------------------------------------------- {@@ ----------------------------------------------------------------------------
Excel's unit of row heights is "twips", i.e. 1/20 point. Excel's unit of row heights is "twips", i.e. 1/20 point.
Converts Twips to points. Converts Twips to points.
@ -2332,15 +2333,16 @@ begin
DateTimeToString(Result, FormatStr, DateTime, FormatSettings,Options); DateTimeToString(Result, FormatStr, DateTime, FormatSettings,Options);
end; end;
{@@ {@@ ----------------------------------------------------------------------------
Extracts compare information from an input string such as "<2.4". Extracts compare information from an input string such as "<2.4".
Is needed for some Excel-strings. Is needed for some Excel-strings.
@param AString Input string starting with "<", "<=", ">", ">=", "<>" or "=" @param AString Input string starting with "<", "<=", ">", ">=", "<>" or "="
If this start code is missing a "=" is assumed. If this start code is missing a "=" is assumed.
@param ACompareOp Identifier for the comparing operation extracted - see TsCompareOperation @param ACompareOp Identifier for the comparing operation extracted
- see TsCompareOperation
@return Input string with the comparing characters stripped. @return Input string with the comparing characters stripped.
} -------------------------------------------------------------------------------}
function AnalyzeComparestr(AString: String; out ACompareOp: TsCompareOperation): String; function AnalyzeComparestr(AString: String; out ACompareOp: TsCompareOperation): String;
procedure RemoveChars(ACount: Integer; ACompare: TsCompareOperation); procedure RemoveChars(ACount: Integer; ACompare: TsCompareOperation);
@ -2403,18 +2405,39 @@ begin
end; end;
end; end;
{@@ ----------------------------------------------------------------------------
Appends a string to a stream
@param AStream Stream to which the string will be added
@param AString String to be written to the stream
-------------------------------------------------------------------------------}
procedure AppendToStream(AStream: TStream; const AString: string); procedure AppendToStream(AStream: TStream; const AString: string);
begin begin
if Length(AString) > 0 then if Length(AString) > 0 then
AStream.WriteBuffer(AString[1], Length(AString)); AStream.WriteBuffer(AString[1], Length(AString));
end; end;
{@@ ----------------------------------------------------------------------------
Appends two strings to a stream
@param AStream Stream to which the strings will be added
@param AString1 First string to be written to the stream
@param AString2 Second string to be written to the stream
-------------------------------------------------------------------------------}
procedure AppendToStream(AStream: TStream; const AString1, AString2: String); procedure AppendToStream(AStream: TStream; const AString1, AString2: String);
begin begin
AppendToStream(AStream, AString1); AppendToStream(AStream, AString1);
AppendToStream(AStream, AString2); AppendToStream(AStream, AString2);
end; end;
{@@ ----------------------------------------------------------------------------
Appends three strings to a stream
@param AStream Stream to which the strings will be added
@param AString1 First string to be written to the stream
@param AString2 Second string to be written to the stream
@param AString3 Third string to be written to the stream
-------------------------------------------------------------------------------}
procedure AppendToStream(AStream: TStream; const AString1, AString2, AString3: String); procedure AppendToStream(AStream: TStream; const AString1, AString2, AString3: String);
begin begin
AppendToStream(AStream, AString1); AppendToStream(AStream, AString1);
@ -2422,28 +2445,6 @@ begin
AppendToStream(AStream, AString3); AppendToStream(AStream, AString3);
end; end;
function PosInMemory(AMagic: QWord; ABuffer: PByteArray; ABufSize: Integer): Integer;
var
i, j: Integer;
MagicBytes: Array[0..7] of byte absolute AMagic;
found: Boolean;
begin
Result := -1;
for i:=0 to ABufSize - SizeOf(QWord) do begin
if (ABuffer^[i] = MagicBytes[0]) then begin
found := true;
for j:=1 to 7 do
if ABuffer^[i+j] <> MagicBytes[j] then begin
found := false;
break;
end;
if found then begin
Result := i;
exit;
end;
end;
end;
end;
{ Modifying colors } { Modifying colors }
{ Next function are copies of GraphUtils to avoid a dependence on the Graphics unit. } { Next function are copies of GraphUtils to avoid a dependence on the Graphics unit. }
@ -2537,7 +2538,6 @@ begin
n1 := 2 * L - n2 - 1; n1 := 2 * L - n2 - 1;
end; end;
// get RGB // get RGB
R := HueToRGB(n1, n2, H + HUE_120); R := HueToRGB(n1, n2, H + HUE_120);
G := HueToRGB(n1, n2, H); G := HueToRGB(n1, n2, H);
@ -2545,12 +2545,19 @@ begin
end; end;
end; end;
{ Excel defines theme colors and applies a "tint" factor (-1...+1) to darken {@@ ----------------------------------------------------------------------------
Excel defines theme colors and applies a "tint" factor (-1...+1) to darken
or brighten them. or brighten them.
This method "tints" a given color with a factor
The algorithm is described in The algorithm is described in
http://msdn.microsoft.com/en-us/library/documentformat.openxml.spreadsheet.backgroundcolor.aspx http://msdn.microsoft.com/en-us/library/documentformat.openxml.spreadsheet.backgroundcolor.aspx
(with the exception that max hue is 240, nur 255!)
} @param AColor rgb color to be modified
@param tint Factor (-1...+1) to be used for the operation
@return Modified color
-------------------------------------------------------------------------------}
function TintedColor(AColor: TsColorValue; tint: Double): TsColorValue; function TintedColor(AColor: TsColorValue; tint: Double): TsColorValue;
const const
HLSMAX = 255; HLSMAX = 255;
@ -2584,9 +2591,14 @@ begin
TRGBA(Result).a := 0; TRGBA(Result).a := 0;
end; end;
{@@ ----------------------------------------------------------------------------
Returns the color index for black or white depending on a color being "bright"
or "dark".
{@@ Returns the color index for black or white depending on a color belng "bright" @param AColorValue rgb color to be analyzed
or "dark". } @return The color index for black (scBlack) if AColorValue is a "bright" color,
or white (scWhite) if AColorValue is a "dark" color.
-------------------------------------------------------------------------------}
function HighContrastColor(AColorValue: TsColorvalue): TsColor; function HighContrastColor(AColorValue: TsColorvalue): TsColor;
begin begin
if TRGBA(AColorValue).r + TRGBA(AColorValue).g + TRGBA(AColorValue).b < 3*128 then if TRGBA(AColorValue).r + TRGBA(AColorValue).g + TRGBA(AColorValue).b < 3*128 then
@ -2616,9 +2628,33 @@ end;
{$POP} {$POP}
{@@ ----------------------------------------------------------------------------
Creates a FPC format settings record in which all strings are encoded as
UTF8.
-------------------------------------------------------------------------------}
procedure InitUTF8FormatSettings;
// remove when available in LazUtils
var
i: Integer;
begin
UTF8FormatSettings := DefaultFormatSettings;
UTF8FormatSettings.CurrencyString := AnsiToUTF8(DefaultFormatSettings.CurrencyString);
for i:=1 to 12 do begin
UTF8FormatSettings.LongMonthNames[i] := AnsiToUTF8(DefaultFormatSettings.LongMonthNames[i]);
UTF8FormatSettings.ShortMonthNames[i] := AnsiToUTF8(DefaultFormatSettings.ShortMonthNames[i]);
end;
for i:=1 to 7 do begin
UTF8FormatSettings.LongDayNames[i] := AnsiToUTF8(DefaultFormatSettings.LongDayNames[i]);
UTF8FormatSettings.ShortDayNames[i] := AnsiToUTF8(DefaultFormatSettings.ShortDayNames[i]);
end;
end;
{ For debugging only } { For debugging only }
{@@ Write the fonts stored for a given workbook to a file. } {@@ ----------------------------------------------------------------------------
Write the fonts stored for a given workbook to a file.
-------------------------------------------------------------------------------}
procedure DumpFontsToFile(AWorkbook: TsWorkbook; AFileName: String); procedure DumpFontsToFile(AWorkbook: TsWorkbook; AFileName: String);
var var
L: TStringList; L: TStringList;
@ -2649,22 +2685,6 @@ begin
end; end;
end; end;
procedure InitUTF8FormatSettings;
// remove when available in LazUtils
var
i: Integer;
begin
UTF8FormatSettings := DefaultFormatSettings;
UTF8FormatSettings.CurrencyString := AnsiToUTF8(DefaultFormatSettings.CurrencyString);
for i:=1 to 12 do begin
UTF8FormatSettings.LongMonthNames[i] := AnsiToUTF8(DefaultFormatSettings.LongMonthNames[i]);
UTF8FormatSettings.ShortMonthNames[i] := AnsiToUTF8(DefaultFormatSettings.ShortMonthNames[i]);
end;
for i:=1 to 7 do begin
UTF8FormatSettings.LongDayNames[i] := AnsiToUTF8(DefaultFormatSettings.LongDayNames[i]);
UTF8FormatSettings.ShortDayNames[i] := AnsiToUTF8(DefaultFormatSettings.ShortDayNames[i]);
end;
end;
initialization initialization
InitUTF8FormatSettings; InitUTF8FormatSettings;