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;`
	`btnDivide: TButton;`
	`btnE: TButton;`
	`btnEquals: TButton;`
	`btnFalse: TButton;`
	`btnFunctionHelp: TBitBtn;`
	`btnGreaterOrEquals: TButton;`
	`btnGreaterThan: TButton;`
	`btnHelp: TBitBtn;`
	`btnLessEquals: TButton;`
	`btnLessThan: TButton;`
	`btnMinus: TButton;`
	`btnMultiply: TButton;`
	`btnNot: TButton;`
	`btnNotEqual: TButton;`
	`btnOK: TBitBtn;`
	`btnOpenParen: TButton;`
	`btnOr: TButton;`
	`btnPlus: TButton;`
	`btnQuote: TButton;`
	`btnTrue: TButton;`
	`btnXor: TButton;`
	`pnlBottom: TPanel;`
	`pnlButtons: TPanel;`
	`pnlLabelItemTree: TPanel;`
	`pnlMain: TPanel;`
	`pnlRight: TPanel;`
	`rbFormulaParser: TRbwParser;`
	`Splitter: TSplitter;`
	`Timer: TTimer;`
	`tvItems: TTreeView;`
	`tvFormulaDiagram: TTreeView;`
	`JvNetscapeSplitter1: TJvNetscapeSplitter;`
	`gbLogicalOperators: TGroupBox;`
	`gbIntegerOperators: TGroupBox;`
	`btnMod: TButton;`
	`btnDiv: TButton;`
	`gbNumbers: TGroupBox;`
	`gbOperators: TGroupBox;`
	`lbltems: TLabel;`
	`jreFormula: TJvRichEdit;`
	`FDataSetGroupName: string;`
	`FFunctionHelpString: string;`
	`FFunctions: TTreeNode;`
	`FLastButton: TButton;`
	`FNewSelectionLength: integer;`
	`FNewSelectionStart: integer;`
	`FResultSet: boolean;`
	`FSelectedNode: TTreeNode;`
	`FClickSelectionStart: integer;`
	`FDiagramObjectStorage: TList;`
	`FUpdating: Boolean;`
	`FSetColor: Boolean;`

Methods

	`procedure btnFunctionHelpClick(Sender: TObject);`
	`procedure btnOKClick(Sender: TObject);`
	`procedure buttonClick(Sender: TObject);`
	`procedure FormCreate(Sender: TObject); override;`
	`procedure FormShow(Sender: TObject);`
	`procedure jreFormulaChange(Sender: TObject);`
	`procedure jreFormulaDblClick(Sender: TObject);`
	`procedure SplitterCanResize(Sender: TObject; var NewSize: Integer; var Accept: Boolean);`
	`procedure TimerSetSelection(Sender: TObject);`
	`procedure tvItemsChange(Sender: TObject; Node: TTreeNode);`
	`procedure tvItemsDblClick(Sender: TObject);`
	`procedure FormDestroy(Sender: TObject); override;`
	`procedure tvFormulaDiagramCollapsed(Sender: TObject; Node: TTreeNode);`
	`procedure tvFormulaDiagramExpanded(Sender: TObject; Node: TTreeNode);`
	`procedure jreFormulaMouseUp(Sender: TObject; Button: TMouseButton; Shift: TShiftState; X, Y: Integer);`
	`procedure jreFormulaSelectionChange(Sender: TObject);`
	`function GetFormula: string;`
	`procedure InsertText(const NewText: string);`
	`procedure SetFormula(const Value: string);`
	`procedure DiagramFormula;`
	`procedure MatchEndingParen(PriorSelection: TCharRange); overload;`
	`procedure MatchStartingParen(PriorSelection: TCharRange); overload;`
	`procedure GetGlobalVariables;`
	`procedure RemoveSpecialImplementor(AClass: TClass);`
	`procedure CreateNodesForVariables;`
	`procedure IncludeGIS_Functions(EvalAt: TEvaluatedAt);`
	`procedure RemoveActiveOnLayer;`
	`procedure RemoveSpecifiedHeadOnLayer;`
	`procedure RemoveGetVCont;`
	`procedure RemoveHufFunctions;`
	`procedure RemoveHufKx;`
	`procedure RemoveHufKy;`
	`procedure RemoveHufKz;`
	`procedure RemoveHufSs;`
	`procedure RemoveHufSy;`
	`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` is used to insert "0" in the formula.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	`btnFunctionHelp: TBitBtn;`
See btnFunctionHelpClick.

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

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

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

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

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

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

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

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

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

	`btnOK: TBitBtn;`
See btnOKClick.

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

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

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

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

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

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

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

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

	`pnlLabelItemTree: TPanel;`
`pnlLabelItemTree` holds a label for tvItems.

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

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

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

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

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

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

	`tvFormulaDiagram: TTreeView;`

	`JvNetscapeSplitter1: TJvNetscapeSplitter;`

	`gbLogicalOperators: TGroupBox;`

	`gbIntegerOperators: TGroupBox;`

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

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

	`gbNumbers: TGroupBox;`

	`gbOperators: TGroupBox;`

	`lbltems: TLabel;`

	`jreFormula: TJvRichEdit;`

	`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 jreFormulaDblClick.

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

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

	`FSelectedNode: TTreeNode;`

	`FClickSelectionStart: integer;`

	`FDiagramObjectStorage: TList;`

	`FUpdating: Boolean;`

	`FSetColor: Boolean;`

Methods

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

	`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 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 jreFormula.SetFocus;

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

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

	`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 jreFormulaDblClick and stops Timer.

	`procedure tvItemsChange(Sender: TObject; Node: TTreeNode);`

	`procedure tvItemsDblClick(Sender: TObject);`

	`procedure FormDestroy(Sender: TObject); override;`

	`procedure tvFormulaDiagramCollapsed(Sender: TObject; Node: TTreeNode);`

	`procedure tvFormulaDiagramExpanded(Sender: TObject; Node: TTreeNode);`

	`procedure jreFormulaMouseUp(Sender: TObject; Button: TMouseButton; Shift: TShiftState; X, Y: Integer);`
`jreFormulaMouseUp` sets FClickSelectionStart.

	`procedure jreFormulaSelectionChange(Sender: TObject);`

	`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 DiagramFormula;`

	`procedure MatchEndingParen(PriorSelection: TCharRange); overload;`

	`procedure MatchStartingParen(PriorSelection: TCharRange); overload;`

	`procedure GetGlobalVariables;`

	`procedure RemoveSpecialImplementor(AClass: TClass);`

	`procedure CreateNodesForVariables;`

	`procedure IncludeGIS_Functions(EvalAt: TEvaluatedAt);`
Private declarations

	`procedure RemoveActiveOnLayer;`

	`procedure RemoveSpecifiedHeadOnLayer;`

	`procedure RemoveGetVCont;`

	`procedure RemoveHufFunctions;`

	`procedure RemoveHufKx;`

	`procedure RemoveHufKy;`

	`procedure RemoveHufKz;`

	`procedure RemoveHufSs;`

	`procedure RemoveHufSy;`

	`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.12.1 on 2013-05-13 15:41:35