-
Notifications
You must be signed in to change notification settings - Fork 71
/
RichEdit.ahk
2097 lines (1724 loc) · 78.5 KB
/
RichEdit.ahk
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* Title: RichEdit
This module allows you to create and programmatically set text properties in rich edit control.
Besides that, it contains functions that work with standard edit controls. Each function contains
description for which kind of control it can be used - any control supporting edit control interface
(Edit, RichEdit, HiEdit...) or just rich edit control.
*/
/*
Function: Add
Create rich edit version 4.1 control. (requires at least Windows XP SP1)
Parameters:
HParent - Handle of the parent of the control.
X..H - Position.
Style - White space separated list of control styles. Any integer style or one of the style keywords (see below).
Invalid styles are skipped. "*MULTILINE WANTRETURN VSCROLL*" by default.
Text - Control text.
Styles:
DISABLENOSCROLL - Disables scroll bars instead of hiding them when they are not needed.
BORDER - Displays the control with a sunken border style so that the rich edit control appears recessed into its parent window.
HIDDEN - Don't show the control.
VSCROLL - Enble vertical scroll bar.
HSCROLL - Enable horizontal scroll bar. If this style is present control starts with wrap mode deactivated. Otherwise, wrap mode is active.
SCROLL - Enable both scroll bars.
AUTOHSCROLL - Automatically scrolls text to the right by 10 characters when the user types a character at the end of the line. When the user presses the ENTER key, the control scrolls all text back to position zero.
AUTOVSCROLL - Automatically scrolls text up one page when the user presses the ENTER key on the last line.
CENTER - Centers text in a single-line or multiline edit control.
LEFT - Left aligns text.
MULTILINE - Designates a multiline edit control. The default is single-line edit control.
NOHIDESEL - Negates the default behavior for an edit control. The default behavior hides the selection when the control loses the input focus and inverts the selection when the control receives the input focus. If you specify *NOHIDESEL*, the selected text is inverted, even if the control does not have the focus.
NUMBER - Allows only digits to be entered into the edit control.
PASSWORD - Displays an asterisk (*) for each character typed into the edit control. This style is valid only for single-line edit controls.
READONLY - Prevents the user from typing or editing text in the edit control.
RIGHT - Right aligns text in a single-line or multiline edit control.
SELECTIONBAR - When set, there is small left margin (wider than default) where cursor changes to right-up arrow allowing full line(s) selection. This style also requires use of *MULTILINE* style.
WANTRETURN - Specifies that a carriage return be inserted when the user presses the ENTER key while entering text into a multiline edit control in a dialog box. If you do not specify this style, pressing the ENTER key has the same effect as pressing the dialog box's default push button. This style has no effect on a single-line edit control.
Returns:
Control's handle or 0. Error message on problem.
Example:
(start code)
Gui, +LastFound
hwnd := WinExist()
hRichEdit := RichEdit_Add(hwnd, 5, 5, 200, 300)
Gui, Show, w210 h310
(end code)
*/
RichEdit_Add(HParent, X="", Y="", W="", H="", Style="", Text="") {
static WS_CLIPCHILDREN=0x2000000, WS_VISIBLE=0x10000000, WS_CHILD=0x40000000
,ES_DISABLENOSCROLL=0x2000, EX_BORDER=0x200
,ES_LEFT=0, ES_CENTER=1, ES_RIGHT=2, ES_MULTILINE=4, ES_AUTOVSCROLL=0x40, ES_AUTOHSCROLL=0x80, ES_NOHIDESEL=0x100, ES_NUMBER=0x2000, ES_PASSWORD=0x20,ES_READONLY=0x800,ES_WANTRETURN=0x1000 ;, ES_SELECTIONBAR = 0x1000000
,ES_HSCROLL=0x100000, ES_VSCROLL=0x200000, ES_SCROLL=0x300000
,MODULEID
if !MODULEID
init := DllCall("LoadLibrary", "Str", "Msftedit.dll", "Uint"), MODULEID := 091009
ifEqual, Style,, SetEnv, Style, MULTILINE WANTRETURN VSCROLL
hStyle := InStr(" " Style " ", " hidden ") ? 0 : WS_VISIBLE, hExStyle := 0
Loop, parse, Style, %A_Tab%%A_Space%
{
IfEqual, A_LoopField, ,continue
else if A_LoopField is integer
hStyle |= A_LoopField
else if (v := ES_%A_LOOPFIELD%)
hStyle |= v
else if (v := EX_%A_LOOPFIELD%)
hExStyle |= v
else if (A_LoopField = "SELECTIONBAR")
selectionbar := true
else continue
}
/*
class := A_OSVersion = "WIN_95" ? "RICHEDIT" : "RichEdit20A"
hModule := DllCall("LoadLibrary", "str", (class="RichEdit20A" ? "riched20.dll" : "riched32.dll") )
http://www.soulfree.net/tag/391
RE version - DLL (hModule)- class
1.0 - Riched32.dll - RichEdit
2.0 - Riched20.dll - RichEdit20A or RichEdit20W (ANSI or Unicode window classes)
3.0 - Riched20.dll - ?
4.1 - Msftedit.dll - RICHEDIT50W
2.0 not compatible w/ EM_CONVPOSITION, EM_GETIMECOLOR, EM_GETIMEOPTIONS, EM_GETPUNCTUATION,
EM_GETWORDWRAPMODE, EM_SETIMECOLOR, EM_SETIMEOPTIONS, EM_SETPUNCTUATION, EM_SETWORDWRAPMODE
Windows XP SP1 Includes Rich Edit 4.1, Rich Edit 3.0, and a Rich Edit 1.0 emulator.
Windows XP Includes Rich Edit 3.0 with a Rich Edit 1.0 emulator.
Windows Me Includes Rich Edit 1.0 and 3.0.
Windows 2000 Includes Rich Edit 3.0 with a Rich Edit 1.0 emulator.
Windows NT 4.0 Includes Rich Edit 1.0 and 2.0.
Windows 98 Includes Rich Edit 1.0 and 2.0.
Windows 95 Includes only Rich Edit 1.0. However, Riched20.dll is compatible with Windows 95 and may be installed by an application that requires it.
*/
hCtrl := DllCall("CreateWindowEx"
, "Uint", hExStyle ; ExStyle
, "str" , "RICHEDIT50W" ; ClassName
, "str" , Text ; WindowName
, "Uint", WS_CHILD | hStyle ; Edit Style
, "int" , X ; Left
, "int" , Y ; Top
, "int" , W ; Width
, "int" , H ; Height
, "Uint", HParent ; hWndParent
, "Uint", MODULEID ; hMenu
, "Uint", 0 ; hInstance
, "Uint", 0, "Uint") ; must return uint.
return hCtrl, selectionbar ? RichEdit_SetOptions( hCtrl, "OR", "SELECTIONBAR" ) : ""
}
/*
Function: AutoUrlDetect
Enable, disable, or toggle automatic detection of URLs in the RichEdit control.
Parameters:
Flag - Specify true to enable automatic URL detection or false to disable it. Specify
*"^"* to toggle its current state. Omit to only return current state without any change.
Returns:
If auto-URL detection is active, the return value is 1.
If auto-URL detection is inactive, the return value is 0.
Example:
(start code)
MsgBox, % RichEdit_AutoUrlDetect( hRichEdit, true )
MsgBox, % RichEdit_AutoUrlDetect( hRichEdit, "^" )
MsgBox, % "Current state: " RichEdit_AutoUrlDetect( hRichEdit )
(end code)
*/
RichEdit_AutoUrlDetect(HCtrl, Flag="" ) { ;wParam Specify TRUE to enable automatic URL detection or FALSE to disable it.
static EM_AUTOURLDETECT=0x45B, EM_GETAUTOURLDETECT=0x45C
If (Flag = "") || (Flag ="^") {
SendMessage, EM_GETAUTOURLDETECT,,,,ahk_id %HCtrl%
ifEqual, Flag,, return ERRORLEVEL
Flag := !ERRORLEVEL
}
SendMessage, EM_AUTOURLDETECT, Flag,,, ahk_id %HCtrl%
return Flag
}
/*
Function: CanPaste
Determines whether an Edit control can paste a specified clipboard format.
Parameters:
ClipboardFormat - Specifies the Clipboard Formats to try. To try any format currently on the clipboard, set this parameter to zero.
The default is 0x1 (CF_TEXT).
Returns:
True if the clipboard format can be pasted otherwise false.
Remarks:
For additional information on clipboard formats, see the following:
<http://msdn.microsoft.com/en-us/library/ms649013(VS.85).aspx>
Related:
<Paste>, <PasteSpecial>
Example:
(start code)
If RichEdit_CanPaste( hRichEdit, 0 )
RichEdit_Paste( hRichEdit )
Else
MsgBox, Cannot paste your clipboard into control..
(end code)
*/
RichEdit_CanPaste(hEdit, ClipboardFormat=0x1) {
Static EM_CANPASTE := 1074
SendMessage EM_CANPASTE,ClipboardFormat,0,,ahk_id %hEdit%
return ErrorLevel
}
/*
Function: CharFromPos
Gets information about the character closest to a specified point in the client area of the Edit control.
Parameters:
X, Y - The coordinates of a point in the Edit control's client area relative to the upper-left corner of the client area.
Returns:
The character index of the specified point or the character index to
the last character if the given point is beyond the last character in the control.
*/
RichEdit_CharFromPos(hEdit,X,Y) {
Static EM_CHARFROMPOS:=0xD7
WinGetClass, cls, ahk_id %hEdit%
if cls in RICHEDIT50W
VarSetCapacity(POINTL, 8), lParam := &POINTL, NumPut(X, POINTL), NumPut(Y,POINTL)
else lParam := (Y<<16)|X
SendMessage EM_CHARFROMPOS,,lParam,,ahk_id %hEdit%
return ErrorLevel
}
/*
Function: Clear
Send to an Edit control or combo box to delete (clear) the current selection.
Remarks:
To delete the current selection and place the deleted content on the clipboard, use the Cut operation.
Related:
<Cut>, <Copy>, <Paste>
*/
RichEdit_Clear(hEdit) {
static WM_CLEAR=0x303
SendMessage WM_CLEAR,,,,ahk_id %hEdit%
}
/*
Function: Convert
Convert twips to pixels or vice-versa.
Parameters:
Input - Twips (Input>0) or pixels (Input<0).
Direction - 0 (default) or 1. Pixels are not always square (the height and width are not the same).
Therefore, it is necessary to pass in the desired "direction" to use, horizontal (0) or vertical (1).
Returns:
Rounded value.
*/
RichEdit_Convert(Input, Direction=0) {
static twipsPerInch = 1440, LOGPIXELSX=88, LOGPIXELSY=90, tpi0, tpi1
if !tpi0
dc := DllCall("GetDC", "uint", 0, "Uint")
, tpi0 := DllCall("gdi32.dll\GetDeviceCaps", "uint", dc, "int", LOGPIXELSX)
, tpi1 := DllCall("gdi32.dll\GetDeviceCaps", "uint", dc, "int", LOGPIXELSY)
, DllCall("ReleaseDC", "uint", 0, "uint", dc)
return (Input>0) ? (Input * tpi%Direction%) // twipsPerInch : (-Input*twipsPerInch) // tpi%Direction%
}
/*
Function: Copy
Copy selection of the Edit control.
Related:
<Cut>, <Clear>, <Paste>
*/
RichEdit_Copy(hEdit) {
Static WM_COPY:=0x301
SendMessage WM_COPY,0,0,,ahk_id %hEdit%
}
/*
Function: Cut
Cut selection from the Edit control.
Related:
<Copy>, <Clear>, <Paste>
*/
RichEdit_Cut(hEdit) {
Static WM_CUT:=0x300
SendMessage WM_CUT,,,,ahk_id %hEdit%
}
/*
Function: FindText
Find desired text in the Edit control.
Parameters:
Text - Text to be searched for.
CpMin - Start searching at this character position. By default 0.
CpMax - End searching at this character position. When searching forward, a value of 1 extends the search range to the end of the text.
Flags - Space separated combination of search flags. See below.
Flags:
WHOLEWORD - If set, the operation searches only for whole words that match the search string. If not set, the operation also searches for word fragments that match the search string.
MATCHCASE - If set, the search operation is case-sensitive. If not set, the search operation is case-insensitive.
DOWN - Rich Edit only: If set, the search is from the end of the current selection to the end of the document.
If not set, the search is from the end of the current selection to the beginning of the document.
UNICODE - Transforms Text into the Unicode charset before searching for it.
Returns:
The zero-based character position of the next match, or -1 if there are no more matches.
Remarks
The *CpMin* member always specifies the starting-point of the search, and *CpMax* specifies the end point.
When searching backward, *CpMin* must be equal to or greater than *CpMax*.
Example:
(start code)
^f::
RichEdit_HideSelection( hRichEdit, false )
Dlg_Find( hwnd, "OnFind", "d" )
return
OnFind(Event, Flags, FindText, ReplaceText) {
global hRichEdit
IfNotEqual, Event, F, return
RichEdit_GetSel(hRichEdit, min, max)
word := InStr(Flags,"w") ? " WHOLEWORD" : ""
case := InStr(Flags,"c") ? " MATCHCASE" : ""
InStr( Flags, "d" ) ? (pos:=max+1 , direction:=" DOWN")
: (pos:=max-1)
; search control for word
pos:=RichEdit_FindText(hRichEdit,FindText,pos,-1,"unicode" direction word case)
; highlight found match
if pos != -1
RichEdit_SetSel(hRichEdit, pos, pos+StrLen(FindText))
Else
MsgBox, no matches found..
}
return
(end code)
*/
RichEdit_FindText(hEdit, Text, CpMin=0, CpMax=-1, Flags="UNICODE") {
static EM_FINDTEXT=1080, FR_DOWN=1, FR_WHOLEWORD=2, FR_MATCHCASE=4, FR_UNICODE=0
hFlags := 0
loop, parse, Flags, %A_Tab%%A_Space%,
ifEqual, A_LoopField,,continue
else hFlags |= FR_%A_LOOPFIELD%
If InStr(Flags, "Unicode") {
VarSetCapacity( uText, (len:=StrLen(Text))*2+1), DllCall( "MultiByteToWideChar", "Int",0,"Int",0,"Str",Text,"UInt",len,"Str", uText, "UInt", len )
txtAdr := &uText
} else txtAdr := &Text
VarSetCapacity(FT, 12)
NumPut(CpMin, FT, 0)
NumPut(CpMax, FT, 4)
NumPut(txtAdr, FT, 8)
SendMessage, EM_FINDTEXT, hFlags, &FT,, ahk_id %hEdit%
Return ErrorLevel=4294967295 ? -1 : ErrorLevel
}
/*
Function: FindWordBreak
Finds the next word break in rich edit conttrol, before or after the specified character position or retrieves information about the character at that position.
Parameters:
CharIndex - Zero-based character starting position.
Flag - One of the flags list below.
Flag:
CLASSIFY - Returns the character class and word-break flags of the character at the specified position.
ISDELIMITER - Returns true if the character at the specified position is a delimiter, or false otherwise.
LEFT - Finds the nearest character before the specified position that begins a word.
LEFTBREAK - Finds the next word end before the specified position. This value is the same as PREVBREAK.
MOVEWORDLEFT - Finds the next character that begins a word before the specified position. This value is used during CTRL+LEFT ARROW key processing.
MOVEWORDRIGHT - Finds the next character that begins a word after the specified position. This value is used during CTRL+right key processing.
RIGHT - Finds the next character that begins a word after the specified position.
RIGHTBREAK - Finds the next end-of-word delimiter after the specified position. This value is the same as NEXTBREAK.
Returns:
The message returns a value based on the wParam parameter.
o CLASSIFY - Returns the character class and word-break flags of the character at the specified position.
o ISDELIMITER - Returns true if the character at the specified position is a delimiter, otherwise it returns false.
o Other - Returns the character index of the word break.
*/
RichEdit_FindWordBreak(hCtrl, CharIndex, Flag="") {
static EM_FINDWORDBREAK=1100
, WB_CLASSIFY=3, WB_ISDELIMITER=2, WB_LEFT=0, WB_LEFTBREAK=6, WB_MOVEWORDLEFT=4, WB_MOVEWORDNEXT=5, WB_MOVEWORDPREV=4, WB_MOVEWORDRIGHT=5, WB_NEXTBREAK=7, WB_PREVBREAK=6, WB_RIGHT=1, WB_RIGHTBREAK=7
SendMessage, EM_FINDWORDBREAK, WB_%Flag%, CharIndex,, ahk_id %hCtrl%
return ErrorLevel
}
/*
Function: FixKeys
Fix Tab and Esc key handling in rich edit control.
Returns:
True or false.
Remarks:
Whenever you press Escape in a multiline edit control it sends a WM_CLOSE message to its parent. Both the regular edit control and the rich edit control have this problem.
This is by Microsoft design. There is also similar undesired behavior for {Tab} key which is used by the system to navigate over controls with "tabstop" flag. RichEdit is designed
to use ^{Tab} instead. This function subclasses the control to prevent such behavior.
However, before using this function be sure to know what subclassing is and what kind of effects
it may introduce to your particular script. There is also other method to solve this problem via
hotkey handling while rich edit control has focus.
Reference:
o WM_GETDLGCODE @ MSDN: <http://msdn.microsoft.com/en-us/library/ms645425(VS.85).aspx>
o William Willing blog: <http://www.williamwilling.com/blog/?p=28>.
o WinAsm Forum: <http://www.winasm.net/forum/index.php?showtopic=487>.
o CodeGuru: <http://www.codeguru.com/cpp/controls/editctrl/keyboard/article.php/c513/>.
o Strange Microsoft solution for VB (that doesn't work): <http://support.microsoft.com/kb/q143273/>.
*/
RichEdit_FixKeys(hCtrl) {
oldProc := DllCall("GetWindowLong", "uint", hCtrl, "uint", -4)
ifEqual, oldProc, 0, return 0
wndProc := RegisterCallback("RichEdit_wndProc", "", 4, oldProc)
ifEqual, wndProc, , return 0
return DllCall("SetWindowLong", "UInt", hCtrl, "Int", -4, "Int", wndProc, "UInt")
}
/*
Function: GetLine
Get the text of the desired line from an Edit control.
Parameters:
LineNumber - Zero-based index of the line. -1 means current line.
Returns:
The return value is the text.
The return value is empty string if the line number specified by the line parameter is greater than the number of lines in the Edit control.
Related:
<GetText>, <LineIndex>, <LineLength>
*/
RichEdit_GetLine(hEdit, LineNumber=-1){
static EM_GETLINE=196 ;The return value is the number of characters copied. The return value is zero if the line number specified by the line parameter is greater than the number of lines in the HiEdit control
if (LineNumber = -1)
LineNumber := RichEdit_LineFromChar(hEdit, RichEdit_LineIndex(hEdit))
len := RichEdit_LineLength(hEdit, LineNumber)
ifEqual, len, 0, return
VarSetCapacity(txt, len, 0), NumPut(len = 1 ? 2 : len, txt) ; HiEdit bug! if line contains only 1 word SendMessage returns FAIL.
SendMessage, EM_GETLINE, LineNumber, &txt,, ahk_id %hEdit%
if ErrorLevel = FAIL
return "", ErrorLevel := A_ThisFunc "> Failed to get line with code: " A_LastError
VarSetCapacity(txt, -1)
return len = 1 ? SubStr(txt, 1, -1) : txt
}
/*
Function: GetLineCount
Gets the number of lines in a multiline Edit control.
Returns:
The return value is an integer specifying the total number of text lines in the multiline edit control or rich edit control.
If the control has no text, the return value is 1. The return value will never be less than 1.
Remarks:
The function retrieves the total number of text lines, not just the number of lines that are currently visible.
If the Wordwrap feature is enabled, the number of lines can change when the dimensions of the editing window change.
Related:
<GetTextLength>, <LineLength>
*/
RichEdit_GetLineCount(hEdit){
static EM_GETLINECOUNT=0xBA
SendMessage, EM_GETLINECOUNT,,,, ahk_id %hEdit%
Return ErrorLevel
}
/*
Function: GetOptions
Get the options for a rich edit control.
Remarks:
See <SetOptions> for details.
*/
RichEdit_GetOptions(hCtrl) {
static EM_GETOPTIONS=1102
,1="AUTOWORDSELECTION", 64="AUTOVSCROLL", 128="AUTOHSCROLL", 256="NOHIDESEL", 2048="READONLY", 4096="WANTRETURN", 16777216="SELECTIONBAR"
,options="1,64,128,256,2048,4096,16777216"
if (hCtrl > 1) {
SendMessage, EM_GETOPTIONS,,,, ahk_id %hCtrl%
o := ErrorLevel
} else o := SubStr(hCtrl, 2)
loop, parse, options, `,
if (o & A_LoopField)
res .= %A_LoopField% " "
return SubStr(res, 1, -1)
}
/*
Function: GetCharFormat
Determines the character formatting in a rich edit control.
Parameters:
Face - Optional byref parameter will contain the name of the font.
Style - Optional byref parameter will contain a space separated list
of styles. See <SetCharFormat> for list of styles.
TextColor - Text forground color. If starts with "-" the color is AUTOCOLOR.
BackColor - Text background color. If starts with "-" the color is AUTOCOLOR.
Mode - If empty, this optional parameter retrieves the formatting to all text in the
control. Otherwise, pass "SELECTION" (default) to get formatting of the current selection. If the selection
is empty, the function will get the character of the insertion point.
Remarks:
Function will get the attributes of the first character.
Related:
<SetCharFormat>, <SetBgColor>
Example:
(start code)
RichEdit_GetCharFormat(hRichEdit, face, style, color)
MsgBox, Face = %Face% `nstyle = %style% `ncolor = %color%
(end code)
*/
RichEdit_GetCharFormat(hCtrl, ByRef Face="", ByRef Style="", ByRef TextColor="", ByRef BackColor="", Mode="SELECTION") {
static EM_GETCHARFORMAT=1082, SCF_SELECTION=1
, CFM_CHARSET:=0x8000000, CFM_BACKCOLOR=0x4000000, CFM_COLOR:=0x40000000, CFM_FACE:=0x20000000, CFM_OFFSET:=0x10000000, CFM_SIZE:=0x80000000, CFM_WEIGHT=0x400000, CFM_UNDERLINETYPE=0x800000
, CFE_HIDDEN=0x100, CFE_BOLD=1, CFE_ITALIC=2, CFE_LINK=0x20, CFE_PROTECTED=0x10, CFE_STRIKEOUT=8, CFE_UNDERLINE=4, CFE_SUPERSCRIPT=0x30000, CFE_SUBSCRIPT=0x30000
, CFM_ALL2=0xFEFFFFFF, COLOR_WINDOW=5, COLOR_WINDOWTEXT=8
, styles="HIDDEN BOLD ITALIC LINK PROTECTED STRIKEOUT UNDERLINE SUPERSCRIPT SUBSCRIPT"
VarSetCapacity(CF, 84, 0), NumPut(84, CF), NumPut(CFM_ALL2, CF, 4)
SendMessage, EM_GETCHARFORMAT, SCF_%Mode%, &CF,, ahk_id %hCtrl%
Face := DllCall("MulDiv", "UInt", &CF+26, "Int",1, "Int",1, "str")
Style := "", dwEffects := NumGet(CF, 8, "UInt")
Loop, parse, styles, %A_SPACE%
if (CFE_%A_LoopField% & dwEffects)
Style .= A_LoopField " "
s := NumGet(CF, 12, "Int") // 20, o := NumGet(CF, 16, "Int")
Style .= "s" s (o ? " o" o : "")
oldFormat := A_FormatInteger
SetFormat, integer, hex
if (dwEffects & CFM_BACKCOLOR)
BackColor := "-" DllCall("GetSysColor", "int", COLOR_WINDOW)
else BackColor := NumGet(CF, 64), BackColor := (BackColor & 0xff00) + ((BackColor & 0xff0000) >> 16) + ((BackColor & 0xff) << 16)
if (dwEffects & CFM_COLOR)
TextColor := "-" DllCall("GetSysColor", "int", COLOR_WINDOWTEXT)
else TextColor := NumGet(CF, 20), TextColor := (TextColor & 0xff00) + ((TextColor & 0xff0000) >> 16) + ((TextColor & 0xff) << 16)
SetFormat, integer, %oldFormat%
}
/*
Function: GetRedo
Determine whether there are any actions in the rich edit control redo queue, and
optionally retrieve the type of the next redo action.
Parameters:
name - This optional parameter is the name of the variable in which to store the
type of redo action, if any.
Name Types:
UNKNOWN - The type of undo action is unknown.
TYPING - Typing operation.
DELETE - Delete operation.
DRAGDROP - Drag-and-drop operation.
CUT - Cut operation.
PASTE - Paste operation.
Returns:
If there are actions in the control redo queue, the return value is a nonzero value.
If the redo queue is empty, the return value is zero.
Related:
<Redo>, <GetUndo>, <Undo>, <SetUndoLimit>
Example:
(start code)
If RichEdit_GetRedo( hRichEdit, name )
MsgBox, The next redo is a %name% type
Else
MsgBox, Nothing left to redo.
(end code)
*/
RichEdit_GetRedo(hCtrl, ByRef name="-") {
static EM_CANREDO=1109, EM_GETREDONAME=1111,UIDs="UNKNOWN,TYPING,DELETE,DRAGDROP,CUT,PASTE"
SendMessage, EM_CANREDO,,,, ahk_id %hCtrl%
nRedo := ErrorLevel
If ( nRedo && name != "-" ) {
SendMessage, EM_GETREDONAME,,,, ahk_id %hCtrl%
Loop, Parse, UIDs, `,
If (A_Index - 1 = ErrorLevel) {
name := A_LoopField
break
}
}
return nRedo
}
/*
Function: GetModify
Gets the state of the modification flag for the Edit control.
The flag indicates whether the contents of the control has been modified.
Returns:
True if the content of Edit control has been modified, false otherwise.
Related:
<SetModify>, <Save>
*/
RichEdit_GetModify(hEdit) {
Static EM_GETMODIFY=0xB8
SendMessage EM_GETMODIFY,,,,ahk_id %hEdit%
Return ErrorLevel = 4294967295 ? 1 : 0
}
/*
Function: GetParaFormat
Retrieves the paragraph formatting of the current selection in a rich edit control. (*** not implemented ***)
*/
; Num,Align,Line,Ident,Space,Tabs
RichEdit_GetParaFormat(hCtrl) {
static EM_GETPARAFORMAT=1085
,PFM_ALL2=0xc0fffdff
VarSetCapacity(PF, 188, 0), NumPut(188, PF), NumPut(PFM_ALL2, PF, 4)
SendMessage, EM_GETPARAFORMAT,, &PF,, ahk_id %hCtrl%
}
/*
Function: GetRect
Gets the formatting rectangle of the Edit control.
Parameters:
Left..Bottom - Output variables, can be omitted.
Returns:
Space separated rectangle.
*/
RichEdit_GetRect(hEdit,ByRef Left="",ByRef Top="",ByRef Right="",ByRef Bottom="") {
static EM_GETRECT:=0xB2
VarSetCapacity(RECT,16)
SendMessage EM_GETRECT,0,&RECT,,ahk_id %hEdit%
Left :=NumGet(RECT, 0,"Int")
, Top :=NumGet(RECT, 4,"Int")
, Right :=NumGet(RECT, 8,"Int")
, Bottom:=NumGet(RECT,12,"Int")
return Left " " Top " " Right " " Bottom
}
/*
Function: GetSel
Retrieve the starting and ending character positions of the selection in a rich edit control.
Parameters:
cpMin - The optional name of the variable in which to store the character position index immediately
preceding the first character in the range.
cpMin - The optional name of the variable in which to store the character position index immediately
following the last character in the range.
Returns:
Returns *cpMin*. If there is no selection this is cursor position.
Related:
<GetText>, <GetTextLength>, <SetSel>, <SetText>, <HideSelection>, <LineFromChar>
*/
RichEdit_GetSel(hCtrl, ByRef cpMin="", ByRef cpMax="" ) {
static EM_EXGETSEL=0x434
VarSetCapacity(CHARRANGE, 8)
SendMessage, EM_EXGETSEL, 0,&CHARRANGE,, ahk_id %hCtrl%
cpMin := NumGet(CHARRANGE, 0, "Int"), cpMax := NumGet(CHARRANGE, 4, "Int")
return cpMin
}
/*
Function: GetText
Retrieves a specified range of characters from a rich edit control.
Parameters:
CpMin - Beginning of range of characters to retrieve.
CpMax - End of range of characters to retrieve.
CodePage - If *UNICODE* or *U*, this optional parameter will use unicode code page
in the translation. Otherwise it will default to using ansi. (*** needs rework ***)
Note:
If the *CpMin* and *CpMax* are omitted, the current selection is retrieved.
The range includes everything if *CpMin* is 0 and *CpMax* is 1.
Returns:
Returns the retrieved text.
Related:
<GetSel>, <GetLine>, <GetTextLength>, <SetText>, <SetSel>, <FindText>
Example:
(start code)
MsgBox, % RichEdit_GetText( hRichEdit ) ; get current selection
MsgBox, % RichEdit_GetText( hRichEdit, 0, -1 ) ; get all
MsgBox, % RichEdit_GetText( hRichEdit, 4, 10 ) ; get range
(end code)
*/
RichEdit_GetText(HCtrl, CpMin="-", CpMax="-", CodePage="") {
static EM_EXGETSEL=0x434, EM_GETTEXTEX=0x45E, EM_GETTEXTRANGE=0x44B, GT_SELECTION=2
bufferLength := RichEdit_GetTextLength(hCtrl, "CLOSE", "UNICODE" )
If (CpMin CpMax = "--")
MODE := GT_SELECTION, CpMin:=CpMax:=""
else if (CpMin=0 && CpMax=-1)
MODE := GT_ALL , CpMin:=CpMax:=""
else if (CpMin+0 != "") && (cpMax+0 != "")
{
VarSetCapacity(lpwstr, bufferLength), VarSetCapacity(TEXTRANGE, 12)
NumPut(CpMin, TEXTRANGE, 0, "UInt")
NumPut(CpMax, TEXTRANGE, 4, "UInt"), NumPut(&lpwstr, TEXTRANGE, 8, "UInt")
SendMessage, EM_GETTEXTRANGE,, &TEXTRANGE,, ahk_id %hCtrl%
; If not unicode, return ansi from string pointer..
if !InStr(RichEdit_TextMode(HCtrl), "MULTICODEPAGE")
return DllCall("MulDiv", "UInt", &lpwstr, "Int",1, "Int",1, "str")
;..else, convert Unicode to Ansi..
nSz := DllCall("lstrlenW","UInt",&lpwstr) + 1, VarSetCapacity( ansi, nSz )
DllCall("WideCharToMultiByte" , "Int",0 , "Int",0
,"UInt",&LPWSTR ,"UInt",nSz+1
, "Str",ansi ,"UInt",nSz+1
, "Int",0 , "Int",0 )
VarSetCapacity(ansi, -1)
return ansi
}
else return "", errorlevel := A_ThisFunc "> Invalid use of cpMin or cpMax parameter."
VarSetCapacity(GETTEXTEX, 20, 0) , VarSetCapacity(BUFFER, bufferLength, 0)
NumPut(bufferLength, GETTEXTEX, 0, "UInt"), NumPut(MODE, GETTEXTEX, 4, "UInt")
NumPut( (CodePage="unicode" || CodePage="u") ? 1200 : 0 , GETTEXTEX, 8, "UInt")
SendMessage, EM_GETTEXTEX, &GETTEXTEX, &BUFFER,, ahk_id %hCtrl%
VarSetCapacity(BUFFER, -1)
return BUFFER
}
/*
Function: GetTextLength
Calculates text length in various ways for a rich edit control.
Parameters:
flag - Space separated list of one or more options. See below list.
codepage - If *UNICODE* or *U*, this optional parameter will use unicode code page
in the translation. Otherwise it will default to using ansi.
Flag Options:
DEFAULT - Returns the number of characters. This is the default.
USECRLF - Computes the answer by using CR/LFs at the end of paragraphs.
PRECISE - Computes a precise answer. This approach could necessitate a conversion
and thereby take longer. This flag cannot be used with the *CLOSE* flag.
CLOSE - Computes an approximate (close) answer. It is obtained quickly and can
be used to set the buffer size. This flag cannot be used with the *PRECISE*
flag.
NUMCHARS - Returns the number of characters. This flag cannot be used with the
*NUMBYTES* flag.
NUMBYTES - Returns the number of bytes. This flag cannot be used with the *NUMCHARS*
flag.
Returns:
If the operation succeeds, the return value is the number of TCHARs in the edit
control, depending on the setting of the flags.
If the operation fails, the return value is blank.
Remarks:
This message is a fast and easy way to determine the number of characters in the
Unicode version of the rich edit control. However, for a non-Unicode target code
page you will potentially be converting to a combination of single-byte and double-byte
characters.
Related:
<LineLength>, <LimitText>, <GetSel>
Example:
(start code)
MsgBox, % "DEFAULT = " RichEdit_GetTextLength(hRichEdit, "DEFAULT" ) "`n"
. "USECRLF = " RichEdit_GetTextLength(hRichEdit, "USECRLF" ) "`n"
. "PRECISE = " RichEdit_GetTextLength(hRichEdit, "PRECISE" ) "`n"
. "CLOSE = " RichEdit_GetTextLength(hRichEdit, "CLOSE" ) "`n"
. "NUMCHARS = " RichEdit_GetTextLength(hRichEdit, "NUMCHARS" ) "`n"
. "NUMBYTES = " RichEdit_GetTextLength(hRichEdit, "NUMBYTES" ) "`n"
(end code)
*/
RichEdit_GetTextLength(hCtrl, Flags=0, CodePage="") {
static EM_GETTEXTLENGTHEX=95,WM_USER=0x400
static GTL_DEFAULT=0,GTL_USECRLF=1,GTL_PRECISE=2,GTL_CLOSE=4,GTL_NUMCHARS=8,GTL_NUMBYTES=16
hexFlags:=0
Loop, parse, Flags, %A_Tab%%A_Space%
hexFlags |= GTL_%A_LOOPFIELD%
VarSetCapacity(GETTEXTLENGTHEX, 4)
NumPut(hexFlags, GETTEXTLENGTHEX, 0), NumPut((codepage="unicode"||codepage="u") ? 1200 : 1252, GETTEXTLENGTHEX, 4)
SendMessage, EM_GETTEXTLENGTHEX | WM_USER, &GETTEXTLENGTHEX,0,, ahk_id %hCtrl%
IfEqual, ERRORLEVEL,0x80070057, return "", errorlevel := A_ThisFunc "> Invalid combination of parameters."
IfEqual, ERRORLEVEL,FAIL , return "", errorlevel := A_ThisFunc "> Invalid control handle."
return ERRORLEVEL
}
/*
Function: GetUndo
Determine whether there are any actions in the Edit control undo queue, and optionally retrieve
the type of the next undo action.
Parameters:
Name - Optional byref parameter will contain the type of undo action, if any.
Types:
UNKNOWN - The type of undo action is unknown.
TYPING - Typing operation.
DELETE - Delete operation.
DRAGDROP - Drag-and-drop operation.
CUT - Cut operation.
PASTE - Paste operation.
Returns:
If there are actions in the control undo queue, the return value is a nonzero value.
If the undo queue is empty, the return value is zero.
Related:
<Undo>, <SetUndoLimit>, <GetRedo>, <Redo>
Example:
(start code)
If RichEdit_GetRedo( hRichEdit, name )
MsgBox, The next redo is a %name% type
Else MsgBox, Nothing left to redo.
(end code)
*/
RichEdit_GetUndo(hCtrl, ByRef Name="-") {
static EM_CANUNDO=0xC6,EM_GETUNDONAME=86,WM_USER=0x400
,UIDs="UNKNOWN,TYPING,DELETE,DRAGDROP,CUT,PASTE"
SendMessage, EM_CANUNDO, 0,0,, ahk_id %hCtrl%
nUndo := ERRORLEVEL
If ( nUndo && name != "-" ) {
SendMessage, WM_USER | EM_GETUNDONAME, 0,0,, ahk_id %hCtrl%
Loop, Parse, UIDs, `,
If (A_Index - 1 = errorlevel) {
name := A_LoopField
break
}
}
return nUndo
}
/*
Function: HideSelection
Hides or shows the selection in a rich edit control.
Parameters:
State - True or false.
Remarks:
This function is noticeable when it is set to false and the rich edit control isn't the active control or window. The example included in <FindText> demonstrates use.
Related:
<SetSel>, <GetSel>
*/
RichEdit_HideSelection(hCtrl, State=true) {
static EM_HIDESELECTION = 1087
SendMessage, EM_HIDESELECTION,%State%,0,, ahk_id %hCtrl%
}
/*
Function: LineFromChar
Determines which line contains the specified character in a rich edit control.
Parameters:
CharIndex - Zero-based integer index of the character. -1 (default) means current line.
Returns:
Zero-based index of the line.
Related:
<LineIndex>, <GetLineCount>
*/
RichEdit_LineFromChar(hCtrl, CharIndex=-1) {
static EM_EXLINEFROMCHAR=1078
SendMessage, EM_EXLINEFROMCHAR,,CharIndex,, ahk_id %hCtrl%
return ERRORLEVEL
}
/*
Function: LineIndex
Returns the character index of the first character of a specified line in an Edit control.
Parameters:
LineNumber - Line number for which to retreive character index. -1 (default) means current line.
Returns:
The character index of the line specified, or -1 if the specified line number is greater than the number of lines.
Related:
<LineLength>, <LineFromChar>, <GetLine>, <GetLineCount>
*/
RichEdit_LineIndex(hEdit, LineNumber=-1) {
static EM_LINEINDEX=187
SendMessage, EM_LINEINDEX, LineNumber,,, ahk_id %hEdit%
Return ErrorLevel
}
/*
Function: LineLength
Returns the length of a line in an Edit control.
Parameters:
LineNumber - Line number for which to retreive line length. -1 (default) means current line.
Returns:
The length (in characters) of the line.
Related:
<GetTextLength>, <LineIndex>, <LineFromChar>
*/
RichEdit_LineLength(hEdit, LineNumber=-1) {
static EM_LINELENGTH=193
SendMessage, EM_LINELENGTH, RichEdit_LineIndex(hEdit, LineNumber),,, ahk_id %hEdit%
Return ErrorLevel
}
/*
Function: LineScroll
Scrolls the text in the Edit control.
Parameters:
XScroll - The number of characters to scroll horizontally. Use a
negative number to scroll to the left and a positive number to
scroll to the right.
YScroll - The number of lines to scroll vertically. Use a negative
number to scroll up and a positive number to scroll down.
Remarks:
This message does not move the caret.
This function can be used to scroll horizontally past the last character of any line.
*/
RichEdit_LineScroll(hEdit,XScroll=0,YScroll=0){
Static EM_LINESCROLL:=0xB6
SendMessage EM_LINESCROLL, XScroll, YScroll,,ahk_id %hEdit%
}
/*
Function: LimitText
Sets an upper limit to the amount of text the user can type or paste into a rich edit control.
Parameters:
txtSize - Specifies the maximum amount of text that can be entered. If this parameter is zero,
the default maximum is used, which is 64K characters. A Component Object Model (COM)
object counts as a single character.
Returns:
This function does not return a value.
Remarks:
Before LimitText is called, the default limit to the amount of text a user can enter is
32,767 characters.
*/
RichEdit_LimitText(hCtrl,txtSize=0) {
static EM_EXLIMITTEXT=53,WM_USER=0x400
SendMessage, WM_USER | EM_EXLIMITTEXT, 0,%txtSize%,, ahk_id %hCtrl%
}
/*
Function: Paste
Paste clipboard into the Edit control.
Related:
<CanPaste>, <PasteSpecial>, <Cut>, <Copy>, <Clear>
*/
RichEdit_Paste(hEdit) {
Static WM_PASTE:=0x302
SendMessage WM_PASTE,0,0,,ahk_id %hEdit%
}
/*
Function: PasteSpecial
Pastes a specific clipboard format in a rich edit control.
Parameters:
Format - One of the clipboard formats. See <http://msdn.microsoft.com/en-us/library/bb774214(VS.85).aspx>
Related:
<CanPaste>, <Paste>
*/
RichEdit_PasteSpecial(HCtrl, Format) {
static EM_PASTESPECIAL=0x440
,CF_BITMAP=2,CF_DIB=8,CF_DIBV5=17,CF_DIF=5,CF_DSPBITMAP=0x82,CF_DSPENHMETAFILE=0x8E,CF_DSPMETAFILEPICT=0x83
,CF_DSPTEXT=0x81,CF_ENHMETAFILE=14,CF_GDIOBJFIRST=0x300,CF_GDIOBJLAST=0x3FF,CF_HDROP=15,CF_LOCALE=16
,CF_METAFILEPICT=3,CF_OEMTEXT=7,CF_OWNERDISPLAY=0x80,CF_PALETTE=9,CF_PENDATA=10,CF_PRIVATEFIRST=0x200
,CF_PRIVATELAST=0x2FF,CF_RIFF=11,CF_SYLK=4,CF_TEXT=1,CF_WAVE=12,CF_TIFF=6,CF_UNICODETEXT=13
SendMessage, EM_PASTESPECIAL, CF_%Format%, 0,, ahk_id %hCtrl%
}
/*
Function: PosFromChar
Gets the client area coordinates of a specified character in an Edit control.
Parameters:
CharIndex - The zero-based index of the character.
X, Y - These parameters, which must contain valid variable names,
are used to return the x/y-coordinates of a point in the control's client relative to the upper-left corner of the client area.
Remarks:
If CharIndex is greater than the index of the last character in the control, the returned coordinates are of the position just past
the last character of the control.
*/
RichEdit_PosFromChar(hEdit, CharIndex, ByRef X, ByRef Y) {
Static EM_POSFROMCHAR=0xD6
VarSetCapacity(POINTL,8,0)
SendMessage EM_POSFROMCHAR,&POINTL,CharIndex,,ahk_id %hEdit%
X:=NumGet(POINTL,0,"Int"), Y:=NumGet(POINTL,4,"Int")
}
/*