TTemplatePopup Class

Code templates plug-in.

TTemplatePopup = class(TSyntMemoPopupList);

File

ecPopupCtrl

Description

Code templates include commonly used statements (such as if, while, and for statements) that you can insert into your text.

There are three sources of code templates:

Active syntax analyzer (analyzer at the current caret position, AnalyzerAtPos) in the syntax memo (SyntMemo).
Own templates specified by the Templates.
Templates from external syntax analyzer specified by the ExternSource.

While working in the editor, press keystroke to execute command CommandID (default - Ctrl+J) to display the code templates list. Select a code template to be entered in your text in one of two ways:

Use the scroll bar as necessary and double-click the template to insert it into your code.
Type the name of the template until the characters entered refer to the entry in the list you want to include. Press Enter.

Each line of the code template is inserted at the same X position in the text line to keep same indent of all code template lines.

If the word at the left side of the caret position is equal to the short-cut (case insensitive) of any code template in the list, TTemplatePopup removes this word and inserts found code template (by using InsertTemplate method).

Otherwise Execute displays pop-up list box with templates list. User can select code template to be inserted at caret position.

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.

TSyntMemoPopupList Class

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

TTemplatePopup Class

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

Legend

	Method
	protected
	virtual
	abstract
	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.

TTemplatePopup Class

TTemplatePopup Class	Description
OnBeforeInsertTemplate	Occurs before inserting template.

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.

TSyntMemoPopupList Class

TSyntMemoPopupList Class	Description
AcceptValue	Called when list item is selected in popup list box.
Create	Creates and initializes a TSyntMemoPopupList instance.
DoAccept	Called when closing popup control. Accept specifies whether user selection in popup control should be accepted.
ParentWndProc	Window procedure of the parent window.

TTemplatePopup Class

TTemplatePopup Class	Description
Create	Creates and initializes a TTemplatePopup instance.
CurrentTemplate	Returns currently selected template.
Destroy	Destroys an instance of TTemplatePopup.
Execute	Inserts templates or displays pop-up list box to select template from the list.
GetPopupSize	Calculates size of popup control.
InsertTemplate	Inserts template in the current caret position.
ItemChanged	Called when selection in popup control is changed.
ParentWndProc	Window procedure of the parent window.

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.

TSyntMemoPopupList Class

TSyntMemoPopupList Class	Description
AutoSelect	Specifies whether list item should be automatically selected when mouse moving over it.
BgColor	Specifies background color of popup list box.
DropDownCount	Specifies the maximum number of items displayed in the pop-up list.
Font	Specifies font of popup list box.
IntegralHeight	Determines whether the list box displays the partial items.
ItemHeight	Specifies the height in pixels of an item in an owner-draw list box.
ListBox	Popup list box reference.
ListStyle	Determines whether the list box is standard or owner-draw and whether it is virtual.
OnlyDblClick	Specifies whether item in popup list box should be accepted on double mouse click.

TTemplatePopup Class

TTemplatePopup Class	Description
AutoSelect	Specifies whether list item should be automatically selected when mouse moving over it.
BgColor	Specifies background color of popup list box.
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.
DropDownCount	Specifies the maximum number of items displayed in the pop-up list.
ExternSource	Provides external source of templates.
Font	Specifies font of popup list box.
Height	Specifies height of popup control.
LayoutSide	Specifies conditional position of popup control.
ListBox	Popup list box reference.
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.
OnlyDblClick	Specifies whether item in popup list box should be accepted on double mouse click.
OnShow	Occurs immediately after showing popup control.
Options	Specifies options of the code template plug-in.
Shadow	Specifies whether popup control should drop shadow (XP and higher).
Sizable	Specifies whether user may change size of the popup control.
SortType	Specifies template items sort type.
SyntMemo	Specifies editor to which popup control is linked.
Templates	Collection of code templates.
ToolHint	Specifies tool hint window.
Width	Specifies width of popup control.

Links

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

Contents | Index

What do you think about this topic? Send feedback!