Class TfrmFormula

Description

Hierarchy

Fields

Methods

Properties

Unit

frmFormulaUnit

Declaration

type TfrmFormula = class(TfrmCustomGoPhast)

Description

TfrmFormula provides a way for the user to edit formulas

Hierarchy

TForm
TfrmCustomGoPhast
TfrmFormula

Overview

Fields

	`btn0: TButton;`
	`btn1: TButton;`
	`btn2: TButton;`
	`btn3: TButton;`
	`btn4: TButton;`
	`btn5: TButton;`
	`btn6: TButton;`
	`btn7: TButton;`
	`btn8: TButton;`
	`btn9: TButton;`
	`btnAnd: TButton;`
	`btnCancel: TBitBtn;`
	`btnCloseParen: TButton;`
	`btnComma: TButton;`
	`btnDecimal: TButton;`
	`btnDiv: TButton;`
	`btnDivide: TButton;`
	`btnE: TButton;`
	`btnEquals: TButton;`
	`btnFalse: TButton;`
	`btnFunctionHelp: TBitBtn;`
	`btnGreaterOrEquals: TButton;`
	`btnGreaterThan: TButton;`
	`btnHelp: TBitBtn;`
	`btnLessEquals: TButton;`
	`btnLessThan: TButton;`
	`btnMinus: TButton;`
	`btnMod: TButton;`
	`btnMultiply: TButton;`
	`btnNot: TButton;`
	`btnNotEqual: TButton;`
	`btnOK: TBitBtn;`
	`btnOpenParen: TButton;`
	`btnOr: TButton;`
	`btnPlus: TButton;`
	`btnQuote: TButton;`
	`btnSelectMatchParen: TButton;`
	`btnTrue: TButton;`
	`btnXor: TButton;`
	`memoFormula: TMemo;`
	`pnlBottom: TPanel;`
	`pnlButtons: TPanel;`
	`pnlLabelTree: TPanel;`
	`pnlMain: TPanel;`
	`pnlRight: TPanel;`
	`rbFormulaParser: TRbwParser;`
	`Splitter: TSplitter;`
	`Timer: TTimer;`
	`tvItems: TTreeView;`
	`FDataSetGroupName: string;`
	`FFunctionHelpString: string;`
	`FFunctions: TTreeNode;`
	`FLastButton: TButton;`
	`FNewSelectionLength: integer;`
	`FNewSelectionStart: integer;`
	`FResultSet: boolean;`

Methods

	`procedure btnFunctionHelpClick(Sender: TObject);`
	`procedure btnOKClick(Sender: TObject);`
	`procedure btnSelectMatchParenClick(Sender: TObject);`
	`procedure buttonClick(Sender: TObject);`
	`procedure FormCreate(Sender: TObject); override;`
	`procedure FormShow(Sender: TObject);`
	`procedure memoFormulaChange(Sender: TObject);`
	`procedure memoFormulaDblClick(Sender: TObject);`
	`procedure memoFormulaKeyUp(Sender: TObject; var Key: Word; Shift: TShiftState);`
	`procedure memoFormulaMouseUp(Sender: TObject; Button: TMouseButton; Shift: TShiftState; X, Y: Integer);`
	`procedure SplitterCanResize(Sender: TObject; var NewSize: Integer; var Accept: Boolean);`
	`procedure TimerSetSelection(Sender: TObject);`
	`procedure tvItemsItemClick(Sender: TObject; Button: TMouseButton; Node: TTreeNode; const Pt: TPoint);`
	`procedure tvItemsItemDoubleClick(Sender: TObject; Node: TTreeNode);`
	`function GetFormula: string;`
	`procedure InsertText(const NewText: string);`
	`procedure SetFormula(const Value: string);`
	`procedure RemoveGIS_Functions;`
	`procedure UpdateTreeList;`

Properties

	`property DataSetGroupName: string read FDataSetGroupName write FDataSetGroupName;`
	`property Formula: string read GetFormula write SetFormula;`
	`property ResultSet: boolean read FResultSet;`

Description

Fields

	`btn0: TButton;`
`btn0`: TButton; `btn0` is used to insert "0" in the formula.

	`btn1: TButton;`
`btn1`: TButton; `btn1` is used to insert "1" in the formula.

	`btn2: TButton;`
`btn2`: TButton; `btn2` is used to insert "2" in the formula.

	`btn3: TButton;`
`btn3`: TButton; `btn3` is used to insert "3" in the formula.

	`btn4: TButton;`
`btn4`: TButton; `btn4` is used to insert "4" in the formula.

	`btn5: TButton;`
`btn5`: TButton; `btn5` is used to insert "5" in the formula.

	`btn6: TButton;`
`btn6`: TButton; `btn6` is used to insert "6" in the formula.

	`btn7: TButton;`
`btn7`: TButton; `btn7` is used to insert "7" in the formula.

	`btn8: TButton;`
