Docs: LCL/controls. Adds short descriptions for various topics.

This commit is contained in:
dsiders 2021-10-11 00:20:46 +01:00
parent 8985175dd5
commit e027061cb5

View File

@ -58,360 +58,360 @@
<!-- included from controlconsts.inc --> <!-- included from controlconsts.inc -->
<element name="CM_BASE"> <element name="CM_BASE">
<short/> <short>Starting value for control message constants defined in the LCL.</short>
</element> </element>
<element name="CM_LCLOFFSET"> <element name="CM_LCLOFFSET">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_ACTIVATE"> <element name="CM_ACTIVATE">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_DEACTIVATE"> <element name="CM_DEACTIVATE">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_GOTFOCUS"> <element name="CM_GOTFOCUS">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_LOSTFOCUS"> <element name="CM_LOSTFOCUS">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_CANCELMODE"> <element name="CM_CANCELMODE">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_DIALOGKEY"> <element name="CM_DIALOGKEY">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_DIALOGCHAR"> <element name="CM_DIALOGCHAR">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_FOCUSCHANGED"> <element name="CM_FOCUSCHANGED">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_PARENTFONTCHANGED"> <element name="CM_PARENTFONTCHANGED">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_PARENTCOLORCHANGED"> <element name="CM_PARENTCOLORCHANGED">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_HITTEST"> <element name="CM_HITTEST">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_VISIBLECHANGED"> <element name="CM_VISIBLECHANGED">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_ENABLEDCHANGED"> <element name="CM_ENABLEDCHANGED">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_COLORCHANGED"> <element name="CM_COLORCHANGED">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_FONTCHANGED"> <element name="CM_FONTCHANGED">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_CURSORCHANGED"> <element name="CM_CURSORCHANGED">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_CTL3DCHANGED"> <element name="CM_CTL3DCHANGED">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_PARENTCTL3DCHANGED"> <element name="CM_PARENTCTL3DCHANGED">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_TEXTCHANGED"> <element name="CM_TEXTCHANGED">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_MOUSEENTER"> <element name="CM_MOUSEENTER">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_MOUSELEAVE"> <element name="CM_MOUSELEAVE">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_MENUCHANGED"> <element name="CM_MENUCHANGED">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_APPKEYDOWN"> <element name="CM_APPKEYDOWN">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_APPSYSCOMMAND"> <element name="CM_APPSYSCOMMAND">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_BUTTONPRESSED"> <element name="CM_BUTTONPRESSED">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_SHOWINGCHANGED"> <element name="CM_SHOWINGCHANGED">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_ENTER"> <element name="CM_ENTER">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_EXIT"> <element name="CM_EXIT">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_DESIGNHITTEST"> <element name="CM_DESIGNHITTEST">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_ICONCHANGED"> <element name="CM_ICONCHANGED">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_WANTSPECIALKEY"> <element name="CM_WANTSPECIALKEY">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_INVOKEHELP"> <element name="CM_INVOKEHELP">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_WINDOWHOOK"> <element name="CM_WINDOWHOOK">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_RELEASE"> <element name="CM_RELEASE">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_SHOWHINTCHANGED"> <element name="CM_SHOWHINTCHANGED">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_PARENTSHOWHINTCHANGED"> <element name="CM_PARENTSHOWHINTCHANGED">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_SYSCOLORCHANGE"> <element name="CM_SYSCOLORCHANGE">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_WININICHANGE"> <element name="CM_WININICHANGE">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_FONTCHANGE"> <element name="CM_FONTCHANGE">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_TIMECHANGE"> <element name="CM_TIMECHANGE">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_TABSTOPCHANGED"> <element name="CM_TABSTOPCHANGED">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_UIACTIVATE"> <element name="CM_UIACTIVATE">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_UIDEACTIVATE"> <element name="CM_UIDEACTIVATE">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_DOCWINDOWACTIVATE"> <element name="CM_DOCWINDOWACTIVATE">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_CONTROLLISTCHANGE"> <element name="CM_CONTROLLISTCHANGE">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_GETDATALINK"> <element name="CM_GETDATALINK">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_CHILDKEY"> <element name="CM_CHILDKEY">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_DRAG"> <element name="CM_DRAG">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_HINTSHOW"> <element name="CM_HINTSHOW">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_DIALOGHANDLE"> <element name="CM_DIALOGHANDLE">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_ISTOOLCONTROL"> <element name="CM_ISTOOLCONTROL">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_RECREATEWND"> <element name="CM_RECREATEWND">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_INVALIDATE"> <element name="CM_INVALIDATE">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_SYSFONTCHANGED"> <element name="CM_SYSFONTCHANGED">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_CONTROLCHANGE"> <element name="CM_CONTROLCHANGE">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_CHANGED"> <element name="CM_CHANGED">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_DOCKCLIENT"> <element name="CM_DOCKCLIENT">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_UNDOCKCLIENT"> <element name="CM_UNDOCKCLIENT">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_FLOAT"> <element name="CM_FLOAT">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_BORDERCHANGED"> <element name="CM_BORDERCHANGED">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_BIDIMODECHANGED"> <element name="CM_BIDIMODECHANGED">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_PARENTBIDIMODECHANGED"> <element name="CM_PARENTBIDIMODECHANGED">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_ALLCHILDRENFLIPPED"> <element name="CM_ALLCHILDRENFLIPPED">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_ACTIONUPDATE"> <element name="CM_ACTIONUPDATE">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_ACTIONEXECUTE"> <element name="CM_ACTIONEXECUTE">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_HINTSHOWPAUSE"> <element name="CM_HINTSHOWPAUSE">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_DOCKNOTIFICATION"> <element name="CM_DOCKNOTIFICATION">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_MOUSEWHEEL"> <element name="CM_MOUSEWHEEL">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_ISSHORTCUT"> <element name="CM_ISSHORTCUT">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_UPDATEACTIONS"> <element name="CM_UPDATEACTIONS">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_INVALIDATEDOCKHOST"> <element name="CM_INVALIDATEDOCKHOST">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_SETACTIVECONTROL"> <element name="CM_SETACTIVECONTROL">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_POPUPHWNDDESTROY"> <element name="CM_POPUPHWNDDESTROY">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_CREATEPOPUP"> <element name="CM_CREATEPOPUP">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_DESTROYHANDLE"> <element name="CM_DESTROYHANDLE">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_MOUSEACTIVATE"> <element name="CM_MOUSEACTIVATE">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_CONTROLLISTCHANGING"> <element name="CM_CONTROLLISTCHANGING">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_BUFFEREDPRINTCLIENT"> <element name="CM_BUFFEREDPRINTCLIENT">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_UNTHEMECONTROL"> <element name="CM_UNTHEMECONTROL">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_DOUBLEBUFFEREDCHANGED"> <element name="CM_DOUBLEBUFFEREDCHANGED">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_PARENTDOUBLEBUFFEREDCHANGED"> <element name="CM_PARENTDOUBLEBUFFEREDCHANGED">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_THEMECHANGED"> <element name="CM_THEMECHANGED">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_GESTURE"> <element name="CM_GESTURE">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_CUSTOMGESTURESCHANGED"> <element name="CM_CUSTOMGESTURESCHANGED">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_GESTUREMANAGERCHANGED"> <element name="CM_GESTUREMANAGERCHANGED">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_STANDARDGESTURESCHANGED"> <element name="CM_STANDARDGESTURESCHANGED">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_INPUTLANGCHANGE"> <element name="CM_INPUTLANGCHANGE">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_TABLETOPTIONSCHANGED"> <element name="CM_TABLETOPTIONSCHANGED">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_PARENTTABLETOPTIONSCHANGED"> <element name="CM_PARENTTABLETOPTIONSCHANGED">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_APPSHOWBTNGLYPHCHANGED"> <element name="CM_APPSHOWBTNGLYPHCHANGED">
<short/> <short>Control message constant.</short>
</element> </element>
<element name="CM_APPSHOWMENUGLYPHCHANGED"> <element name="CM_APPSHOWMENUGLYPHCHANGED">
<short/> <short>Control message constant.</short>
</element> </element>
<!-- included from controlconsts.inc --> <!-- included from controlconsts.inc -->
<element name="CN_BASE"> <element name="CN_BASE">
<short/> <short>Starting value for control notification messages in the LCL.</short>
</element> </element>
<element name="CN_CHARTOITEM"> <element name="CN_CHARTOITEM">
<short/> <short>Control notification message constant.</short>
</element> </element>
<element name="CN_COMMAND"> <element name="CN_COMMAND">
<short/> <short>Control notification message constant.</short>
</element> </element>
<element name="CN_COMPAREITEM"> <element name="CN_COMPAREITEM">
<short/> <short>Control notification message constant.</short>
</element> </element>
<element name="CN_CTLCOLORBTN"> <element name="CN_CTLCOLORBTN">
<short/> <short>Control notification message constant.</short>
</element> </element>
<element name="CN_CTLCOLORDLG"> <element name="CN_CTLCOLORDLG">
<short/> <short>Control notification message constant.</short>
</element> </element>
<element name="CN_CTLCOLOREDIT"> <element name="CN_CTLCOLOREDIT">
<short/> <short>Control notification message constant.</short>
</element> </element>
<element name="CN_CTLCOLORLISTBOX"> <element name="CN_CTLCOLORLISTBOX">
<short/> <short>Control notification message constant.</short>
</element> </element>
<element name="CN_CTLCOLORMSGBOX"> <element name="CN_CTLCOLORMSGBOX">
<short/> <short>Control notification message constant.</short>
</element> </element>
<element name="CN_CTLCOLORSCROLLBAR"> <element name="CN_CTLCOLORSCROLLBAR">
<short/> <short>Control notification message constant.</short>
</element> </element>
<element name="CN_CTLCOLORSTATIC"> <element name="CN_CTLCOLORSTATIC">
<short/> <short>Control notification message constant.</short>
</element> </element>
<element name="CN_DELETEITEM"> <element name="CN_DELETEITEM">
<short/> <short>Control notification message constant.</short>
</element> </element>
<element name="CN_DRAWITEM"> <element name="CN_DRAWITEM">
<short/> <short>Control notification message constant.</short>
</element> </element>
<element name="CN_HSCROLL"> <element name="CN_HSCROLL">
<short/> <short>Control notification message constant.</short>
</element> </element>
<element name="CN_MEASUREITEM"> <element name="CN_MEASUREITEM">
<short/> <short>Control notification message constant.</short>
</element> </element>
<element name="CN_PARENTNOTIFY"> <element name="CN_PARENTNOTIFY">
<short/> <short>Control notification message constant.</short>
</element> </element>
<element name="CN_VKEYTOITEM"> <element name="CN_VKEYTOITEM">
<short/> <short>Control notification message constant.</short>
</element> </element>
<element name="CN_VSCROLL"> <element name="CN_VSCROLL">
<short/> <short>Control notification message constant.</short>
</element> </element>
<element name="CN_KEYDOWN"> <element name="CN_KEYDOWN">
<short/> <short>Control notification message constant.</short>
</element> </element>
<element name="CN_KEYUP"> <element name="CN_KEYUP">
<short/> <short>Control notification message constant.</short>
</element> </element>
<element name="CN_CHAR"> <element name="CN_CHAR">
<short/> <short>Control notification message constant.</short>
</element> </element>
<element name="CN_SYSKEYUP"> <element name="CN_SYSKEYUP">
<short/> <short>Control notification message constant.</short>
</element> </element>
<element name="CN_SYSKEYDOWN"> <element name="CN_SYSKEYDOWN">
<short/> <short>Control notification message constant.</short>
</element> </element>
<element name="CN_SYSCHAR"> <element name="CN_SYSCHAR">
<short/> <short>Control notification message constant.</short>
</element> </element>
<element name="CN_NOTIFY"> <element name="CN_NOTIFY">
<short/> <short>Control notification message constant.</short>
</element> </element>
<element name="mrNone"> <element name="mrNone">
@ -628,8 +628,21 @@
</short> </short>
</element> </element>
<element name="TCMHitTest" link="#lcl.lmessages.TLMNCHitTest"/> <element name="TCMHitTest">
<element name="TCMDesignHitTest" link="#lcl.lmessages.TLMMouse"/> <short>Alias for the TLMNCHitTest type.</short>
<descr/>
<seealso>
<link id="#lcl.lmessages.TLMNCHitTest"/>
</seealso>
</element>
<element name="TCMDesignHitTest">
<short>Alias for the TLMMouse type.</short>
<descr/>
<seealso>
<link id="#lcl.lmessages.TLMMouse"/>
</seealso>
</element>
<element name="TCMControlChange"> <element name="TCMControlChange">
<short>Contains values representing a Control Change Message.</short> <short>Contains values representing a Control Change Message.</short>
@ -656,74 +669,70 @@
</element> </element>
<element name="TCMChanged"> <element name="TCMChanged">
<short/> <short>Not used in the current LCL implementation.</short>
<descr/>
<seealso/>
</element> </element>
<element name="TCMChanged.Msg"> <element name="TCMChanged.Msg">
<short/> <short/>
<descr/>
<seealso/>
</element> </element>
<element name="TCMChanged.Unused"> <element name="TCMChanged.Unused">
<short/> <short/>
<descr/>
<seealso/>
</element> </element>
<element name="TCMChanged.Child"> <element name="TCMChanged.Child">
<short/> <short/>
<descr/>
<seealso/>
</element> </element>
<element name="TCMChanged.Result"> <element name="TCMChanged.Result">
<short/> <short/>
<descr/>
<seealso/>
</element> </element>
<element name="TCMControlListChange"> <element name="TCMControlListChange">
<short/> <short>Not used in the current LCL implementation.</short>
<descr/>
<seealso/>
</element> </element>
<element name="TCMControlListChange.Msg"> <element name="TCMControlListChange.Msg">
<short/> <short/>
</element> </element>
<element name="TCMControlListChange.Control"> <element name="TCMControlListChange.Control">
<short/> <short/>
<descr/>
<seealso/>
</element> </element>
<element name="TCMControlListChange.Inserting"> <element name="TCMControlListChange.Inserting">
<short/> <short/>
<descr/>
<seealso/>
</element> </element>
<element name="TCMControlListChange.Result"> <element name="TCMControlListChange.Result">
<short/> <short/>
<descr/>
<seealso/>
</element> </element>
<element name="TCMDialogChar" link="#lcl.lmessages.TLMKey"> <element name="TCMDialogChar">
<short/> <short>Alias for the TLMKey type.</short>
<notes><note>Used in LazReport controls</note></notes> <seealso>
<link id="#lcl.lmessages.TLMKey"/>
</seealso>
<notes><note>Used in LazReport controls.</note></notes>
</element> </element>
<element name="TCMDialogKey" link="#lcl.lmessages.TLMKey"> <element name="TCMDialogKey">
<short/> <short>Alias for the TLMKey type.</short>
<seealso>
<link id="#lcl.lmessages.TLMKey"/>
</seealso>
<notes><note>Used in the jvcllaz package.</note></notes>
</element> </element>
<element name="TCMEnter" link="#lcl.lmessages.TLMEnter"> <element name="TCMEnter">
<short/> <short>Alias for the TLMEnter type.</short>
<seealso>
<link id="#lcl.lmessages.TLMEnter">TLMEnter</link>
</seealso>
</element> </element>
<element name="TCMExit" link="#lcl.lmessages.TLMExit"> <element name="TCMExit">
<short/> <short>Alias for the TLMExit type.</short>
<seealso>
<link id="#lcl.lmessages.TLMExit"/>
</seealso>
</element> </element>
<element name="TCMCancelMode"> <element name="TCMCancelMode">
<short/> <short>Contains information representing a CM_CANCELMODE control message.</short>
<notes><note>Used in the jvcllaz package.</note></notes>
</element> </element>
<element name="TCMCancelMode.Msg"> <element name="TCMCancelMode.Msg">
<short/> <short/>
@ -739,7 +748,7 @@
</element> </element>
<element name="TCMChildKey"> <element name="TCMChildKey">
<short/> <short>Not used in the current LCL implementation.</short>
<descr/> <descr/>
<seealso/> <seealso/>
</element> </element>