CBCGPEditCtrl

Detailed Description

The CBCGPEditCtrl class implements the functionality of advanced edit control with the following special features:

• IntelliSense support
• Syntax highlighting support
• Markers support
• Adjustable left-side area suitable for displaying visual markers and other information
• Extended (customizable) undo/redo support
• Block selection support
• Tooltip support
• Drag & drop support
• Line numbering
• Outlining (collapsible nodes) support

To use the CBCGPEditCtrl class in your application you can take advantage of CBCGPEditView or just embed an object of this (or derived) class in a view (or any other parent) and call CBCGPEditCtrl::Create with WS_CHILD | WS_VISIBLE styles. After that you may want to set the edit control up by loading XML settings, enabling IntelliSense support and so on.

The following is the list of classes and structures used in conjunction with the edit control:

• BCGP_BASE_UNDO_DATA,
• BCGP_EDIT_UNDO_ACTION,
• CBCGPEditMarker,
• CBCGPEditView,
• CBCGPIntelliSenseData,
• CBCGPIntelliSenseLB,
• CBCGPIntelliSenseWnd,
• CBCGPLineColorMarker

Outlining:

• BlockType,
• CBCGPOutlineBaseNode,
• CBCGPOutlineNode,
• BCGP_EDIT_OUTLINE_CHANGES,
• CBCGPOutlineParser

Inheritance diagram for CBCGPEditCtrl:

