luisgulo/gambas-source-code
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

TextEditor: Add documentation.

Browse source 
[GB.FORM.EDITOR]
* NEW: TextEditor: Add documentation.
This commit is contained in:
gambas 2021-03-18 17:22:59 +01:00
parent bf7c562d35
commit ab99669d6b
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
comp/src/gb.form.editor/.src/_TextEditor_Line.class
View file

@ -151,6 +151,14 @@ Private Function InitialState_Read() As _TextEditor_State
End
'' Purge the line from its comments and/or strings, according to its highlighting.
''
'' - If ~KeepComment~ is set, the comments are kept intact. Comments are the characters associated with [Highlight.Comment](/comp/gb.eval/highlight/comment) or [Highlight.Help](/comp/gb.eval/highlight/help) styles.
'' - If ~KeepString~ is set, the strings are kept intact. Strings are the characters associated with [Highlight.String](/comp/gb.eval/highlight/string) style.
'' - ~Replace~ is the character that replaces the removed elements. By default it is a space.
''
'' If the line is not highlighted, then it is returned as is.
Public Sub Purge(Optional KeepComment As Boolean, KeepString As Boolean, Replace As String = " ") As String
Dim hDoc As CDocument = GetDoc()