Class TCustomEditScreenObjectTool

DescriptionHierarchyFieldsMethodsProperties

Unit

InteractiveTools

Declaration

type TCustomEditScreenObjectTool = class(TCustomInteractiveTool)

Description

TCustomEditScreenObjectTool is meant to be the abstract ancestor of tools that need to edit TScreenObjects .

Hierarchy

Overview

Methods

Private function AreScreenObjectsSelected: boolean;
Private function SelectScreenObjects(const X, Y: integer; const SelectLowerScreenObjects, ToggleSelectedItem: boolean; const CanChangeSelection: boolean = True; const ReturnScreenObjectPresent: boolean = False): boolean;

Description

Methods

Private function AreScreenObjectsSelected: boolean;

AreScreenObjectsSelected returns True if any TScreenObjects are selected in the view to which this TCustomEditScreenObjectTool applies.

Private function SelectScreenObjects(const X, Y: integer; const SelectLowerScreenObjects, ToggleSelectedItem: boolean; const CanChangeSelection: boolean = True; const ReturnScreenObjectPresent: boolean = False): boolean;

SelectScreenObjects is used to select (or deselect) the TScreenObject at X,Y.

Parameters
X
is the X mouse coordinate.
Y
is the Y mouse coordinate.
SelectLowerScreenObjects
If SelectLowerScreenObjects is true, SelectScreenObjects will look for a TScreenObject that is below the selected one and try to select it.
CanChangeSelection
If CanChangeSelection is true, the TScreenObject at X,Y will be selected. otherwise, there will be no change in what is selected.
ReturnScreenObjectPresent
ReturnScreenObjectPresent is only used if CanChangeSelection is false. If ReturnScreenObjectPresent is true, SelectScreenObjects returns true if there is a TScreenObject at X,Y that can be selected. If ReturnScreenObjectPresent, SelectScreenObjects returns true if there already is a selected TScreenObject at X,Y.
Returns

SelectScreenObjects returns True if a TScreenObject can be selected at X,Y. Otherwise it returns False.

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