TParamCompletion Class

Hint tool which shows possible parameters for the function.

TParamCompletion = class(TSyntMemoPopup, IecTextClient, IecSyntMemoClient);

File

ecPopupCtrl

Description

Displays hint window with appropriate parameters for current function.

Each item of parameter completion corresponds to single overloaded version of the function. Each item may contain different number of parameters. Items should be filled in OnGetParams or OnGetParamsEx event handlers. Use AddItem method to add new item which may contain several lines and ItemCount function to get number of items.

Separator, TerminateChar, CloseChar, OpenChar properties specify characters used to parser function parameters. When UseParserResults is True parameters are processed as tokens, so you should ensure that corresponding tokens are of length equal to 1 character.

There are two modes to parse function name. In simple mode single function name extracted and passed to OnGetParams event handler. In complex mode multiple names are extracted using rules FuncPathRule and FuncNameRule and passed to OnGetParamsEx event handler.

There is ability to display up-down control to scroll items, see UpDownSwitch, UpDownOrientation, UpDownWidth.

To enable/disable items filtration set FilterItems property.

There is ability of complex items formatting using properties: FmtEnable, FmtImages, FmtSelEndImage, FmtSelParamStyleIndex, FmtSelStartImage, FmtStyles. In this case, each parameter should be surrounded by the /X/ formatting tag.

Group

Classes

Topics

Topic	Description
TPopupControl Methods	The methods of the TPopupControl class are listed here.
TPopupControl Properties	The properties of the TPopupControl class are listed here.
TPopupControl Events	The events of the TPopupControl class are listed here.

IecCommandHook Interface

Topic	Description
IecCommandHook Methods	The methods of the IecCommandHook class are listed here.

TSyntMemoPopup Class

Topic	Description
TSyntMemoPopup Methods	The methods of the TSyntMemoPopup class are listed here.
TSyntMemoPopup Properties	The properties of the TSyntMemoPopup class are listed here.

IecSyntMemoClient Interface

Topic	Description
IecSyntMemoClient Methods	The methods of the IecSyntMemoClient class are listed here.

IecTextClient Interface

Topic	Description
IecTextClient Methods	The methods of the IecTextClient class are listed here.

TParamCompletion Class

Topic	Description
TParamCompletion Methods	The methods of the TParamCompletion class are listed here.
TParamCompletion Properties	The properties of the TParamCompletion class are listed here.
TParamCompletion Events	The events of the TParamCompletion class are listed here.

Legend

	Method
	protected
	virtual
	Property
	read only
	Event

TPopupControl Events

TPopupControl Events	Description
OnCloseUp	Occurs when popup control is closing.
OnChange	Occurs when selection in popup control is changed.
OnShow	Occurs immediately after showing popup control.
OnAdjustPopupPos	Occurs before showing popup control after calculating popup layout.
OnCanShow	Occurs before showing popup control.

TParamCompletion Class

TParamCompletion Class	Description
OnGetParams	Occurs before showing parameter hint to update items list.
OnGetParamsEx	Occurs before showing parameter hint to update items list.

TPopupControl Methods

TPopupControl Methods	Description
CalcLayout	Calculates size and position of popup control.
CanShow	Returns True if the popup control can be shown.
CloseUp	Closes popup window.
Create	Creates and initializes a TPopupControl instance.
Destroy	Destroys an instance of TPopupControl.
DoAccept	Called when closing popup control. Accept specifies whether user selection in popup control should be accepted.
DoShow	Called immediately after showing popup control.
GetPopupRect	Returns actual position of popup window.
GetPopupSize	Calculates size of popup control.
ItemChanged	Called when selection in popup control is changed.
ParentFormWndProc	Window procedure of the parent form.
ParentWndProc	Window procedure of the parent window.
PopupWndProc	Window procedure of the popup window.
PostItemChanged	Posts internal message which will call ItemChanged method in some time.
RecalculateBounds	Recalculates size and position of popup control.
ShowAround	Shows popup control around selected rectangle area.

IecCommandHook Interface

IecCommandHook Interface	Description
AfterCommand	Called after execution in syntax memo.
BeforeCommand	Called before execution in syntax memo.
IsCommandEnabled	Called to test wether command is enabled.

TSyntMemoPopup Class

TSyntMemoPopup Class	Description
Execute	Executes syntax memo plug-in.
ShowPopup	Shows popup window under character at specified position in the syntax memo.

IecSyntMemoClient Interface

IecSyntMemoClient Interface	Description
CaretPosChanged	Is called when caret position is changed.

IecTextClient Interface

IecTextClient Interface	Description
TextChanged	Called after text have been changed.