Public Member Functions
	AddOutlining	Creates a new collapsible node.
	AddUndoAction	Adds undo action to the undo buffer.
	AddUndoAction	Adds undo action to the undo buffer.
	AddUndoAction	Adds undo action to the undo buffer.
	AddUndoAction	Adds undo action to the undo buffer.
	BookmarkLine	Toggles bookmark in the specified line.
	CanRedo	Tells whether redo operation is available.
	CanRemoveMarker	Called by the framework when it's about to remove a marker.
	CanUndo	Tells whether an undo operation is available or not.
	CanUpdateMarker	Called by the framework when the marker line is about to be updated.
	CleanUpMarkers	Removes all markers from the edit control.
	Clear	Clears (deletes) the selected text without copying it to the Clipboard.
	ClientToVirt	Converts a point in client coordinates to document coordinates.
	ClientToVirt	Converts a point in client coordinates to document coordinates.
	CollapseToDefinitions	Collapses the members of all outlining types.
	CommentSelectedText	Call this method to comment/uncomment selected text.
	Copy	Copies either selected text or the whole text to the Clipboard in CF_TEXT format.
	Create	Creates a Windows child window and attaches it to the CBCGPEditCtrl object.
	CreateOutlineParser	Creates outline parser.
	Cut	Deletes (cuts) the current selection (if any) in the edit control and copies the deleted text to the Clipboard in CF_TEXT format.
	DeleteAllMarkers	Removes all markers.
	DeleteMarker	Deletes a marker of specified type at the particular row.
	DeleteMarker	Deletes a marker of specified type at the particular row.
	DeleteSelectedText	Deletes the selected text from the edit control.
	DeleteText	Deletes a block of text from the edit control.
	Down	Moves the caret to the next line. Scrolls the window if necessary.
	EmptyUndoList	Removes all undo operations from the undo buffer.
	EnableAutoHideScrollBars	Scpecifies whether control's scroll bars should be hidden when scroll bars are inactive (mouse cursor is located outside of scrollbar).
	EnableAutoOutlining	Enables or disables auto-outlining.
	EnableCommentingSelectedText	Enables or disables the commenting of selected text.
	EnableErrorIndication	Enables or disables edit control error indication. By default, the error indication is disabled.
	EnableGradientMarkers	Enable or disable gradient markers.
	EnableIntelliSense	Enables or disables IntelliSense support.
	EnableOutlineParser	Enables/disables the outlining parser.
	EnableOutlining	Enables or disables outlining.
	EnableSyntaxHilightingOnColorLine	Enables or disables the syntax hilighting on the colored line.
	EnableSyntaxHilightingOnHiliteMarkers	Enables or disables the syntax hilighting on the hilite markers.
	EnableSyntaxHilightingOnSelection	Enables or disables the syntax hilighting on the selection area.
	EnableToolTips	Enables tooltips.
	EnableUndoCharMode	Enables or disables undo "char mode".
	EnableVisualManagerMarkers	Enable or disable visual theme-style markers.
	EnableZoom	Enables/disables editor zooming by the mouse wheel (when Ctrl is pressed) or gesture zoom.
	End	Sets the caret at the end of the current line.
	EndOfText	Sets the caret at the end of text.
	ExportToHTML	Saves the content of edit control to a memory buffer adding HTML tags for color blocks.
	ExportToRTF	Exports text from edit control to a buffer in RTF format.
	FillIntelliSenseList	Called by the edit control when it needs to fill a list with IntelliSense data.
	FindMarkerByData	Searches the list of markers by user-defined data.
	FindText	Finds and selects a text in the edit control.
	FindWordStartFinish	Given an offset finds the offsets of the beginning and end of a word.
	GetCaretSize	Returns the size, in pixels, of the caret.
	GetCharAt	Returns a character from the internal text buffer at the given position.
	GetCommentChars	Returns comment characters specified by EnableCommentingSelectedText() method.
	GetCurColumn	Returns the current column.
	GetCurLine	Returns text string at the current line.
	GetCurOffset	Returns the current caret offset from the beginning of the text.
	GetCurRow	Returns the current caret row.
	GetFirstVisibleLine	Determines the topmost visible line.
	GetIncorrectWordToolTip	Called by the framework to obtain tooltip which appears near an incorrect word.
	GetIntelliSenseImgList	Returns a pointer to the image list associated with the IntelliSense list box.
	GetIntelliSenseLBFont	Returns the font that is currently used to display the IntelliSense data.
	GetLastUndoReason	Retrieves the last undo reason.
	GetLine	Given a line number retrieves a line from the internal buffer.
	GetLine	Given a line number retrieves a line from the internal buffer.
	GetLineCount	Returns the number of lines in the edit control.
	GetLineHeight	Returns the height of a single line in the text.
	GetLineNumbersMarginWidth	Returns the width of the line numbers margin.
	GetMarker	Obtains a marker of some type at the specified row.
	GetMarker	Obtains a marker of some type at the specified position.
	GetMarkerList	Returns the list of all markers.
	GetMarkerListByData	Queries the list of markers by the user-defined data.
	GetMarkerListByType	Returns a list of all markers of the specified type (s).
	GetMarkersInRange	Returns the list of markers whose lines are in the specified range.
	GetOutlineMarginWidth	Returns the width of the outline margin.
	GetOverrideMode	Tells whether the edit control in the override mode or not.
	GetRedoActions	Returns the list of available redo actions.
	GetScale	Returns control font scale.
	GetSel	Returns the current selection range.
	GetSelText	Retrieves the text from the current selection
	GetSymbolExtraLen	Returns additional spacing for a special symbol.
	GetSymImgList	Returns a pointer to image list used to display special symbols.
	GetTabSize	Returns the tabulation size.
	GetText	Returns the reference to the internal text buffer.
	GetTextLeftMargin	Returns a distance between text and left-side bar.
	GetUndoActions	Returns the list of available undo actions.
	GetWordCorrections	Called by the framewrok to obtain a list of suggestions and list of custom action associated with incorrect word.
	GetWordFromOffset	Given an offset from the beginning of the text returns a word at this offset.
	GetWordFromPoint	Given a point in client coordinates returns a word at this point.
	GoToFirstMarker	Moves the caret to the first marker.
	GoToLine	Scrolls edit control to specified line.
	GoToMarker	Moves the caret to the specified marker.
	GoToNextMarker	Moves the caret to the next marker in the specified (up or down) direction.
	HasMarkers	Tells whether the edit control contains the markers of the specified type (s).
	HasSelection	Tells whether the edit control has selected text.
	HideSelection	Turns selected text into collapsible node.
	HitTest	Given a point in the client coordinates returns the offset of a symbol containing this point from the beginning of the text.
	Home	Moves caret to the beginning of the current line.
	IndentSelection	Indents the selected text forward or backward.
	IndentText	Indents a block of text forward or backward inserting or deleting spaces.
	InsertChar	Inserts a character into edit control.
	InsertMarker	Inserts a new marker into the list of markers.
	InsertNewLine	Inserts a new line into the edit control.
	InsertTab	Inserts the tabulation into the edit control.
	InsertText	Inserts text into the edit control at specified position.
	InvokeIntelliSense	Invokes the IntelliSense list box.
	InvokeIntelliSense	Invokes the IntelliSense list box.
	InvokeSymList	Invokes the IntelliSense-like listbox with the list of symbols (images).
	IsAutoOutliningEnabled	Tells whether the auto-outlining is enabled or not.
	IsCopyEnabled	Tells whether text copy is enabled (TRUE) or disabled (possible).
	IsCorrectWord	Called by the framework when it needs to obtain a word "corectness" status.
	IsCutEnabled	Tells whether the text cut is enabled or not.
	IsDPIAware	Tells whether the edit control is DPI aware.
	IsErrorIndicationEnabled	Tells whether an error indication is enabled.
	IsGradientMarkersEnabled	Tells whether gradient markers enabled or not.
	IsInBlock	Determines whether the specifies offset is located between two characters.
	IsIndentEnabled	Tells whether text indentation is possible.
	IsIntelliSenseEnabled	Tells whether IntelliSense support is enabled or disabled.
	IsLineNumbersMarginVisible	Determine whether the line margin is visible or not
	IsModified	Tells whether text in the edit control is modified or not.
	IsOutlineMarginVisible	Tells whether the outline margin is visible or not.
	IsOutliningEnabled	Tells whether the outlining is enabled or not.
	IsPasteEnabled	Tells whether paste from the Clipboard is allowed (enabled).
	IsProcessClipboardAccelerators	Tells whether the edit control automatically processes the standard keyboard accelelators.
	IsReadOnly	Tells whether the edit control is read-only or not.
	IsScrollBarAutoHideEnabled	Tells whether control's scroll bars are auto-hidden.
	IsSyntaxHilightingOnColorLine	Tells whether the syntax hilighting on the colored line is enabled.
	IsSyntaxHilightingOnHiliteMarkers	Tells whether the syntax hilighting on the hilite markers is enabled.
	IsSyntaxHilightingOnSelection	Tells whether the syntax hilighting on the selection area is enabled.
	IsViewWhiteSpace	Tells whether the edit contol draws special symbold on the white space or not.
	IsVisualManagerMarkersEnabled	Tells whether visual theme-style markers enabled or not.
	IsZoomEnabled	Tells whether editor zooming is enabled.
	Left	Advances the caret to one position in the left direction.
	LineFromChar	Retrieves the number of the line that contains the specified character index.
	LineIndex	Retrieves the character index of the line.
	LineLength	Retrieves the length of a line in an edit control
	LineScroll	Scrolls the text of an edit control.
	LoadOutlineParserXMLSettings	Loads XML settings for outline parser.
	LoadXMLSettings	Loads XML settings from a disk file.
	LoadXMLSettingsFromBuffer	Loads XML settings from a memory buffer.
	LoadXMLSettingsFromResource	Loads XML settings from application resource.
	LoadXMLSettingsFromResource	Loads XML settings from application resource.
	LookUpSymbol	Called by the framework when the symbol support is enabled every time it needs to check if a character should be replaced by a symbol (image).
	MakeSelection	Selects a block of text according to selection type.
	MarkAll	Mark all lines which contain a specified text.
	NextWord	Moves the caret to the next word. Scrolls the text if necessary.
	OffsetToPoint	Given an offset from the beginning of text buffer returns a point in the client coordinates.
	OnAfterTextChanged	Called by the edit control when the text has been changed.
	OnAfterUndoRedo	Called by the framework after undo or redo action has been executed.
	OnBeforeAddUndoAction	Called by the framework before an undo action is added to the undo buffer.
	OnBeforeInvokeIntelliSense	Called by the framework before the IntelliSense is invoked.
	OnBeforeTextDeleted	Called by the edit control when a piece of text is about to be deleted from the edit control.
	OnBeforeTextInserted	Called by the edit control when a fragment of text is about to be inserted in the edit control.
	OnCalcOutlineSymbol	Called to recalculate the outline symbol.
	OnDelete	Deletes a symbol at the current position or selected text.
	OnDeleteTextFromBuffer	Called by the framework when text is deleted from the edit control.
	OnDrawErrorIndication	Called when the edit control needs to draw an error indication.
	OnDrawMarker	Called by the framework when it needs to draw a marker.
	OnDrawOutlineBar	Called by the framework when it needs to draw the outline side bar.
	OnDrawOutlineButton	Called when the edit control needs to draw an outline button.
	OnDrawOutlineSymbol	Called when the edit control needs to draw the replace symbol instead of the hidden text
	OnDrawSideBar	Called by the framework when it needs to draw the side bar from the left.
	OnDrawSymbol	Called by the framework when it needs to display a symbol.
	OnDrawText	Called by the framework to draw the edit control's text.
	OnFailedOperation	Called when an operation has failed.
	OnFillBackground	Called by the framework to fill the edit control's background.
	OnFillIntelliSenseList	Called by the framework when it needs to fill the IntelliSense list with data.
	OnFillSymListData	Called by the framework when it needs to fill the IntelliSense-like symbol list with data.
	OnGetCharColor	Called by the framework when it draws the text and it needs to retrieve the color for the current character to be drawn.
	OnGetTipText	Called by the framework when it needs to obtain the tooltip text.
	OnGetWordColor	Called by the edit control when it draws the text and needs to retrieve the current word color.
	OnGoToNextMarker	Called by the framework when next or previous marker should be focused.
	OnInsertOutlineBlock	Called by the framework when a collapsible node is inserted
	OnInsertTextToBuffer	Called when a piece of text is being inserted into the edit control.
	OnOutlineButtonClick	Called by the framework when a user clicks left mouse button at the outline margin.
	OnOutlineChanges	Called when the outlining information in the edit control has changed
	OnRedo	Performs redo operation.
	OnRemoveMarker	Called by the framework when a marker is about to be removed.
	OnRemoveOutlineBlock	Called by the framework when a collapsible node is removed.
	OnRemoveUndoAction	Called by the framework when undo action data is being removed.
	OnScaleChanged	Called by the framework when control font has been scaled.
	OnSetCaret	Called by the framework when position of caret has changed.
	OnSetOvrMode	Called by the framework when when the override mode is switched on or off.
	OnUndo	Performs the next undo action.
	OnUpdateAutoOutlining	Called when the text in edit control has changed.
	OnUpdateMarkerLine	Called by the edit control when a marker's line is about to be updated.
	OnWordCorrectionMenuCustomAction	Override this method to execute a custom action associated with incorrect word.
	OpenFile	Opens a file, reads text from it and sets this text to the edit control.
	OpenFile	Opens a file, reads text from it and sets this text to the edit control.
	PageDown	Scrolls one page down.
	PageUp	Scrolls one page up.
	Paste	Pastes the text from the Clipboard to the edit control at the specified position.
	PrevIndent	Moves the caret to the previous indent position.
	PrevWord	Moves the caret to the previous word.
	ProcessTextBeforeInsert	Called by the framework just before the text is inserted into the edit control.
	RedrawMarkerArea	Redraws the marker area for a single marker.
	RedrawText	Redraws text between specified rows.
	RedrawTextOffsets	Redraws text in the specifies range defined by offsets.
	RemoveAllBlocks	Removes all color blocks.
	RemoveAllWordsFromColorTable	Removes all words from the color table.
	RemoveBlockColor	Removes a color block definition from the list of color block definitions.
	RemoveSelection	Removes selection from the edit control.
	RemoveWordFromColorTable	Removes a word from the color table.
	RemoveXMLSettings	Removes all syntax highlighting settings that have been applied to the edit control.
	ReplaceAll	Replaces all matching substrings in the edit control.
	ReplaceSel	Replaces the current selection with the specified text.
	ReplaceText	Finds, replaces and selects text in the edit control.
	Right	Advances the caret to one position in the right direction.
	SaveFile	Saves the edit control's text to a file.
	SaveFile	Saves the edit control's text to a file.
	ScrollDown	Scrolls the edit control one line down or one step right.
	ScrollEnd	Scrolls the edit control to the end of text or to the most right position of the horizontal scroll bar.
	ScrollHome	Scrolls the edit control to the beginning of the text.
	ScrollPageDown	Scrolls one page down vertically or horizontally.
	ScrollPageUp	Scrolls one page up vertically or horizontally.
	ScrollText	Scrolls text one line up or down.
	ScrollToCaret	Scroll to the currently focused editor location.
	ScrollUp	Scrolls the edit control up vertically or horizontally.
	SelectLine	Selects a line.
	SelectLineRange	Selects several lines.
	SetBlockColor	Adds a new color block definition to the list of color block definitions.
	SetCaret	Sets the caret at the specified offset.
	SetColorBlockStrLenMax	Sets the new length of color block.
	SetDPIAware	Specifies whether the edit control is DPI aware.
	SetIntelliSenseImgList	Associates a new image list with the IntelliSense data.
	SetIntelliSenseLBFont	Sets the font to be used in the IntelliSense list box to display the data.
	SetLastUndoReason	Sets the last undo reason
	SetLineColorMarker	Sets a new line color marker.
	SetLineNumbersMargin	Shows or hides line numbers.
	SetMarker	Sets a marker at the specified row.
	SetMarkerData	Associates the user-defined data with a marker.
	SetMarkerData	Associates the user-defined data with a marker.
	SetModified	Sets or clears the "modified" flag for the editor's document.
	SetOutlineMargin	Sets outline margin of the editor.
	SetOverrideMode	Enables or disables override mode.
	SetPrinterFont	Sets the font to be used for printing.
	SetProcessClipboardAccelerators	Specifies whether the edit control automatically processes the standard keyboard accelelators.
	SetReadOnly	Sets read-only flag and makes the edit control read-only.
	SetScale	Specifies control font scale.
	SetScalingRange	Specifies control font scaling range.
	SetSel	Sets the current selection.
	SetSel2	Sets the current selection.
	SetSymImgList	Associates a new image list with symbol definitions.
	SetTabSize	Sets tabulation size.
	SetTextLeftMargin	Specifies a distance between text and left-side bar. By default, this value is 1.
	SetViewWhiteSpace	Specifies whether the edit contol draws special symbold on the white space.
	SetWordColor	Assigns the specified foreground and background colors to a word.
	StartOfText	Moves the caret to the beginning of text.
	StopHidingCurrent	Deletes a collapsible node(s) selected by user.
	StopOutlining	Cancels outlining mode.
	ToggleAllOutlining	Toggles outline mode for the whole text.
	ToggleMarker	Toggles a marker at the specified row.
	ToggleOutlining	Toggles outlining inside selection.
	ToolTipPop	Removes tooltip.
	Up	Moves the caret to the previous line. Scrolls the window if necessary.
	UpdateAutoOutlining	Updates the outlining information for the specified range.
	UpdateScrollBars	Updates scroll bar's range and position.
	VirtToClient	Converts a point in document coordinates to client coordinates.
	VirtToClient	Converts a point in document coordinates to client coordinates.

