Class TfrmShowHideObjects

Description

Hierarchy

Fields

Methods

Properties

Unit

frmShowHideObjectsUnit

Declaration

type TfrmShowHideObjects = class(TfrmCustomGoPhast)

Description

TfrmShowHideObjects is used to show or hide TScreenObjects either individually or based on the data sets or boundary conditions they affect.

Hierarchy

TForm
TfrmCustomGoPhast
TfrmShowHideObjects

Overview

Fields

	`btnClose: TBitBtn;`
	`btnHelp: TBitBtn;`
	`ctvObjects: TRbwCheckTreeView;`
	`pnlBottom: TPanel;`
	`pmSelectEdit: TPopupMenu;`
	`miSelect: TMenuItem;`
	`miEdit: TMenuItem;`
	`FAllObjectsNode: TTreeNode;`
	`FBoundaryConditionsRoot: TTreeNode;`
	`FCanEdit: boolean;`
	`FDataSetRootNode: TTreeNode;`
	`FSettingData: boolean;`
	`FLeakyNode: TTreeNode;`
	`FOtherObjectsNode: TTreeNode;`
	`FRiverNode: TTreeNode;`
	`FSizeNode: TTreeNode;`
	`FSpecifiedFluxNode: TTreeNode;`
	`FSpecifiedHeadNode: TTreeNode;`
	`FWellNode: TTreeNode;`

Methods

	`procedure ctvObjectsCheckChange(Sender: TObject; Node: TCheckNode);`
	`procedure ctvObjectsItemEnter(Sender: TObject; Node: TTreeNode);`
	`procedure ctvObjectsItemClick(Sender: TObject; Button: TMouseButton; Node: TTreeNode; const Pt: TPoint);`
	`procedure FormClose(Sender: TObject; var Action: TCloseAction);`
	`procedure FormCreate(Sender: TObject); override;`
	`procedure miEditClick(Sender: TObject);`
	`procedure miSelectClick(Sender: TObject);`
	`procedure FormShow(Sender: TObject);`
	`procedure AddScreenObject(AScreenObject: TScreenObject; const DataSetList: TStringList);`
	`procedure ClearBaseNodes;`
	`procedure CreateBaseNodes;`
	`procedure EnablePopupMenuItems(Node: TTreeNode);`
	`procedure FillDataSetList(DataSetList: TStringList);`
	`procedure GetData;`
	`function GetSelectedScreenObject: TScreenObject;`
	`procedure NilBaseNodes;`
	`procedure RemoveScreenObject(AScreenObject: TScreenObject);`
	`procedure SetCanEdit(const Value: boolean);`
	`procedure SortBaseNodes;`
	`procedure SortRemainingNodes;`
	`procedure UpdateDisplay;`
	`procedure UpdateScreenObjects;`

Properties

property CanEdit: boolean read FCanEdit write SetCanEdit;

Description

Fields

	`btnClose: TBitBtn;`
`btnClose`: TBitBtn; `btnClose` is used to close the form.

	`btnHelp: TBitBtn;`
`btnHelp`: TBitBtn; `btnHelp` is used to display help for the form.

	`ctvObjects: TRbwCheckTreeView;`
`ctvObjects`: TRbwCheckTreeView; `ctvObjects` is used to display and change the visibility of the TScreenObjects. See ctvObjectsCheckChange.

	`pnlBottom: TPanel;`
`pnlBottom`: TPanel; `pnlBottom` is the panel at the bottom of the form that holds the buttons.

	`pmSelectEdit: TPopupMenu;`
`pmSelectEdit` is associated with ctvObjects and holds miSelect and miSelect;

	`miSelect: TMenuItem;`
`miSelect` is the Select menu item of pmSelectEdit. Clicking it selects the TScreenObject of the selected node.

	`miEdit: TMenuItem;`
`miEdit` is the Edit menu item of pmSelectEdit. Clicking it edits the TScreenObject of the selected node.

	`FAllObjectsNode: TTreeNode;`
`FAllObjectsNode` holds a TTreeNode for each TScreenObject.

	`FBoundaryConditionsRoot: TTreeNode;`
`FBoundaryConditionsRoot` holds a TTreeNode for each boundary condition.

	`FCanEdit: boolean;`
See CanEdit.

	`FDataSetRootNode: TTreeNode;`
`FDataSetRootNode` holds a TTreeNode for each data set.

	`FSettingData: boolean;`
`FSettingData` is used in GetData and ctvObjectsCheckChange to prevent stack overflows.

	`FLeakyNode: TTreeNode;`
`FLeakyNode` holds a TTreeNode for each TScreenObject that specifies a leaky boundary.

	`FOtherObjectsNode: TTreeNode;`