TParamCompletion Class

TParamCompletion Class	Description
AddItem	Adds single item (function entry) to the items list. Item string may contain line break characters, in this case this item will occupy several lines. It is recommended to use this function instead of adding directly to the Items list.
Create	Creates and initializes a TParamCompletion instance.
Destroy	Destroys an instance of TParamCompletion.
Execute	Executes syntax memo plug-in.
ExecuteAt	Executes parameter hint at specified position in text.
GetPopupSize	Calculates size of popup control.
ItemChanged	Called when selection in popup control is changed.
ItemCount	Returns number of items. Number of items may be less than Items.Count because, some items may occupy several lines.
ParentWndProc	Window procedure of the parent window.
ShowAt	Shows parameter hint at specified position in text.

TPopupControl Properties

TPopupControl Properties	Description
AroundRect	Specifies rectangle area around which popup control was shown.
Closing	Specifies whether popup control is closing.
Constraints	Specifies the size constraints for the popup control.
Container	Specifies popup container control.
Controls	Collection of additional controls added to popup container.
Height	Specifies height of popup control.
LayoutSide	Specifies conditional position of popup control.
MinMaxWidth	Specifies the minimal preferable width of the popup control.
Parent	Parent window.
Popup	Specifies popup control.
Shadow	Specifies whether popup control should drop shadow (XP and higher).
Sizable	Specifies whether user may change size of the popup control.
ToolHint	Specifies tool hint window.
Visible	Indicates whether popup window is visible.
Width	Specifies width of popup control.

TSyntMemoPopup Class

TSyntMemoPopup Class	Description
CommandID	Specifies identifier of the syntax memo command which will fire popup tool execution.
SyntMemo	Specifies editor to which popup control is linked.

TParamCompletion Class

TParamCompletion Class	Description
Automatic	Specifies mode of the parameter hint tool.
CloseChar	Character that closes function, default - ')'
Color	Specifies color of the hint window.
CommandID	Specifies identifier of the syntax memo command which will fire popup tool execution.
Constraints	Specifies the size constraints for the popup control.
Controls	Collection of additional controls added to popup container.
DeclSeparator	Character that is used as parameters delimiter in the hint items, default - ';'
Delay	Specifies delay between moment when hint may be displayed and showing of the hint.
Enabled	Specifies whether parameters hint has to be displayed automatically when user types text.
FilterItems	Specifies whether items should be filtered when user input parameters.
FmtEnable	Specifies whether items should be processed as formatted items.
FmtImages	Specifies images to be used for custom items formatting.
FmtSelEndImage	Specifies image which will be displayed at the end of current parameter.
FmtSelParamStyleIndex	Specifies style index which will be used to format current parameter.
FmtSelStartImage	Specifies image which will be displayed at the start of current parameter.
FmtStyles	Specifies display styles to be used for custom items formatting.
Font	Specifies font of the hint window.
FuncNameRule	Specifies grammar rule name which is associated with single function name in the chain.
FuncPathRule	Specifies grammar rule name which is associated with whole chain of function names.
Items	List of hints for the current function.
LayoutSide	Specifies conditional position of popup control.
MinMaxWidth	Specifies the minimal preferable width of the popup control.
OnAdjustPopupPos	Occurs before showing popup control after calculating popup layout.
OnCanShow	Occurs before showing popup control.
OnChange	Occurs when selection in popup control is changed.
OnCloseUp	Occurs when popup control is closing.
OnShow	Occurs immediately after showing popup control.
OpenChar	Character that opens function parameters, default - '('
ParamNumber	Currently edited parameter.
Selected	Specifies currently selected item.
Separator	Character that is used as parameters delimiter in the text, default - ','
SeparatorPen	Specifies pen properties of separator line between items.
Shadow	Specifies whether popup control should drop shadow (XP and higher).
SyntMemo	Specifies editor to which popup control is linked.
TerminateChar	Character that terminates search (operator delimiter), default - ';'
ToolHint	Specifies tool hint window.
UpDownOrientation	Specifies orientation of Up-Down control.
UpDownSwitch	Specifies whether Up-Down switch should be used to scroll items displayed in parameter hint window. To get/set currently visible item use Selected property.
UpDownWidth	Specifies width of the Up-Down control.
UseParserResults	Specifies whether internal scanner has to use tokens instead of characters scanning.

Links

Classes, Legend, Members, Topics, TParamCompletion Methods, TParamCompletion Properties, TParamCompletion Events, TPopupControl Events, TPopupControl Methods, TPopupControl Properties

Contents | Index

What do you think about this topic? Send feedback!