646
1269
<!-- function Visibility: public -->
647
1270
<element name="TWidgetSet.CreateCompatibleDC">
1271
<short>Creates an memory Device Context, compatible with the device of the given DC.</short>
653
1276
<!-- function result Visibility: default -->
654
1277
<element name="TWidgetSet.CreateCompatibleDC.Result">
1278
<short>The memory DC, zero on failure.</short>
657
1280
<!-- argument Visibility: default -->
658
1281
<element name="TWidgetSet.CreateCompatibleDC.DC">
1282
<short>The device DC.</short>
661
1284
<!-- function Visibility: public -->
662
1285
<element name="TWidgetSet.CreateDIBitmap">
1286
<short>Creates a Device Dependent Bitmap (DDB) from a Device Independent Bitmap (DIB).</short>
668
<!-- function result Visibility: default -->
669
1291
<element name="TWidgetSet.CreateDIBitmap.Result">
1292
<short>The bitmap handle, zero on failure.</short>
672
<!-- argument Visibility: default -->
673
1294
<element name="TWidgetSet.CreateDIBitmap.DC">
1295
<short>The context for the DDB.</short>
676
<!-- argument Visibility: default -->
677
1297
<element name="TWidgetSet.CreateDIBitmap.InfoHeader">
680
<!-- argument Visibility: default -->
681
1300
<element name="TWidgetSet.CreateDIBitmap.dwUsage">
684
<!-- argument Visibility: default -->
685
1303
<element name="TWidgetSet.CreateDIBitmap.InitBits">
1304
<short>An array containing the bitmap pixels.</short>
688
<!-- argument Visibility: default -->
689
1306
<element name="TWidgetSet.CreateDIBitmap.InitInfo">
1307
<short>CBM_INIT when InitBits contains valid data, else zero.</short>
692
<!-- argument Visibility: default -->
693
1309
<element name="TWidgetSet.CreateDIBitmap.wUsage">
696
1312
<!-- function Visibility: public -->
697
1313
<element name="TWidgetSet.CreateDIBSection">
1314
<short>Creates a bitmap into which the application can write.</short>
703
<!-- function result Visibility: default -->
704
1318
<element name="TWidgetSet.CreateDIBSection.Result">
1319
<short>The bitmap Handle, zero on failure.</short>
707
<!-- argument Visibility: default -->
708
1321
<element name="TWidgetSet.CreateDIBSection.DC">
1322
<short>The DC for the bitmap.</short>
711
<!-- argument Visibility: default -->
712
1324
<element name="TWidgetSet.CreateDIBSection.BitmapInfo">
1325
<short>Contains all information about the bitmap, except the pixels.</short>
715
<!-- argument Visibility: default -->
716
1327
<element name="TWidgetSet.CreateDIBSection.Usage">
1328
<short>The type of the bitmap colors, e.g. DIB_RGB_COLORS.</short>
719
<!-- argument Visibility: default -->
720
1330
<element name="TWidgetSet.CreateDIBSection.Bits">
1331
<short>Pointer to the bitmap pixels.</short>
723
<!-- argument Visibility: default -->
724
1333
<element name="TWidgetSet.CreateDIBSection.SectionHandle">
1334
<short>Zero or the Handle of a file-mapping object, from which the bitmap is initialized
1335
(needs CreateFileMapping).
727
<!-- argument Visibility: default -->
728
1338
<element name="TWidgetSet.CreateDIBSection.Offset">
1339
<short>The offset to the bitmap bits in the file-mapping object.</short>
731
1341
<!-- function Visibility: public -->
732
1342
<element name="TWidgetSet.CreateEllipticRgn">
1343
<short>Creates an elliptic region, bounded by the given rectangle.</short>
738
1348
<!-- function result Visibility: default -->
739
1349
<element name="TWidgetSet.CreateEllipticRgn.Result">
742
<!-- argument Visibility: default -->
743
<element name="TWidgetSet.CreateEllipticRgn.p1">
746
<!-- argument Visibility: default -->
747
<element name="TWidgetSet.CreateEllipticRgn.p2">
750
<!-- argument Visibility: default -->
751
<element name="TWidgetSet.CreateEllipticRgn.p3">
754
<!-- argument Visibility: default -->
755
<element name="TWidgetSet.CreateEllipticRgn.p4">
1350
<short>The region Handle, zero on failure.</short>
1352
<element name="TWidgetSet.CreateEllipticRgn.X1">
1355
<element name="TWidgetSet.CreateEllipticRgn.Y1">
1358
<element name="TWidgetSet.CreateEllipticRgn.X2">
1361
<element name="TWidgetSet.CreateEllipticRgn.Y2">
758
1364
<!-- function Visibility: public -->
759
1365
<element name="TWidgetSet.CreateFontIndirect">
1366
<short>Creates an logical font, selectable into any DC.</short>
1370
<link id="TWidgetSet.CreateFontIndirectEx"/>
765
1373
<!-- function result Visibility: default -->
766
1374
<element name="TWidgetSet.CreateFontIndirect.Result">
1375
<short>The font handle, zero on failure.</short>
769
<!-- argument Visibility: default -->
770
1377
<element name="TWidgetSet.CreateFontIndirect.LogFont">
1378
<short>The font description.</short>
773
1380
<!-- function Visibility: public -->
774
1381
<element name="TWidgetSet.CreateFontIndirectEx">
1382
<short>Creates an logical font, selectable into any DC. Allows for an long fontname.</short>
1386
<link id="TWidgetSet.CreateFontIndirect"/>
780
<!-- function result Visibility: default -->
781
1389
<element name="TWidgetSet.CreateFontIndirectEx.Result">
1390
<short>The font handle, zero on failure.</short>
784
<!-- argument Visibility: default -->
785
1392
<element name="TWidgetSet.CreateFontIndirectEx.LogFont">
1393
<short>The font description.</short>
788
<!-- argument Visibility: default -->
789
1395
<element name="TWidgetSet.CreateFontIndirectEx.LongFontName">
1396
<short>The font name, can be longer than 32 characters.</short>
1398
<!-- function Visibility: public -->
1399
<element name="TWidgetSet.CreateIconIndirect">
1400
<short>Creates an icon or cursor.</short>
1406
<element name="TWidgetSet.CreateIconIndirect.Result">
1407
<short>The Handle, zero on failure.</short>
1409
<element name="TWidgetSet.CreateIconIndirect.IconInfo">
792
1412
<!-- function Visibility: public -->
793
1413
<element name="TWidgetSet.CreatePalette">
1414
<short>Creates a logical palette, selectable into any DC.</short>
799
<!-- function result Visibility: default -->
800
1419
<element name="TWidgetSet.CreatePalette.Result">
1420
<short>The palette Handle, zero on failure.</short>
803
<!-- argument Visibility: default -->
804
1422
<element name="TWidgetSet.CreatePalette.LogPalette">
807
1425
<!-- function Visibility: public -->
1426
<element name="TWidgetSet.CreatePatternBrush">
1427
<short>Creates a logical brush, selectable into any DC.</short>
1430
The bitmap pattern is repeated for areas of larger width or height,
1431
it should allow for smooth transitions.
1433
Monochrome bitmaps obtain the actual text (0) or background (1) color of the DC.
1439
<element name="TWidgetSet.CreatePatternBrush.Result">
1440
<short>The brush handle, zero on failure.</short>
1442
<element name="TWidgetSet.CreatePatternBrush.ABitmap">
1443
<short>The bitmap to use for the brush.</short>
1445
<!-- function Visibility: public -->
808
1446
<element name="TWidgetSet.CreatePenIndirect">
1447
<short>Creates an logical Pen, selectable into any DC.</short>
814
<!-- function result Visibility: default -->
815
1452
<element name="TWidgetSet.CreatePenIndirect.Result">
1453
<short>The pen Handle, zero on failure.</short>
818
<!-- argument Visibility: default -->
819
1455
<element name="TWidgetSet.CreatePenIndirect.LogPen">
822
1458
<!-- function Visibility: public -->
823
1459
<element name="TWidgetSet.CreatePolygonRgn">
1460
<short>Creates a polygonial region.</short>
1463
The Points parameter is an array of points that give the vertices of the polygon.
1464
The connections between two points can cross others.
1466
FillMode determines what points are going to be included in the region.
1467
When FillMode=Winding points are selected by using the Winding fill algorithm.
1468
When FillMode=ALTERNATE points are selected by using using the
1469
even-odd (alternative) fill algorithm.
1471
The last point is connected to the first point, to close the region.
829
<!-- function result Visibility: default -->
830
1477
<element name="TWidgetSet.CreatePolygonRgn.Result">
1478
<short>The region Handle, zero on failure.</short>
833
<!-- argument Visibility: default -->
834
1480
<element name="TWidgetSet.CreatePolygonRgn.Points">
1481
<short>The array of points.</short>
837
<!-- argument Visibility: default -->
838
1483
<element name="TWidgetSet.CreatePolygonRgn.NumPts">
1484
<short>The number of points in Points.</short>
841
<!-- argument Visibility: default -->
842
1486
<element name="TWidgetSet.CreatePolygonRgn.FillMode">
1487
<short>Can be ALTERNATE or WINDING.</short>
845
1489
<!-- function Visibility: public -->
846
1490
<element name="TWidgetSet.CreateRectRgn">
1491
<short>Creates a rectangular region.</short>
852
<!-- function result Visibility: default -->
853
1496
<element name="TWidgetSet.CreateRectRgn.Result">
1497
<short>The region handle, zero on failure.</short>
856
<!-- argument Visibility: default -->
857
1499
<element name="TWidgetSet.CreateRectRgn.X1">
860
<!-- argument Visibility: default -->
861
1502
<element name="TWidgetSet.CreateRectRgn.Y1">
864
<!-- argument Visibility: default -->
865
1505
<element name="TWidgetSet.CreateRectRgn.X2">
868
<!-- argument Visibility: default -->
869
1508
<element name="TWidgetSet.CreateRectRgn.Y2">
1511
<!-- function Visibility: public -->
1512
<element name="TWidgetSet.CreateRoundRectRgn">
1513
<short>Creates a rectangular region with rounded corners.
1520
<element name="TWidgetSet.CreateRoundRectRgn.Result">
1521
<short>The region Handle, zero on failure.</short>
1523
<element name="TWidgetSet.CreateRoundRectRgn.X1">
1526
<element name="TWidgetSet.CreateRoundRectRgn.Y1">
1529
<element name="TWidgetSet.CreateRoundRectRgn.X2">
1532
<element name="TWidgetSet.CreateRoundRectRgn.Y2">
1535
<element name="TWidgetSet.CreateRoundRectRgn.nWidthEllipse">
1536
<short>The extent of the ellipse, used for the rounded corners.</short>
1538
<element name="TWidgetSet.CreateRoundRectRgn.nHeightEllipse">
1539
<short>The extent of the ellipse, used for the rounded corners.</short>
872
1541
<!-- procedure Visibility: public -->
873
1542
<element name="TWidgetSet.DeleteCriticalSection">
1543
<short>Deletes an unowned critical section.</short>
1545
<errors>Results are unpredictable when the section is owned,
1546
i.e. has been entered but not yet left.
1549
<link id="TWidgetSet.InitializeCriticalSection"/>
879
<!-- argument Visibility: default -->
880
1552
<element name="TWidgetSet.DeleteCriticalSection.CritSection">
1553
<short>The critical section object.</short>
883
1555
<!-- function Visibility: public -->
884
1556
<element name="TWidgetSet.DeleteDC">
1557
<short>Deletes an Device Context, created by CreateDC.</short>
1561
<link id="TWidgetSet.ReleaseDC"/>
890
<!-- function result Visibility: default -->
891
1564
<element name="TWidgetSet.DeleteDC.Result">
1565
<short>False on failure.</short>
894
<!-- argument Visibility: default -->
895
1567
<element name="TWidgetSet.DeleteDC.hDC">
898
1570
<!-- function Visibility: public -->
899
1571
<element name="TWidgetSet.DeleteObject">
1572
<short>Deletes a graphic object, freeing all system resources
1573
associated with the object.
1576
<errors>The function fails when the Handle is selected into an DC.
905
<!-- function result Visibility: default -->
906
1580
<element name="TWidgetSet.DeleteObject.Result">
1581
<short>False on failure.</short>
909
<!-- argument Visibility: default -->
910
1583
<element name="TWidgetSet.DeleteObject.GDIObject">
913
1586
<!-- function Visibility: public -->
914
1587
<element name="TWidgetSet.DestroyCaret">
1588
<short>Destroys the caret but doesn't free the bitmap.</short>
920
<!-- function result Visibility: default -->
921
1593
<element name="TWidgetSet.DestroyCaret.Result">
1594
<short>False on failure.</short>
924
<!-- argument Visibility: default -->
925
1596
<element name="TWidgetSet.DestroyCaret.Handle">
1597
<short>Handle of the window with the caret.</short>
1599
<!-- function Visibility: public -->
1600
<element name="TWidgetSet.DestroyCursor">
1601
<short>Destroys an mouse cursor.</short>
1607
<element name="TWidgetSet.DestroyCursor.Result">
1608
<short>False on failure.</short>
1610
<element name="TWidgetSet.DestroyCursor.Handle">
1611
<short>The cursor Handle.</short>
1613
<!-- function Visibility: public -->
1614
<element name="TWidgetSet.DestroyIcon">
1615
<short>Destroys an icon.</short>
1623
<element name="TWidgetSet.DestroyIcon.Result">
1624
<short>False on failure.</short>
1626
<element name="TWidgetSet.DestroyIcon.Handle">
928
1629
<!-- function Visibility: public -->
929
1630
<element name="TWidgetSet.DPtoLP">
1631
<short>Converts an array of Device Points (coordinates) into Logical Points.</short>
935
<!-- function result Visibility: default -->
936
1635
<element name="TWidgetSet.DPtoLP.Result">
1636
<short>False on failure.</short>
939
<!-- argument Visibility: default -->
940
1638
<element name="TWidgetSet.DPtoLP.DC">
1639
<short>The device context, containing the coordinate mapping information.</short>
943
<!-- argument Visibility: default -->
944
1641
<element name="TWidgetSet.DPtoLP.Points">
1642
<short>An array of points.</short>
947
<!-- argument Visibility: default -->
948
1644
<element name="TWidgetSet.DPtoLP.Count">
1645
<short>The number of points to convert.</short>
951
1647
<!-- function Visibility: public -->
952
1648
<element name="TWidgetSet.DrawFrameControl">
1649
<short>Draws a window frame control, of the specified type and style.
1653
A window frame includes these components (uType):
1657
title bar (DFC_CAPTION)
1661
popup menus (DFC_POPUPMENU)
1663
scrollbars (DFC_SCROLL)
1667
Window managers do not normally allow the user to paint the
1668
components of an window frame, do not even supply an DC for that purpose.
1670
The available features depend on the window manager of the actual platform,
1671
and the used widgetset.
958
<!-- function result Visibility: default -->
959
1677
<element name="TWidgetSet.DrawFrameControl.Result">
1678
<short>False on failure.</short>
962
<!-- argument Visibility: default -->
963
1680
<element name="TWidgetSet.DrawFrameControl.DC">
1681
<short>The window frame device context.</short>
966
<!-- argument Visibility: default -->
967
1683
<element name="TWidgetSet.DrawFrameControl.Rect">
970
<!-- argument Visibility: default -->
971
1686
<element name="TWidgetSet.DrawFrameControl.uType">
1687
<short>The control type, e.g. DFC_CAPTION.</short>
974
<!-- argument Visibility: default -->
975
1689
<element name="TWidgetSet.DrawFrameControl.uState">
1690
<short>The control state, e.g. DFCS_CAPTIONCLOSE (close button).</short>
1692
<!-- function Visibility: public -->
1693
<element name="TWidgetSet.DrawFocusRect">
1694
<short>Shows or hides a floating rectangle.</short>
1697
This function is intended to <b>temporarily</b> outline part of an canvas,
1698
e.g. a rectangular selection following mouse moves
1699
(rubber box, DockRect).
1701
A second call of the function, with the same parameters,
1702
removes the rectangle again (XOR painting).
1703
Due to this behaviour the frame should be removed
1704
before it might be overwritten by any other painting operation.
1707
Not all platforms allow for painting outside WM_PAINT events.
1710
Child windows may be excluded (clipped),
1711
i.e. the rectangle is not necessarily fully shown.
1719
<element name="TWidgetSet.DrawFocusRect.Result">
1720
<short>False on failure.</short>
1722
<element name="TWidgetSet.DrawFocusRect.DC">
1723
<short>Almost a screen DC.</short>
1725
<element name="TWidgetSet.DrawFocusRect.Rect">
978
1728
<!-- function Visibility: public -->
979
1729
<element name="TWidgetSet.DrawEdge">
1730
<short>Draws one or more edges of a rectangle.</short>
985
<!-- function result Visibility: default -->
986
1735
<element name="TWidgetSet.DrawEdge.Result">
1736
<short>False on failure.</short>
989
<!-- argument Visibility: default -->
990
1738
<element name="TWidgetSet.DrawEdge.DC">
993
<!-- argument Visibility: default -->
994
1741
<element name="TWidgetSet.DrawEdge.Rect">
997
<!-- argument Visibility: default -->
998
1744
<element name="TWidgetSet.DrawEdge.edge">
1745
<short>A combination of edge styles (inner/outer, raised/sunken)</short>
1001
<!-- argument Visibility: default -->
1002
1747
<element name="TWidgetSet.DrawEdge.grfFlags">
1748
<short>Indicates e.g. the edges to paint (BF_LEFT).</short>
1005
1750
<!-- function Visibility: public -->
1006
1751
<element name="TWidgetSet.DrawText">
1752
<short>Draws formatted text within a rectangle.</short>
1755
Several formatting options are available (DT_WORDBREAK...).
1757
DT_CALCRECT suppresses all painting, instead the extent of the formatted text
1758
is returned in the Rect parameter.
1012
1764
<!-- function result Visibility: default -->
1013
1765
<element name="TWidgetSet.DrawText.Result">
1766
<short>The height of the drawn text,
1767
from Rect.Top to the bottom of the text.
1016
<!-- argument Visibility: default -->
1017
1771
<element name="TWidgetSet.DrawText.DC">
1020
<!-- argument Visibility: default -->
1021
1774
<element name="TWidgetSet.DrawText.Str">
1775
<short>The text (should be zero terminated).</short>
1024
<!-- argument Visibility: default -->
1025
1777
<element name="TWidgetSet.DrawText.Count">
1778
<short>The number of (Wide)Chars in the text.</short>
1028
<!-- argument Visibility: default -->
1029
1780
<element name="TWidgetSet.DrawText.Rect">
1781
<short>The bounding (clipping) rectangle.
1032
<!-- argument Visibility: default -->
1033
1784
<element name="TWidgetSet.DrawText.Flags">
1785
<short>Various flags.</short>
1036
1787
<!-- function Visibility: public -->
1037
1788
<element name="TWidgetSet.EnableScrollBar">
1789
<short>Enables or disables the arrows of a scrollbar control,
1790
or of the scrollbars of a window.
1043
<!-- function result Visibility: default -->
1044
1796
<element name="TWidgetSet.EnableScrollBar.Result">
1797
<short>False when nothing was changed.</short>
1047
<!-- argument Visibility: default -->
1048
1799
<element name="TWidgetSet.EnableScrollBar.Wnd">
1800
<short>The window or control handle.</short>
1051
<!-- argument Visibility: default -->
1052
1802
<element name="TWidgetSet.EnableScrollBar.wSBflags">
1803
<short>The scrollbar type (SB_CTL, SB_HORZ...).</short>
1055
<!-- argument Visibility: default -->
1056
1805
<element name="TWidgetSet.EnableScrollBar.wArrows">
1806
<short>The affected buttons.</short>
1059
1808
<!-- function Visibility: public -->
1060
1809
<element name="TWidgetSet.EnableWindow">
1810
<short>Enables or disables mouse and keyboard input to the specified window or control.
1066
<!-- function result Visibility: default -->
1067
1816
<element name="TWidgetSet.EnableWindow.Result">
1817
<short>True when the window was disabled before.</short>
1070
<!-- argument Visibility: default -->
1071
1819
<element name="TWidgetSet.EnableWindow.hWnd">
1074
<!-- argument Visibility: default -->
1075
1822
<element name="TWidgetSet.EnableWindow.bEnable">
1078
1825
<!-- function Visibility: public -->
1079
1826
<element name="TWidgetSet.EndPaint">
1827
<short>Ends painting a window, started with BeginPaint.</short>
1830
<link id="TWidgetSet.BeginPaint"/>
1085
<!-- function result Visibility: default -->
1086
1833
<element name="TWidgetSet.EndPaint.Result">
1834
<short>Almost nonzero.</short>
1089
<!-- argument Visibility: default -->
1090
1836
<element name="TWidgetSet.EndPaint.Handle">
1837
<short>The window to paint.</short>
1093
<!-- argument Visibility: default -->
1094
1839
<element name="TWidgetSet.EndPaint.PS">
1840
<short>Painting information.</short>
1097
1842
<!-- procedure Visibility: public -->
1098
1843
<element name="TWidgetSet.EnterCriticalSection">
1844
<short>Enters a critical section.</short>
1845
<descr>The call returns only when the calling thread has obtained ownership of the critical section.
1846
See TryEnterCriticalSection for testing the ownership of the critical section.
1849
<link id="TWidgetSet.InitializeCriticalSection"/>
1850
<link id="TWidgetSet.TryEnterCriticalSection"/>
1104
<!-- argument Visibility: default -->
1105
1853
<element name="TWidgetSet.EnterCriticalSection.CritSection">
1854
<short>The critical section object.</short>
1856
<!-- function Visibility: public -->
1857
<element name="TWidgetSet.EnumDisplayMonitors">
1858
<short>Invokes a callback function for every available display monitor.</short>
1866
<element name="TWidgetSet.EnumDisplayMonitors.Result">
1867
<short>False on failure.</short>
1869
<element name="TWidgetSet.EnumDisplayMonitors.hdc">
1872
<element name="TWidgetSet.EnumDisplayMonitors.lprcClip">
1875
<element name="TWidgetSet.EnumDisplayMonitors.lpfnEnum">
1876
<short>The callback function.</short>
1878
<element name="TWidgetSet.EnumDisplayMonitors.dwData">
1879
<short>Data passed to the callback function</short>
1881
<!-- function Visibility: public -->
1882
<element name="TWidgetSet.EnumFontFamilies">
1883
<short>Invokes a callback function for every font available on a specified device.</short>
1887
<link id="TWidgetSet.EnumFontFamiliesEx"/>
1890
<element name="TWidgetSet.EnumFontFamilies.Result">
1891
<short>The last value returned by the callback function.</short>
1893
<element name="TWidgetSet.EnumFontFamilies.DC">
1894
<short>The device context.</short>
1896
<element name="TWidgetSet.EnumFontFamilies.Family">
1897
<short>The font family name, empty for all families.</short>
1899
<element name="TWidgetSet.EnumFontFamilies.EnumFontFamProc">
1900
<short>The callback function.</short>
1902
<element name="TWidgetSet.EnumFontFamilies.LParam">
1903
<short>Data passed to the callback function.</short>
1905
<!-- function Visibility: public -->
1906
<element name="TWidgetSet.EnumFontFamiliesEx">
1907
<short>Invokes a callback function for every available font that matches certain criteria.
1916
<element name="TWidgetSet.EnumFontFamiliesEx.Result">
1917
<short>The last value returned by the callback function.</short>
1919
<element name="TWidgetSet.EnumFontFamiliesEx.DC">
1920
<short>The device context.</short>
1922
<element name="TWidgetSet.EnumFontFamiliesEx.lpLogFont">
1923
<short>Description of the desired fonts.</short>
1925
<element name="TWidgetSet.EnumFontFamiliesEx.Callback">
1926
<short>The callback function.</short>
1928
<element name="TWidgetSet.EnumFontFamiliesEx.Lparam">
1929
<short>Data passed to the callback function.</short>
1931
<element name="TWidgetSet.EnumFontFamiliesEx.Flags">
1108
1934
<!-- function Visibility: public -->
1109
1935
<element name="TWidgetSet.Ellipse">
1936
<short>Draws a filled circle or ellipse, bounded by a rectangle.</short>
1937
<descr>The ellipse is outlined with the current pen,
1938
and filled with the current brush.
1941
<link id="TWidgetSet.Arc"/>
1115
<!-- function result Visibility: default -->
1116
1944
<element name="TWidgetSet.Ellipse.Result">
1945
<short>False on failure.</short>
1119
<!-- argument Visibility: default -->
1120
1947
<element name="TWidgetSet.Ellipse.DC">
1123
<!-- argument Visibility: default -->
1124
1950
<element name="TWidgetSet.Ellipse.x1">
1127
<!-- argument Visibility: default -->
1128
1953
<element name="TWidgetSet.Ellipse.y1">
1131
<!-- argument Visibility: default -->
1132
1956
<element name="TWidgetSet.Ellipse.x2">
1135
<!-- argument Visibility: default -->
1136
1959
<element name="TWidgetSet.Ellipse.y2">
1139
1962
<!-- function Visibility: public -->
1140
1963
<element name="TWidgetSet.ExcludeClipRect">
1964
<short>Excludes a rectangle from the clipping region,
1965
i.e. prevents painting within the rectangle.
1146
<!-- function result Visibility: default -->
1147
1971
<element name="TWidgetSet.ExcludeClipRect.Result">
1972
<short>The type of the new clipping region, Error (0) on failure.</short>
1150
<!-- argument Visibility: default -->
1151
1974
<element name="TWidgetSet.ExcludeClipRect.dc">
1154
<!-- argument Visibility: default -->
1155
1977
<element name="TWidgetSet.ExcludeClipRect.Left">
1158
<!-- argument Visibility: default -->
1159
1980
<element name="TWidgetSet.ExcludeClipRect.Top">
1162
<!-- argument Visibility: default -->
1163
1983
<element name="TWidgetSet.ExcludeClipRect.Right">
1166
<!-- argument Visibility: default -->
1167
1986
<element name="TWidgetSet.ExcludeClipRect.Bottom">
1170
1989
<!-- function Visibility: public -->
1990
<element name="TWidgetSet.ExtCreatePen">
1991
<short>Creates an logical pen, selectable into any DC.</short>
1997
<element name="TWidgetSet.ExtCreatePen.Result">
1998
<short>The pen handle, zero on failure.</short>
2000
<element name="TWidgetSet.ExtCreatePen.dwPenStyle">
2001
<short>A collection of style options.</short>
2003
<element name="TWidgetSet.ExtCreatePen.dwWidth">
2004
<short>The pen width.</short>
2006
<element name="TWidgetSet.ExtCreatePen.lplb">
2007
<short>The brush description.</short>
2009
<element name="TWidgetSet.ExtCreatePen.dwStyleCount">
2010
<short>The number of sections of an dashed pen.</short>
2012
<element name="TWidgetSet.ExtCreatePen.lpStyle">
2013
<short>Array of the section lengths of an dashed pen.</short>
2015
<!-- function Visibility: public -->
1171
2016
<element name="TWidgetSet.ExtTextOut">
2017
<short>Draws an string without formatting (single line).</short>
2020
The string is drawn with the current font and colors.
2022
The following Options are supported:
2026
ETO_CLIPPED - the text is clipped to the given rectangle.
2028
ETO_OPAQUE - the rectangle is filled with the background color.
2033
<link id="TWidgetSet.ExtUTF8Out"/>
1177
<!-- function result Visibility: default -->
1178
2036
<element name="TWidgetSet.ExtTextOut.Result">
2037
<short>False on failure.</short>
1181
<!-- argument Visibility: default -->
1182
2039
<element name="TWidgetSet.ExtTextOut.DC">
2040
<short>The Device Context.</short>
1185
<!-- argument Visibility: default -->
1186
2042
<element name="TWidgetSet.ExtTextOut.X">
2043
<short>The reference point, used to position the text.</short>
1189
<!-- argument Visibility: default -->
1190
2045
<element name="TWidgetSet.ExtTextOut.Y">
2046
<short>The reference point, used to position the text.</short>
1193
<!-- argument Visibility: default -->
1194
2048
<element name="TWidgetSet.ExtTextOut.Options">
2049
<short>Output options.</short>
1197
<!-- argument Visibility: default -->
1198
2051
<element name="TWidgetSet.ExtTextOut.Rect">
2052
<short>The bounding rectangle.</short>
1201
<!-- argument Visibility: default -->
1202
2054
<element name="TWidgetSet.ExtTextOut.Str">
2055
<short>The text.</short>
1205
<!-- argument Visibility: default -->
1206
2057
<element name="TWidgetSet.ExtTextOut.Count">
2058
<short>The number of (Wide)Chars in the string.</short>
1209
<!-- argument Visibility: default -->
1210
2060
<element name="TWidgetSet.ExtTextOut.Dx">
2061
<short>Pointer to an array of intercharacter spacing values, can be Nil.</short>
1213
2063
<!-- function Visibility: public -->
1214
2064
<element name="TWidgetSet.ExtSelectClipRGN">
2065
<short>Combines the passed Region with the current clipping region.</short>
2067
<p>The Mode can be one of:</p>
2070
RGN_AND - all points which are in both regions.
2072
RGN_COPY - an exact copy of the source region, same as SelectClipRGN.
2074
RGN_DIFF - all points which are in the Clipping Region but but not in the Source. (Clip - RGN)
2076
RGN_OR - all points which are in either the Clip Region or in the Source. (Clip + RGN)
2078
RGN_XOR - all points which are in either the Clip Region or in the Source, but not in both.
1220
<!-- function result Visibility: default -->
1221
2085
<element name="TWidgetSet.ExtSelectClipRGN.Result">
2086
<short>The type of the resulting clipping region.</short>
1224
<!-- argument Visibility: default -->
1225
2088
<element name="TWidgetSet.ExtSelectClipRGN.dc">
1228
<!-- argument Visibility: default -->
1229
2091
<element name="TWidgetSet.ExtSelectClipRGN.rgn">
2092
<short>The region to combine with.</short>
1232
<!-- argument Visibility: default -->
1233
2094
<element name="TWidgetSet.ExtSelectClipRGN.Mode">
2095
<short>How the regions are combined.</short>
1236
2097
<!-- function Visibility: public -->
1237
2098
<element name="TWidgetSet.FillRect">
2099
<short>Fills a rectangle using the specified brush.</short>
1243
<!-- function result Visibility: default -->
1244
2104
<element name="TWidgetSet.FillRect.Result">
2105
<short>False on failure.</short>
1247
<!-- argument Visibility: default -->
1248
2107
<element name="TWidgetSet.FillRect.DC">
1251
<!-- argument Visibility: default -->
1252
2110
<element name="TWidgetSet.FillRect.Rect">
1255
<!-- argument Visibility: default -->
1256
2113
<element name="TWidgetSet.FillRect.Brush">
1259
2116
<!-- function Visibility: public -->
1260
2117
<element name="TWidgetSet.FillRgn">
2118
<short>Fills a region using the specified brush.</short>
1266
<!-- function result Visibility: default -->
1267
2123
<element name="TWidgetSet.FillRgn.Result">
1270
<!-- argument Visibility: default -->
1271
2126
<element name="TWidgetSet.FillRgn.DC">
1274
<!-- argument Visibility: default -->
1275
2129
<element name="TWidgetSet.FillRgn.RegionHnd">
1278
<!-- argument Visibility: default -->
1279
2132
<element name="TWidgetSet.FillRgn.hbr">
1282
2135
<!-- function Visibility: public -->
1283
2136
<element name="TWidgetSet.FloodFill">
2137
<short>Fills an area of the display surface with the current brush.</short>
2140
FillStyle specifies the area:
2144
When FillStyle is <var>fsBorder</var>, the area is <b>bounded</b> by a certain Color,
2145
the boundary must not have gaps in it.
2147
When FillStyle is <var>fsSurface</var>, the area <b>has</b> the specified Color,
2148
and all adjacent pixels of this color are replaced.
2152
Filling starts at a given point, which resides somewhere inside the area.
1289
<!-- function result Visibility: default -->
1290
2157
<element name="TWidgetSet.FloodFill.Result">
2158
<short>False on failure.</short>
1293
<!-- argument Visibility: default -->
1294
2160
<element name="TWidgetSet.FloodFill.DC">
2161
<short>The device context.</short>
1297
<!-- argument Visibility: default -->
1298
2163
<element name="TWidgetSet.FloodFill.X">
2164
<short>The starting point.</short>
1301
<!-- argument Visibility: default -->
1302
2166
<element name="TWidgetSet.FloodFill.Y">
2167
<short>The starting point.</short>
1305
<!-- argument Visibility: default -->
1306
2169
<element name="TWidgetSet.FloodFill.Color">
2170
<short>The area or boundary color, depending on FillStyle.</short>
1309
<!-- argument Visibility: default -->
1310
2172
<element name="TWidgetSet.FloodFill.FillStyle">
2173
<short>fsBorder or fsSurface.</short>
1313
<!-- argument Visibility: default -->
1314
2175
<element name="TWidgetSet.FloodFill.Brush">
2176
<short>The brush used to fill the area.</short>
1317
2178
<!-- function Visibility: public -->
1318
2179
<element name="TWidgetSet.FrameRect">
2180
<short>Draws a border around a rectangle.</short>
2181
<descr>The boundary is one logical unit wide,
2182
painted using the given brush.
1324
2187
<!-- function result Visibility: default -->
1325
2188
<element name="TWidgetSet.FrameRect.Result">
2189
<short>Zero on failure.</short>
1328
<!-- argument Visibility: default -->
1329
2191
<element name="TWidgetSet.FrameRect.DC">
1332
<!-- argument Visibility: default -->
1333
2194
<element name="TWidgetSet.FrameRect.ARect">
2195
<short>The rectangle to outline.</short>
1336
<!-- argument Visibility: default -->
1337
2197
<element name="TWidgetSet.FrameRect.hBr">
2198
<short>The brush for drawing the border.</short>
1340
2200
<!-- function Visibility: public -->
1341
2201
<element name="TWidgetSet.GetActiveWindow">
2202
<short>Returns the Handle of the active window of the calling thread.
1347
<!-- function result Visibility: default -->
1348
2208
<element name="TWidgetSet.GetActiveWindow.Result">
2209
<short>The window handle, zero on failure.</short>
1351
2211
<!-- function Visibility: public -->
1352
2212
<element name="TWidgetSet.GetBitmapBits">
2213
<short>Fills an buffer with the bitmap bits.</short>
1358
<!-- function result Visibility: default -->
1359
2218
<element name="TWidgetSet.GetBitmapBits.Result">
2219
<short>The number of bytes copied, zero on failure.</short>
1362
<!-- argument Visibility: default -->
1363
2221
<element name="TWidgetSet.GetBitmapBits.Bitmap">
2222
<short>The (device dependent) bitmap handle.</short>
1366
<!-- argument Visibility: default -->
1367
2224
<element name="TWidgetSet.GetBitmapBits.Count">
2225
<short>The byte size of the buffer.</short>
1370
<!-- argument Visibility: default -->
1371
2227
<element name="TWidgetSet.GetBitmapBits.Bits">
2228
<short>Pointer to the output buffer.</short>
2230
<!-- function Visibility: public -->
2231
<element name="TWidgetSet.GetBkColor">
2232
<short>Returns the background color of an device context.</short>
2238
<element name="TWidgetSet.GetBkColor.Result">
2239
<short>The background color, CLR_INVALID on failure.</short>
2241
<element name="TWidgetSet.GetBkColor.DC">
1374
2244
<!-- function Visibility: public -->
1375
2245
<element name="TWidgetSet.GetCapture">
2246
<short>Returns the window that captures mouse messages.</short>
1381
<!-- function result Visibility: default -->
1382
2251
<element name="TWidgetSet.GetCapture.Result">
2252
<short>The window handle, zero if no window of the thread captures mouse messages.</short>
1385
2254
<!-- function Visibility: public -->
1386
2255
<element name="TWidgetSet.GetCaretPos">
2256
<short>Returns the caret position, in client coordinates.</short>
1392
<!-- function result Visibility: default -->
1393
2261
<element name="TWidgetSet.GetCaretPos.Result">
2262
<short>False on failure.</short>
1396
<!-- argument Visibility: default -->
1397
2264
<element name="TWidgetSet.GetCaretPos.lpPoint">
2265
<short>Receives the coordinates.</short>
1400
2267
<!-- function Visibility: public -->
1401
2268
<element name="TWidgetSet.GetClientRect">
2269
<short>Returns the client rectangle of a window.</short>
2272
The client rectangle is the size of the inner area of a control,
2273
where e.g. the child controls are visible.
2274
Left and Top are always 0.
2276
A child control with Align=alClient will completely fill the clientrect.
1407
<!-- function result Visibility: default -->
1408
2281
<element name="TWidgetSet.GetClientRect.Result">
2282
<short>False on failure.</short>
1411
<!-- argument Visibility: default -->
1412
2284
<element name="TWidgetSet.GetClientRect.handle">
2285
<short>The window handle.</short>
1415
<!-- argument Visibility: default -->
1416
2287
<element name="TWidgetSet.GetClientRect.Rect">
2288
<short>Receives the client coordinates.</short>
1419
2290
<!-- function Visibility: public -->
1420
2291
<element name="TWidgetSet.GetClipBox">
2292
<short>Returns the smallest rectangle
2293
which includes the entire clipping region of an device context.
1426
<!-- function result Visibility: default -->
1427
2299
<element name="TWidgetSet.GetClipBox.Result">
2300
<short>The region kind.</short>
1430
<!-- argument Visibility: default -->
1431
2302
<element name="TWidgetSet.GetClipBox.DC">
2303
<short>The device context.</short>
1434
<!-- argument Visibility: default -->
1435
2305
<element name="TWidgetSet.GetClipBox.lpRect">
2306
<short>Receives the coordinates.</short>
1438
2308
<!-- function Visibility: public -->
1439
2309
<element name="TWidgetSet.GetClipRGN">
2310
<short>Returns the clipping region of an device context.</short>
1445
<!-- function result Visibility: default -->
1446
2315
<element name="TWidgetSet.GetClipRGN.Result">
2316
<short>Zero on failure.</short>
1449
<!-- argument Visibility: default -->
1450
2318
<element name="TWidgetSet.GetClipRGN.DC">
2319
<short>The device context.</short>
1453
<!-- argument Visibility: default -->
1454
2321
<element name="TWidgetSet.GetClipRGN.RGN">
2322
<short>The handle of the clipping region.</short>
2324
<!-- function Visibility: public -->
2325
<element name="TWidgetSet.GetCurrentObject">
2326
<short>Returns an currently selected object in an device context.</short>
2332
<element name="TWidgetSet.GetCurrentObject.Result">
2333
<short>The object handle, zero on failure.</short>
2335
<element name="TWidgetSet.GetCurrentObject.DC">
2336
<short>The device context.</short>
2338
<element name="TWidgetSet.GetCurrentObject.uObjectType">
2339
<short>The type of the selected object, e.g. OBJ_BRUSH.</short>
1457
2341
<!-- function Visibility: public -->
1458
2342
<element name="TWidgetSet.GetCursorPos">
2343
<short>Gets the mouse cursor position, in screen coordinates.</short>
1464
<!-- function result Visibility: default -->
1465
2347
<element name="TWidgetSet.GetCursorPos.Result">
2348
<short>False on failure.</short>
1468
<!-- argument Visibility: default -->
1469
2350
<element name="TWidgetSet.GetCursorPos.lpPoint">
2351
<short>Receives the mouse coordinates.</short>
1472
2353
<!-- function Visibility: public -->
1473
2354
<element name="TWidgetSet.GetCharABCWidths">
2355
<short>Returns the ABC widths of an range of character codes.</short>
2359
<link id="#lcl.LCLType._ABC"/>
1479
<!-- function result Visibility: default -->
1480
2362
<element name="TWidgetSet.GetCharABCWidths.Result">
2363
<short>False on failure.</short>
1483
<!-- argument Visibility: default -->
1484
2365
<element name="TWidgetSet.GetCharABCWidths.DC">
2366
<short>The device context.</short>
1487
<!-- argument Visibility: default -->
1488
2368
<element name="TWidgetSet.GetCharABCWidths.p2">
2369
<short>The first character code</short>
1491
<!-- argument Visibility: default -->
1492
2371
<element name="TWidgetSet.GetCharABCWidths.p3">
2372
<short>The last character code.</short>
1495
<!-- argument Visibility: default -->
1496
2374
<element name="TWidgetSet.GetCharABCWidths.ABCStructs">
2375
<short>Array of ABC records, receiving the information.</short>
1499
2377
<!-- function Visibility: public -->
1500
2378
<element name="TWidgetSet.GetDC">
2379
<short>Returns the handle of an Device Context (DC) for the client area of a window.
1506
<!-- function result Visibility: default -->
1507
2385
<element name="TWidgetSet.GetDC.Result">
2386
<short>The DC handle, zero on failure.</short>
1510
<!-- argument Visibility: default -->
1511
2388
<element name="TWidgetSet.GetDC.hWnd">
2389
<short>The window handle.</short>
1514
2391
<!-- function Visibility: public -->
1515
2392
<element name="TWidgetSet.GetDeviceCaps">
2393
<short>Returns various device specific informations.</short>
2395
<p>The following informations can be retrieved:</p>
2398
HORZSIZE - Horizontal size in millimeters
2400
VERTSIZE - Vertical size in millimeters
2402
HORZRES - Horizontal width in pixels
2404
VERTRES - Vertical height in pixels
2406
BITSPIXEL - Number of bits per pixel
2408
PLANES - Number of color planes
2410
LOGPIXELSX - The number of pixels per logical inch, in X (horizontal) direction.
2412
LOGPIXELSY - The number of pixels per logical inch, in Y (vertical) direction.
2414
SIZEPALETTE - Number of entries in the color palette
2416
NUMRESERVED - Number of reserved entries in the color palette
2422
<link id="#lcl.LCLType.HORZRES"/>
1521
<!-- function result Visibility: default -->
1522
2425
<element name="TWidgetSet.GetDeviceCaps.Result">
2426
<short>The requested value</short>
1525
<!-- argument Visibility: default -->
1526
2428
<element name="TWidgetSet.GetDeviceCaps.DC">
2429
<short>The device context.</short>
1529
<!-- argument Visibility: default -->
1530
2431
<element name="TWidgetSet.GetDeviceCaps.Index">
2432
<short>The value type, e.g. HORZRES.</short>
1533
2434
<!-- function Visibility: public -->
1534
2435
<element name="TWidgetSet.GetDIBits">
2436
<short>Fills an buffer with bitmap color bits.</short>
2439
The bitmap must be a compatible (device dependent) bitmap,
2440
for the given device context.
2441
It should not be selected into any DC.
2443
The color bits are copied into the Bits array
2444
in Device Independent Bitmap (DIB) format.
2446
When Bits is Nil, the BitInfo record receives the bitmap information,
2447
from which the required size of the Bits array can be determined.
2453
<link id="#lcl.LCLType.DIB_RGB_COLORS"/>
1540
<!-- function result Visibility: default -->
1541
2456
<element name="TWidgetSet.GetDIBits.Result">
2457
<short>The number of returned scanlines, zero on failure.</short>
1544
<!-- argument Visibility: default -->
1545
2459
<element name="TWidgetSet.GetDIBits.DC">
2460
<short>The device context.</short>
1548
<!-- argument Visibility: default -->
1549
2462
<element name="TWidgetSet.GetDIBits.Bitmap">
2463
<short>The bitmap handle.</short>
1552
<!-- argument Visibility: default -->
1553
2465
<element name="TWidgetSet.GetDIBits.StartScan">
2466
<short>The first scanline to retrieve.</short>
1556
<!-- argument Visibility: default -->
1557
2468
<element name="TWidgetSet.GetDIBits.NumScans">
2469
<short>The number of scanlines to retrieve.</short>
1560
<!-- argument Visibility: default -->
1561
2471
<element name="TWidgetSet.GetDIBits.Bits">
2472
<short>Pointer to the color bits array, or Nil to get the BitmapInfo.</short>
1564
<!-- argument Visibility: default -->
1565
2474
<element name="TWidgetSet.GetDIBits.BitInfo">
2475
<short>Contains or receives the BitmapInfo.</short>
1568
<!-- argument Visibility: default -->
1569
2477
<element name="TWidgetSet.GetDIBits.Usage">
2478
<short>The color format, e.g. DIB_RGB_COLORS.</short>
2480
<!-- function Visibility: public -->
2481
<element name="TWidgetSet.GetDoubleClickTime">
2482
<short>Returns the double-click time, in milliseconds.</short>
2490
<element name="TWidgetSet.GetDoubleClickTime.Result">
1572
2493
<!-- function Visibility: public -->
1573
2494
<element name="TWidgetSet.GetFocus">
2495
<short>Returns the handle of the window that has the focus in the current thread.
1579
<!-- function result Visibility: default -->
1580
2501
<element name="TWidgetSet.GetFocus.Result">
2502
<short>The window handle, zero if no window has the focus.</short>
1583
2504
<!-- function Visibility: public -->
1584
2505
<element name="TWidgetSet.GetFontLanguageInfo">
2506
<short>Returns language information about the currently selected font.</short>
2508
<p>The following flags are supported:</p>
2510
<li>GCP_DBCS - the character set is double-byte (DBCS).
1590
<!-- function result Visibility: default -->
1591
2517
<element name="TWidgetSet.GetFontLanguageInfo.Result">
2518
<short>Font flags, zero for Latin font alikes.</short>
1594
<!-- argument Visibility: default -->
1595
2520
<element name="TWidgetSet.GetFontLanguageInfo.DC">
1598
2523
<!-- function Visibility: public -->
2524
<element name="TWidgetSet.GetForegroundWindow">
2525
<short>Returns the window that the user is currently working with, session wide.</short>
2531
<element name="TWidgetSet.GetForegroundWindow.Result">
2532
<short>The window handle, zero when no such window exists.</short>
2534
<!-- function Visibility: public -->
2535
<element name="TWidgetSet.GetIconInfo">
2536
<short>Returns information about an Icon or Cursor.</short>
2544
<element name="TWidgetSet.GetIconInfo.Result">
2547
<element name="TWidgetSet.GetIconInfo.AIcon">
2548
<short>The item handle.</short>
2550
<element name="TWidgetSet.GetIconInfo.AIconInfo">
2551
<short>Receives the information.</short>
2553
<!-- function Visibility: public -->
1599
2554
<element name="TWidgetSet.GetKeyState">
2555
<short>The status of a virtual key.</short>
2558
The result reflects the message processing state,
2559
at the time of the last seen key message.
2561
A key can be up, down or toggled.
2563
The high order bit of the result is the up/down state,
2566
The low order bit of the result is the toggled state,
2567
applicable to e.g. the caps-lock key.
2568
The bit is set if the key is toggled (active).
1605
<!-- function result Visibility: default -->
1606
2574
<element name="TWidgetSet.GetKeyState.Result">
2575
<short>The key state flags.</short>
1609
<!-- argument Visibility: default -->
1610
2577
<element name="TWidgetSet.GetKeyState.nVirtKey">
2578
<short>The virtual key code.</short>
1613
2580
<!-- function Visibility: public -->
1614
2581
<element name="TWidgetSet.GetMapMode">
2582
<short>Returns the mapping mode of an device context.</short>
2586
<link id="TWidgetSet.SetMapMode"/>
1620
<!-- function result Visibility: default -->
1621
2589
<element name="TWidgetSet.GetMapMode.Result">
2590
<short>The <link id="TWidgetSet.SetMapMode">mapping mode</link>, zero on failure.</short>
1624
<!-- argument Visibility: default -->
1625
2592
<element name="TWidgetSet.GetMapMode.DC">
2593
<short>The device context.</short>
2595
<!-- function Visibility: public -->
2596
<element name="TWidgetSet.GetMonitorInfo">
2597
<short>Returns information about an display monitor.</short>
2603
<element name="TWidgetSet.GetMonitorInfo.Result">
2604
<short>False on failure.</short>
2606
<element name="TWidgetSet.GetMonitorInfo.hMonitor">
2607
<short>The monitor handle.</short>
2609
<element name="TWidgetSet.GetMonitorInfo.lpmi">
2610
<short>Receives the information.</short>
1628
2612
<!-- function Visibility: public -->
1629
2613
<element name="TWidgetSet.GetObject">
2614
<short>Returns information about a graphics object.</short>
2615
<descr>The returned information depends on the object type
1635
<!-- function result Visibility: default -->
1636
2620
<element name="TWidgetSet.GetObject.Result">
2621
<short>The number of bytes written into the buffer.</short>
1639
<!-- argument Visibility: default -->
1640
2623
<element name="TWidgetSet.GetObject.GDIObject">
2624
<short>The Handle of the object.</short>
1643
<!-- argument Visibility: default -->
1644
2626
<element name="TWidgetSet.GetObject.BufSize">
2627
<short>The bytecount of the buffer.</short>
1647
<!-- argument Visibility: default -->
1648
2629
<element name="TWidgetSet.GetObject.Buf">
2630
<short>Receives the information. Nil means to return the required buffer size.</short>
1651
2632
<!-- function Visibility: public -->
1652
2633
<element name="TWidgetSet.GetPaletteEntries">
2634
<short>Retrieves an range of color entries from a logical palette.</short>
1658
<!-- function result Visibility: default -->
1659
2638
<element name="TWidgetSet.GetPaletteEntries.Result">
2639
<short>The number of entries copied.</short>
1662
<!-- argument Visibility: default -->
1663
2641
<element name="TWidgetSet.GetPaletteEntries.Palette">
2642
<short>The palette handle.</short>
1666
<!-- argument Visibility: default -->
1667
2644
<element name="TWidgetSet.GetPaletteEntries.StartIndex">
2645
<short>The first entry.</short>
1670
<!-- argument Visibility: default -->
1671
2647
<element name="TWidgetSet.GetPaletteEntries.NumEntries">
2648
<short>The number of entries to retrieve.</short>
1674
<!-- argument Visibility: default -->
1675
2650
<element name="TWidgetSet.GetPaletteEntries.PaletteEntries">
2651
<short>Array of PALETTEENTRY records, receiving the information.</short>
1678
2653
<!-- function Visibility: public -->
1679
2654
<element name="TWidgetSet.GetParent">
2655
<short>Returns the parent window of a window.</short>
1685
<!-- function result Visibility: default -->
1686
2660
<element name="TWidgetSet.GetParent.Result">
2661
<short>The parent window handle, zero on failure.</short>
1689
<!-- argument Visibility: default -->
1690
2663
<element name="TWidgetSet.GetParent.Handle">
2664
<short>The window handle.</short>
1693
2666
<!-- function Visibility: public -->
1694
2667
<element name="TWidgetSet.GetProp">
2668
<short>Retrieves an property value for a window.</short>
2671
<link id="TWidgetSet.SetProp"/>
1700
<!-- function result Visibility: default -->
1701
2674
<element name="TWidgetSet.GetProp.Result">
2675
<short>Nil on failure.</short>
1704
<!-- argument Visibility: default -->
1705
2677
<element name="TWidgetSet.GetProp.Handle">
2678
<short>The window handle.</short>
1708
<!-- argument Visibility: default -->
1709
2680
<element name="TWidgetSet.GetProp.Str">
2681
<short>The property name.</short>
1712
2683
<!-- function Visibility: public -->
1713
2684
<element name="TWidgetSet.GetRgnBox">
2685
<short>Returns the bounding rectangle of a region, containing the entire region.
1719
<!-- function result Visibility: default -->
1720
2691
<element name="TWidgetSet.GetRgnBox.Result">
2692
<short>The region kind.</short>
1723
<!-- argument Visibility: default -->
1724
2694
<element name="TWidgetSet.GetRgnBox.RGN">
2695
<short>The region handle.</short>
1727
<!-- argument Visibility: default -->
1728
2697
<element name="TWidgetSet.GetRgnBox.lpRect">
2698
<short>Receives the coordinates.</short>
2700
<!-- function Visibility: public -->
2701
<element name="TWidgetSet.GetROP2">
2702
<short>The current Foreground Mixing Mode in an device context.</short>
2706
<link id="TWidgetSet.SetROP2"/>
2707
<link id="#lcl.LCLType.R2_COPYPEN"/>
2710
<element name="TWidgetSet.GetROP2.Result">
2711
<short>The mode, zero on failure.</short>
2713
<element name="TWidgetSet.GetROP2.DC">
2714
<short>The device context.</short>
1731
2716
<!-- function Visibility: public -->
1732
2717
<element name="TWidgetSet.GetScrollInfo">
2718
<short>Returns all or selected information about a ScrollBar.
2722
<link id="TWidgetSet.SetScrollInfo"/>
1738
<!-- function result Visibility: default -->
1739
2725
<element name="TWidgetSet.GetScrollInfo.Result">
2726
<short>False on failure.</short>
1742
<!-- argument Visibility: default -->
1743
2728
<element name="TWidgetSet.GetScrollInfo.Handle">
2729
<short>The handle of a ScrollBar, or of a window containing scrollbars.</short>
1746
<!-- argument Visibility: default -->
1747
2731
<element name="TWidgetSet.GetScrollInfo.SBStyle">
2732
<short>The ScrollBar kind.</short>
1750
<!-- argument Visibility: default -->
1751
2734
<element name="TWidgetSet.GetScrollInfo.ScrollInfo">
2735
<short>Receives the values indicated in fMask.</short>
1754
2737
<!-- function Visibility: public -->
1755
2738
<element name="TWidgetSet.GetStockObject">
2739
<short>Retrieves a handle to one of the predefined graphic objects.</short>
2741
<p>These are the predefined (Windows) stock objects:
1761
<!-- function result Visibility: default -->
1762
2788
<element name="TWidgetSet.GetStockObject.Result">
2789
<short>The handle, zero on failure.</short>
1765
<!-- argument Visibility: default -->
1766
2791
<element name="TWidgetSet.GetStockObject.Value">
2792
<short>The object kind.</short>
1769
2794
<!-- function Visibility: public -->
1770
2795
<element name="TWidgetSet.GetSysColor">
2796
<short>Retrieves the system color for standard display elements.</short>
2798
<p>These are the available display elements:
2804
COLOR_3DFACE, COLOR_BTNFACE
2806
COLOR_3DHIGHLIGHT, COLOR_3DHILIGHT, COLOR_BTNHILIGHT, COLOR_BTNHIGHLIGHT
2810
COLOR_3DSHADOW, COLOR_BTNSHADOW
2818
COLOR_BACKGROUND, COLOR_DESKTOP
2824
COLOR_GRADIENTACTIVECAPTION
2826
COLOR_GRADIENTINACTIVECAPTION
2836
COLOR_INACTIVEBORDER
2838
COLOR_INACTIVECAPTION
2840
COLOR_INACTIVECAPTIONTEXT
2864
Since all returned values are valid colors, errors cannot be detected.
2865
GetSysColorBrush instead returns a zero handle on failure.
2869
<link id="TWidgetSet.GetSysColorBrush"/>
1776
<!-- function result Visibility: default -->
1777
2872
<element name="TWidgetSet.GetSysColor.Result">
2873
<short>The RGB color.</short>
1780
<!-- argument Visibility: default -->
1781
2875
<element name="TWidgetSet.GetSysColor.nIndex">
2876
<short>The system color type.</short>
2878
<!-- function Visibility: public -->
2879
<element name="TWidgetSet.GetSysColorBrush">
2880
<short>Retrieves a system brush for standard display elements.</short>
2884
<link id="TWidgetSet.GetSysColor"/>
2887
<element name="TWidgetSet.GetSysColorBrush.Result">
2888
<short>The brush handle, zero on failure.</short>
2890
<element name="TWidgetSet.GetSysColorBrush.nIndex">
2891
<short>The system color type.</short>
1784
2893
<!-- function Visibility: public -->
1785
2894
<element name="TWidgetSet.GetSystemPaletteEntries">
2895
<short>Retrieves an range of color entries from the system palette for a device.</short>
2898
<link id="TWidgetSet.GetPaletteEntries"/>
1791
<!-- function result Visibility: default -->
1792
2901
<element name="TWidgetSet.GetSystemPaletteEntries.Result">
2902
<short>The number of entries copied, zero on failure.</short>
1795
<!-- argument Visibility: default -->
1796
2904
<element name="TWidgetSet.GetSystemPaletteEntries.DC">
2905
<short>The device context.</short>
1799
<!-- argument Visibility: default -->
1800
2907
<element name="TWidgetSet.GetSystemPaletteEntries.StartIndex">
2908
<short>The first entry to retrieve.</short>
1803
<!-- argument Visibility: default -->
1804
2910
<element name="TWidgetSet.GetSystemPaletteEntries.NumEntries">
2911
<short>The number of requested entries.</short>
1807
<!-- argument Visibility: default -->
1808
2913
<element name="TWidgetSet.GetSystemPaletteEntries.PaletteEntries">
2914
<short>Receives the color information. When Nil, the total number of palette entries is returned.</short>
1811
2916
<!-- function Visibility: public -->
1812
2917
<element name="TWidgetSet.GetSystemMetrics">
2918
<short>Retrieves various system metrics.</short>
2921
All dimensions are measured in pixels.
2923
These are available items:
2935
SM_CXBORDER, SM_CYBORDER
2937
SM_CXCURSOR, SM_CYCURSOR
2939
SM_CXDLGFRAME, SM_CYDLGFRAME
2941
SM_CXDOUBLECLK, SM_CYDOUBLECLK
2943
SM_CXDRAG, SM_CYDRAG
2945
SM_CXEDGE, SM_CYEDGE
2947
SM_CXFIXEDFRAME, SM_CYFIXEDFRAME
2951
SM_CXFRAME, SM_CYFRAME
2953
SM_CXFULLSCREEN, SM_CYFULLSCREEN
2955
SM_CXHSCROLL, SM_CYHSCROLL
2959
SM_CXICON, SM_CYICON
2961
SM_CXICONSPACING, SM_CYICONSPACING
2963
SM_CXMAXIMIZED, SM_CYMAXIMIZED
2965
SM_CXMAXTRACK, SM_CYMAXTRACK
2967
SM_CXMENUCHECK, SM_CYMENUCHECK
2969
SM_CXMENUSIZE, SM_CYMENUSIZE
2973
SM_CXMINIMIZED, SM_CYMINIMIZED
2975
SM_CXMINSPACING, SM_CYMINSPACING
2977
SM_CXMINTRACK, SM_CYMINTRACK
2979
SM_CXSCREEN, SM_CYSCREEN
2981
SM_CXSIZE, SM_CYSIZE
2983
SM_CXSIZEFRAME, SM_CYSIZEFRAME
2985
SM_CXSMICON, SM_CYSMICON
2987
SM_CXSMSIZE, SM_CYSMSIZE
2989
SM_CXVIRTUALSCREEN, SM_CYVIRTUALSCREEN
2991
SM_CXVSCROLL, SM_CYVSCROLL
3010
SM_MENUDROPALIGNMENT
3016
SM_MOUSEWHEELPRESENT
3027
SM_SAMEDISPLAYFORMAT
3039
SM_XVIRTUALSCREEN, SM_YVIRTUALSCREEN
1818
<!-- function result Visibility: default -->
1819
3047
<element name="TWidgetSet.GetSystemMetrics.Result">
3048
<short>Depends on the requested item.</short>
1822
<!-- argument Visibility: default -->
1823
3050
<element name="TWidgetSet.GetSystemMetrics.nIndex">
3051
<short>The requested item.</short>
1826
3053
<!-- function Visibility: public -->
1827
3054
<element name="TWidgetSet.GetTextColor">
3055
<short>The current text color in an device context.</short>
1833
<!-- function result Visibility: default -->
1834
3060
<element name="TWidgetSet.GetTextColor.Result">
3061
<short>The RGB color.</short>
1837
<!-- argument Visibility: default -->
1838
3063
<element name="TWidgetSet.GetTextColor.DC">
3064
<short>The device context.</short>
1841
3066
<!-- function Visibility: public -->
1842
3067
<element name="TWidgetSet.GetTextExtentExPoint">
3068
<short>Calculates the number of characters, that fit into some horizontal space.</short>
1848
<!-- function result Visibility: default -->
1849
3073
<element name="TWidgetSet.GetTextExtentExPoint.Result">
3074
<short>False on failure.</short>
1852
<!-- argument Visibility: default -->
1853
3076
<element name="TWidgetSet.GetTextExtentExPoint.DC">
3077
<short>The device context.</short>
1856
<!-- argument Visibility: default -->
1857
3079
<element name="TWidgetSet.GetTextExtentExPoint.Str">
3080
<short>The string containing the characters.</short>
1860
<!-- argument Visibility: default -->
1861
3082
<element name="TWidgetSet.GetTextExtentExPoint.Count">
3083
<short>The number of logical characters in Str, -1 for automatic detection.</short>
1864
<!-- argument Visibility: default -->
1865
3085
<element name="TWidgetSet.GetTextExtentExPoint.MaxWidth">
3086
<short>The maximum display width, in logical units.</short>
1868
<!-- argument Visibility: default -->
1869
3088
<element name="TWidgetSet.GetTextExtentExPoint.MaxCount">
3089
<short>Receives the number of <b>logical</b> (UTF) characters that can be displayed.
3090
When Nil, MaxWidth is ignored.</short>
1872
<!-- argument Visibility: default -->
1873
3092
<element name="TWidgetSet.GetTextExtentExPoint.PartialWidths">
3093
<short>Receives the widths for every partial sequence of characters. Can be Nil.</short>
1876
<!-- argument Visibility: default -->
1877
3095
<element name="TWidgetSet.GetTextExtentExPoint.Size">
3096
<short>Receives the total width and height of the display area.</short>
1880
3098
<!-- function Visibility: public -->
1881
3099
<element name="TWidgetSet.GetTextExtentPoint">
3100
<short>Computes the display width and height of an string.</short>
3102
<errors>May not work properly without Unicode support.
3105
<link id="TWidgetSet.GetTextExtentExPoint"/>
1887
<!-- function result Visibility: default -->
1888
3108
<element name="TWidgetSet.GetTextExtentPoint.Result">
3109
<short>False on failure.</short>
1891
<!-- argument Visibility: default -->
1892
3111
<element name="TWidgetSet.GetTextExtentPoint.DC">
3112
<short>The display DC.</short>
1895
<!-- argument Visibility: default -->
1896
3114
<element name="TWidgetSet.GetTextExtentPoint.Str">
3115
<short>The text.</short>
1899
<!-- argument Visibility: default -->
1900
3117
<element name="TWidgetSet.GetTextExtentPoint.Count">
3118
<short>The number of <b>bytes</b> in Str, -1 for automatic detection.</short>
1903
<!-- argument Visibility: default -->
1904
3120
<element name="TWidgetSet.GetTextExtentPoint.Size">
3121
<short>Receives the total width and height of the required display area.</short>
1907
3123
<!-- function Visibility: public -->
1908
<element name="TWidgetSet.GetTextExtentPoint32">
3124
<element name="TWidgetSet.GetTextExtentPoint32" link="TWidgetSet.GetTextExtentPoint">
3125
<short>Computes the display width and height of an string.</short>
3130
<link id="TWidgetSet.GetTextExtentPoint"/>
3131
<link id="TWidgetSet.GetTextExtentExPoint"/>
1914
<!-- function result Visibility: default -->
1915
3134
<element name="TWidgetSet.GetTextExtentPoint32.Result">
1918
<!-- argument Visibility: default -->
1919
3137
<element name="TWidgetSet.GetTextExtentPoint32.DC">
1922
<!-- argument Visibility: default -->
1923
3140
<element name="TWidgetSet.GetTextExtentPoint32.Str">
1926
<!-- argument Visibility: default -->
1927
3143
<element name="TWidgetSet.GetTextExtentPoint32.Count">
1930
<!-- argument Visibility: default -->
1931
3146
<element name="TWidgetSet.GetTextExtentPoint32.Size">
1934
3149
<!-- function Visibility: public -->
1935
3150
<element name="TWidgetSet.GetTextMetrics">
3151
<short>Retrieves the metrics for the currently selected font.</short>
1941
<!-- function result Visibility: default -->
1942
3155
<element name="TWidgetSet.GetTextMetrics.Result">
3156
<short>False on failure.</short>
1945
<!-- argument Visibility: default -->
1946
3158
<element name="TWidgetSet.GetTextMetrics.DC">
3159
<short>The device context, where the font is selected.</short>
1949
<!-- argument Visibility: default -->
1950
3161
<element name="TWidgetSet.GetTextMetrics.TM">
3162
<short>Receives the information.</short>
3164
<!-- function Visibility: public -->
3165
<element name="TWidgetSet.GetViewPortExtEx">
3166
<short>Returns the size of the viewport of an device context.</short>
3170
<link id="TWidgetSet.SetViewPortExtEx"/>
3171
<link id="TWidgetSet.GetViewPortOrgEx"/>
3174
<element name="TWidgetSet.GetViewPortExtEx.Result">
3175
<short>False (zero) on failure.</short>
3177
<element name="TWidgetSet.GetViewPortExtEx.DC">
3180
<element name="TWidgetSet.GetViewPortExtEx.Size">
3181
<short>Receives the viewport size.</short>
3183
<!-- function Visibility: public -->
3184
<element name="TWidgetSet.GetViewPortOrgEx">
3185
<short>Returns the origin of the viewport of an device context.</short>
3189
<link id="TWidgetSet.SetViewPortOrgEx"/>
3190
<link id="TWidgetSet.GetViewPortExtEx"/>
3193
<element name="TWidgetSet.GetViewPortOrgEx.Result">
3194
<short>False (zero) on failure.</short>
3196
<element name="TWidgetSet.GetViewPortOrgEx.DC">
3199
<element name="TWidgetSet.GetViewPortOrgEx.P">
3200
<short>Receives the viewport origin.</short>
3202
<!-- function Visibility: public -->
3203
<element name="TWidgetSet.GetWindowExtEx">
3204
<short>Returns the extent of a window, in logical units.</short>
3210
<element name="TWidgetSet.GetWindowExtEx.Result">
3211
<short>False (zero) on failure.</short>
3213
<element name="TWidgetSet.GetWindowExtEx.DC">
3216
<element name="TWidgetSet.GetWindowExtEx.Size">
3217
<short>Receives the window extent.</short>
1953
3219
<!-- function Visibility: public -->
1954
3220
<element name="TWidgetSet.GetWindowLong">
3221
<short>Returns attributes of a window.</short>
3223
<p>The following attributes are defined:
3227
GWL_EXSTYLE - extended window style flags. See CreateWindowEx.
3229
GWL_STYLE - window style flags.
3231
GWL_WNDPROC - the window procedure (address or handle). See CallWindowProc.
3233
GWL_HINSTANCE - handle of the application instance.
3235
GWL_HWNDPARENT - handle of the parent window.
3237
GWL_ID - the identifier of the window.
3239
GWL_USERDATA - user data associated with the window.
3242
<p>The following attributes are also available when the window is a dialog box:
3246
DWL_DLGPROC - the dialog box procedure (address or handle).
3248
DWL_MSGRESULT - the return value of a message processed in the dialog box procedure.
3250
DWL_USER - extra application information.
3254
GWL_USERDATA and DWL_USER are the base offsets of user added attributes.
3255
The second user attribute can be access with an additional offset of 4,
1960
<!-- function result Visibility: default -->
1961
3262
<element name="TWidgetSet.GetWindowLong.Result">
3263
<short>The sttribute.</short>
1964
<!-- argument Visibility: default -->
1965
3265
<element name="TWidgetSet.GetWindowLong.Handle">
3266
<short>The window handle.</short>
1968
<!-- argument Visibility: default -->
1969
3268
<element name="TWidgetSet.GetWindowLong.int">
3269
<short>Offset of the attribute.</short>
1972
3271
<!-- function Visibility: public -->
1973
3272
<element name="TWidgetSet.GetWindowRect">
3273
<short>Retrieves the bounding rectangle of a window, in screen coordinates.
1979
<!-- function result Visibility: default -->
1980
3279
<element name="TWidgetSet.GetWindowRect.Result">
3280
<short>Zero on failure.</short>
1983
<!-- argument Visibility: default -->
1984
3282
<element name="TWidgetSet.GetWindowRect.Handle">
3283
<short>The window handle.</short>
1987
<!-- argument Visibility: default -->
1988
3285
<element name="TWidgetSet.GetWindowRect.Rect">
3286
<short>Receives the window bounds.</short>
1991
3288
<!-- function Visibility: public -->
1992
3289
<element name="TWidgetSet.GetWindowSize">
3290
<short>Returns the Width and Height of the window.</short>
3291
<descr>The size is the client width and height for forms or the total size for sub-controls</descr>
1998
<!-- function result Visibility: default -->
1999
3294
<element name="TWidgetSet.GetWindowSize.Result">
3295
<short>False on failure.</short>
2002
<!-- argument Visibility: default -->
2003
3297
<element name="TWidgetSet.GetWindowSize.Handle">
3298
<short>The window handle.</short>
2006
<!-- argument Visibility: default -->
2007
3300
<element name="TWidgetSet.GetWindowSize.Width">
3301
<short>The width.</short>
2010
<!-- argument Visibility: default -->
2011
3303
<element name="TWidgetSet.GetWindowSize.Height">
3304
<short>The height.</short>
2014
3306
<!-- function Visibility: public -->
2015
3307
<element name="TWidgetSet.GetWindowOrgEx">
3308
<short>Retrieves the window origin of an device context, in logical units.</short>
3311
<link id="TWidgetSet.SetWindowOrgEx"/>
3312
<link id="TWidgetSet.GetViewPortOrgEx"/>
2021
<!-- function result Visibility: default -->
2022
3315
<element name="TWidgetSet.GetWindowOrgEx.Result">
3316
<short>Zero on failure.</short>
2025
<!-- argument Visibility: default -->
2026
3318
<element name="TWidgetSet.GetWindowOrgEx.dc">
3319
<short>The device context</short>
2029
<!-- argument Visibility: default -->
2030
3321
<element name="TWidgetSet.GetWindowOrgEx.P">
3322
<short>Receives the origin.</short>
2033
3324
<!-- function Visibility: public -->
2034
3325
<element name="TWidgetSet.GradientFill">
3326
<short>Fills rectangle or triangle areas with gradient colors.</short>
2040
<!-- function result Visibility: default -->
2041
3331
<element name="TWidgetSet.GradientFill.Result">
3332
<short>False on failure</short>
2044
<!-- argument Visibility: default -->
2045
3334
<element name="TWidgetSet.GradientFill.DC">
3335
<short>The device context.</short>
2048
<!-- argument Visibility: default -->
2049
3337
<element name="TWidgetSet.GradientFill.Vertices">
2052
<!-- argument Visibility: default -->
2053
3340
<element name="TWidgetSet.GradientFill.NumVertices">
2056
<!-- argument Visibility: default -->
2057
3343
<element name="TWidgetSet.GradientFill.Meshes">
2060
<!-- argument Visibility: default -->
2061
3346
<element name="TWidgetSet.GradientFill.NumMeshes">
2064
<!-- argument Visibility: default -->
2065
3349
<element name="TWidgetSet.GradientFill.Mode">
3350
<short>E.g. GRADIENT_FILL_RECT_H.</short>
2068
3352
<!-- function Visibility: public -->
2069
3353
<element name="TWidgetSet.HideCaret">
3354
<short>Removes the caret from the screen.</short>
3355
<descr>Calls are cumulative,
3356
for every HideCaret a call to ShowCaret is required.
2075
<!-- function result Visibility: default -->
2076
3360
<element name="TWidgetSet.HideCaret.Result">
3361
<short>False on failure</short>
2079
<!-- argument Visibility: default -->
2080
3363
<element name="TWidgetSet.HideCaret.hWnd">
3364
<short>The window handle, can be zero.</short>
2083
3366
<!-- procedure Visibility: public -->
2084
3367
<element name="TWidgetSet.InitializeCriticalSection">
3368
<short>Initializes a Critical Section object.</short>
3371
Critical sections are thread synchronization elements,
3372
typically used to prevent concurrent access to a shared resource.
3374
Only one thread can own a critical section at the same time,
3375
other requests (to enter the same critical section)
3376
are delayed until the owner has left the critical section.
3378
The TCriticalSection type is platform specific,
3379
treat it like a Handle.
3383
<link id="TWidgetSet.EnterCriticalSection"/>
3384
<link id="TWidgetSet.TryEnterCriticalSection"/>
3385
<link id="TWidgetSet.LeaveCriticalSection"/>
3386
<link id="TWidgetSet.DeleteCriticalSection"/>
2090
<!-- argument Visibility: default -->
2091
3389
<element name="TWidgetSet.InitializeCriticalSection.CritSection">
3390
<short>The critical section object.</short>
2094
3392
<!-- function Visibility: public -->
2095
3393
<element name="TWidgetSet.IntersectClipRect">
3395
Shrinks the clipping region of an Device Context
3396
to a rectangular boundary, e.g. a text area.
3400
Use this method before painting into a rectangle in an DC,
3401
to clip everything outside the rectangle
3402
<b>and</b> outside the current clipping region of the DC.
3404
The result can be one of the following constants:<br/>
2101
<!-- function result Visibility: default -->
2102
3414
<element name="TWidgetSet.IntersectClipRect.Result">
3415
<short>The region type, zero on failure.</short>
2105
<!-- argument Visibility: default -->
2106
3417
<element name="TWidgetSet.IntersectClipRect.dc">
2109
<!-- argument Visibility: default -->
2110
3420
<element name="TWidgetSet.IntersectClipRect.Left">
2113
<!-- argument Visibility: default -->
2114
3423
<element name="TWidgetSet.IntersectClipRect.Top">
2117
<!-- argument Visibility: default -->
2118
3426
<element name="TWidgetSet.IntersectClipRect.Right">
2121
<!-- argument Visibility: default -->
2122
3429
<element name="TWidgetSet.IntersectClipRect.Bottom">
2125
3432
<!-- function Visibility: public -->
2126
3433
<element name="TWidgetSet.InvalidateRect">
3434
<short>Marks a display area for repaint.</short>
3438
<link id="TWidgetSet.InvalidateRgn"/>
2132
<!-- function result Visibility: default -->
2133
3441
<element name="TWidgetSet.InvalidateRect.Result">
3442
<short>False on failure.</short>
2136
<!-- argument Visibility: default -->
2137
3444
<element name="TWidgetSet.InvalidateRect.aHandle">
3445
<short>The window handle.</short>
2140
<!-- argument Visibility: default -->
2141
3447
<element name="TWidgetSet.InvalidateRect.ARect">
3448
<short>The client coordinates of the area.</short>
2144
<!-- argument Visibility: default -->
2145
3450
<element name="TWidgetSet.InvalidateRect.bErase">
3451
<short>True forces a repaint of the background, before further painting.</short>
3453
<!-- function Visibility: public -->
3454
<element name="TWidgetSet.InvalidateRgn">
3455
<short>Marks a display area for repaint.</short>
3459
<link id="TWidgetSet.InvalidateRect"/>
3462
<element name="TWidgetSet.InvalidateRgn.Result">
3463
<short>False on failure.</short>
3465
<element name="TWidgetSet.InvalidateRgn.Handle">
3466
<short>The window handle.</short>
3468
<element name="TWidgetSet.InvalidateRgn.Rgn">
3469
<short>The region to repaint.</short>
3471
<element name="TWidgetSet.InvalidateRgn.Erase">
3472
<short>True forces a repaint of the background, before further painting.</short>
2148
3474
<!-- function Visibility: public -->
2149
3475
<element name="TWidgetSet.IsDBCSLeadByte">
2155
<!-- function result Visibility: default -->
2156
3481
<element name="TWidgetSet.IsDBCSLeadByte.Result">
3482
<short>True when the character code is the first of a double-byte character sequence</short>
2159
<!-- argument Visibility: default -->
2160
3484
<element name="TWidgetSet.IsDBCSLeadByte.TestChar">
3485
<short>The character code to test.</short>
3487
<!-- function Visibility: public -->
3488
<element name="TWidgetSet.IsIconic">
3489
<short>True when the window is minimized.</short>
3497
<element name="TWidgetSet.IsIconic.Result">
3498
<short>True when the window is minimized.</short>
3500
<element name="TWidgetSet.IsIconic.handle">
3501
<short>The window handle.</short>
3503
<!-- function Visibility: public -->
3504
<element name="TWidgetSet.IsWindow">
3505
<short>Checks whether a handle refers to a window.</short>
3511
<element name="TWidgetSet.IsWindow.Result">
3512
<short>True when handle is a valid window handle.</short>
3514
<element name="TWidgetSet.IsWindow.handle">
3515
<short>The handle to test.</short>
3517
<!-- function Visibility: public -->
3518
<element name="TWidgetSet.IsWindowEnabled">
3519
<short>Determines whether a window can receive mouse and keyboard input.
3526
<element name="TWidgetSet.IsWindowEnabled.Result">
3527
<short>True when the window is enabled (and visible).</short>
3529
<element name="TWidgetSet.IsWindowEnabled.handle">
3530
<short>The window handle.</short>
2163
3532
<!-- function Visibility: public -->
2164
3533
<element name="TWidgetSet.IsWindowVisible">
3534
<short>The definite Visible state of a window.</short>
2170
<!-- function result Visibility: default -->
2171
3539
<element name="TWidgetSet.IsWindowVisible.Result">
3540
<short>True when the window and all its parents are visible.</short>
2174
<!-- argument Visibility: default -->
2175
3542
<element name="TWidgetSet.IsWindowVisible.handle">
3545
<!-- function Visibility: public -->
3546
<element name="TWidgetSet.IsZoomed">
3547
<short>True when the window is maximized.</short>
3551
<link id="TWidgetSet.IsIconic"/>
3554
<element name="TWidgetSet.IsZoomed.Result">
3555
<short>True when the window is maximized.</short>
3557
<element name="TWidgetSet.IsZoomed.handle">
3558
<short>The window handle.</short>
2178
3560
<!-- procedure Visibility: public -->
2179
3561
<element name="TWidgetSet.LeaveCriticalSection">
3562
<short>Releases a critical section, for use by other threads.</short>
3566
<link id="TWidgetSet.InitializeCriticalSection"/>
2185
<!-- argument Visibility: default -->
2186
3569
<element name="TWidgetSet.LeaveCriticalSection.CritSection">
3570
<short>The critical section object.</short>
2189
3572
<!-- function Visibility: public -->
2190
3573
<element name="TWidgetSet.LineTo">
3574
<short>Draws a line from the current position up to, but not including, the specified point.</short>
3575
<descr>The current position is set to the given endpoint.
2196
<!-- function result Visibility: default -->
2197
3580
<element name="TWidgetSet.LineTo.Result">
3581
<short>False on failure.</short>
2200
<!-- argument Visibility: default -->
2201
3583
<element name="TWidgetSet.LineTo.DC">
3584
<short>The device context.</short>
2204
<!-- argument Visibility: default -->
2205
3586
<element name="TWidgetSet.LineTo.X">
3587
<short>The endpoint in logical units.</short>
2208
<!-- argument Visibility: default -->
2209
3589
<element name="TWidgetSet.LineTo.Y">
3590
<short>The endpoint in logical units.</short>
3592
<!-- function Visibility: public -->
3593
<element name="TWidgetSet.LPtoDP">
3594
<short>Converts logical coordinates into device coordinates.</short>
3600
<element name="TWidgetSet.LPtoDP.Result">
3601
<short>False on failure.</short>
3603
<element name="TWidgetSet.LPtoDP.DC">
3604
<short>The device context.</short>
3606
<element name="TWidgetSet.LPtoDP.Points">
3607
<short>Holds and receives the transformed coordinates.</short>
3609
<element name="TWidgetSet.LPtoDP.Count">
3610
<short>The number of points in Points.</short>
2212
3612
<!-- function Visibility: public -->
2213
3613
<element name="TWidgetSet.MaskBlt">
3614
<short>Copies part of an source DC into an destination DC,
3615
using the specified foreground and background raster operations.
3619
MaskBlt behaves like BitBlt when no mask bitmap is specified.
3620
It does a SRCOPY operation when also no Rop is specified.
3621
See BitBlt for general information about raster operations.
3623
Rop contains both a foreground and a background raster operation
3625
When a (monochrome) mask bitmap is present, its bits select
3626
either the foreground (1) or background (0) raster operation.
3631
<link id="TWidgetSet.BitBlt"/>
3632
<link id="TWidgetSet.StretchBlt"/>
3633
<link id="#lcl.LCLIntf.MakeROP4"/>
2219
<!-- function result Visibility: default -->
2220
3636
<element name="TWidgetSet.MaskBlt.Result">
3637
<short>False on failure.</short>
2223
<!-- argument Visibility: default -->
2224
3639
<element name="TWidgetSet.MaskBlt.DestDC">
3640
<short>The destination device context.</short>
2227
<!-- argument Visibility: default -->
2228
3642
<element name="TWidgetSet.MaskBlt.X">
3643
<short>The origin of the destination rectangle.</short>
2231
<!-- argument Visibility: default -->
2232
3645
<element name="TWidgetSet.MaskBlt.Y">
3646
<short>The origin of the destination rectangle.</short>
2235
<!-- argument Visibility: default -->
2236
3648
<element name="TWidgetSet.MaskBlt.Width">
3649
<short>The size of the destination rectangle.</short>
2239
<!-- argument Visibility: default -->
2240
3651
<element name="TWidgetSet.MaskBlt.Height">
3652
<short>The size of the destination rectangle.</short>
2243
<!-- argument Visibility: default -->
2244
3654
<element name="TWidgetSet.MaskBlt.SrcDC">
3655
<short>The source device context.</short>
2247
<!-- argument Visibility: default -->
2248
3657
<element name="TWidgetSet.MaskBlt.XSrc">
3658
<short>The origin of the source rectangle.</short>
2251
<!-- argument Visibility: default -->
2252
3660
<element name="TWidgetSet.MaskBlt.YSrc">
3661
<short>The origin of the source rectangle.</short>
2255
<!-- argument Visibility: default -->
2256
3663
<element name="TWidgetSet.MaskBlt.Mask">
3664
<short>The monochrome mask bitmap handle, can be zero.</short>
2259
<!-- argument Visibility: default -->
2260
3666
<element name="TWidgetSet.MaskBlt.XMask">
3667
<short>The origin of the mask rectangle.</short>
2263
<!-- argument Visibility: default -->
2264
3669
<element name="TWidgetSet.MaskBlt.YMask">
3670
<short>The origin of the mask rectangle.</short>
2267
<!-- argument Visibility: default -->
2268
3672
<element name="TWidgetSet.MaskBlt.Rop">
2271
<!-- function Visibility: public -->
2272
<element name="TWidgetSet.MaskBlt">
2278
<!-- function result Visibility: default -->
2279
<element name="TWidgetSet.MaskBlt.Result">
2282
<!-- argument Visibility: default -->
2283
<element name="TWidgetSet.MaskBlt.DestDC">
2286
<!-- argument Visibility: default -->
2287
<element name="TWidgetSet.MaskBlt.X">
2290
<!-- argument Visibility: default -->
2291
<element name="TWidgetSet.MaskBlt.Y">
2294
<!-- argument Visibility: default -->
2295
<element name="TWidgetSet.MaskBlt.Width">
2298
<!-- argument Visibility: default -->
2299
<element name="TWidgetSet.MaskBlt.Height">
2302
<!-- argument Visibility: default -->
2303
<element name="TWidgetSet.MaskBlt.SrcDC">
2306
<!-- argument Visibility: default -->
2307
<element name="TWidgetSet.MaskBlt.XSrc">
2310
<!-- argument Visibility: default -->
2311
<element name="TWidgetSet.MaskBlt.YSrc">
2314
<!-- argument Visibility: default -->
2315
<element name="TWidgetSet.MaskBlt.Mask">
2318
<!-- argument Visibility: default -->
2319
<element name="TWidgetSet.MaskBlt.XMask">
2322
<!-- argument Visibility: default -->
2323
<element name="TWidgetSet.MaskBlt.YMask">
3673
<short>The raster operations (optional).</short>
2326
3675
<!-- function Visibility: public -->
2327
3676
<element name="TWidgetSet.MessageBox">
3677
<short>The MessageBox function displays an modal dialog,
3678
with the given text, caption, icon and buttons.
3682
uType is a combination of flags from the following lists.
3684
The shown buttons are selected by one of:
3688
MB_ABORTRETRYIGNORE - Abort, Retry, and Ignore.
3690
MB_CANCELTRYCONTINUE - Cancel, Try Again, Continue.
3691
Use this message box type instead of MB_ABORTRETRYIGNORE.
3695
MB_OKCANCEL - OK and Cancel.
3697
MB_RETRYCANCEL - Retry and Cancel.
3699
MB_YESNO - Yes and No.
3701
MB_YESNOCANCEL - Yes, No, and Cancel.
3705
Add MB_HELP for an Help button.
3706
When the user clicks the Help button or presses F1,
3707
the owner window receives a WM_HELP message.
3709
An icon can be added by one of:
3714
MB_ICONWARNING - exclamation-point icon
3717
MB_ICONASTERISK - letter i in a circle
3719
MB_ICONQUESTION - question-mark icon
3723
MB_ICONHAND - stop-sign icon
3727
The default button number, activated when the user presses Enter,
3728
can be indicated by one of:<br/>
3735
Further Windows MessageBox specific options
3736
are not (yet) implemented on other platforms.
3738
The function result corresponds to the pressed button:<br/>
2333
<!-- function result Visibility: default -->
2334
3752
<element name="TWidgetSet.MessageBox.Result">
3753
<short>The pressed button, or zero on failure.</short>
2337
<!-- argument Visibility: default -->
2338
3755
<element name="TWidgetSet.MessageBox.hWnd">
3756
<short>The handle of the window that owns the MessageBox.</short>
2341
<!-- argument Visibility: default -->
2342
3758
<element name="TWidgetSet.MessageBox.lpText">
3759
<short>The text displayed in the MessageBox.</short>
2345
<!-- argument Visibility: default -->
2346
3761
<element name="TWidgetSet.MessageBox.lpCaption">
3762
<short>The caption of the MessageBox.</short>
2349
<!-- argument Visibility: default -->
2350
3764
<element name="TWidgetSet.MessageBox.uType">
3765
<short>Style flags specifiying the shown buttons etc.</short>
3767
<!-- function Visibility: public -->
3768
<element name="TWidgetSet.MonitorFromPoint">
3769
<short>Finds an monitor from screen coordinates.</short>
3775
<element name="TWidgetSet.MonitorFromPoint.Result">
3776
<short><p>The monitor handle.</p>
3777
<p>When no monitor applies, <var>dwFlags</var> determines the result:</p>
3780
MONITOR_DEFAULTTONEAREST - the nearest monitor.
3783
MONITOR_DEFAULTTONULL - zero.
3786
MONITOR_DEFAULTTOPRIMARY - the primary monitor.
3791
<element name="TWidgetSet.MonitorFromPoint.ptScreenCoords">
3792
<short>The point in screen coordinates.</short>
3794
<element name="TWidgetSet.MonitorFromPoint.dwFlags">
3795
<short>How coordinates outside any monitor are handled,
3796
see <link id="TWidgetSet.MonitorFromPoint.Result">MonitorFromPoint.Result</link>.
3799
<!-- function Visibility: public -->
3800
<element name="TWidgetSet.MonitorFromRect" link="TWidgetSet.MonitorFromPoint">
3801
<short>Finds the monitor covering most of a rectangle.</short>
3807
<element name="TWidgetSet.MonitorFromRect.Result">
3808
<short>The monitor handle,
3809
see <link id="TWidgetSet.MonitorFromPoint.Result"> dwFlags</link>.
3812
<element name="TWidgetSet.MonitorFromRect.lprcScreenCoords">
3813
<short>The logical screen coordinates.</short>
3815
<element name="TWidgetSet.MonitorFromRect.dwFlags">
3816
<short>How coordinates outside any monitor are handled,
3817
see <link id="TWidgetSet.MonitorFromPoint.Result">MonitorFromPoint.Result</link>.
3820
<!-- function Visibility: public -->
3821
<element name="TWidgetSet.MonitorFromWindow">
3822
<short>Finds the monitor covering most of a window.</short>
3828
<element name="TWidgetSet.MonitorFromWindow.Result">
3829
<short>The monitor handle,
3830
see <link id="TWidgetSet.MonitorFromPoint.Result">MonitorFromPoint.Result</link>.
3833
<element name="TWidgetSet.MonitorFromWindow.hWnd">
3834
<short>The window handle.</short>
3836
<element name="TWidgetSet.MonitorFromWindow.dwFlags">
3837
<short>How coordinates outside any monitor are handled,
3838
see <link id="TWidgetSet.MonitorFromPoint.Result">MonitorFromPoint.Result</link>.
2353
3841
<!-- function Visibility: public -->
2354
3842
<element name="TWidgetSet.MoveToEx">
3843
<short>Moves the current position to the specified point.</short>
2360
<!-- function result Visibility: default -->
2361
3847
<element name="TWidgetSet.MoveToEx.Result">
3848
<short>False on failure.</short>
2364
<!-- argument Visibility: default -->
2365
3850
<element name="TWidgetSet.MoveToEx.DC">
3851
<short>The device context.</short>
2368
<!-- argument Visibility: default -->
2369
3853
<element name="TWidgetSet.MoveToEx.X">
3854
<short>The new logical position.</short>
2372
<!-- argument Visibility: default -->
2373
3856
<element name="TWidgetSet.MoveToEx.Y">
3857
<short>The new logical position.</short>
2376
<!-- argument Visibility: default -->
2377
3859
<element name="TWidgetSet.MoveToEx.OldPoint">
3860
<short>Receives the old position, can be Nil if not required.</short>
3862
<!-- function Visibility: public -->
3863
<element name="TWidgetSet.OffsetRgn">
3864
<short>Moves a region relative.</short>
3870
<element name="TWidgetSet.OffsetRgn.Result">
3871
<short>The new region kind, zero on failure.</short>
3873
<element name="TWidgetSet.OffsetRgn.RGN">
3874
<short>The Region to move.</short>
3876
<element name="TWidgetSet.OffsetRgn.nXOffset">
3877
<short>The relative distance to move.</short>
3879
<element name="TWidgetSet.OffsetRgn.nYOffset">
3880
<short>The relative distance to move.</short>
2380
3882
<!-- function Visibility: public -->
2381
3883
<element name="TWidgetSet.PeekMessage">
3884
<short>Checks the thread's message queue for a message.</short>
2387
<!-- function result Visibility: default -->
2388
3888
<element name="TWidgetSet.PeekMessage.Result">
2391
<!-- argument Visibility: default -->
2392
3891
<element name="TWidgetSet.PeekMessage.lpMsg">
3892
<short>Receives the message.</short>
2395
<!-- argument Visibility: default -->
2396
3894
<element name="TWidgetSet.PeekMessage.Handle">
3895
<short>The target window handle of the message.
3896
Zero for any window, INVALID_HANDLE_VALUE for thread messages.
2399
<!-- argument Visibility: default -->
2400
3899
<element name="TWidgetSet.PeekMessage.wMsgFilterMin">
3900
<short>The lowest message ID to retrieve.</short>
2403
<!-- argument Visibility: default -->
2404
3902
<element name="TWidgetSet.PeekMessage.wMsgFilterMax">
3903
<short>The highest message ID to retrieve, zero for all messages.</short>
2407
<!-- argument Visibility: default -->
2408
3905
<element name="TWidgetSet.PeekMessage.wRemoveMsg">
3906
<short>PM_REMOVE will remove the message from the queue.</short>
2411
3908
<!-- function Visibility: public -->
2412
3909
<element name="TWidgetSet.Pie">
3910
<short>Draws a filled pie-shaped wedge, from an ellipse and two radials.
3914
The ellipse is bounded by a rectangle x1..y2.
3916
Each radial is defined by the center of the rectangle an point,
3917
which must not necessarily reside on the ellipse.
3919
The bounding arc goes counter-clockwise from the Start to the End radial.
3921
The pie is outlined with the current pen and filled with the current brush.
3926
<link id="TWidgetSet.Chord"/>
2418
<!-- function result Visibility: default -->
2419
3929
<element name="TWidgetSet.Pie.Result">
3930
<short>False on failure.</short>
2422
<!-- argument Visibility: default -->
2423
3932
<element name="TWidgetSet.Pie.DC">
2426
<!-- argument Visibility: default -->
2427
<element name="TWidgetSet.Pie.EllipseX1">
2430
<!-- argument Visibility: default -->
2431
<element name="TWidgetSet.Pie.EllipseY1">
2434
<!-- argument Visibility: default -->
2435
<element name="TWidgetSet.Pie.EllipseX2">
2438
<!-- argument Visibility: default -->
2439
<element name="TWidgetSet.Pie.EllipseY2">
2442
<!-- argument Visibility: default -->
2443
<element name="TWidgetSet.Pie.StartX">
2446
<!-- argument Visibility: default -->
2447
<element name="TWidgetSet.Pie.StartY">
2450
<!-- argument Visibility: default -->
2451
<element name="TWidgetSet.Pie.EndX">
2454
<!-- argument Visibility: default -->
2455
<element name="TWidgetSet.Pie.EndY">
3933
<short>The device context.</short>
3935
<element name="TWidgetSet.Pie.x1">
3936
<short>The bounding rectangle.</short>
3938
<element name="TWidgetSet.Pie.y1">
3941
<element name="TWidgetSet.Pie.x2">
3944
<element name="TWidgetSet.Pie.y2">
3947
<element name="TWidgetSet.Pie.sx">
3948
<short>The starting radial.</short>
3950
<element name="TWidgetSet.Pie.sy">
3953
<element name="TWidgetSet.Pie.ex">
3954
<short>The ending radial.</short>
3956
<element name="TWidgetSet.Pie.ey">
2458
3959
<!-- function Visibility: public -->
2459
3960
<element name="TWidgetSet.PolyBezier">
3961
<short>Draws Bézier curves.</short>
3964
Use Polybezier to draw cubic Bézier curves.
3966
The first curve is drawn from the first point to the fourth point
3967
with the second and third points being the control points.
3969
If the Continuous flag is TRUE then each subsequent curve
3970
requires three more points, using the end-point of the previous Curve
3971
as its starting point.
3973
If the Continous flag is set to FALSE, then each subsequent Curve
3974
requires 4 additional points, which are used exactly as in the first curve.
3976
Any additonal points which do not add up to a full
3977
bezier (4 for Continuous, 3 otherwise) are ignored.
3978
There must be at least 4 points for an drawing to occur.
3980
If the Filled Flag is TRUE then the resulting Poly-Bézier
3981
will be drawn as a Polygon.
2465
<!-- function result Visibility: default -->
2466
3987
<element name="TWidgetSet.PolyBezier.Result">
3988
<short>False on failure.</short>
2469
<!-- argument Visibility: default -->
2470
3990
<element name="TWidgetSet.PolyBezier.DC">
3991
<short>The device context.</short>
2473
<!-- argument Visibility: default -->
2474
3993
<element name="TWidgetSet.PolyBezier.Points">
3994
<short>The array of points.</short>
2477
<!-- argument Visibility: default -->
2478
3996
<element name="TWidgetSet.PolyBezier.NumPts">
3997
<short>The number of points in Points.</short>
2481
<!-- argument Visibility: default -->
2482
3999
<element name="TWidgetSet.PolyBezier.Filled">
4000
<short>True draws a Polygon.</short>
2485
<!-- argument Visibility: default -->
2486
4002
<element name="TWidgetSet.PolyBezier.Continuous">
4003
<short>True uses the end-point as the starting point of the next segment.</short>
2489
4005
<!-- function Visibility: public -->
2490
4006
<element name="TWidgetSet.Polygon">
4007
<short>Draws a filled Polygon.</short>
4010
Use Polygon to draw a closed, many-sided shape on the canvas,
4011
outlined with the current Pen and filled with the current Brush.
4013
The Points parameter is an array of the vertices of the polygon.
4015
Winding determines how the polygon is filled.
4016
When Winding is True, Polygon fills the shape using the Winding fill algorithm.
4017
When Winding is False, Polygon uses the even-odd (alternative) fill algorithm.
4019
The first point is always connected to the last point.
4021
To draw an unfilled polygon use the Polyline method,
4022
specifying the first point a second time at the end.
2496
<!-- function result Visibility: default -->
2497
4028
<element name="TWidgetSet.Polygon.Result">
4029
<short>False on failure.</short>
2500
<!-- argument Visibility: default -->
2501
4031
<element name="TWidgetSet.Polygon.DC">
4032
<short>The device context.</short>
2504
<!-- argument Visibility: default -->
2505
4034
<element name="TWidgetSet.Polygon.Points">
4035
<short>The array of vertices.</short>
2508
<!-- argument Visibility: default -->
2509
4037
<element name="TWidgetSet.Polygon.NumPts">
4038
<short>The number of vertices.</short>
2512
<!-- argument Visibility: default -->
2513
4040
<element name="TWidgetSet.Polygon.Winding">
4041
<short>Selects the fill algorithm.</short>
2516
4043
<!-- function Visibility: public -->
2517
4044
<element name="TWidgetSet.Polyline">
4045
<short>Draws a sequence of lines.</short>
4048
Use Polyline to connect a set of points on the canvas.
4050
The Points parameter is an array of points to be connected.
4052
If you specify only two points, Polyline draws a single line.
4054
Calling the MoveTo function with the value of the first point,
4055
and then repeatedly calling LineTo with all subsequent points
4056
will draw the same image on the canvas.
4057
However, unlike LineTo, Polyline does not change the value of PenPos.
2523
<!-- function result Visibility: default -->
2524
4063
<element name="TWidgetSet.Polyline.Result">
2527
<!-- argument Visibility: default -->
2528
4066
<element name="TWidgetSet.Polyline.DC">
2531
<!-- argument Visibility: default -->
2532
4069
<element name="TWidgetSet.Polyline.Points">
2535
<!-- argument Visibility: default -->
2536
4072
<element name="TWidgetSet.Polyline.NumPts">
2539
4075
<!-- function Visibility: public -->
2540
4076
<element name="TWidgetSet.PostMessage">
4077
<short>Sends a message to a window, without waiting for the message result.
4081
This section was copied from LCLIntf, and may not apply to all platforms.
4084
This method is a thread-safe solution to send messages to windows.
4085
Those messages will be handled in the message loop of the application
4086
and therefore can be sent from any thread.
4087
They are not immediate, but they will awake the main thread if it
4088
is waiting for messages.
4090
These messages can be handled by procedures with the keyword message
4091
in the class of a form for example.
4092
One would then use the handle of this form as the Handle parameter
4095
Custom messages should always have an identification number
4096
(represented by the parameter Msg) larger then the constant LM_USER.
4098
The two parameters WParam and LParam will be passed along to the
4099
window together with the Msg identification number.
4101
The difference between SendMessage and PostMessage is the way that
4102
they return control to the calling thread.
4103
With SendMessage control is not returned until the window that the
4104
message was sent to has completed processing the sent message,
4105
however with PostMessage control is returned immediately.
4110
<link id="TWidgetSet.SendMessage"/>
2546
<!-- function result Visibility: default -->
2547
4113
<element name="TWidgetSet.PostMessage.Result">
4114
<short>Zero on failure.</short>
2550
<!-- argument Visibility: default -->
2551
4116
<element name="TWidgetSet.PostMessage.Handle">
4117
<short>The target window handle.</short>
2554
<!-- argument Visibility: default -->
2555
4119
<element name="TWidgetSet.PostMessage.Msg">
4120
<short>The message ID.</short>
2558
<!-- argument Visibility: default -->
2559
4122
<element name="TWidgetSet.PostMessage.WParam">
2562
<!-- argument Visibility: default -->
2563
4125
<element name="TWidgetSet.PostMessage.LParam">
2566
4128
<!-- function Visibility: public -->
2567
4129
<element name="TWidgetSet.PtInRegion">
4130
<short>Tests whether a point lies in a region.</short>
2573
<!-- function result Visibility: default -->
2574
4135
<element name="TWidgetSet.PtInRegion.Result">
4136
<short>True when the point lies in the region.</short>
2577
<!-- argument Visibility: default -->
2578
4138
<element name="TWidgetSet.PtInRegion.RGN">
4139
<short>The region.</short>
2581
<!-- argument Visibility: default -->
2582
4141
<element name="TWidgetSet.PtInRegion.X">
4142
<short>The point coordinate.</short>
2585
<!-- argument Visibility: default -->
2586
4144
<element name="TWidgetSet.PtInRegion.Y">
4145
<short>The point coordinate.</short>
2589
4147
<!-- function Visibility: public -->
2590
4148
<element name="TWidgetSet.RealizePalette">
4149
<short>Maps palette entries from the current logical palette to the system palette.</short>
2596
<!-- function result Visibility: default -->
2597
4154
<element name="TWidgetSet.RealizePalette.Result">
4155
<short>The number of mapped entries.</short>
2600
<!-- argument Visibility: default -->
2601
4157
<element name="TWidgetSet.RealizePalette.DC">
4158
<short>The device context.</short>
2604
4160
<!-- function Visibility: public -->
2605
4161
<element name="TWidgetSet.Rectangle">
4162
<short>Draws a filled rectangle.</short>
4164
The rectangle is outlined with the current Pen, and filled with the current Brush.
4166
The bottom and right edges are not part of the rectangle.
2611
<!-- function result Visibility: default -->
2612
4171
<element name="TWidgetSet.Rectangle.Result">
4172
<short>False on failure.</short>
2615
<!-- argument Visibility: default -->
2616
4174
<element name="TWidgetSet.Rectangle.DC">
4175
<short>The device context.</short>
2619
<!-- argument Visibility: default -->
2620
4177
<element name="TWidgetSet.Rectangle.X1">
2623
<!-- argument Visibility: default -->
2624
4180
<element name="TWidgetSet.Rectangle.Y1">
2627
<!-- argument Visibility: default -->
2628
4183
<element name="TWidgetSet.Rectangle.X2">
2631
<!-- argument Visibility: default -->
2632
4186
<element name="TWidgetSet.Rectangle.Y2">
2635
4189
<!-- function Visibility: public -->
2636
4190
<element name="TWidgetSet.RectVisible">
4191
<short>Checks whether the clipping region contains (part of) a rectangle.</short>
2642
<!-- function result Visibility: default -->
2643
4195
<element name="TWidgetSet.RectVisible.Result">
4196
<short>True when (part of) the rectangle is visible.</short>
2646
<!-- argument Visibility: default -->
2647
4198
<element name="TWidgetSet.RectVisible.dc">
4199
<short>The device context.</short>
2650
<!-- argument Visibility: default -->
2651
4201
<element name="TWidgetSet.RectVisible.ARect">
4202
<short>The rectangle.</short>
4204
<!-- function Visibility: public -->
4205
<element name="TWidgetSet.RedrawWindow">
4206
<short>Redraws (part of) a window.</short>
4209
All invalidated parts of a window, which deserve an update,
4210
are collected in the update region.
4211
When this region is not empty, WM_ERASEBKGND, WM_PAINT and WM_NCPAINT messages
4212
are sent to the window, as soon as the application is (almost) idle.
4213
RedrawWindow can be used to force an immediate redraw instead.
4215
WM_ERASEBKGND is optional, erases the background before painting.
4216
WM_NCPAINT paints the non-client areas (borders, caption...),
4217
without assistance by user code.
4219
When neither lprcUpdate nor hrgnUpdate are specified,
4220
the whole client area of the window is affected.
4221
Otherwise the region takes precedence over the rectangle.
4223
Flags specify how the window is invalidated or validated,
4224
and when repainting occurs.
4225
Flags other than RDW_ERASE may not be supported by all platforms.
4227
To invalidate specify RDW_INVALIDATE, and optionally one of:
4231
RDW_ERASE - forces a WM_ERASEBKGND message before painting.
4233
RDW_FRAME - also redraws the window frame, as covered by the update region.
4235
RDW_INTERNALPAINT - force WM_PAINT even if the update region is empty.
4240
Validation is not implemented for all platforms.
4241
To validate specify RDW_VALIDATE, and optionally one of:
4245
RDW_NOERASE - suppress all pending WM_ERASEBKGND messages.
4247
RDW_NOFRAME - suppress all pending WM_NCPAINT messages.
4249
RDW_NOINTERNALPAINT - suppress all pending internal WM_PAINT messages.
4253
These flags specify <b>when</b> repainting will occur:
4257
RDW_ERASENOW - send WM_ERASEBKGND messages before returning.
4259
RDW_UPDATENOW - send WM_PAINT messages before returning.
4263
The handling of child windows normally depends on the
4264
WS_CLIPCHILDREN window style flag.
4265
Clipped child windows are not normally affected by RedrawWindow.
4266
These flags override:
4270
RDW_ALLCHILDREN - include all child windows.
4272
RDW_NOCHILDREN - exclude all child windows.
4279
<link id="TWidgetSet.InvalidateRect"/>
4280
<link id="TWidgetSet.InvalidateRgn"/>
4283
<element name="TWidgetSet.RedrawWindow.Result">
4284
<short>False on failure.</short>
4286
<element name="TWidgetSet.RedrawWindow.Wnd">
4287
<short>The window to redraw.</short>
4289
<element name="TWidgetSet.RedrawWindow.lprcUpdate">
4290
<short>The rectangle to redraw, ignored when a region is given.</short>
4292
<element name="TWidgetSet.RedrawWindow.hrgnUpdate">
4293
<short>The region to redraw, can be zero.</short>
4295
<element name="TWidgetSet.RedrawWindow.flags">
4296
<short>How the redraw works.</short>
2654
4298
<!-- function Visibility: public -->
2655
4299
<element name="TWidgetSet.ReleaseCapture">
4300
<short>Restores normal mouse input processing,
4301
after <link id="TWidgetSet.SetCapture">SetCapture</link>.
2661
<!-- function result Visibility: default -->
2662
4306
<element name="TWidgetSet.ReleaseCapture.Result">
4307
<short>False on failure.</short>
2665
4309
<!-- function Visibility: public -->
2666
4310
<element name="TWidgetSet.ReleaseDC">
4311
<short>Releases an Device Context obtained by GetDC.</short>
2672
<!-- function result Visibility: default -->
2673
4315
<element name="TWidgetSet.ReleaseDC.Result">
4316
<short>Zero on failure.</short>
2676
<!-- argument Visibility: default -->
2677
4318
<element name="TWidgetSet.ReleaseDC.hWnd">
4319
<short>The handle of the window, whose DC is released.</short>
2680
<!-- argument Visibility: default -->
2681
4321
<element name="TWidgetSet.ReleaseDC.DC">
4322
<short>The device context to release.</short>
4324
<!-- function Visibility: public -->
4325
<element name="TWidgetSet.RemoveProp">
4326
<short>Removes a named property from a window.</short>
4334
<element name="TWidgetSet.RemoveProp.Result">
4335
<short>The handle of the removed data, zero on failure.</short>
4337
<element name="TWidgetSet.RemoveProp.Handle">
4338
<short>The window handle.</short>
4340
<element name="TWidgetSet.RemoveProp.Str">
4341
<short>The name of the property to remove.</short>
2684
4343
<!-- function Visibility: public -->
2685
4344
<element name="TWidgetSet.RestoreDC">
4345
<short>Restores an Device Context (DC) to an previously
4346
<link id="TWidgetSet.SaveDC">saved</link> state.</short>
4350
<link id="TWidgetSet.SaveDC"/>
2691
<!-- function result Visibility: default -->
2692
4353
<element name="TWidgetSet.RestoreDC.Result">
4354
<short>False on failure.</short>
2695
<!-- argument Visibility: default -->
2696
4356
<element name="TWidgetSet.RestoreDC.DC">
4357
<short>The device context.</short>
2699
<!-- argument Visibility: default -->
2700
4359
<element name="TWidgetSet.RestoreDC.SavedDC">
4360
<short>The index returned by SaveDC, or -1 for the most recently saved state.</short>
2703
4362
<!-- function Visibility: public -->
2704
4363
<element name="TWidgetSet.RoundRect">
4364
<short>Draws a filled rectangle with rounded corners.</short>
4365
<descr>The rectangle is outlined with the current Pen, and filled with the current Brush.
2710
<!-- function result Visibility: default -->
2711
4369
<element name="TWidgetSet.RoundRect.Result">
4370
<short>False on failure.</short>
2714
<!-- argument Visibility: default -->
2715
4372
<element name="TWidgetSet.RoundRect.DC">
4373
<short>The device context.</short>
2718
<!-- argument Visibility: default -->
2719
4375
<element name="TWidgetSet.RoundRect.X1">
4376
<short>The rectangle coordinates.</short>
2722
<!-- argument Visibility: default -->
2723
4378
<element name="TWidgetSet.RoundRect.Y1">
2726
<!-- argument Visibility: default -->
2727
4381
<element name="TWidgetSet.RoundRect.X2">
2730
<!-- argument Visibility: default -->
2731
4384
<element name="TWidgetSet.RoundRect.Y2">
2734
<!-- argument Visibility: default -->
2735
4387
<element name="TWidgetSet.RoundRect.RX">
4388
<short>The extent of the ellipse, used for the rounded corners.</short>
2738
<!-- argument Visibility: default -->
2739
4390
<element name="TWidgetSet.RoundRect.RY">
4391
<short>The extent of the ellipse, used for the rounded corners.</short>
2742
4393
<!-- function Visibility: public -->
2743
4394
<element name="TWidgetSet.SaveDC">
4395
<short>Saves the state of an Device Context in the context stack.</short>
4398
<link id="TWidgetSet.RestoreDC"/>
2749
<!-- function result Visibility: default -->
2750
4401
<element name="TWidgetSet.SaveDC.Result">
4402
<short>The index of the saved DC, zero on failure.</short>
2753
<!-- argument Visibility: default -->
2754
4404
<element name="TWidgetSet.SaveDC.DC">
4405
<short>The device context to save.</short>
2757
4407
<!-- function Visibility: public -->
2758
4408
<element name="TWidgetSet.ScreenToClient">
4409
<short>Converts absolute Screen coordinates into Client relative coordinates.
2764
<!-- function result Visibility: default -->
2765
4415
<element name="TWidgetSet.ScreenToClient.Result">
4416
<short>False on failure.</short>
2768
<!-- argument Visibility: default -->
2769
4418
<element name="TWidgetSet.ScreenToClient.Handle">
4419
<short>The handle of the window with the client area.</short>
2772
<!-- argument Visibility: default -->
2773
4421
<element name="TWidgetSet.ScreenToClient.P">
4422
<short>The point to convert.</short>
2776
4424
<!-- function Visibility: public -->
2777
4425
<element name="TWidgetSet.ScrollWindowEx">
4426
<short>Scrolls the content of a window, by a number of pixels.</short>
4428
<p>The following flags are defined:
4432
SW_ERASE - when used with SW_INVALIDATE sends WM_ERASEBKGND messages
4433
for the invalidated parts of the window.
4435
SW_INVALIDATE - invalidates the resulting hrgnUpdate region.
4437
SW_SCROLLCHILDREN - also scrolls child windows within the scroll rect.
4438
Beware: also scrolls <b>parts</b> of the child windows!
4440
SW_SMOOTHSCROLL - set HIWORD of <var>flags</var> to the time for the scrolling operation.
2783
<!-- function result Visibility: default -->
2784
4447
<element name="TWidgetSet.ScrollWindowEx.Result">
4448
<short>False on failure.</short>
2787
<!-- argument Visibility: default -->
2788
4450
<element name="TWidgetSet.ScrollWindowEx.hWnd">
4451
<short>The window handle.</short>
2791
<!-- argument Visibility: default -->
2792
4453
<element name="TWidgetSet.ScrollWindowEx.dx">
4454
<short>Horizontal distance (positive to scroll right)</short>
2795
<!-- argument Visibility: default -->
2796
4456
<element name="TWidgetSet.ScrollWindowEx.dy">
4457
<short>Vertical distance (positive to scroll down)</short>
2799
<!-- argument Visibility: default -->
2800
4459
<element name="TWidgetSet.ScrollWindowEx.prcScroll">
4460
<short>The part of the window, that is to be scrolled. Nil means the entire client area.
2803
<!-- argument Visibility: default -->
2804
4463
<element name="TWidgetSet.ScrollWindowEx.prcClip">
4464
<short>Pixels falling outside this rectangle are lost. Nil means the entire client area.</short>
2807
<!-- argument Visibility: default -->
2808
4466
<element name="TWidgetSet.ScrollWindowEx.hrgnUpdate">
4467
<short>The invalidated parts of the window are added to this region (can be zero).</short>
2811
<!-- argument Visibility: default -->
2812
4469
<element name="TWidgetSet.ScrollWindowEx.prcUpdate">
4470
<short>Receives the boundary of the invalidated part of the window (can be Nil).</short>
2815
<!-- argument Visibility: default -->
2816
4472
<element name="TWidgetSet.ScrollWindowEx.flags">
4473
<short>Control flags.</short>
2819
4475
<!-- function Visibility: public -->
2820
4476
<element name="TWidgetSet.SelectClipRGN">
4477
<short>Sets the ClipRegion of an DeviceContext.
2826
<!-- function result Visibility: default -->
2827
4483
<element name="TWidgetSet.SelectClipRGN.Result">
4484
<short>The region kind.</short>
2830
<!-- argument Visibility: default -->
2831
4486
<element name="TWidgetSet.SelectClipRGN.DC">
4487
<short>The device context.</short>
2834
<!-- argument Visibility: default -->
2835
4489
<element name="TWidgetSet.SelectClipRGN.RGN">
4490
<short>The region to copy, zero for an empty region.</short>
2838
4492
<!-- function Visibility: public -->
2839
4493
<element name="TWidgetSet.SelectObject">
4494
<short>Selects an object into an device context.</short>
2845
<!-- function result Visibility: default -->
2846
4499
<element name="TWidgetSet.SelectObject.Result">
4500
<short>The previously selected object, for a region the new region type.</short>
2849
<!-- argument Visibility: default -->
2850
4502
<element name="TWidgetSet.SelectObject.DC">
4503
<short>The device context.</short>
2853
<!-- argument Visibility: default -->
2854
4505
<element name="TWidgetSet.SelectObject.GDIObj">
4506
<short>The object to select.</short>
2857
4508
<!-- function Visibility: public -->
2858
4509
<element name="TWidgetSet.SelectPalette">
4510
<short>Selects a logical palette into an device context.</short>
4511
<descr>A foreground palette becomes the palette of the device, when the
4512
application is in the foreground.
4513
A background palette instead is mapped to the closest
4514
colors in the palette of the physical device.
2864
<!-- function result Visibility: default -->
2865
4519
<element name="TWidgetSet.SelectPalette.Result">
4520
<short>The handle of the previously selected palette.</short>
2868
<!-- argument Visibility: default -->
2869
4522
<element name="TWidgetSet.SelectPalette.DC">
4523
<short>The device context.</short>
2872
<!-- argument Visibility: default -->
2873
4525
<element name="TWidgetSet.SelectPalette.Palette">
4526
<short>The palette to select.</short>
2876
<!-- argument Visibility: default -->
2877
4528
<element name="TWidgetSet.SelectPalette.ForceBackground">
4529
<short>True to select the background palette.</short>
2880
4531
<!-- function Visibility: public -->
2881
4532
<element name="TWidgetSet.SendMessage">
4533
<short>Sends a message to a window.</short>
4536
This section was copied from LCLIntf, and may not apply to all platforms.
4539
This method is a thread-safe solution to send messages to windows.
4541
The messages will be handled in the message loop of the application
4542
and therefore can be sent from any thread.
4543
They are not immediate, but they will awake the main thread if it
4544
is waiting for messages.
4546
Custom messages should always have an ID higher than the constant LM_USER.
4548
The two parameters WParam and LParam will be passed to the
4549
message handler, together with the message ID.
4551
The difference between SendMessage and PostMessage is the way that
4552
they return control to the calling thread.
4553
With SendMessage control is not returned until the window that the
4554
message was sent to has completed processing the sent message,
4555
however with PostMessage control is returned immediately.
4560
<link id="TWidgetSet.PostMessage"/>
2887
<!-- function result Visibility: default -->
2888
4563
<element name="TWidgetSet.SendMessage.Result">
4564
<short>The result depends on the message type.</short>
2891
<!-- argument Visibility: default -->
2892
4566
<element name="TWidgetSet.SendMessage.HandleWnd">
4567
<short>The handle of the target window.</short>
2895
<!-- argument Visibility: default -->
2896
4569
<element name="TWidgetSet.SendMessage.Msg">
4570
<short>The message ID.</short>
2899
<!-- argument Visibility: default -->
2900
4572
<element name="TWidgetSet.SendMessage.WParam">
4573
<short>Message parameter.</short>
2903
<!-- argument Visibility: default -->
2904
4575
<element name="TWidgetSet.SendMessage.LParam">
4576
<short>Message parameter.</short>
2907
4578
<!-- function Visibility: public -->
2908
4579
<element name="TWidgetSet.SetActiveWindow">
4580
<short>Sets focus to the specified window, if the application is on top.</short>
2914
<!-- function result Visibility: default -->
2915
4585
<element name="TWidgetSet.SetActiveWindow.Result">
4586
<short>The handle of the window that lost the focus, zero on failure.</short>
2918
<!-- argument Visibility: default -->
2919
4588
<element name="TWidgetSet.SetActiveWindow.Handle">
4589
<short>The window handle to activate.</short>
2922
4591
<!-- function Visibility: public -->
2923
4592
<element name="TWidgetSet.SetBkColor">
4593
<short>Sets the current background color of an decice context.</short>
2929
<!-- function result Visibility: default -->
2930
4598
<element name="TWidgetSet.SetBkColor.Result">
4599
<short>The old background color, CLR_INVALID on failure.</short>
2933
<!-- argument Visibility: default -->
2934
4601
<element name="TWidgetSet.SetBkColor.DC">
4602
<short>The device context.</short>
2937
<!-- argument Visibility: default -->
2938
4604
<element name="TWidgetSet.SetBkColor.Color">
4605
<short>The new background color.</short>
2941
4607
<!-- function Visibility: public -->
2942
4608
<element name="TWidgetSet.SetBkMode">
4609
<short>Sets the background mix mode (transparency) of an device context.</short>
4612
The background mode specifies the handling of non-solid painting objects,
4613
like text, hatched brushes or dotted pens.
4617
OPAQUE mode fills the affected painting area with the background color
4618
before painting the foreground.
4620
TRANSPARENT mode leaves the background unchanged.
2948
<!-- function result Visibility: default -->
2949
4627
<element name="TWidgetSet.SetBkMode.Result">
4628
<short>The previous background mode, zero on failure.</short>
2952
<!-- argument Visibility: default -->
2953
4630
<element name="TWidgetSet.SetBkMode.DC">
4631
<short>The device context.</short>
2956
<!-- argument Visibility: default -->
2957
4633
<element name="TWidgetSet.SetBkMode.bkMode">
4634
<short>The new background mode.</short>
2960
4636
<!-- function Visibility: public -->
2961
4637
<element name="TWidgetSet.SetCapture">
4638
<short>Sets the mouse capture to the specified window.</short>
4639
<descr>The window will receive all mouse messages, until capture
4644
<link id="TWidgetSet.ReleaseCapture"/>
2967
<!-- function result Visibility: default -->
2968
4647
<element name="TWidgetSet.SetCapture.Result">
4648
<short>The handle of the previous capture window, zero if none.</short>
2971
<!-- argument Visibility: default -->
2972
<element name="TWidgetSet.SetCapture.Value">
4650
<element name="TWidgetSet.SetCapture.AHandle">
4651
<short>The handle of the capturing window.</short>
2975
4653
<!-- function Visibility: public -->
2976
4654
<element name="TWidgetSet.SetCaretPos">
4655
<short>Moves the Caret to the specified coordinates.</short>
4659
<link id="TWidgetSet.CreateCaret"/>
2982
<!-- function result Visibility: default -->
2983
4662
<element name="TWidgetSet.SetCaretPos.Result">
4663
<short>False on failure.</short>
2986
<!-- argument Visibility: default -->
2987
4665
<element name="TWidgetSet.SetCaretPos.X">
4666
<short>The new caret position.</short>
2990
<!-- argument Visibility: default -->
2991
4668
<element name="TWidgetSet.SetCaretPos.Y">
4669
<short>The new caret position.</short>
2994
4671
<!-- function Visibility: public -->
2995
4672
<element name="TWidgetSet.SetCaretPosEx">
4673
<short>Moves the Caret into a window.</short>
3001
<!-- function result Visibility: default -->
3002
4678
<element name="TWidgetSet.SetCaretPosEx.Result">
4679
<short>False on failure.</short>
3005
<!-- argument Visibility: default -->
3006
4681
<element name="TWidgetSet.SetCaretPosEx.handle">
4682
<short>The window handle.</short>
3009
<!-- argument Visibility: default -->
3010
4684
<element name="TWidgetSet.SetCaretPosEx.X">
4685
<short>The new caret position.</short>
3013
<!-- argument Visibility: default -->
3014
4687
<element name="TWidgetSet.SetCaretPosEx.Y">
4688
<short>The new caret position.</short>
3017
4690
<!-- function Visibility: public -->
3018
4691
<element name="TWidgetSet.SetCursor">
4692
<short>Changes the shape of the mouse cursor.</short>
4695
<link id="#lcl.Controls.TCursor"/>
4696
<link id="TWidgetSet.CreateStandardCursor"/>
3024
<!-- function result Visibility: default -->
3025
4699
<element name="TWidgetSet.SetCursor.Result">
4700
<short>The handle of the previous cursor, zero if none.</short>
3028
<!-- argument Visibility: default -->
3029
4702
<element name="TWidgetSet.SetCursor.hCursor">
4703
<short>The new cursor handle.</short>
4705
<!-- function Visibility: public -->
4706
<element name="TWidgetSet.SetCursorPos">
4707
<short>Changes the position of the mouse cursor.</short>
4713
<element name="TWidgetSet.SetCursorPos.Result">
4714
<short>False on failure.</short>
4716
<element name="TWidgetSet.SetCursorPos.X">
4717
<short>The new screen coordinates.</short>
4719
<element name="TWidgetSet.SetCursorPos.Y">
4720
<short>The new screen coordinates.</short>
3032
4722
<!-- function Visibility: public -->
3033
4723
<element name="TWidgetSet.SetFocus">
4724
<short>Sets the keyboard input focus to the specified window.</short>
3039
<!-- function result Visibility: default -->
3040
4728
<element name="TWidgetSet.SetFocus.Result">
4729
<short>The handle of the previously focused window, zero if none.</short>
3043
<!-- argument Visibility: default -->
3044
4731
<element name="TWidgetSet.SetFocus.hWnd">
4732
<short>The handle of the window receiving the focus.</short>
4734
<!-- function Visibility: public -->
4735
<element name="TWidgetSet.SetForegroundWindow">
4736
<short>Moves a window in front of all other windows, and activates it.
4743
<element name="TWidgetSet.SetForegroundWindow.Result">
4744
<short>False on failure.</short>
4746
<element name="TWidgetSet.SetForegroundWindow.hWnd">
4747
<short>The window handle.</short>
3047
4749
<!-- function Visibility: public -->
3048
4750
<element name="TWidgetSet.SetMapMode">
4751
<short>Sets the mapping mode of an device context.</short>
4754
The mapping mode specifies the correspondence between logical and physical units.
4755
Supported modes are:
4759
MM_ANISOTROPIC - arbitrary mapping
4761
MM_HIENGLISH - 0.001 inch
4763
MM_HIMETRIC - 0.01 mm
4765
MM_ISOTROPIC - arbitrary mapping, same for X and Y axis
4767
MM_LOENGLISH - 0.01 inch
4769
MM_LOMETRIC - 0.1 mm
4771
MM_TEXT - 1 device pixel
4773
MM_TWIPS - 1/20th point (twip, 1/1440 inch)
4777
Positive X is right, except for (an)isotropic mappings.
4778
Positive Y is up, except for (an)isotropic and MM_TEXT mappings.
4782
<link id="TWidgetSet.GetMapMode"/>
3054
<!-- function result Visibility: default -->
3055
4785
<element name="TWidgetSet.SetMapMode.Result">
4786
<short>The old mapping mode.</short>
3058
<!-- argument Visibility: default -->
3059
4788
<element name="TWidgetSet.SetMapMode.DC">
3062
<!-- argument Visibility: default -->
3063
<element name="TWidgetSet.SetMapMode.MapMode">
4789
<short>The device context.</short>
4791
<element name="TWidgetSet.SetMapMode.fnMapMode">
4792
<short>The new mapping mode.</short>
4794
<!-- function Visibility: public -->
4795
<element name="TWidgetSet.SetMenu">
4796
<short>Assigns a menu to a window.</short>
4802
<element name="TWidgetSet.SetMenu.Result">
4803
<short>False on failure.</short>
4805
<element name="TWidgetSet.SetMenu.AWindowHandle">
4806
<short>The window handle.</short>
4808
<element name="TWidgetSet.SetMenu.AMenuHandle">
4809
<short>The menu handle.</short>
4811
<!-- function Visibility: public -->
4812
<element name="TWidgetSet.SetParent">
4813
<short>Changes the parent of a window.</short>
4819
<element name="TWidgetSet.SetParent.Result">
4820
<short>The handle of the previous parent window, zero if none or failure.</short>
4822
<element name="TWidgetSet.SetParent.hWndChild">
4823
<short>The handle of the child window.</short>
4825
<element name="TWidgetSet.SetParent.hWndParent">
4826
<short>The handle of the new parent window, zero for the desktop window.</short>
3066
4828
<!-- function Visibility: public -->
3067
4829
<element name="TWidgetSet.SetProp">
4830
<short>Adds a property to a window.</short>
4833
<link id="TWidgetSet.GetProp"/>
3073
<!-- function result Visibility: default -->
3074
4836
<element name="TWidgetSet.SetProp.Result">
4837
<short>False on failure.</short>
3077
<!-- argument Visibility: default -->
3078
4839
<element name="TWidgetSet.SetProp.Handle">
4840
<short>The window handle.</short>
3081
<!-- argument Visibility: default -->
3082
4842
<element name="TWidgetSet.SetProp.Str">
4843
<short>The property name.</short>
3085
<!-- argument Visibility: default -->
3086
4845
<element name="TWidgetSet.SetProp.Data">
4846
<short>Pointer to the property data.</short>
4848
<!-- function Visibility: public -->
4849
<element name="TWidgetSet.SetROP2">
4850
<short>Sets the Foreground Mixing Mode in an device context.</short>
4853
The raster operation specifies how foreground painting (Brush, Pen)
4854
is combined with the current pixels in the DC.
4856
The operation combines bitwise the distinct red, green and blue values of the pixel colors.
4858
There exist 16 raster operations, according to the possible combinations
4859
of two (boolean) values:
4863
R2_BLACK - all black (0).
4865
R2_COPYPEN - Pen color.
4867
R2_MASKNOTPEN - Dst and not Pen.
4869
R2_MASKPEN - Dst and Pen.
4871
R2_MASKPENNOT - (not Dst) and Pen.
4873
R2_MERGENOTPEN - Dst or not Pen.
4875
R2_MERGEPEN - Dst or Pen.
4877
R2_MERGEPENNOT - (not Dst) or Pen.
4879
R2_NOP - Dst (unchanged).
4883
R2_NOTCOPYPEN - not Pen.
4885
R2_NOTMASKPEN - not (Dst and Pen).
4887
R2_NOTMERGEPEN - not (Dst or Pen).
4889
R2_NOTXORPEN - not (Dst xor Pen).
4891
R2_WHITE - all white.
4893
R2_XORPEN - Dst xor Pen.
4898
<link id="TWidgetSet.GetROP2"/>
4899
<link id="#lcl.LCLType.R2_COPYPEN"/>
4902
<element name="TWidgetSet.SetROP2.Result">
4903
<short>The old mode, zero on failure.</short>
4905
<element name="TWidgetSet.SetROP2.DC">
4906
<short>The device context.</short>
4908
<element name="TWidgetSet.SetROP2.Mode">
4909
<short>The new mode.</short>
3089
4911
<!-- function Visibility: public -->
3090
4912
<element name="TWidgetSet.SetScrollInfo">
4913
<short>Sets (selected) parameters of a scroll bar.</short>
4916
<link id="TWidgetSet.GetScrollInfo"/>
3096
<!-- function result Visibility: default -->
3097
4919
<element name="TWidgetSet.SetScrollInfo.Result">
4920
<short>The (new) slider position.</short>
3100
<!-- argument Visibility: default -->
3101
4922
<element name="TWidgetSet.SetScrollInfo.Handle">
4923
<short>The handle of a ScrollBar, or of a window containing scrollbars.</short>
3104
<!-- argument Visibility: default -->
3105
4925
<element name="TWidgetSet.SetScrollInfo.SBStyle">
4926
<short>The ScrollBar kind.</short>
3108
<!-- argument Visibility: default -->
3109
4928
<element name="TWidgetSet.SetScrollInfo.ScrollInfo">
4929
<short>Contains the new values.</short>
3112
<!-- argument Visibility: default -->
3113
4931
<element name="TWidgetSet.SetScrollInfo.Redraw">
4932
<short>True forces a repaint of the ScrollBar.</short>
3116
4934
<!-- function Visibility: public -->
3117
4935
<element name="TWidgetSet.SetStretchBltMode">
4936
<short>Sets the StrechBlt mode for an device context.</short>
4939
The following modes are defined:
4943
BLACKONWHITE - preserves black pixels in a monchrome bitmap.
4947
HALFTONE, STRETCH_HALFTONE
4949
WHITEONBLACK - preserves white pixels in a monchrome bitmap.
3123
<!-- function result Visibility: default -->
3124
4955
<element name="TWidgetSet.SetStretchBltMode.Result">
4956
<short>The previous mode, zero on failure.</short>
3127
<!-- argument Visibility: default -->
3128
4958
<element name="TWidgetSet.SetStretchBltMode.DC">
4959
<short>The Device Context.</short>
3131
<!-- argument Visibility: default -->
3132
4961
<element name="TWidgetSet.SetStretchBltMode.StretchMode">
4962
<short>The new mode.</short>
3135
4964
<!-- function Visibility: public -->
3136
4965
<element name="TWidgetSet.SetSysColors">
4966
<short>Sets the colors for one or more display elements of window borders and desktop.</short>
4969
<link id="TWidgetSet.GetSysColor">GetSysColor</link> for the element identifiers.
3142
<!-- function result Visibility: default -->
3143
4972
<element name="TWidgetSet.SetSysColors.Result">
4973
<short>False on failure.</short>
3146
<!-- argument Visibility: default -->
3147
4975
<element name="TWidgetSet.SetSysColors.cElements">
4976
<short>The number of colors to change, size of the arrays.</short>
3150
<!-- argument Visibility: default -->
3151
4978
<element name="TWidgetSet.SetSysColors.lpaElements">
4979
<short>Array of element identifiers.</short>
3154
<!-- argument Visibility: default -->
3155
4981
<element name="TWidgetSet.SetSysColors.lpaRgbValues">
3158
<!-- function Visibility: public -->
3159
<element name="TWidgetSet.SetTextAlign">
3165
<!-- function result Visibility: default -->
3166
<element name="TWidgetSet.SetTextAlign.Result">
3169
<!-- argument Visibility: default -->
3170
<element name="TWidgetSet.SetTextAlign.DC">
3173
<!-- argument Visibility: default -->
3174
<element name="TWidgetSet.SetTextAlign.Flags">
4982
<short>Array of RGB colors.</short>
3177
4984
<!-- function Visibility: public -->
3178
4985
<element name="TWidgetSet.SetTextCharacterExtra">
4986
<short>Sets extra intercharacter spacing in text output.</short>
3184
<!-- function result Visibility: default -->
3185
4991
<element name="TWidgetSet.SetTextCharacterExtra.Result">
4992
<short>The previous spacing, $80000000 on failure.</short>
3188
<!-- argument Visibility: default -->
3189
4994
<element name="TWidgetSet.SetTextCharacterExtra._hdc">
4995
<short>The device context.</short>
3192
<!-- argument Visibility: default -->
3193
4997
<element name="TWidgetSet.SetTextCharacterExtra.nCharExtra">
4998
<short>The additional spacing, in logical units.</short>
3196
5000
<!-- function Visibility: public -->
3197
5001
<element name="TWidgetSet.SetTextColor">
5002
<short>Sets the text color in an device context.</short>
3203
<!-- function result Visibility: default -->
3204
5007
<element name="TWidgetSet.SetTextColor.Result">
5008
<short>The previous color, CLR_INVALID on failure.</short>
3207
<!-- argument Visibility: default -->
3208
5010
<element name="TWidgetSet.SetTextColor.DC">
5011
<short>The Device Context.</short>
3211
<!-- argument Visibility: default -->
3212
5013
<element name="TWidgetSet.SetTextColor.Color">
5014
<short>The new text color.</short>
5016
<!-- function Visibility: public -->
5017
<element name="TWidgetSet.SetViewPortExtEx">
5018
<short>Sets the extent of the viewport for a device context.</short>
5022
<link id="TWidgetSet.SetViewPortOrgEx"/>
5023
<link id="TWidgetSet.SetWindowExtEx"/>
5026
<element name="TWidgetSet.SetViewPortExtEx.Result">
5027
<short>False on failure.</short>
5029
<element name="TWidgetSet.SetViewPortExtEx.DC">
5030
<short>The Device Context.</short>
5032
<element name="TWidgetSet.SetViewPortExtEx.XExtent">
5033
<short>The extent in device units.</short>
5035
<element name="TWidgetSet.SetViewPortExtEx.YExtent">
5036
<short>The extent in device units.</short>
5038
<element name="TWidgetSet.SetViewPortExtEx.OldSize">
5039
<short>Receives the previous extent, if not Nil.</short>
5041
<!-- function Visibility: public -->
5042
<element name="TWidgetSet.SetViewPortOrgEx">
5043
<short>Sets the device origin corresponding to the window origin (0,0) in an device context.</short>
5047
<link id="TWidgetSet.SetViewPortExtEx"/>
5048
<link id="TWidgetSet.SetWindowOrgEx"/>
5051
<element name="TWidgetSet.SetViewPortOrgEx.Result">
5052
<short>False on failure.</short>
5054
<element name="TWidgetSet.SetViewPortOrgEx.DC">
5055
<short>The Device Context.</short>
5057
<element name="TWidgetSet.SetViewPortOrgEx.NewX">
5058
<short>The coordinates in device units.</short>
5060
<element name="TWidgetSet.SetViewPortOrgEx.NewY">
5061
<short>The coordinates in device units.</short>
5063
<element name="TWidgetSet.SetViewPortOrgEx.OldPoint">
5064
<short>Receives the previous origin, if not Nil.</short>
5066
<!-- function Visibility: public -->
5067
<element name="TWidgetSet.SetWindowExtEx">
5068
<short>Sets the extent of the window for an device context.</short>
5072
<link id="TWidgetSet.SetViewPortExtEx"/>
5073
<link id="TWidgetSet.SetWindowOrgEx"/>
5076
<element name="TWidgetSet.SetWindowExtEx.Result">
5077
<short>False on failure.</short>
5079
<element name="TWidgetSet.SetWindowExtEx.DC">
5080
<short>The Device Context.</short>
5082
<element name="TWidgetSet.SetWindowExtEx.XExtent">
5083
<short>The extent in logical units.</short>
5085
<element name="TWidgetSet.SetWindowExtEx.YExtent">
5086
<short>The extent in logical units.</short>
5088
<element name="TWidgetSet.SetWindowExtEx.OldSize">
5089
<short>Receives the previous extent, if not Nil.</short>
3215
5091
<!-- function Visibility: public -->
3216
5092
<element name="TWidgetSet.SetWindowLong">
5093
<short>Sets an attribute of a window.</short>
5096
<link id="TWidgetSet.GetWindowLong"/>
3222
<!-- function result Visibility: default -->
3223
5099
<element name="TWidgetSet.SetWindowLong.Result">
5100
<short>The previous value, zero on failure.</short>
3226
<!-- argument Visibility: default -->
3227
5102
<element name="TWidgetSet.SetWindowLong.Handle">
5103
<short>The window handle.</short>
3230
<!-- argument Visibility: default -->
3231
5105
<element name="TWidgetSet.SetWindowLong.Idx">
5106
<short>The attribute offset.</short>
3234
<!-- argument Visibility: default -->
3235
5108
<element name="TWidgetSet.SetWindowLong.NewLong">
5109
<short>The new value.</short>
3238
5111
<!-- function Visibility: public -->
3239
5112
<element name="TWidgetSet.SetWindowOrgEx">
5113
<short>Specifies which window point maps to the viewport origin (0,0).</short>
3245
<!-- function result Visibility: default -->
3246
5117
<element name="TWidgetSet.SetWindowOrgEx.Result">
5118
<short>False on failure.</short>
3249
<!-- argument Visibility: default -->
3250
5120
<element name="TWidgetSet.SetWindowOrgEx.dc">
5121
<short>The device context.</short>
3253
<!-- argument Visibility: default -->
3254
5123
<element name="TWidgetSet.SetWindowOrgEx.NewX">
5124
<short>The origin in logical units.</short>
3257
<!-- argument Visibility: default -->
3258
5126
<element name="TWidgetSet.SetWindowOrgEx.NewY">
5127
<short>The origin in logical units.</short>
3261
<!-- argument Visibility: default -->
3262
5129
<element name="TWidgetSet.SetWindowOrgEx.OldPoint">
5130
<short>Receives the previous origin, if not Nil.</short>
3265
5132
<!-- function Visibility: public -->
3266
5133
<element name="TWidgetSet.SetWindowPos">
5134
<short>Changes the size, position, and Z order of a window.</short>
5137
The Z order can be changed to just behind another window, or:
5141
HWND_BOTTOM - behind all other windows.
5143
HWND_NOTOPMOST - behind all topmost windows.
5145
HWND_TOP - above all other windows.
5147
HWND_TOPMOST - above all other non-topmost windows.
5151
The general placement can be a combination of:
5155
SWP_ASYNCWINDOWPOS - don't block the calling thread
5156
when the window is owned by an different thread.
5158
SWP_DEFERERASE - suppress WM_SYNCPAINT message.
5160
SWP_DRAWFRAME - draw the window frame.
5162
SWP_FRAMECHANGED - apply new frame style.
5164
SWP_HIDEWINDOW - hides the window.
5166
SWP_NOACTIVATE - don't activate the window.
5168
SWP_NOCOPYBITS - invalidate the entire client area.
5169
If not set, the window content moves together with the window.
5171
SWP_NOMOVE - the position is not changed (ignores X, Y).
5174
SWP_NOOWNERZORDER - the Z order of the owner window is unchanged.
5176
SWP_NOREDRAW - nothing is redrawn automatically,
5177
not even uncovered parts of the window.
5180
SWP_NOSENDCHANGING - no WM_WINDOWPOSCHANGING message.
5182
SWP_NOSIZE - the size is unchanged (ignores cx, cy).
5184
SWP_NOZORDER - the Z order is unchanged (ignores hWndInsertAfter)
5186
SWP_SHOWWINDOW - unhide the window.
3272
<!-- function result Visibility: default -->
3273
5194
<element name="TWidgetSet.SetWindowPos.Result">
5195
<short>Zero on failure.</short>
3276
<!-- argument Visibility: default -->
3277
5197
<element name="TWidgetSet.SetWindowPos.hWnd">
5198
<short>The window handle.</short>
3280
<!-- argument Visibility: default -->
3281
5200
<element name="TWidgetSet.SetWindowPos.hWndInsertAfter">
5201
<short>The window handle or Z order position.</short>
3284
<!-- argument Visibility: default -->
3285
5203
<element name="TWidgetSet.SetWindowPos.X">
5204
<short>The window origin.</short>
3288
<!-- argument Visibility: default -->
3289
5206
<element name="TWidgetSet.SetWindowPos.Y">
5207
<short>The window origin.</short>
3292
<!-- argument Visibility: default -->
3293
5209
<element name="TWidgetSet.SetWindowPos.cx">
5210
<short>The window extent.</short>
3296
<!-- argument Visibility: default -->
3297
5212
<element name="TWidgetSet.SetWindowPos.cy">
5213
<short>The window extent.</short>
3300
<!-- argument Visibility: default -->
3301
5215
<element name="TWidgetSet.SetWindowPos.uFlags">
5216
<short>General placement flags.</short>
5218
<!-- function Visibility: public -->
5219
<element name="TWidgetSet.SetWindowRgn">
5220
<short>Restricts the visible part of the entire window.</short>
5226
<element name="TWidgetSet.SetWindowRgn.Result">
5227
<short>False on failure.</short>
5229
<element name="TWidgetSet.SetWindowRgn.hWnd">
5230
<short>The window handle.</short>
5232
<element name="TWidgetSet.SetWindowRgn.hRgn">
5233
<short>The window region handle.</short>
5235
<element name="TWidgetSet.SetWindowRgn.bRedraw">
5236
<short>True forces a repaint of the window.</short>
3304
5238
<!-- function Visibility: public -->
3305
5239
<element name="TWidgetSet.ShowCaret">
5240
<short>Shows the Caret (text cursor).</short>
5243
<link id="TWidgetSet.HideCaret"/>
3311
<!-- function result Visibility: default -->
3312
5246
<element name="TWidgetSet.ShowCaret.Result">
5247
<short>False on failure.</short>
3315
<!-- argument Visibility: default -->
3316
5249
<element name="TWidgetSet.ShowCaret.hWnd">
5250
<short>The window handle.</short>
3319
5252
<!-- function Visibility: public -->
3320
5253
<element name="TWidgetSet.ShowScrollBar">
5254
<short>Shows or hides a ScrollBar.</short>
5257
<link id="TWidgetSet.EnableScrollBar"/>
3326
<!-- function result Visibility: default -->
3327
5260
<element name="TWidgetSet.ShowScrollBar.Result">
5261
<short>False on failure.</short>
3330
<!-- argument Visibility: default -->
3331
5263
<element name="TWidgetSet.ShowScrollBar.Handle">
5264
<short>The window or ScrollBar handle.</short>
3334
<!-- argument Visibility: default -->
3335
5266
<element name="TWidgetSet.ShowScrollBar.wBar">
5267
<short>The scrollbar type (SB_CTL, SB_HORZ...).</short>
3338
<!-- argument Visibility: default -->
3339
5269
<element name="TWidgetSet.ShowScrollBar.bShow">
5270
<short>True shows, False hides the ScrollBar.</short>
3342
5272
<!-- function Visibility: public -->
3343
5273
<element name="TWidgetSet.ShowWindow">
5274
<short>Shows a window in an specific state.</short>
5277
These are available options:
5283
SW_HIDE - hides the window.
5285
SW_MAXIMIZE - maximizes the window.
5287
SW_MINIMIZE - minimizes the window.
5289
SW_RESTORE - activates and restores from minimized/maximized to normal state.
5291
SW_SHOW - activates and shows the window.
5293
SW_SHOWMAXIMIZED - activates and maximizes the window.
5295
SW_SHOWMINIMIZED - activates and minimizes the window.
5297
SW_SHOWMINNOACTIVE - minimizes the window.
5299
SW_SHOWNA - shows the window.
5301
SW_SHOWNOACTIVATE - shows the window as designed.
5303
SW_SHOWNORMAL - activates and shows the window as designed.
3349
<!-- function result Visibility: default -->
3350
5309
<element name="TWidgetSet.ShowWindow.Result">
5310
<short>True when the window was already visible.</short>
3353
<!-- argument Visibility: default -->
3354
5312
<element name="TWidgetSet.ShowWindow.hWnd">
5313
<short>The window handle.</short>
3357
<!-- argument Visibility: default -->
3358
5315
<element name="TWidgetSet.ShowWindow.nCmdShow">
3361
5318
<!-- procedure Visibility: public -->
3362
5319
<element name="TWidgetSet.Sleep">
5320
<short>Suspends the current thread for a certain time interval.</short>
3368
<!-- argument Visibility: default -->
3369
5324
<element name="TWidgetSet.Sleep.dwMilliseconds">
5325
<short>The time interval in milliseconds.</short>
3372
5327
<!-- function Visibility: public -->
3373
5328
<element name="TWidgetSet.StretchBlt">
5329
<short>Copies a rectangular region into an device context,
5330
shrinking or stretching it as required.
5334
<link id="TWidgetSet.StretchMaskBlt"/>
5335
<link id="TWidgetSet.SetStretchBltMode"/>
5336
<link id="TWidgetSet.BitBlt"/>
3379
<!-- function result Visibility: default -->
3380
5339
<element name="TWidgetSet.StretchBlt.Result">
5340
<short>False on failure.</short>
3383
<!-- argument Visibility: default -->
3384
5342
<element name="TWidgetSet.StretchBlt.DestDC">
5343
<short>The destination device context.</short>
3387
<!-- argument Visibility: default -->
3388
5345
<element name="TWidgetSet.StretchBlt.X">
5346
<short>The destination origin.</short>
3391
<!-- argument Visibility: default -->
3392
5348
<element name="TWidgetSet.StretchBlt.Y">
5349
<short>The destination origin.</short>
3395
<!-- argument Visibility: default -->
3396
5351
<element name="TWidgetSet.StretchBlt.Width">
5352
<short>The destination extent.</short>
3399
<!-- argument Visibility: default -->
3400
5354
<element name="TWidgetSet.StretchBlt.Height">
5355
<short>The destination extent.</short>
3403
<!-- argument Visibility: default -->
3404
5357
<element name="TWidgetSet.StretchBlt.SrcDC">
5358
<short>The source device context.</short>
3407
<!-- argument Visibility: default -->
3408
5360
<element name="TWidgetSet.StretchBlt.XSrc">
5361
<short>The source origin.</short>
3411
<!-- argument Visibility: default -->
3412
5363
<element name="TWidgetSet.StretchBlt.YSrc">
5364
<short>The source origin.</short>
3415
<!-- argument Visibility: default -->
3416
5366
<element name="TWidgetSet.StretchBlt.SrcWidth">
5367
<short>The source extent.</short>
3419
<!-- argument Visibility: default -->
3420
5369
<element name="TWidgetSet.StretchBlt.SrcHeight">
5370
<short>The source extent.</short>
3423
<!-- argument Visibility: default -->
3424
5372
<element name="TWidgetSet.StretchBlt.Rop">
5373
<short>The raster opcode (see BitBlt).</short>
3427
5375
<!-- function Visibility: public -->
3428
5376
<element name="TWidgetSet.StretchDIBits">
5377
<short>Copies a rectangular region from a DIB into an device context,
5378
shrinking or stretching it as required.
5382
<link id="TWidgetSet.StretchMaskBlt"/>
5383
<link id="TWidgetSet.StretchBlt"/>
5384
<link id="TWidgetSet.StretchMaskBlt"/>
3434
<!-- function result Visibility: default -->
3435
5387
<element name="TWidgetSet.StretchDIBits.Result">
3438
<!-- argument Visibility: default -->
3439
5390
<element name="TWidgetSet.StretchDIBits.DC">
5391
<short>The destination Device Context.</short>
3442
<!-- argument Visibility: default -->
3443
5393
<element name="TWidgetSet.StretchDIBits.DestX">
5394
<short>The destination origin.</short>
3446
<!-- argument Visibility: default -->
3447
5396
<element name="TWidgetSet.StretchDIBits.DestY">
5397
<short>The destination origin.</short>
3450
<!-- argument Visibility: default -->
3451
5399
<element name="TWidgetSet.StretchDIBits.DestWidth">
5400
<short>The destination extent.</short>
3454
<!-- argument Visibility: default -->
3455
5402
<element name="TWidgetSet.StretchDIBits.DestHeight">
5403
<short>The destination extent.</short>
3458
<!-- argument Visibility: default -->
3459
5405
<element name="TWidgetSet.StretchDIBits.SrcX">
5406
<short>The source origin.</short>
3462
<!-- argument Visibility: default -->
3463
5408
<element name="TWidgetSet.StretchDIBits.SrcY">
5409
<short>The source origin.</short>
3466
<!-- argument Visibility: default -->
3467
5411
<element name="TWidgetSet.StretchDIBits.SrcWidth">
5412
<short>The source extent.</short>
3470
<!-- argument Visibility: default -->
3471
5414
<element name="TWidgetSet.StretchDIBits.SrcHeight">
5415
<short>The source extent.</short>
3474
<!-- argument Visibility: default -->
3475
5417
<element name="TWidgetSet.StretchDIBits.Bits">
5418
<short>The device independent bitmap bits.</short>
3478
<!-- argument Visibility: default -->
3479
5420
<element name="TWidgetSet.StretchDIBits.BitsInfo">
5421
<short>The bitmap info structure.</short>
3482
<!-- argument Visibility: default -->
3483
5423
<element name="TWidgetSet.StretchDIBits.Usage">
5424
<short>The color mode.</short>
3486
<!-- argument Visibility: default -->
3487
5426
<element name="TWidgetSet.StretchDIBits.Rop">
5427
<short>The raster operation.</short>
5429
<!-- function Visibility: public -->
5430
<element name="TWidgetSet.SystemParametersInfo">
5431
<short>Retrieves or sets one of the system-wide parameters.</short>
5434
Most of the parameters are Windows platform specific.
5436
SPI_GETACCESSTIMEOUT
5438
SPI_GETFOCUSBORDERHEIGHT
5439
SPI_GETFOCUSBORDERWIDTH
5441
SPI_GETMOUSECLICKLOCK
5442
SPI_GETMOUSECLICKLOCKTIME
5453
SPI_SETACCESSTIMEOUT
5455
SPI_SETFOCUSBORDERHEIGHT
5456
SPI_SETFOCUSBORDERWIDTH
5458
SPI_SETMOUSECLICKLOCK
5459
SPI_SETMOUSECLICKLOCKTIME
5470
SPI_GETDESKWALLPAPER
5473
SPI_GETFONTSMOOTHING
5474
SPI_GETFONTSMOOTHINGCONTRAST
5475
SPI_GETFONTSMOOTHINGTYPE
5480
SPI_SETDESKWALLPAPER
5483
SPI_SETFONTSMOOTHING
5484
SPI_SETFONTSMOOTHINGCONTRAST
5485
SPI_SETFONTSMOOTHINGTYPE
5489
SPI_GETICONTITLELOGFONT
5490
SPI_GETICONTITLEWRAP
5491
SPI_ICONHORIZONTALSPACING
5492
SPI_ICONVERTICALSPACING
5496
SPI_SETICONTITLELOGFONT
5497
SPI_SETICONTITLEWRAP
5500
SPI_GETBLOCKSENDINPUTRESETS
5501
SPI_GETDEFAULTINPUTLANG
5503
SPI_GETKEYBOARDDELAY
5505
SPI_GETKEYBOARDSPEED
5507
SPI_GETMOUSEHOVERHEIGHT
5508
SPI_GETMOUSEHOVERTIME
5509
SPI_GETMOUSEHOVERWIDTH
5512
SPI_GETSNAPTODEFBUTTON
5513
SPI_GETWHEELSCROLLLINES
5516
SPI_SETBLOCKSENDINPUTRESETS
5517
SPI_SETDEFAULTINPUTLANG
5518
SPI_SETDOUBLECLICKTIME
5519
SPI_SETDOUBLECLKHEIGHT
5520
SPI_SETDOUBLECLKWIDTH
5522
SPI_SETKEYBOARDDELAY
5524
SPI_SETKEYBOARDSPEED
5527
SPI_SETMOUSEBUTTONSWAP
5528
SPI_SETMOUSEHOVERHEIGHT
5529
SPI_SETMOUSEHOVERTIME
5530
SPI_SETMOUSEHOVERWIDTH
5533
SPI_SETSNAPTODEFBUTTON
5534
SPI_SETWHEELSCROLLLINES
5536
SPI_GETMENUDROPALIGNMENT
5538
SPI_GETMENUSHOWDELAY
5540
SPI_SETMENUDROPALIGNMENT
5542
SPI_SETMENUSHOWDELAY
5544
SPI_GETLOWPOWERACTIVE
5545
SPI_GETLOWPOWERTIMEOUT
5546
SPI_GETPOWEROFFACTIVE
5547
SPI_GETPOWEROFFTIMEOUT
5549
SPI_SETLOWPOWERACTIVE
5550
SPI_SETLOWPOWERTIMEOUT
5551
SPI_SETPOWEROFFACTIVE
5552
SPI_SETPOWEROFFTIMEOUT
5554
SPI_GETSCREENSAVEACTIVE
5555
SPI_GETSCREENSAVERRUNNING
5556
SPI_GETSCREENSAVETIMEOUT
5558
SPI_SETSCREENSAVEACTIVE
5559
SPI_SETSCREENSAVERRUNNING
5560
SPI_SETSCREENSAVETIMEOUT
5562
SPI_GETCOMBOBOXANIMATION
5564
SPI_GETGRADIENTCAPTIONS
5566
SPI_GETLISTBOXSMOOTHSCROLLING
5567
SPI_GETMENUANIMATION
5568
SPI_GETMENUUNDERLINES
5569
SPI_GETSELECTIONFADE
5570
SPI_GETTOOLTIPANIMATION
5574
SPI_SETCOMBOBOXANIMATION
5576
SPI_SETGRADIENTCAPTIONS
5578
SPI_SETLISTBOXSMOOTHSCROLLING
5579
SPI_SETMENUANIMATION
5580
SPI_SETMENUUNDERLINES
5581
SPI_SETSELECTIONFADE
5582
SPI_SETTOOLTIPANIMATION
5586
SPI_GETACTIVEWINDOWTRACKING
5587
SPI_GETACTIVEWNDTRKZORDER
5588
SPI_GETACTIVEWNDTRKTIMEOUT
5592
SPI_GETDRAGFULLWINDOWS
5593
SPI_GETFOREGROUNDFLASHCOUNT
5594
SPI_GETFOREGROUNDLOCKTIMEOUT
5595
SPI_GETMINIMIZEDMETRICS
5596
SPI_GETNONCLIENTMETRICS
5599
SPI_SETACTIVEWINDOWTRACKING
5600
SPI_SETACTIVEWNDTRKZORDER
5601
SPI_SETACTIVEWNDTRKTIMEOUT
5605
SPI_SETDRAGFULLWINDOWS
5608
SPI_SETFOREGROUNDFLASHCOUNT
5609
SPI_SETFOREGROUNDLOCKTIMEOUT
5610
SPI_SETMINIMIZEDMETRICS
5611
SPI_SETNONCLIENTMETRICS
5614
SPI_GETWINDOWSEXTENSION
5617
Additional actions (zero for none):<br/>
5620
spif_sendwindowinichange
5626
<element name="TWidgetSet.SystemParametersInfo.Result">
5627
<short>False on failure.</short>
5629
<element name="TWidgetSet.SystemParametersInfo.uiAction">
5630
<short>The parameter and action.</short>
5632
<element name="TWidgetSet.SystemParametersInfo.uiParam">
5633
<short>Depends on uiAction.</short>
5635
<element name="TWidgetSet.SystemParametersInfo.pvParam">
5636
<short>Depends on uiAction.</short>
5638
<element name="TWidgetSet.SystemParametersInfo.fWinIni">
5639
<short>Additional actions.</short>
3490
5641
<!-- function Visibility: public -->
3491
5642
<element name="TWidgetSet.TextOut">
5643
<short>Draws an string without formatting (single line).</short>
5646
<link id="TWidgetSet.ExtTextOut"/>
3497
<!-- function result Visibility: default -->
3498
5649
<element name="TWidgetSet.TextOut.Result">
5650
<short>False on failure.</short>
3501
<!-- argument Visibility: default -->
3502
5652
<element name="TWidgetSet.TextOut.DC">
5653
<short>The Device Context.</short>
3505
<!-- argument Visibility: default -->
3506
5655
<element name="TWidgetSet.TextOut.X">
5656
<short>The text origin in logical coordinates.</short>
3509
<!-- argument Visibility: default -->
3510
5658
<element name="TWidgetSet.TextOut.Y">
5659
<short>The text origin in logical coordinates.</short>
3513
<!-- argument Visibility: default -->
3514
5661
<element name="TWidgetSet.TextOut.Str">
5662
<short>The text.</short>
3517
<!-- argument Visibility: default -->
3518
5664
<element name="TWidgetSet.TextOut.Count">
5665
<short>The number of (Wide)Chars in the string.</short>
3521
5667
<!-- function Visibility: public -->
3522
5668
<element name="TWidgetSet.UpdateWindow">
5669
<short>Forces an immediate repaint of a window, if required.</short>
3528
<!-- function result Visibility: default -->
3529
5673
<element name="TWidgetSet.UpdateWindow.Result">
5674
<short>False on failure.</short>
3532
<!-- argument Visibility: default -->
3533
5676
<element name="TWidgetSet.UpdateWindow.Handle">
3536
<!-- function Visibility: public -->
3537
<element name="TWidgetSet.VkKeyScan">
3543
<!-- function result Visibility: default -->
3544
<element name="TWidgetSet.VkKeyScan.Result">
3547
<!-- argument Visibility: default -->
3548
<element name="TWidgetSet.VkKeyScan.AChar">
5677
<short>The window handle.</short>
3551
5679
<!-- function Visibility: public -->
3552
5680
<element name="TWidgetSet.WindowFromPoint">
5681
<short>Finds the window containing the specified point.</short>
3558
<!-- function result Visibility: default -->
3559
5685
<element name="TWidgetSet.WindowFromPoint.Result">
5686
<short>The window handle, zero on failure.</short>
3562
<!-- argument Visibility: default -->
3563
5688
<element name="TWidgetSet.WindowFromPoint.Point">
3566
<!-- procedure Visibility: public -->
3567
<element name="TWidgetSet.AttachMenuToWindow">
3573
<!-- argument Visibility: default -->
3574
<element name="TWidgetSet.AttachMenuToWindow.AMenuObject">
5689
<short>The screen coordinates.</short>
5692
<!-- function Visibility: public -->
5693
<element name="TWidgetSet.AddEventHandler">
5702
<element name="TWidgetSet.AddEventHandler.Result">
5705
<element name="TWidgetSet.AddEventHandler.AHandle">
5708
<element name="TWidgetSet.AddEventHandler.AFlags">
5711
<element name="TWidgetSet.AddEventHandler.AEventHandler">
5714
<element name="TWidgetSet.AddEventHandler.AData">
5717
<!-- function Visibility: public -->
5718
<element name="TWidgetSet.AddProcessEventHandler">
5727
<element name="TWidgetSet.AddProcessEventHandler.Result">
5730
<element name="TWidgetSet.AddProcessEventHandler.AHandle">
5733
<element name="TWidgetSet.AddProcessEventHandler.AEventHandler">
5736
<element name="TWidgetSet.AddProcessEventHandler.AData">
5739
<!-- function Visibility: public -->
5740
<element name="TWidgetSet.AddPipeEventHandler">
5749
<element name="TWidgetSet.AddPipeEventHandler.Result">
5752
<element name="TWidgetSet.AddPipeEventHandler.AHandle">
5755
<element name="TWidgetSet.AddPipeEventHandler.AEventHandler">
5758
<element name="TWidgetSet.AddPipeEventHandler.AData">
5761
<element name="TWidgetSet.AllocateHWnd">
5762
<short>Allocates an invisible window that can be used to receive messages.</short>
5766
<link id="TWidgetSet.DeallocateHWnd"/>
5769
<element name="TWidgetSet.AllocateHWnd.Result">
5770
<short>The window handle, zero on failure.</short>
5772
<element name="TWidgetSet.AllocateHWnd.Method">
5773
<short>The callback method for the window. Can be Nil.</short>
5775
<!-- function Visibility: public -->
5776
<element name="TWidgetSet.AskUser">
5785
<element name="TWidgetSet.AskUser.Result">
5788
<element name="TWidgetSet.AskUser.DialogCaption">
5791
<element name="TWidgetSet.AskUser.DialogMessage">
5794
<element name="TWidgetSet.AskUser.DialogType">
5797
<element name="TWidgetSet.AskUser.Buttons">
5800
<element name="TWidgetSet.AskUser.HelpCtx">
3577
5803
<!-- procedure Visibility: public -->