`FOtherObjectsNode` holds a TTreeNode for each TScreenObject that isn't used for anything.

	`FRiverNode: TTreeNode;`
`FRiverNode` holds a TTreeNode for each TScreenObject that specifies a river boundary.

	`FSizeNode: TTreeNode;`
`FSizeNode` holds a TTreeNode for each TScreenObject that specifies the grid element size.

	`FSpecifiedFluxNode: TTreeNode;`
`FSpecifiedFluxNode` holds a TTreeNode for each TScreenObject that specifies a specified flux boundary.

	`FSpecifiedHeadNode: TTreeNode;`
`FSpecifiedHeadNode` holds a TTreeNode for each TScreenObject that specifies a specified head boundary.

	`FWellNode: TTreeNode;`
`FWellNode` holds a TTreeNode for each TScreenObject that specifies a well boundary.

Methods

	`procedure ctvObjectsCheckChange(Sender: TObject; Node: TCheckNode);`
`ctvObjectsCheckChange` is the event handler for the OnCheckChange event of ctvObjects. It causes TScreenObjects to be displayed or hidden.

	`procedure ctvObjectsItemEnter(Sender: TObject; Node: TTreeNode);`
`ctvObjectsItemEnter` is called when the mouse passes over a TTreeNode in ctvObjects. It calls EnablePopupMenuItems.

	`procedure ctvObjectsItemClick(Sender: TObject; Button: TMouseButton; Node: TTreeNode; const Pt: TPoint);`
`ctvObjectsItemClick` enables and disables miEdit and miSelect based on whether the current node of ctvObjects has a TScreenObject.

	`procedure FormClose(Sender: TObject; var Action: TCloseAction);`
`FormClose` calls Release and sets frmShowHideObjects to nil.

	`procedure FormCreate(Sender: TObject); override;`
`FormCreate` is the event handler for the OnCreate event of `TfrmShowHideObjects`.

	`procedure miEditClick(Sender: TObject);`
See miEdit. Also the event handler for ctvObjects.OnDblClick.

	`procedure miSelectClick(Sender: TObject);`
See miSelect.

	`procedure FormShow(Sender: TObject);`
`FormShow` calls AdjustFormPosition.

	`procedure AddScreenObject(AScreenObject: TScreenObject; const DataSetList: TStringList);`
`AddScreenObject` adds one or more TTreeNodes to ctvObjects for AScreenObject. It skips TScreenObjects that are deleted.

	`procedure ClearBaseNodes;`
`ClearBaseNodes` removes all base nodes that have no children.

	`procedure CreateBaseNodes;`
`CreateBaseNodes` creates all the basal nodes of ctvObjects that will hold the nodes that have data about the TScreenObjects. `CreateBaseNodes` checks that the basal nodes don't already exist before creating them.

	`procedure EnablePopupMenuItems(Node: TTreeNode);`
`EnablePopupMenuItems` enables the menu items on pmSelectEdit if Node has a TScreenObject in its Data property.

	`procedure FillDataSetList(DataSetList: TStringList);`
`FillDataSetList` fills DataSetList with the names of the TTreeNodes for each data set. The Objects property of DataSetList holds the TTreeNodes themselves.

	`procedure GetData;`
`GetData` creates all the nodes in ctvObjects

	`function GetSelectedScreenObject: TScreenObject;`
`GetSelectedScreenObject` gets the TScreenObject associated with the selected node in ctvObjects.

	`procedure NilBaseNodes;`
`NilBaseNodes` sets FAllObjectsNode, FSizeNode, FDataSetRootNode, FBoundaryConditionsRoot, FSpecifiedHeadNode, FSpecifiedFluxNode, FLeakyNode, FRiverNode, FWellNode, and FOtherObjectsNode to nil.

	`procedure RemoveScreenObject(AScreenObject: TScreenObject);`
`RemoveScreenObject` removes all TTreeNodes related to AScreenObject from ctvObjects

	`procedure SetCanEdit(const Value: boolean);`
See CanEdit.

	`procedure SortBaseNodes;`
`SortBaseNodes` sorts the base nodes of ctvObjects.

	`procedure SortRemainingNodes;`
`SortRemainingNodes` sorts the nodes of ctvObjects that aren't base nodes alphabetically.

	`procedure UpdateDisplay;`
`UpdateDisplay` updates the checked state of nodes of ctvObjects. without adding or removing nodes.

	`procedure UpdateScreenObjects;`
`UpdateScreenObjects` adds or removes nodes as needed to make ctvObjects reflect the TScreenObjects that are present.

Properties

	`property CanEdit: boolean read FCanEdit write SetCanEdit;`
`CanEdit` is used to prevent access violations caused by attempting to edit a TScreenObject while another one is already being edited.

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