`btn8`: TButton; `btn8` is used to insert "8" in the formula.

	`btn9: TButton;`
`btn9`: TButton; `btn9` is used to insert "9" in the formula.

	`btnAnd: TButton;`
`btnAnd`: TButton; `btnAnd` is used to insert "and" in the formula.

	`btnCancel: TBitBtn;`
`btnCancel`: TBitBtn; `btnCancel` closes the dialog box and sets the ModalResult to mrCancel.

	`btnCloseParen: TButton;`
`btnCloseParen`: TButton; `btnCloseParen` is used to insert ")" in the formula.

	`btnComma: TButton;`
`btnComma`: TButton; `btnComma` is used to insert "," in the formula.

	`btnDecimal: TButton;`
`btnDecimal`: TButton; `btnDecimal` is used to insert "." in the formula.

	`btnDiv: TButton;`
`btnDiv`: TButton; `btnDiv` is used to insert "div" in the formula.

	`btnDivide: TButton;`
`btnDivide`: TButton; `btnDivide` is used to insert "/" in the formula.

	`btnE: TButton;`
`btnE`: TButton; `btnE` is used to insert "E" in the formula.

	`btnEquals: TButton;`
`btnEquals`: TButton; `btnEquals` is used to insert "=" in the formula.

	`btnFalse: TButton;`
`btnFalse`: TButton; `btnFalse` is used to insert "False" in the formula.

	`btnFunctionHelp: TBitBtn;`
`btnFunctionHelp`: TBitBtn; See btnFunctionHelpClick.

	`btnGreaterOrEquals: TButton;`
`btnGreaterOrEquals`: TButton; `btnGreaterOrEquals` is used to insert ">-" in the formula.

	`btnGreaterThan: TButton;`
`btnGreaterThan`: TButton; `btnGreaterThan` is used to insert ">" in the formula.

	`btnHelp: TBitBtn;`
`btnHelp`: TBitBtn; `btnHelp` shows help for the dialog box.

	`btnLessEquals: TButton;`
`btnLessEquals`: TButton; `btnLessEquals` is used to insert "<=" in the formula.

	`btnLessThan: TButton;`
`btnLessThan`: TButton; `btnLessThan` is used to insert "<" in the formula.

	`btnMinus: TButton;`
`btnMinus`: TButton; `btnMinus` is used to insert "-" in the formula.

	`btnMod: TButton;`
`btnMod`: TButton; `btnMod` is used to insert "mod" in the formula.

	`btnMultiply: TButton;`
`btnMultiply`: TButton; `btnMultiply` is used to insert "*" in the formula.

	`btnNot: TButton;`
`btnNot`: TButton; `btnNot` is used to insert "not" in the formula.

	`btnNotEqual: TButton;`
`btnNotEqual`: TButton; `btnNotEqual` is used to insert "<>" in the formula.

	`btnOK: TBitBtn;`
`btnOK`: TBitBtn; See btnOKClick.

	`btnOpenParen: TButton;`
`btnOpenParen`: TButton; `btnOpenParen` is used to insert "(" in the formula.

	`btnOr: TButton;`
`btnOr`: TButton; `btnOr` is used to insert "or" in the formula.

	`btnPlus: TButton;`
`btnPlus`: TButton; `btnPlus` is used to insert "+" in the formula.

	`btnQuote: TButton;`
`btnQuote`: TButton; `btnQuote` is used to insert '"" in the formula.

	`btnSelectMatchParen: TButton;`
`btnSelectMatchParen`: TButton; See btnSelectMatchParenClick.

	`btnTrue: TButton;`
`btnTrue`: TButton; `btnTrue` is used to insert "True" in the formula.

	`btnXor: TButton;`
`btnXor`: TButton; `btnXor` is used to insert "xor" in the formula.

	`memoFormula: TMemo;`
`memoFormula`: TMemo; `memoFormula` displays the formula.

	`pnlBottom: TPanel;`
`pnlBottom`: TPanel; `pnlBottom` is the panel at the bottom of the dialog box.

	`pnlButtons: TPanel;`
`pnlButtons`: TPanel; `pnlButtons` is the panel holding must of the buttons.

	`pnlLabelTree: TPanel;`
`pnlLabelTree` labels tvItems.

	`pnlMain: TPanel;`
`pnlMain`: TPanel; `pnlMain` holds pnlButtons and memoFormula. It is present to allow Splitter to work properly.

	`pnlRight: TPanel;`
`pnlRight` holds tvItems and pnlLabelTree.

	`rbFormulaParser: TRbwParser;`
`rbFormulaParser`: TRbwParser; `rbFormulaParser` is used to test the validity of the formula.

	`Splitter: TSplitter;`
`Splitter`: TSplitter; `Splitter` allows the user to resize parts of the dialog box.

	`Timer: TTimer;`