Public Attributes
	m_bColorHyperlink	Enables or disables support for hyperlink.
	m_bDefaultIndent	Specifies indentation option for the edit control.
	m_bEnableCurrentLineCopy	Enables or disables the ability to copy the current line text to the Clipboard when the current line is not selected.
	m_bEnableSymSupport	If TRUE, symbol support is enabled. If FALSE, symbol support is disabled.
	m_bEnableWholeTextCopy	Enables or disables the ability to copy the whole text buffer into the Clipboard.
	m_bReplaceTabsAndEOLOnCopy	Specifies whether to replace tab symbols and end of line symbols when the text is copied to the Clipboard.
	m_clrBack	Specifies the background color of text in the edit control.
	m_clrBackLineNumber	Background color for the line numbers area of the editor.
	m_clrBackOutline	Specifies background color of the outline area.
	m_clrBackSelActive	Specifies the background color of selected text in the edit control when the edit control has the input focus.
	m_clrBackSelInActive	Specifies the background color of selected text in the edit control when the edit control is not active.
	m_clrBackSidebar	Background color of the sidebar of the editor.
	m_clrHyperlink	Specifies the color for hyper links. If it is -1, then the default color is used.
	m_clrLineOutline	Specifies the color used to paint lines in the outline area.
	m_clrText	Specifies the foreground color of text in the edit control.
	m_clrTextLineNumber	This color is used to display line numbers in the line numbers area of the editor.
	m_clrTextSelActive	Specifies the foreground color of selected text in the edit control when the edit control has the input focus.
	m_clrTextSelInActive	Specifies the foreground color of selected text in the edit control when the edit control is not active (doesn't have the input focus).
	m_lstSymDefs	List of symbol definitions
	m_lstURLPrefixes	The list of URL prefixes required for hyperlink support.
	m_nIndentSize	Specifies the indentation size.
	m_nLeftMarginWidth	Specifies the width of left margin.
	m_nLineVertSpacing	Specifies the additional spacing between text lines.
	m_nOutlineMarginWidth	Specifies the width of outline margin at the left.
	m_nTabSize	Defines the tab size.
	m_strContinueStringSymbols	Defines a list of symbols that are used in the edit control to mark and exclude closing blocks from the string color blocks.
	m_strIndentChars	Defines what characters to insert when the text is indented.
	m_strIntelliSenseChars	Defines the list of symbols to be used for IntelliSense invocation.
	m_strNonSelectableChars	Defines a list of symbols (delimiters) that can't be selected by double click.
	m_strSpecialDelimiters	Defines a list of special delimiters.
	m_strWordDelimeters	Specifies a set of characters used as word delimiters in the edit control.

Protected Member Functions
	CopyTextToClipboard	Copies a text string to the Clipboard.
	DrawString	Draws a string in the edit control.
	ExportToRTF	Exports text from edit control to a buffer in RTF format.
Protected Member Functions inherited from CBCGPGestureBase
	OnGestureEventBegin	Called by the framework to handle BCGP_GID_BEGIN notification.
	OnGestureEventEnd	Called by the framework to handle BCGP_GID_END notification.
	OnGestureEventPressAndTap	Called by the framework to handle BCGP_GID_PRESSANDTAP notification.
	OnGestureEventRotate	Called by the framework to handle BCGP_GID_ROTATE notification.
	OnGestureEventTwoFingerTap	Called by the framework to handle BCGP_GID_TWOFINGERTAP notification.
	ProcessGestureEvent	This method should be called from WM_GESTURE message handler.

Protected Attributes
	m_bKeepTabs	Specifies whether the edit control keeps the tab '\t' symbols or replaces them with spaces.
	m_bViewWhiteSpace	Specifies whether the edit control draws special symbols on the empty ("white") space.
	m_iEndSel	Holds the end selection offset.
	m_iStartSel	Holds the start selection offset.
	m_lstUndoActions	The internal buffer containing undo actions.
	m_nCurColumn	Holds the current column.
	m_nCurrOffset	Holds the current offset.
	m_nLineHeight	Holds the line height.
	m_nMaxCharWidth	Specifies the maximal character width.
	m_nMaxScrollWidth	The maximal scroll width.
	m_nUndoBufferSize	Specifies the size of undo buffer.
	m_posUndoBuffer	Position in the internal undo buffer.
	m_strBuffer	The internal text buffer.