`Timer`: TTimer; `Timer` is used to allow for a slight delay before selecting text in memoFormula.

	`tvItems: TTreeView;`
`tvItems`: TTreeView; `tvItems` displays the TDataArrays and functions that can be used in the formula.

	`FDataSetGroupName: string;`
See DataSetGroupName

	`FFunctionHelpString: string;`
`FFunctionHelpString` is the caption of the TTreeNode in tvItems that was last clicked. It is used to get context sensitive help on Functions displayed in tvItems.

	`FFunctions: TTreeNode;`
`FFunctions`: TTreeNode; `FFunctions` is the parent TTreeNode that holds all the TTreeNodes for functions.

	`FLastButton: TButton;`
`FLastButton`: TButton; `FLastButton` is set to the previous button that was clicked. It is used to help determine whether there should be spaces before the the text specified by the button.

	`FNewSelectionLength: integer;`
`FNewSelectionLength`: integer; `FNewSelectionLength` specifies the length of the text that should be selected in memoFormulaDblClick.

	`FNewSelectionStart: integer;`
`FNewSelectionStart`: integer; `FNewSelectionStart` specifies the start of the text that should be selected in memoFormulaDblClick.

	`FResultSet: boolean;`
`FResultSet`: boolean; See ResultSet.

Methods

	`procedure btnFunctionHelpClick(Sender: TObject);`
`btnFunctionHelpClick` shows help on the function that is selected in tvItems. See tvItemsItemClick.

	`procedure btnOKClick(Sender: TObject);`
`btnOKClick` checks that the formula is valid. If so, it closes the dialog box and sets the ModalResult to mrOK. Otherwise, it disables the OK button.

	`procedure btnSelectMatchParenClick(Sender: TObject);`
When a "(" or a ")" is selected, clicking btnSelectMatchParen will move to the matching ")" or "(". See memoFormulaMouseUp and memoFormulaKeyUp.

	`procedure buttonClick(Sender: TObject);`
`buttonClick` is the OnClick event handler for most of the buttons in the dialog box. It inserts the caption of the button into the formula.

	`procedure FormCreate(Sender: TObject); override;`
`FormCreate` initializes the `TfrmFormula`.

	`procedure FormShow(Sender: TObject);`
`FormShow` calls memoFormula.SetFocus;

	`procedure memoFormulaChange(Sender: TObject);`
`memoFormulaChange` enables the OK button.

	`procedure memoFormulaDblClick(Sender: TObject);`
`memoFormulaDblClick` determines which a token in the formula should be selected and starts Timer. See TimerSetSelection.

	`procedure memoFormulaKeyUp(Sender: TObject; var Key: Word; Shift: TShiftState);`
`memoFormulaKeyUp` enables btnSelectMatchParen when the selected text in memoFormula is a "(" or a ")".

	`procedure memoFormulaMouseUp(Sender: TObject; Button: TMouseButton; Shift: TShiftState; X, Y: Integer);`
`memoFormulaMouseUp` enables btnSelectMatchParen when the selected text in memoFormula is a "(" or a ")".

	`procedure SplitterCanResize(Sender: TObject; var NewSize: Integer; var Accept: Boolean);`
`SplitterCanResize` ensures that the splitter can't make pnlMain go below its minimum width.

	`procedure TimerSetSelection(Sender: TObject);`
`TimerSetSelection` selects the text specified in memoFormulaDblClick and stops Timer.

	`procedure tvItemsItemClick(Sender: TObject; Button: TMouseButton; Node: TTreeNode; const Pt: TPoint);`
`tvItemsItemClick` sets FFunctionHelpString to the Text of Node. FFunctionHelpString is then used in btnFunctionHelpClick.

	`procedure tvItemsItemDoubleClick(Sender: TObject; Node: TTreeNode);`
`tvItemsItemDoubleClick` inserts the selected in in tvItems into the formula.

	`function GetFormula: string;`
See Formula.

	`procedure InsertText(const NewText: string);`
`InsertText` inserts NewText into the formula at the position of the selected text.

	`procedure SetFormula(const Value: string);`
See Formula.

	`procedure RemoveGIS_Functions;`
`RemoveGIS_Functions` sets rbFormulaParser so that only the functions set in TRbwParser.Functions by default are present. GIS functions and any other extra functions are removed.

	`procedure UpdateTreeList;`
`UpdateTreeList` creates the nodes in tvItems.

Properties

	`property DataSetGroupName: string read FDataSetGroupName write FDataSetGroupName;`
Name used in the TTreeNode that holds TCustomVariables in tvItems. By default, it is 'Data Sets'.

	`property Formula: string read GetFormula write SetFormula;`
use `Formula` to read or set the formula.

	`property ResultSet: boolean read FResultSet;`
`ResultSet` is set to true if the formula has been successfully changed.

Generated by PasDoc 0.10.0 on 2006-10-31 09:56:34