Class twidget

Description

Hierarchy

Fields

Methods

Properties

Unit

msegui

Declaration

type twidget = class(tactcomponent, iscrollframe, iface, iassistiveclient)

Description

This item has no description. Showing description inherited from tmsecomponent.

Extends the FPC tcomponent with object linking facilities and the like; base of every MSEgui component. This unit, mseclasses, must be added to uses after classes in code that also uses a third-party unit expecting the plain FPC tcomponent (e.g. TPSScript.Create(TComponent)), since MSEgui forks the FPC classes unit.

Hierarchy

Overview

Fields

Protected	`fwidgets: widgetarty;`
Protected	`fnoinvalidate: integer;`
Protected	`fwidgetupdating: integer;`
Protected	`foptionswidget: optionswidgetty;`
Protected	`foptionswidget1: optionswidget1ty;`
Protected	`fparentwidget: twidget;`
Protected	`fanchors: anchorsty;`
Protected	`fwidgetstate: widgetstatesty;`
Protected	`fwidgetstate1: widgetstates1ty;`
Protected	`fcolor: colorty;`
Protected	`fwindow: twindow;`
Protected	`fwidgetrect: rectty;`
Protected	`fparentclientsize: sizety;`
Protected	`fframe: tcustomframe;`
Protected	`fface: tcustomface;`
Protected	`ffont: twidgetfont;`
Protected	`ffontempty: twidgetfontempty;`
Protected	`fhint: msestring;`
Protected	`fdefaultfocuschild: twidget;`

Methods

Protected	`procedure checksizes();`
Protected	`function widgetminsize1: sizety;`
Protected	`function widgetmaxsize1: sizety;`
Protected	`function minclientsize: sizety;`
Protected	`function isdesignwidget(): boolean; virtual;`
Protected	`procedure setdesignwidget();`
Protected	`procedure designmouseevent(var info: moeventinfoty; capture: twidget); virtual;`
Protected	`procedure designkeyevent(const eventkind: eventkindty; var info: keyeventinfoty); virtual;`
Protected	`procedure defineproperties(filer: tfiler); override;`
Protected	`function gethelpcontext: msestring; override;`
Protected	`class function classskininfo: skininfoty; override;`
Protected	`function skininfo: skininfoty; override;`
Protected	`function hasskin: boolean; override;`
Protected	`function navigstartrect: rectty; virtual;`
Protected	`function navigrect: rectty; virtual;`
Protected	`procedure navigrequest(var info: naviginfoty; const nowrap: boolean = false); virtual;`
Protected	`function navigdistance(var info: naviginfoty; const nowrap: boolean = false): integer; virtual;`
Protected	`function nexttaborderoverride(const sender: twidget; const down: boolean = false): twidget virtual;`
Protected	`function getwidgetrects(const awidgets: array of twidget): rectarty;`
Protected	`procedure setwidgetrects(const awidgets: array of twidget; const arects: rectarty);`
Protected	`procedure updateroot;`
Protected	`procedure setcolor(const avalue: colorty); virtual;`
Protected	`function gethint: msestring; virtual;`
Protected	`procedure sethint(const Value: msestring); virtual;`
Protected	`function ishintstored: boolean; virtual;`
Protected	`function getshowhint: boolean;`
Protected	`procedure showhint(const aid: int32; var info: hintinfoty); virtual;`
Protected	`function isgroupleader: boolean; virtual;`
Protected	`function needsfocuspaint: boolean; virtual;`
Protected	`function needsfocuspaintstate(): boolean;`
Protected	`function getnoscroll(): boolean; virtual;`
Protected	`function getenabled: boolean;`
Protected	`procedure setenabled(const Value: boolean); virtual;`
Protected	`function getvisible: boolean;`
Protected	`procedure setvisible(const avalue: boolean); virtual;`
Protected	`function isvisible: boolean;`
Protected	`function parentisvisible: boolean;`
Protected	`function parentvisible: boolean;`
Protected	`function updateopaque(const children: boolean; const widgetregioncall: boolean): boolean;`
Protected	`procedure dragstarted; virtual;`
Protected	`function getzoomrefframe: framety; virtual;`
Protected	`function getdragrect(const apos: pointty): rectty; virtual;`
Protected	`procedure widgetregioninvalid;`
Protected	`procedure setframeinstance(instance: tcustomframe); virtual;`
Protected	`procedure setstaticframe(value: boolean);`
Protected	`function getstaticframe: boolean;`
Protected	`function getwidgetrect: rectty;`
Protected	`function getcomponentstate: tcomponentstate;`
Protected	`function getframestateflags: framestateflagsty; virtual;`
Protected	`function getwidget: twidget;`
Protected	`function getframe: tcustomframe;`
Protected	`procedure setframe(const avalue: tcustomframe);`
Protected	`function getface: tcustomface;`
Protected	`procedure setface(const avalue: tcustomface);`
Protected	`function getgdi: pgdifunctionaty; virtual;`
Protected	`procedure createwindow; virtual;`
Protected	`procedure objectchanged(const sender: tobject); virtual;`
Protected	`procedure objectevent(const sender: tobject; const event: objecteventty); override;`
Protected	`procedure receiveevent(const event: tobjectevent); override;`
Protected	`procedure setchildorder(child: tcomponent; order: integer); overload; override;`
Protected	`procedure setparentcomponent(value: tcomponent); override;`
Protected	`function clearparentwidget: twidget;`
Protected	`procedure setparentwidget(const Value: twidget); virtual;`
Protected	`procedure setlockedparentwidget(const avalue: twidget);`
Protected	`procedure updatewindowinfo(var info: windowinfoty); virtual;`
Protected	`procedure windowcreated; virtual;`
Protected	`procedure setoptionswidget(const avalue: optionswidgetty); virtual;`
Protected	`procedure setoptionswidget1(const avalue: optionswidget1ty); virtual;`
Protected	`procedure getchildren(proc: tgetchildproc; root: tcomponent); override;`
Protected	`procedure initparentclientsize;`
Protected	`function getcaretcliprect: rectty; virtual;`
Protected	`procedure dobeginread; override;`
Protected	`procedure doendread; override;`
Protected	`procedure loaded; override;`
Protected	`procedure setdesigning(value: boolean; setchildren : boolean = true); override;`
Protected	`procedure updatemousestate(const info: mouseeventinfoty); virtual;`
Protected	`procedure setclientclick;`
Protected	`procedure releasebuttonpressgrab();`
Protected	`procedure registerchildwidget(const child: twidget); virtual;`
Protected	`procedure unregisterchildwidget(const child: twidget); virtual;`
Protected	`function isfontstored: Boolean;`
Protected	`procedure setfont(const avalue: twidgetfont);`
Protected	`function getfont: twidgetfont;`
Protected	`function getfont1: twidgetfont;`
Protected	`function isfontemptystored: Boolean;`
Protected	`procedure setfontempty(const avalue: twidgetfontempty);`
Protected	`function getfontempty: twidgetfontempty;`
Protected	`function getfontempty1: twidgetfontempty;`
Protected	`function getframefont: tfont;`
Protected	`procedure fontchanged; virtual;`
Protected	`procedure fontcanvaschanged; virtual;`
Protected	`procedure updatecursorshape(apos: pointty);`
Protected	`procedure parentclientrectchanged; virtual;`
Protected	`procedure parentwidgetregionchanged(const sender: twidget); virtual;`
Protected	`procedure widgetregionchanged(const sender: twidget); virtual;`
Protected	`procedure scalebasechanged(const sender: twidget); virtual;`
Protected	`procedure ifiwidgetstatechanged;`
Protected	`function getifiwidgetstate: ifiwidgetstatesty; virtual;`
Protected	`procedure cursorchanged;`
Protected	`procedure statechanged; virtual;`
Protected	`procedure enabledchanged; virtual;`
Protected	`procedure activechanged; virtual;`
Protected	`procedure visiblepropchanged; virtual;`
Protected	`procedure visiblechanged; virtual;`
Protected	`procedure colorchanged; virtual;`
Protected	`procedure sizechanged; virtual;`
Protected	`procedure getautopaintsize(var asize: sizety); virtual;`
Protected	`procedure getautocellsize(const acanvas: tcanvas; var asize: sizety); virtual;`
Protected	`procedure childclientrectchanged(const sender: twidget); virtual;`
Protected	`procedure childautosizechanged(const sender: twidget); virtual;`
Protected	`procedure poschanged; virtual;`
Protected	`procedure clientrectchanged; virtual;`
Protected	`procedure parentchanged; virtual;`
Protected	`procedure rootchanged(const aflags: rootchangeflagsty); virtual;`
Protected	`function getdefaultfocuschild: twidget; virtual;`
Protected	`procedure setdefaultfocuschild(const value: twidget); virtual;`
Protected	`function trycancelmodal(const newactive: twindow): boolean; virtual;`
Protected	`procedure sortzorder;`
Protected	`function needsdesignframe: boolean; virtual;`
Protected	`function getactface: tcustomface; virtual;`
Protected	`procedure dobeforepaint(const canvas: tcanvas); virtual;`
Protected	`procedure dopaint(const canvas: tcanvas); virtual;`
Protected	`procedure paintbackground(const canvas: tcanvas; const arect: rectty); virtual;`
Protected	`procedure dopaintbackground(const canvas: tcanvas); virtual;`
Protected	`procedure doonpaintbackground(const canvas: tcanvas); virtual;`
Protected	`procedure dobeforepaintforeground(const canvas: tcanvas); virtual;`
Protected	`procedure dopaintforeground(const canvas: tcanvas); virtual;`
Protected	`procedure doonpaint(const canvas: tcanvas); virtual;`
Protected	`procedure paintoverlay(const canvas: tcanvas; const arect: rectty); virtual;`
Protected	`procedure dopaintoverlay(const canvas: tcanvas); virtual;`
Protected	`procedure doafterpaint(const canvas: tcanvas); virtual;`
Protected	`procedure doscroll(const dist: pointty); virtual;`
Protected	`procedure doscrolled(const dist: pointty); virtual;`
Protected	`procedure doloaded() virtual;`
Protected	`procedure dohide() virtual;`
Protected	`procedure doshow() virtual;`
Protected	`procedure doactivate() virtual;`
Protected	`procedure doafteractivate() virtual;`
Protected	`procedure dodeactivate() virtual;`
Protected	`procedure doenter() virtual;`
Protected	`procedure doexit() virtual;`
Protected	`procedure dofocus() virtual;`
Protected	`procedure dodefocus() virtual;`
Protected	`procedure dochildfocused(const sender: twidget); virtual;`
Protected	`procedure dofocuschanged(const oldwidget,newwidget: twidget); virtual;`
Protected	`procedure domousewheelevent(var info: mousewheeleventinfoty); virtual;`
Protected	`function wantmousefocus(const info: mouseeventinfoty): boolean;`
Protected	`procedure reflectmouseevent(var info: mouseeventinfoty);`
Protected	`procedure mouseevent(var info: mouseeventinfoty); virtual;`
Protected	`procedure mousepreview(const sender: twidget; var info: mouseeventinfoty); virtual;`
Protected	`procedure childmouseevent(const sender: twidget; var info: mouseeventinfoty); virtual;`
Protected	`procedure clientmouseevent(var info: mouseeventinfoty); virtual;`
Protected	`procedure mousewheelevent(var info: mousewheeleventinfoty); virtual;`
Protected	`procedure dokeydown1(var info: keyeventinfoty);`
Protected	`procedure dokeydown(var info: keyeventinfoty); virtual;`
Protected	`procedure doshortcut(var info: keyeventinfoty; const sender: twidget); virtual;`
Protected	`function checkfocusshortcut(var info: keyeventinfoty): boolean; virtual;`
Protected	`procedure handlenavigkeys(var info: keyeventinfoty; const nowrap: boolean = false); virtual;`
Protected	`procedure dokeydownaftershortcut(var info: keyeventinfoty); virtual;`
Protected	`procedure dokeyup(var info: keyeventinfoty); virtual;`
Protected	`procedure dofontchanged(const sender: tobject);`
Protected	`procedure setfontheight;`
Protected	`procedure postchildscaled;`
Protected	`function verticalfontheightdelta: boolean; virtual;`
Protected	`procedure dofontheightdelta(var delta: integer); virtual;`
Protected	`procedure syncsinglelinefontheight(const lineheight: boolean = false; const space: integer = 2);`
Protected	`procedure setwidgetrect(const Value: rectty);`
Protected	`procedure internalsetwidgetrect(Value: rectty; const windowevent: boolean); virtual;`
Protected	`function getclientpos: pointty;`
Protected	`function getclientsize: sizety;`
Protected	`procedure setclientsize(const asize: sizety); virtual;`
Protected	`function getclientwidth: integer;`
Protected	`procedure setclientwidth(const avalue: integer);`
Protected	`function getclientheight: integer;`
Protected	`procedure setclientheight(const avalue: integer);`
Protected	`function internalshow(const modallevel: modallevelty; const transientfor: pwindow; const windowevent,nomodalforreset: boolean): modalresultty; virtual;`
Protected	`procedure internalhide(const windowevent: boolean);`
Protected	`function checksubfocus(const aactivate: boolean): boolean; virtual;`
Protected	`function getnextfocus: twidget;`
Protected	`function cantabfocus: boolean;`
Protected	`function getdisprect: rectty; virtual;`
Protected	`function getshrinkpriority: integer; virtual;`
Protected	`procedure tryshrink(const aclientsize: sizety); virtual;`
Protected	`function calcminscrollsize: sizety; virtual;`
Protected	`function getminshrinkpos: pointty; virtual;`
Protected	`function calcminshrinksize: sizety; virtual;`
Protected	`function getcontainer: twidget; virtual;`
Protected	`function getchildwidgets(const index: integer): twidget; virtual;`
Protected	`function getright: integer;`
Protected	`procedure setright(const avalue: integer);`
Protected	`function getbottom: integer;`
Protected	`procedure setbottom(const avalue: integer);`
Protected	`function ownswindow1: boolean;`
Protected	`procedure internalcreateframe; virtual;`
Protected	`procedure internalcreateface; virtual;`
Protected	`function getfontclass: widgetfontclassty; virtual;`
Protected	`function getfontemptyclass: widgetfontemptyclassty; virtual;`
Protected	`procedure internalcreatefont; virtual;`
Protected	`procedure internalcreatefontempty; virtual;`
Protected	`function getclientrect: rectty;`
Protected	`function windowpo: pwindowty;`
Protected	`function canclose1: boolean;`
Protected	`function getiassistiveclient(): iassistiveclient virtual;`
Protected	`function getassistiveparent(): iassistiveclient virtual;`
Protected	`function getassistivewidget(): tobject virtual;`
Protected	`function getassistivename(): msestring virtual;`
Protected	`function getassistivecaption(): msestring virtual;`
Protected	`function getassistivetext(): msestring virtual;`
Protected	`function getassistivecaretindex(): int32 virtual;`
Protected	`function getassistivehint(): msestring virtual;`
Protected	`function getassistiveflags(): assistiveflagsty virtual;`
Protected	`function getifidatalinkintf(): iifidatalink virtual;`
Public	`constructor create(aowner: tcomponent); overload; override;`
Public	`constructor create(const aowner: tcomponent; const aparentwidget: twidget); overload;`
Public	`constructor create(const aowner: tcomponent; const aparentwidget: twidget; const aiswidget: boolean); overload;`
Public	`constructor createandinit(const aowner: tcomponent; const aparentwidget: twidget; const aiswidget: boolean); overload;`
Public	`destructor destroy; override;`
Public	`procedure afterconstruction; override;`
Public	`procedure initnewcomponent(const ascale: real); override;`
Public	`procedure initnewwidget(const ascale: real); virtual;`
Public	`procedure createframe;`
Public	`procedure createface;`
Public	`procedure createfont;`
Public	`procedure createfontempty;`
Public	`procedure checkautosize();`
Public	`procedure updatehotkeys() virtual;`
Public	`function isloading: boolean;`
Public	`procedure beginupdate;`
Public	`procedure endupdate;`
Public	`function canmouseinteract: boolean;`
Public	`function canassistive(): boolean virtual;`
Public	`function widgetstate: widgetstatesty;`
Public	`function hasparent: boolean; override;`
Public	`function getparentcomponent: tcomponent; override;`
Public	`function hascaret: boolean;`
Public	`function canwindow: boolean;`
Public	`function windowallocated: boolean;`
Public	`function ownswindow: boolean;`
Public	`function updaterect: rectty;`
Public	`procedure beforeclosequery(var amodalresult: modalresultty); virtual;`
Public	`function canclose(const newfocus: twidget = nil): boolean; virtual;`
Public	`function canparentclose(const newfocus: twidget): boolean; overload;`
Public	`function forceclose: boolean;`
Public	`function canparentclose: boolean; overload;`
Public	`function canfocus: boolean; virtual;`
Public	`function setfocus(aactivate: boolean = true): boolean; virtual;`
Public	`procedure parentfocus;`
Public	`procedure nextfocus;`
Public	`function findtabfocus(const ataborder: integer): twidget;`
Public	`function firsttabfocus: twidget;`
Public	`function lasttabfocus: twidget;`
Public	`function nexttaborder(const down: boolean = false; nowrap: boolean = false): twidget;`
Public	`function focusback(const aactivate: boolean = true): boolean; virtual;`
Public	`function parentcolor: colorty;`
Public	`function actualcolor: colorty; virtual;`
Public	`function actualopaquecolor: colorty; virtual;`
Public	`function backgroundcolor: colorty;`
Public	`function translatecolor(const acolor: colorty): colorty;`
Public	`procedure widgetevent(const event: twidgetevent); virtual;`
Public	`procedure sendwidgetevent(const event: twidgetevent);`
Public	`procedure release(const nomodaldefer: boolean=false); override;`
Public	`function show(const modallevel: modallevelty; const transientfor: twindow = nil): modalresultty; overload; virtual;`
Public	`function show(const modallevel: modallevelty; const transientfor: twidget): modalresultty; overload;`
Public	`function show(const modal: boolean = false; const transientfor: twindow = nil): modalresultty; overload;`
Public	`procedure endmodal;`
Public	`procedure hide;`
Public	`procedure activate(const abringtofront: boolean = true; const aforce: boolean = false); virtual;`
Public	`procedure bringtofront;`
Public	`procedure sendtoback;`
Public	`procedure stackunder(const predecessor: twidget);`
Public	`procedure setchildorder(const achildren: widgetarty); overload;`
Public	`procedure paint(const canvas: tcanvas); virtual;`
Public	`procedure update; virtual;`
Public	`procedure scrollwidgets(const dist: pointty);`
Public	`procedure scrollrect(const dist: pointty; const rect: rectty; scrollcaret: boolean);`
Public	`procedure scroll(const dist: pointty);`
Public	`procedure clampinview(const arect: rectty; const bottomright: boolean = false); virtual;`
Public	`procedure getcaret;`
Public	`procedure scrollcaret(const dist: pointty);`
Public	`function mousecaptured: boolean;`
Public	`function capturemouse(grab: boolean = true): boolean;`
Public	`procedure releasemouse(const grab: boolean = false);`
Public	`function capturekeyboard: boolean;`
Public	`procedure releasekeyboard;`
Public	`procedure synctofontheight; virtual;`
Public	`procedure dragevent(var info: draginfoty); virtual;`
Public	`procedure dolayout(const sender: twidget); virtual;`
Public	`procedure invalidatewidget;`
Public	`procedure invalidate;`
Public	`procedure invalidaterect(const rect: rectty; const org: originty = org_client; const noclip: boolean = false);`
Public	`procedure invalidateframestate;`
Public	`procedure invalidateframestaterect(const rect: rectty; const aframe: tcustomframe; const org: originty = org_client);`
Public	`function hasoverlappingsiblings(arect: rectty): boolean;`
Public	`function window: twindow;`
Public	`function rootwidget: twidget;`
Public	`function parentofcontainer: twidget;`
Public	`function getrootwidgetpath: widgetarty;`
Public	`function widgetcount: integer;`
Public	`function parentwidgetindex: integer;`
Public	`function indexofwidget(const awidget: twidget): integer;`
Public	`function checkdescendent(awidget: twidget): boolean;`
Public	`function checkancestor(awidget: twidget): boolean;`
Public	`function containswidget(awidget: twidget): boolean;`
Public	`function widgetatpos(var info: widgetatposinfoty): twidget; overload;`
Public	`function widgetatpos(const pos: pointty): twidget; overload;`
Public	`function widgetatpos(const pos: pointty; const state: widgetstatesty): twidget; overload;`
Public	`function containeroffset: pointty;`
Public	`function childrencount: integer; virtual;`
Public	`function visiblechildrencount: integer;`
Public	`function findtagchild(const atag: integer; const aclass: widgetclassty): twidget;`
Public	`function findchild(const aname: ansistring): twidget;`
Public	`function childatpos(const pos: pointty; const clientorigin: boolean = true): twidget; virtual;`
Public	`function gettaborderedwidgets: widgetarty;`
Public	`function getvisiblewidgets: widgetarty;`
Public	`function getcornerwidget(const side: graphicdirectionty; const visibleonly: boolean): twidget;`
Public	`function getsortxchildren(const banded: boolean = false): widgetarty;`
Public	`function getsortychildren(const banded: boolean = false): widgetarty;`
Public	`function getlogicalchildren: widgetarty; virtual;`
Public	`procedure addlogicalchildren(var achildren: widgetarty);`
Public	`function findlogicalchild(const aname: ansistring): twidget;`
Public	`function enteredchild(): twidget;`
Public	`function mouseeventwidget(const info: mouseeventinfoty): twidget;`
Public	`procedure insertwidget(const awidget: twidget); overload;`
Public	`procedure insertwidget(const awidget: twidget; const apos: pointty); overload; virtual;`
Public	`function iswidgetclick(const info: mouseeventinfoty; const caption: boolean = false): boolean;`
Public	`function iswidgetdblclick(const info: mouseeventinfoty; const caption: boolean = false): boolean;`
Public	`function iswidgetdblclicked(const info: mouseeventinfoty; const caption: boolean = false): boolean;`
Public	`function isclick(const info: mouseeventinfoty): boolean;`
Public	`function isdblclick(const info: mouseeventinfoty): boolean;`
Public	`function isdblclicked(const info: mouseeventinfoty): boolean;`
Public	`function isleftbuttondown(const info: mouseeventinfoty): boolean; overload;`
Public	`function isleftbuttondown(const info: mouseeventinfoty; const akeyshiftstate: shiftstatesty): boolean; overload;`
Public	`function widgetmousepos(const ainfo: mouseeventinfoty): pointty;`
Public	`function rootpos: pointty;`
Public	`function rootwidgetrect: rectty;`
Public	`function clientpostowidgetpos(const apos: pointty): pointty;`
Public	`function widgetpostoclientpos(const apos: pointty): pointty;`
Public	`function widgetpostopaintpos(const apos: pointty): pointty;`
Public	`function paintpostowidgetpos(const apos: pointty): pointty;`
Public	`procedure scale(const ascale: real); virtual;`
Public	`function widgetscreenrect: rectty;`
Public	`function widgetclientrect: rectty;`
Public	`function widgetminsize: sizety;`
Public	`function widgetmaxsize: sizety;`
Public	`function maxclientsize: sizety; virtual;`
Public	`function minscrollsize: sizety;`
Public	`function minshrinksize: sizety;`
Public	`procedure setclippedwidgetrect(arect: rectty);`
Public	`function framedim: sizety;`
Public	`function framedimnoscrollbar: sizety;`
Public	`function clientframewidth: sizety;`
Public	`function innerclientframewidth: sizety;`
Public	`function innerframewidth: sizety;`
Public	`function framerect: rectty;`
Public	`function framepos: pointty;`
Public	`function frameinnerrect: rectty;`
Public	`function paintrect: rectty;`
Public	`function paintclientrect: rectty;`
Public	`function paintpos: pointty;`
Public	`function clippedpaintrect: rectty;`
Public	`function innerpaintrect: rectty;`
Public	`procedure setanchordwidgetsize(const asize: sizety);`
Public	`function widgetsizerect: rectty;`
Public	`function paintsizerect: rectty;`
Public	`function clientsizerect: rectty;`
Public	`function containerclientsizerect: rectty;`
Public	`procedure changeclientsize(const delta: sizety);`
Public	`function clientwidgetrect: rectty;`
Public	`function clientwidgetpos: pointty;`
Public	`function clientparentpos: pointty;`
Public	`function paintparentrect: rectty;`
Public	`function paintparentpos: pointty;`
Public	`function parentpaintpos: pointty;`
Public	`function refpos(const aorigin: originty): pointty;`
Public	`function paintrectparent: rectty;`
Public	`function clientrectparent: rectty;`
Public	`function innerparentrect: rectty;`
Public	`function innerwidgetrect: rectty;`
Public	`function innerclientrect: rectty;`
Public	`function innerclientsize: sizety;`
Public	`function innerclientpos: pointty;`
Public	`function innerclientframe: framety;`
Public	`function innerclientpaintpos: pointty;`
Public	`function innerclientwidgetpos: pointty;`
Public	`procedure innertopaintsize(var asize: sizety);`
Public	`procedure outertopaintsize(var asize: sizety);`
Public	`procedure painttowidgetsize(var asize: sizety);`
Public	`procedure widgettopaintsize(var asize: sizety);`
Public	`function getcanvas(aorigin: originty = org_client): tcanvas;`
Public	`function showing: boolean;`
Public	`function isenabled: boolean;`
Public	`function active: boolean;`
Public	`function entered: boolean;`
Public	`function activeentered: boolean;`
Public	`function activefocused(): boolean;`
Public	`function focused: boolean;`
Public	`function clicked: boolean;`
Public	`procedure changedirection(const avalue: graphicdirectionty; var dest: graphicdirectionty); virtual;`
Public	`procedure placexorder(const startx: integer; const dist: array of integer; const awidgets: array of twidget; const endmargin: integer = minint);`
Public	`procedure placeyorder(const starty: integer; const dist: array of integer; const awidgets: array of twidget; const endmargin: integer = minint);`
Public	`function alignx(const mode: widgetalignmodety; const awidgets: array of twidget; const glue: widgetalignmodety = wam_none; const margin: integer = 0): integer;`
Public	`function aligny(const mode: widgetalignmodety; const awidgets: array of twidget; const glue: widgetalignmodety = wam_none; const margin: integer = 0): integer;`
Public	`function actualcursor(const apos: pointty): cursorshapety; virtual;`

Properties

Public	`property widgetstate1: widgetstates1ty read fwidgetstate1;`
Public	`property parentwidget: twidget read fparentwidget write setparentwidget;`
Public	`property widgets[const index: integer]: twidget read getwidgets;`
Public	`property container: twidget read getcontainer;`
Public	`property children[const index: integer]: twidget read getchildwidgets; default;`
Public	`property focusedchild: twidget read ffocusedchild;`
Public	`property focusedchildbefore: twidget read ffocusedchildbefore;`
Public	`property screenpos: pointty read getscreenpos write setscreenpos;`
Public	`property widgetrect: rectty read fwidgetrect write setwidgetrect;`
Public	`property pos: pointty read fwidgetrect.pos write setpos;`
Public	`property size: sizety read fwidgetrect.size write setsize;`
Public	`property minsize: sizety read fminsize write setminsize;`
Public	`property maxsize: sizety read fmaxsize write setmaxsize;`
Public	`property bounds_x: integer read fwidgetrect.x write setbounds_x;`
Public	`property bounds_y: integer read fwidgetrect.y write setbounds_y;`
Public	`property bounds_cx: integer read fwidgetrect.cx write setbounds_cx stored true;`
Public	`property bounds_cy: integer read fwidgetrect.cy write setbounds_cy stored true;`
Public	`property bounds_cxmin: integer read fminsize.cx write setbounds_cxmin default 0;`
Public	`property bounds_cymin: integer read fminsize.cy write setbounds_cymin default 0;`
Public	`property bounds_cxmax: integer read fmaxsize.cx write setbounds_cxmax default 0;`
Public	`property bounds_cymax: integer read fmaxsize.cy write setbounds_cymax default 0;`
Public	`property left: integer read fwidgetrect.x write setbounds_x;`
Public	`property right: integer read getright write setright;`
Public	`property top: integer read fwidgetrect.y write setbounds_y;`
Public	`property bottom: integer read getbottom write setbottom;`
Public	`property width: integer read fwidgetrect.cx write setbounds_cx;`
Public	`property height: integer read fwidgetrect.cy write setbounds_cy;`
Public	`property anchors: anchorsty read fanchors write setanchors default defaultanchors;`
Public	`property defaultfocuschild: twidget read getdefaultfocuschild write setdefaultfocuschild;`
Public	`property framesize: sizety read getframesize write setframesize;`
Public	`property framewidth: integer read geframewidth write setframewidth;`
Public	`property frameheight: integer read getframeheight write setframeheight;`
Public	`property paintsize: sizety read getpaintsize write setpaintsize;`
Public	`property paintwidth: integer read getpaintwidth write setpaintwidth;`
Public	`property paintheight: integer read getpaintheight write setpaintheight;`
Public	`property clientrect: rectty read getclientrect;`
Public	`property clientsize: sizety read getclientsize write setclientsize;`
Public	`property clientwidth: integer read getclientwidth write setclientwidth;`
Public	`property clientheight: integer read getclientheight write setclientheight;`
Public	`property clientpos: pointty read getclientpos;`
Public	`property parentclientpos: pointty read getparentclientpos write setparentclientpos;`
Public	`property frame: tcustomframe read getframe write setframe;`
Public	`property face: tcustomface read getface write setface;`
Public	`property optionswidget: optionswidgetty read foptionswidget write setoptionswidget default defaultoptionswidget;`
Public	`property optionswidget1: optionswidget1ty read foptionswidget1 write setoptionswidget1 default defaultoptionswidget1;`
Public	`property optionsskin: optionsskinty read foptionsskin write setoptionsskin default [];`
Public	`property cursor: cursorshapety read fcursor write setcursor default cr_default;`
Public	`property color: colorty read fcolor write setcolor default defaultwidgetcolor;`
Public	`property visible: boolean read getvisible write setvisible default true;`
Public	`property enabled: boolean read getenabled write setenabled default true;`
Public	`property taborder: integer read ftaborder write settaborder default 0;`
Public	`property hint: msestring read gethint write sethint stored ishintstored;`
Public	`property zorder: integer read getzorder write setzorder;`
Published	`property onnavigrequest: navigrequesteventty read fonnavigrequest write fonnavigrequest;`
Published	`property skingroup: integer read fskingroup write fskingroup default 0;`
Published	`property onbeforeupdateskin;`
Published	`property onafterupdateskin;`

Description

Fields

Protected	`fwidgets: widgetarty;`
This item has no description.

Protected	`fnoinvalidate: integer;`
This item has no description.

Protected	`fwidgetupdating: integer;`
This item has no description.

Protected	`foptionswidget: optionswidgetty;`
This item has no description.

Protected	`foptionswidget1: optionswidget1ty;`
This item has no description.

Protected	`fparentwidget: twidget;`
This item has no description.

Protected	`fanchors: anchorsty;`
This item has no description.

Protected	`fwidgetstate: widgetstatesty;`
This item has no description.

Protected	`fwidgetstate1: widgetstates1ty;`
This item has no description.

Protected	`fcolor: colorty;`
This item has no description.

Protected	`fwindow: twindow;`
This item has no description.

Protected	`fwidgetrect: rectty;`
This item has no description.

Protected	`fparentclientsize: sizety;`
This item has no description.

Protected	`fframe: tcustomframe;`
This item has no description.

Protected	`fface: tcustomface;`
This item has no description.

Protected	`ffont: twidgetfont;`
This item has no description.

Protected	`ffontempty: twidgetfontempty;`
This item has no description.

Protected	`fhint: msestring;`
This item has no description.

Protected	`fdefaultfocuschild: twidget;`
This item has no description.

Methods

Protected	`procedure checksizes();`
This item has no description.

Protected	`function widgetminsize1: sizety;`
This item has no description.

Protected	`function widgetmaxsize1: sizety;`
This item has no description.

Protected	`function minclientsize: sizety;`
This item has no description.

Protected	`function isdesignwidget(): boolean; virtual;`
This item has no description.

Protected	`procedure setdesignwidget();`
This item has no description.

Protected	`procedure designmouseevent(var info: moeventinfoty; capture: twidget); virtual;`
This item has no description.

Protected	`procedure designkeyevent(const eventkind: eventkindty; var info: keyeventinfoty); virtual;`
This item has no description.

Protected	`procedure defineproperties(filer: tfiler); override;`
This item has no description.

Protected	`function gethelpcontext: msestring; override;`
This item has no description.

Protected	`class function classskininfo: skininfoty; override;`
This item has no description.

Protected	`function skininfo: skininfoty; override;`
This item has no description.

Protected	`function hasskin: boolean; override;`
This item has no description.

Protected	`function navigstartrect: rectty; virtual;`
This item has no description.

Protected	`function navigrect: rectty; virtual;`
This item has no description.

Protected	`procedure navigrequest(var info: naviginfoty; const nowrap: boolean = false); virtual;`
This item has no description.

Protected	`function navigdistance(var info: naviginfoty; const nowrap: boolean = false): integer; virtual;`
This item has no description.

Protected	`function nexttaborderoverride(const sender: twidget; const down: boolean = false): twidget virtual;`
This item has no description.

Protected	`function getwidgetrects(const awidgets: array of twidget): rectarty;`
This item has no description.

Protected	`procedure setwidgetrects(const awidgets: array of twidget; const arects: rectarty);`
This item has no description.

Protected	`procedure updateroot;`
This item has no description.

Protected	`procedure setcolor(const avalue: colorty); virtual;`
This item has no description.

Protected	`function gethint: msestring; virtual;`
This item has no description.

Protected	`procedure sethint(const Value: msestring); virtual;`
This item has no description.

Protected	`function ishintstored: boolean; virtual;`
This item has no description.

Protected	`function getshowhint: boolean;`
This item has no description.

Protected	`procedure showhint(const aid: int32; var info: hintinfoty); virtual;`
This item has no description.

Protected	`function isgroupleader: boolean; virtual;`
This item has no description.

Protected	`function needsfocuspaint: boolean; virtual;`
This item has no description.

Protected	`function needsfocuspaintstate(): boolean;`
This item has no description.

Protected	`function getnoscroll(): boolean; virtual;`
This item has no description.

Protected	`function getenabled: boolean;`
This item has no description.

Protected	`procedure setenabled(const Value: boolean); virtual;`
This item has no description.

Protected	`function getvisible: boolean;`
This item has no description.

Protected	`procedure setvisible(const avalue: boolean); virtual;`
This item has no description.

Protected	`function isvisible: boolean;`
This item has no description.

Protected	`function parentisvisible: boolean;`
This item has no description.

Protected	`function parentvisible: boolean;`
This item has no description.

Protected	`function updateopaque(const children: boolean; const widgetregioncall: boolean): boolean;`
This item has no description.

Protected	`procedure dragstarted; virtual;`
This item has no description.

Protected	`function getzoomrefframe: framety; virtual;`
This item has no description.

Protected	`function getdragrect(const apos: pointty): rectty; virtual;`
This item has no description.

Protected	`procedure widgetregioninvalid;`
This item has no description.

Protected	`procedure setframeinstance(instance: tcustomframe); virtual;`
This item has no description.

Protected	`procedure setstaticframe(value: boolean);`
This item has no description.

Protected	`function getstaticframe: boolean;`
This item has no description.

Protected	`function getwidgetrect: rectty;`
This item has no description.

Protected	`function getcomponentstate: tcomponentstate;`
This item has no description.

Protected	`function getframestateflags: framestateflagsty; virtual;`
This item has no description.

Protected	`function getwidget: twidget;`
This item has no description.

Protected	`function getframe: tcustomframe;`
This item has no description.

Protected	`procedure setframe(const avalue: tcustomframe);`
This item has no description.

Protected	`function getface: tcustomface;`
This item has no description.

Protected	`procedure setface(const avalue: tcustomface);`
This item has no description.

Protected	`function getgdi: pgdifunctionaty; virtual;`
This item has no description.

Protected	`procedure createwindow; virtual;`
This item has no description.

Protected	`procedure objectchanged(const sender: tobject); virtual;`
This item has no description.

Protected	`procedure objectevent(const sender: tobject; const event: objecteventty); override;`
This item has no description.

Protected	`procedure receiveevent(const event: tobjectevent); override;`
This item has no description.

Protected	`procedure setchildorder(child: tcomponent; order: integer); overload; override;`
This item has no description.

Protected	`procedure setparentcomponent(value: tcomponent); override;`
This item has no description.

Protected	`function clearparentwidget: twidget;`
This item has no description.

Protected	`procedure setparentwidget(const Value: twidget); virtual;`
This item has no description.

Protected	`procedure setlockedparentwidget(const avalue: twidget);`
This item has no description.

Protected	`procedure updatewindowinfo(var info: windowinfoty); virtual;`
This item has no description.

Protected	`procedure windowcreated; virtual;`
This item has no description.

Protected	`procedure setoptionswidget(const avalue: optionswidgetty); virtual;`
This item has no description.

Protected	`procedure setoptionswidget1(const avalue: optionswidget1ty); virtual;`
This item has no description.

Protected	`procedure getchildren(proc: tgetchildproc; root: tcomponent); override;`
This item has no description.

Protected	`procedure initparentclientsize;`
This item has no description.

Protected	`function getcaretcliprect: rectty; virtual;`
This item has no description.

Protected	`procedure dobeginread; override;`
This item has no description.

Protected	`procedure doendread; override;`
This item has no description.

Protected	`procedure loaded; override;`
This item has no description.

Protected	`procedure setdesigning(value: boolean; setchildren : boolean = true); override;`
This item has no description.

Protected	`procedure updatemousestate(const info: mouseeventinfoty); virtual;`
This item has no description.

Protected	`procedure setclientclick;`
This item has no description.

Protected	`procedure releasebuttonpressgrab();`
This item has no description.

Protected	`procedure registerchildwidget(const child: twidget); virtual;`
This item has no description.

Protected	`procedure unregisterchildwidget(const child: twidget); virtual;`
This item has no description.

Protected	`function isfontstored: Boolean;`
This item has no description.

Protected	`procedure setfont(const avalue: twidgetfont);`
This item has no description.

Protected	`function getfont: twidgetfont;`
This item has no description.

Protected	`function getfont1: twidgetfont;`
This item has no description.

Protected	`function isfontemptystored: Boolean;`
This item has no description.

Protected	`procedure setfontempty(const avalue: twidgetfontempty);`
This item has no description.

Protected	`function getfontempty: twidgetfontempty;`
This item has no description.

Protected	`function getfontempty1: twidgetfontempty;`
This item has no description.

Protected	`function getframefont: tfont;`
This item has no description.

Protected	`procedure fontchanged; virtual;`
This item has no description.

Protected	`procedure fontcanvaschanged; virtual;`
This item has no description.

Protected	`procedure updatecursorshape(apos: pointty);`
This item has no description.

Protected	`procedure parentclientrectchanged; virtual;`
This item has no description.

Protected	`procedure parentwidgetregionchanged(const sender: twidget); virtual;`
This item has no description.

Protected	`procedure widgetregionchanged(const sender: twidget); virtual;`
This item has no description.

Protected	`procedure scalebasechanged(const sender: twidget); virtual;`
This item has no description.

Protected	`procedure ifiwidgetstatechanged;`
This item has no description.

Protected	`function getifiwidgetstate: ifiwidgetstatesty; virtual;`
This item has no description.

Protected	`procedure cursorchanged;`
This item has no description.

Protected	`procedure statechanged; virtual;`
This item has no description.

Protected	`procedure enabledchanged; virtual;`
This item has no description.

Protected	`procedure activechanged; virtual;`
This item has no description.

Protected	`procedure visiblepropchanged; virtual;`
This item has no description.

Protected	`procedure visiblechanged; virtual;`
This item has no description.

Protected	`procedure colorchanged; virtual;`
This item has no description.

Protected	`procedure sizechanged; virtual;`
This item has no description.

Protected	`procedure getautopaintsize(var asize: sizety); virtual;`
This item has no description.

Protected	`procedure getautocellsize(const acanvas: tcanvas; var asize: sizety); virtual;`
This item has no description.

Protected	`procedure childclientrectchanged(const sender: twidget); virtual;`
This item has no description.

Protected	`procedure childautosizechanged(const sender: twidget); virtual;`
This item has no description.

Protected	`procedure poschanged; virtual;`
This item has no description.

Protected	`procedure clientrectchanged; virtual;`
This item has no description.

Protected	`procedure parentchanged; virtual;`
This item has no description.

Protected	`procedure rootchanged(const aflags: rootchangeflagsty); virtual;`
This item has no description.

Protected	`function getdefaultfocuschild: twidget; virtual;`
This item has no description.

Protected	`procedure setdefaultfocuschild(const value: twidget); virtual;`
This item has no description.

Protected	`function trycancelmodal(const newactive: twindow): boolean; virtual;`
This item has no description.

Protected	`procedure sortzorder;`
This item has no description.

Protected	`function needsdesignframe: boolean; virtual;`
This item has no description.

Protected	`function getactface: tcustomface; virtual;`
This item has no description.

Protected	`procedure dobeforepaint(const canvas: tcanvas); virtual;`
This item has no description.

Protected	`procedure dopaint(const canvas: tcanvas); virtual;`
Override `dopaint` in a widget descendant to implement custom drawing for that widget class, instead of using the `onpaint` event (meant for occasional per-instance drawing on top of the standard rendering). Most widgets can already be customized without overriding anything, through their `frame` and `face` properties (see `tframetemplate`/`tfacetemplate` to centralize such customizations).

Protected	`procedure paintbackground(const canvas: tcanvas; const arect: rectty); virtual;`
This item has no description.

Protected	`procedure dopaintbackground(const canvas: tcanvas); virtual;`
This item has no description.

Protected	`procedure doonpaintbackground(const canvas: tcanvas); virtual;`
This item has no description.

Protected	`procedure dobeforepaintforeground(const canvas: tcanvas); virtual;`
This item has no description.

Protected	`procedure dopaintforeground(const canvas: tcanvas); virtual;`
This item has no description.

Protected	`procedure doonpaint(const canvas: tcanvas); virtual;`
This item has no description.

Protected	`procedure paintoverlay(const canvas: tcanvas; const arect: rectty); virtual;`
This item has no description.

Protected	`procedure dopaintoverlay(const canvas: tcanvas); virtual;`
This item has no description.

Protected	`procedure doafterpaint(const canvas: tcanvas); virtual;`
Override `doafterpaint` to draw over the widget's child widgets, after they have painted.

Protected	`procedure doscroll(const dist: pointty); virtual;`
This item has no description.

Protected	`procedure doscrolled(const dist: pointty); virtual;`
This item has no description.

Protected	`procedure doloaded() virtual;`
This item has no description.

Protected	`procedure dohide() virtual;`
This item has no description.

Protected	`procedure doshow() virtual;`
This item has no description.

Protected	`procedure doactivate() virtual;`
This item has no description.

Protected	`procedure doafteractivate() virtual;`
This item has no description.

Protected	`procedure dodeactivate() virtual;`
This item has no description.

Protected	`procedure doenter() virtual;`
This item has no description.

Protected	`procedure doexit() virtual;`
This item has no description.

Protected	`procedure dofocus() virtual;`
This item has no description.

Protected	`procedure dodefocus() virtual;`
This item has no description.

Protected	`procedure dochildfocused(const sender: twidget); virtual;`
This item has no description.

Protected	`procedure dofocuschanged(const oldwidget,newwidget: twidget); virtual;`
This item has no description.

Protected	`procedure domousewheelevent(var info: mousewheeleventinfoty); virtual;`
This item has no description.

Protected	`function wantmousefocus(const info: mouseeventinfoty): boolean;`
This item has no description.

Protected	`procedure reflectmouseevent(var info: mouseeventinfoty);`
This item has no description.

Protected	`procedure mouseevent(var info: mouseeventinfoty); virtual;`
This item has no description.

Protected	`procedure mousepreview(const sender: twidget; var info: mouseeventinfoty); virtual;`
This item has no description.

Protected	`procedure childmouseevent(const sender: twidget; var info: mouseeventinfoty); virtual;`
This item has no description.

Protected	`procedure clientmouseevent(var info: mouseeventinfoty); virtual;`
This item has no description.

Protected	`procedure mousewheelevent(var info: mousewheeleventinfoty); virtual;`
This item has no description.

Protected	`procedure dokeydown1(var info: keyeventinfoty);`
This item has no description.

Protected	`procedure dokeydown(var info: keyeventinfoty); virtual;`
This item has no description.

Protected procedure doshortcut(var info: keyeventinfoty; const sender: twidget); virtual;

Simplified key event propagation: an unhandled key first goes through dokeydown of the focused widget, then of its parents (dokeydown of the parent is called with es_child set). If still unhandled, doshortcut is tried: siblings and children first, then (unless ow_nochildshortcut is set) the parent widget — a widget with ow_noparentshortcut ignores a call coming from its parent. If no widget handled it, the window's own doshortcut first checks tcustomactions with ao_localshortcut set whose owner is an ancestor of the widget that received the key; if still unhandled and tws_localshortcuts is not set on the window, application.checkshortcut calls doshortcut of all windows, and then of all actions with ao_globalshortcut set. Finally, unhandled navigation keys are processed by dokeydownaftershortcut, again propagated to parents. Recursion is avoided by always calling top-down.

Protected	`function checkfocusshortcut(var info: keyeventinfoty): boolean; virtual;`
This item has no description.

Protected	`procedure handlenavigkeys(var info: keyeventinfoty; const nowrap: boolean = false); virtual;`
This item has no description.

Protected	`procedure dokeydownaftershortcut(var info: keyeventinfoty); virtual;`
This item has no description.

Protected	`procedure dokeyup(var info: keyeventinfoty); virtual;`
This item has no description.

Protected	`procedure dofontchanged(const sender: tobject);`
This item has no description.

Protected	`procedure setfontheight;`
This item has no description.

Protected	`procedure postchildscaled;`
This item has no description.

Protected	`function verticalfontheightdelta: boolean; virtual;`
This item has no description.

Protected	`procedure dofontheightdelta(var delta: integer); virtual;`
This item has no description.

Protected	`procedure syncsinglelinefontheight(const lineheight: boolean = false; const space: integer = 2);`
This item has no description.

Protected	`procedure setwidgetrect(const Value: rectty);`
This item has no description.

Protected	`procedure internalsetwidgetrect(Value: rectty; const windowevent: boolean); virtual;`
This item has no description.

Protected	`function getclientpos: pointty;`
This item has no description.

Protected	`function getclientsize: sizety;`
This item has no description.

Protected	`procedure setclientsize(const asize: sizety); virtual;`
This item has no description.

Protected	`function getclientwidth: integer;`
This item has no description.

Protected	`procedure setclientwidth(const avalue: integer);`
This item has no description.

Protected	`function getclientheight: integer;`
This item has no description.

Protected	`procedure setclientheight(const avalue: integer);`
This item has no description.

Protected	`function internalshow(const modallevel: modallevelty; const transientfor: pwindow; const windowevent,nomodalforreset: boolean): modalresultty; virtual;`
This item has no description.

Protected	`procedure internalhide(const windowevent: boolean);`
This item has no description.

Protected	`function checksubfocus(const aactivate: boolean): boolean; virtual;`
This item has no description.

Protected	`function getnextfocus: twidget;`
This item has no description.

Protected	`function cantabfocus: boolean;`
This item has no description.

Protected	`function getdisprect: rectty; virtual;`
This item has no description.

Protected	`function getshrinkpriority: integer; virtual;`
This item has no description.

Protected	`procedure tryshrink(const aclientsize: sizety); virtual;`
This item has no description.

Protected	`function calcminscrollsize: sizety; virtual;`
This item has no description.

Protected	`function getminshrinkpos: pointty; virtual;`
This item has no description.

Protected	`function calcminshrinksize: sizety; virtual;`
This item has no description.

Protected	`function getcontainer: twidget; virtual;`
This item has no description.

Protected	`function getchildwidgets(const index: integer): twidget; virtual;`
This item has no description.

Protected	`function getright: integer;`
This item has no description.

Protected	`procedure setright(const avalue: integer);`
This item has no description.

Protected	`function getbottom: integer;`
This item has no description.

Protected	`procedure setbottom(const avalue: integer);`
This item has no description.

Protected	`function ownswindow1: boolean;`
This item has no description.

Protected	`procedure internalcreateframe; virtual;`
This item has no description.

Protected	`procedure internalcreateface; virtual;`
This item has no description.

Protected	`function getfontclass: widgetfontclassty; virtual;`
This item has no description.

Protected	`function getfontemptyclass: widgetfontemptyclassty; virtual;`
This item has no description.

Protected	`procedure internalcreatefont; virtual;`
This item has no description.

Protected	`procedure internalcreatefontempty; virtual;`
This item has no description.

Protected	`function getclientrect: rectty;`
This item has no description.

Protected	`function windowpo: pwindowty;`
This item has no description.

Protected	`function canclose1: boolean;`
This item has no description.

Protected	`function getiassistiveclient(): iassistiveclient virtual;`
This item has no description.

Protected	`function getassistiveparent(): iassistiveclient virtual;`
This item has no description.

Protected	`function getassistivewidget(): tobject virtual;`
This item has no description.

Protected	`function getassistivename(): msestring virtual;`
This item has no description.

Protected	`function getassistivecaption(): msestring virtual;`
This item has no description.

Protected	`function getassistivetext(): msestring virtual;`
This item has no description.

Protected	`function getassistivecaretindex(): int32 virtual;`
This item has no description.

Protected	`function getassistivehint(): msestring virtual;`
This item has no description.

Protected	`function getassistiveflags(): assistiveflagsty virtual;`
This item has no description.

Protected	`function getifidatalinkintf(): iifidatalink virtual;`
This item has no description.

Public	`constructor create(aowner: tcomponent); overload; override;`
This item has no description.

Public	`constructor create(const aowner: tcomponent; const aparentwidget: twidget); overload;`
This item has no description.

Public	`constructor create(const aowner: tcomponent; const aparentwidget: twidget; const aiswidget: boolean); overload;`
This item has no description.

Public	`constructor createandinit(const aowner: tcomponent; const aparentwidget: twidget; const aiswidget: boolean); overload;`
This item has no description.

Public	`destructor destroy; override;`
This item has no description.

Public	`procedure afterconstruction; override;`
This item has no description.

Public	`procedure initnewcomponent(const ascale: real); override;`
This item has no description.

Public	`procedure initnewwidget(const ascale: real); virtual;`
This item has no description.

Public	`procedure createframe;`
This item has no description.

Public	`procedure createface;`
This item has no description.

Public	`procedure createfont;`
Do not write to `font` if the widget has no own font instance (shown as `<parent>` in the object inspector) — call `createfont` first to give it one.

Public	`procedure createfontempty;`
This item has no description.

Public	`procedure checkautosize();`
This item has no description.

Public	`procedure updatehotkeys() virtual;`
This item has no description.

Public	`function isloading: boolean;`
This item has no description.

Public	`procedure beginupdate;`
This item has no description.

Public	`procedure endupdate;`
This item has no description.

Public	`function canmouseinteract: boolean;`
This item has no description.

Public	`function canassistive(): boolean virtual;`
This item has no description.

Public	`function widgetstate: widgetstatesty;`
This item has no description.

Public	`function hasparent: boolean; override;`
This item has no description.

Public	`function getparentcomponent: tcomponent; override;`
This item has no description.

Public	`function hascaret: boolean;`
This item has no description.

Public	`function canwindow: boolean;`
This item has no description.

Public	`function windowallocated: boolean;`
This item has no description.

Public	`function ownswindow: boolean;`
This item has no description.

Public	`function updaterect: rectty;`
This item has no description.

Public	`procedure beforeclosequery(var amodalresult: modalresultty); virtual;`
This item has no description.

Public	`function canclose(const newfocus: twidget = nil): boolean; virtual;`
This item has no description.

Public function canparentclose(const newfocus: twidget): boolean; overload;

Checks whether all descendant widgets accept losing focus, without raising onclosequery: the currently focused widget is checked first with canclose if it is a descendant, then the remaining descendants. window.owner addresses the top level widget; if it is a tcustomform, window.owner.container.canparentclose checks all widgets of the form and does not fire onclosequery (window.owner.canparentclose does).

Public	`function forceclose: boolean;`
This item has no description.

Public	`function canparentclose: boolean; overload;`
This item has no description.

Public	`function canfocus: boolean; virtual;`
This item has no description.

Public	`function setfocus(aactivate: boolean = true): boolean; virtual;`
This item has no description.

Public	`procedure parentfocus;`
This item has no description.

Public	`procedure nextfocus;`
This item has no description.

Public	`function findtabfocus(const ataborder: integer): twidget;`
This item has no description.

Public	`function firsttabfocus: twidget;`
This item has no description.

Public	`function lasttabfocus: twidget;`
This item has no description.

Public	`function nexttaborder(const down: boolean = false; nowrap: boolean = false): twidget;`
This item has no description.

Public	`function focusback(const aactivate: boolean = true): boolean; virtual;`
This item has no description.

Public	`function parentcolor: colorty;`
This item has no description.

Public	`function actualcolor: colorty; virtual;`
This item has no description.

Public	`function actualopaquecolor: colorty; virtual;`
This item has no description.

Public	`function backgroundcolor: colorty;`
This item has no description.

Public	`function translatecolor(const acolor: colorty): colorty;`
This item has no description.

Public	`procedure widgetevent(const event: twidgetevent); virtual;`
This item has no description.

Public	`procedure sendwidgetevent(const event: twidgetevent);`
This item has no description.

Public	`procedure release(const nomodaldefer: boolean=false); override;`
Frees the widget. Unlike calling `destroy` or `free` directly, `release` is safe to call from the widget's own event handler.

Public	`function show(const modallevel: modallevelty; const transientfor: twindow = nil): modalresultty; overload; virtual;`
Call `show(true)` to show the widget as a modal window; after it closes, the window manager activates the main form again.

Public	`function show(const modallevel: modallevelty; const transientfor: twidget): modalresultty; overload;`
This item has no description.

Public	`function show(const modal: boolean = false; const transientfor: twindow = nil): modalresultty; overload;`
This item has no description.

Public	`procedure endmodal;`
This item has no description.

Public	`procedure hide;`
This item has no description.

Public	`procedure activate(const abringtofront: boolean = true; const aforce: boolean = false); virtual;`
This item has no description.

Public	`procedure bringtofront;`
This item has no description.

Public	`procedure sendtoback;`
This item has no description.

Public	`procedure stackunder(const predecessor: twidget);`
This item has no description.

Public	`procedure setchildorder(const achildren: widgetarty); overload;`
This item has no description.

Public procedure paint(const canvas: tcanvas); virtual;

invalidate (called automatically, e.g. by setcaption) adds the widget's client area to its window's update region; once the main event queue is empty, the update regions of all windows are painted, widget by widget, bottom-up in z-order, by paint. If the widget's color is not cl_transparent, the area is first filled with that color; then, if active, frame is painted (filling its own client area with colorclient if that is not cl_transparent), then, if active, face; the widget's own content (e.g. a caption) is painted last, on top of that background. When code changes a widget's widgetrect directly rather than through a property that does it automatically, it must invalidate the old widgetrect before the change and the new one after, so both the vacated and the newly covered area get repainted.

Public	`procedure update; virtual;`
This item has no description.

Public	`procedure scrollwidgets(const dist: pointty);`
This item has no description.

Public	`procedure scrollrect(const dist: pointty; const rect: rectty; scrollcaret: boolean);`
This item has no description.

Public	`procedure scroll(const dist: pointty);`
This item has no description.

Public	`procedure clampinview(const arect: rectty; const bottomright: boolean = false); virtual;`
This item has no description.

Public	`procedure getcaret;`
This item has no description.

Public	`procedure scrollcaret(const dist: pointty);`
This item has no description.

Public	`function mousecaptured: boolean;`
This item has no description.

Public	`function capturemouse(grab: boolean = true): boolean;`
This item has no description.

Public	`procedure releasemouse(const grab: boolean = false);`
This item has no description.

Public	`function capturekeyboard: boolean;`
This item has no description.

Public	`procedure releasekeyboard;`
This item has no description.

Public	`procedure synctofontheight; virtual;`
This item has no description.

Public	`procedure dragevent(var info: draginfoty); virtual;`
This item has no description.

Public	`procedure dolayout(const sender: twidget); virtual;`
This item has no description.

Public	`procedure invalidatewidget;`
To force a repaint, escalate as needed: `invalidate` repaints a single widget, `rootwidget.invalidate` repaints its whole window, and `application.invalidate` repaints every window (form) of the application.

Public	`procedure invalidate;`
This item has no description.

Public	`procedure invalidaterect(const rect: rectty; const org: originty = org_client; const noclip: boolean = false);`
This item has no description.

Public	`procedure invalidateframestate;`
This item has no description.

Public	`procedure invalidateframestaterect(const rect: rectty; const aframe: tcustomframe; const org: originty = org_client);`
This item has no description.

Public	`function hasoverlappingsiblings(arect: rectty): boolean;`
This item has no description.

Public	`function window: twindow;`
This item has no description.

Public	`function rootwidget: twidget;`
This item has no description.

Public	`function parentofcontainer: twidget;`
This item has no description.

Public	`function getrootwidgetpath: widgetarty;`
This item has no description.

Public	`function widgetcount: integer;`
This item has no description.

Public	`function parentwidgetindex: integer;`
This item has no description.

Public	`function indexofwidget(const awidget: twidget): integer;`
This item has no description.

Public	`function checkdescendent(awidget: twidget): boolean;`
This item has no description.

Public	`function checkancestor(awidget: twidget): boolean;`
This item has no description.

Public	`function containswidget(awidget: twidget): boolean;`
This item has no description.

Public	`function widgetatpos(var info: widgetatposinfoty): twidget; overload;`
This item has no description.

Public	`function widgetatpos(const pos: pointty): twidget; overload;`
This item has no description.

Public	`function widgetatpos(const pos: pointty; const state: widgetstatesty): twidget; overload;`
This item has no description.

Public	`function containeroffset: pointty;`
This item has no description.

Public	`function childrencount: integer; virtual;`
This item has no description.

Public	`function visiblechildrencount: integer;`
This item has no description.

Public	`function findtagchild(const atag: integer; const aclass: widgetclassty): twidget;`
This item has no description.

Public	`function findchild(const aname: ansistring): twidget;`
This item has no description.

Public	`function childatpos(const pos: pointty; const clientorigin: boolean = true): twidget; virtual;`
This item has no description.

Public	`function gettaborderedwidgets: widgetarty;`
This item has no description.

Public	`function getvisiblewidgets: widgetarty;`
This item has no description.

Public	`function getcornerwidget(const side: graphicdirectionty; const visibleonly: boolean): twidget;`
This item has no description.

Public	`function getsortxchildren(const banded: boolean = false): widgetarty;`
This item has no description.

Public	`function getsortychildren(const banded: boolean = false): widgetarty;`
This item has no description.

Public	`function getlogicalchildren: widgetarty; virtual;`
This item has no description.

Public	`procedure addlogicalchildren(var achildren: widgetarty);`
This item has no description.

Public	`function findlogicalchild(const aname: ansistring): twidget;`
This item has no description.

Public	`function enteredchild(): twidget;`
This item has no description.

Public	`function mouseeventwidget(const info: mouseeventinfoty): twidget;`
This item has no description.

Public	`procedure insertwidget(const awidget: twidget); overload;`
Inserts `awidget` as a child, doing the same initialization as placing it in the form designer would. This differs from assigning `awidget.parentwidget` directly (or setting an editwidget's `editwidget` property "as is"), which does not perform that initialization.

Public	`procedure insertwidget(const awidget: twidget; const apos: pointty); overload; virtual;`
This item has no description.

Public	`function iswidgetclick(const info: mouseeventinfoty; const caption: boolean = false): boolean;`
This item has no description.

Public	`function iswidgetdblclick(const info: mouseeventinfoty; const caption: boolean = false): boolean;`
This item has no description.

Public	`function iswidgetdblclicked(const info: mouseeventinfoty; const caption: boolean = false): boolean;`
This item has no description.

Public	`function isclick(const info: mouseeventinfoty): boolean;`
This item has no description.

Public	`function isdblclick(const info: mouseeventinfoty): boolean;`
This item has no description.

Public	`function isdblclicked(const info: mouseeventinfoty): boolean;`
This item has no description.

Public	`function isleftbuttondown(const info: mouseeventinfoty): boolean; overload;`
This item has no description.

Public	`function isleftbuttondown(const info: mouseeventinfoty; const akeyshiftstate: shiftstatesty): boolean; overload;`
This item has no description.

Public	`function widgetmousepos(const ainfo: mouseeventinfoty): pointty;`
This item has no description.

Public	`function rootpos: pointty;`
This item has no description.

Public	`function rootwidgetrect: rectty;`
This item has no description.

Public	`function clientpostowidgetpos(const apos: pointty): pointty;`
This item has no description.

Public	`function widgetpostoclientpos(const apos: pointty): pointty;`
This item has no description.

Public	`function widgetpostopaintpos(const apos: pointty): pointty;`
This item has no description.

Public	`function paintpostowidgetpos(const apos: pointty): pointty;`
This item has no description.

Public	`procedure scale(const ascale: real); virtual;`
This item has no description.

Public	`function widgetscreenrect: rectty;`
This item has no description.

Public	`function widgetclientrect: rectty;`
This item has no description.

Public	`function widgetminsize: sizety;`
This item has no description.

Public	`function widgetmaxsize: sizety;`
This item has no description.

Public	`function maxclientsize: sizety; virtual;`
This item has no description.

Public	`function minscrollsize: sizety;`
This item has no description.

Public	`function minshrinksize: sizety;`
This item has no description.

Public	`procedure setclippedwidgetrect(arect: rectty);`
This item has no description.

Public	`function framedim: sizety;`
This item has no description.

Public	`function framedimnoscrollbar: sizety;`
This item has no description.

Public	`function clientframewidth: sizety;`
This item has no description.

Public	`function innerclientframewidth: sizety;`
This item has no description.

Public	`function innerframewidth: sizety;`
This item has no description.

Public	`function framerect: rectty;`
This item has no description.

Public	`function framepos: pointty;`
This item has no description.

Public	`function frameinnerrect: rectty;`
This item has no description.

Public	`function paintrect: rectty;`
This item has no description.

Public	`function paintclientrect: rectty;`
This item has no description.

Public	`function paintpos: pointty;`
This item has no description.

Public	`function clippedpaintrect: rectty;`
This item has no description.

Public	`function innerpaintrect: rectty;`
This item has no description.

Public	`procedure setanchordwidgetsize(const asize: sizety);`
This item has no description.

Public	`function widgetsizerect: rectty;`
This item has no description.

Public	`function paintsizerect: rectty;`
This item has no description.

Public	`function clientsizerect: rectty;`
This item has no description.

Public	`function containerclientsizerect: rectty;`
This item has no description.

Public	`procedure changeclientsize(const delta: sizety);`
This item has no description.

Public	`function clientwidgetrect: rectty;`
This item has no description.

Public	`function clientwidgetpos: pointty;`
This item has no description.

Public	`function clientparentpos: pointty;`
This item has no description.

Public	`function paintparentrect: rectty;`
This item has no description.

Public	`function paintparentpos: pointty;`
This item has no description.

Public	`function parentpaintpos: pointty;`
This item has no description.

Public	`function refpos(const aorigin: originty): pointty;`
This item has no description.

Public	`function paintrectparent: rectty;`
This item has no description.

Public	`function clientrectparent: rectty;`
This item has no description.

Public	`function innerparentrect: rectty;`
This item has no description.

Public	`function innerwidgetrect: rectty;`
This item has no description.

Public	`function innerclientrect: rectty;`
This item has no description.

Public	`function innerclientsize: sizety;`
This item has no description.

Public	`function innerclientpos: pointty;`
This item has no description.

Public	`function innerclientframe: framety;`
This item has no description.

Public	`function innerclientpaintpos: pointty;`
This item has no description.

Public	`function innerclientwidgetpos: pointty;`
This item has no description.

Public	`procedure innertopaintsize(var asize: sizety);`
This item has no description.

Public	`procedure outertopaintsize(var asize: sizety);`
This item has no description.

Public	`procedure painttowidgetsize(var asize: sizety);`
This item has no description.

Public	`procedure widgettopaintsize(var asize: sizety);`
This item has no description.

Public	`function getcanvas(aorigin: originty = org_client): tcanvas;`
This item has no description.

Public	`function showing: boolean;`
This item has no description.

Public	`function isenabled: boolean;`
This item has no description.

Public	`function active: boolean;`
This item has no description.

Public	`function entered: boolean;`
This item has no description.

Public	`function activeentered: boolean;`
This item has no description.

Public	`function activefocused(): boolean;`
This item has no description.

Public	`function focused: boolean;`
This item has no description.

Public	`function clicked: boolean;`
This item has no description.

Public	`procedure changedirection(const avalue: graphicdirectionty; var dest: graphicdirectionty); virtual;`
This item has no description.

Public	`procedure placexorder(const startx: integer; const dist: array of integer; const awidgets: array of twidget; const endmargin: integer = minint);`
MSEgui has no built-in layout manager. For simple cases, use anchoring, `tspacer` and `tsplitter` (with `spo_hmove`/`spo_hprop` and/or `spo_vmove`/`spo_vprop`), plus a widget's auto-size capability and font height synchronization. For more complex, code-driven layouts, use the `onchildscaled` event together with `placexorder`, `placeyorder`, `alignx` and `aligny`.

Public	`procedure placeyorder(const starty: integer; const dist: array of integer; const awidgets: array of twidget; const endmargin: integer = minint);`
This item has no description.

Public	`function alignx(const mode: widgetalignmodety; const awidgets: array of twidget; const glue: widgetalignmodety = wam_none; const margin: integer = 0): integer;`
This item has no description.

Public	`function aligny(const mode: widgetalignmodety; const awidgets: array of twidget; const glue: widgetalignmodety = wam_none; const margin: integer = 0): integer;`
This item has no description.

Public	`function actualcursor(const apos: pointty): cursorshapety; virtual;`
This item has no description.

Properties

Public	`property widgetstate1: widgetstates1ty read fwidgetstate1;`
This item has no description.

Public	`property parentwidget: twidget read fparentwidget write setparentwidget;`
When reparenting into a widget that has its own `container` (e.g. a form or a panel), set `parentwidget` to that widget's `container` — or call its `insertwidget` — rather than to the widget itself.

Public	`property widgets[const index: integer]: twidget read getwidgets;`
This item has no description.

Public	`property container: twidget read getcontainer;`
A widget's own face (e.g. its fade) can be hidden by its `container` child widget, which paints in front of it: to make the widget's face effect visible, set the same `face` (or `color:= cl_transparent`) on `container` itself.

Public	`property children[const index: integer]: twidget read getchildwidgets; default;`
This item has no description.

Public	`property focusedchild: twidget read ffocusedchild;`
The currently focused descendant of this widget (e.g. `somegrid.focusedchild` to get the focused cell editor of a grid), as opposed to a window's `focusedwidget`, the globally focused widget.

Public	`property focusedchildbefore: twidget read ffocusedchildbefore;`
This item has no description.

Public	`property screenpos: pointty read getscreenpos write setscreenpos;`
This item has no description.

Public property widgetrect: rectty read fwidgetrect write setwidgetrect;

The widget's nested rectangles, each a subset of the previous one: widgetrect (the outer bounds, including frame and frame caption; origin relative to the parent widget, or the screen if there is none — its individual elements are also available as bounds_x/ bounds_y/bounds_cx/bounds_cy) contains paintrect (origin pos; excludes the frame and its caption; the canvas in paint is clipped to it by default), which contains clientrect (the "virtual" client area, origin paintrect.pos; can be bigger than paintrect for a scrolling widget), which contains innerpaintrect (origin pos; clientrect minus frame.framei_*). To convert a point or rectangle between two widgets' coordinates (or to/from screen coordinates, with nil as the missing widget), use translatewidgetpoint/translatewidgetrect (relative to widgetrect), translatepaintpoint/translatepaintrect (relative to paintrect), or translateclientpoint/translateclientrect (relative to clientrect).

Public	`property pos: pointty read fwidgetrect.pos write setpos;`
Every widget has a `pos` property (corresponding to `widgetrect.pos`), which shadows `system.pos`: use `system.pos` explicitly to call the string search function instead inside a widget's methods.

Public	`property size: sizety read fwidgetrect.size write setsize;`
This item has no description.

Public	`property minsize: sizety read fminsize write setminsize;`
This item has no description.

Public	`property maxsize: sizety read fmaxsize write setmaxsize;`
This item has no description.

Public	`property bounds_x: integer read fwidgetrect.x write setbounds_x;`
This item has no description.

Public	`property bounds_y: integer read fwidgetrect.y write setbounds_y;`
This item has no description.

Public	`property bounds_cx: integer read fwidgetrect.cx write setbounds_cx stored true;`
This item has no description.

Public	`property bounds_cy: integer read fwidgetrect.cy write setbounds_cy stored true;`
This item has no description.

Public	`property bounds_cxmin: integer read fminsize.cx write setbounds_cxmin default 0;`
Set `bounds_cxmin`/`bounds_cymin` and `bounds_cxmax`/ `bounds_cymax` to constrain a widget's (e.g. a modal form's) resizing — for example to prevent resizing entirely by setting the min and max to the same value.

Public	`property bounds_cymin: integer read fminsize.cy write setbounds_cymin default 0;`
This item has no description.

Public	`property bounds_cxmax: integer read fmaxsize.cx write setbounds_cxmax default 0;`
This item has no description.

Public	`property bounds_cymax: integer read fmaxsize.cy write setbounds_cymax default 0;`
This item has no description.

Public	`property left: integer read fwidgetrect.x write setbounds_x;`
This item has no description.

Public	`property right: integer read getright write setright;`
This item has no description.

Public	`property top: integer read fwidgetrect.y write setbounds_y;`
This item has no description.

Public	`property bottom: integer read getbottom write setbottom;`
This item has no description.

Public	`property width: integer read fwidgetrect.cx write setbounds_cx;`
This item has no description.

Public	`property height: integer read fwidgetrect.cy write setbounds_cy;`
This item has no description.

Public property anchors: anchorsty read fanchors write setanchors default defaultanchors;

Controls how the widget's position and size follow the resizing of its parent, independently for each edge (an_left, an_top, an_right, an_bottom): with both edges of a dimension False, position is 0 and size always equals the parent's paint area (as with Delphi's Align = alClient); with only the leading edge True, the leading position and the size are constant; with only the trailing edge True, the trailing edge follows the parent's trailing edge and the size stays constant; with both edges True, the leading position is constant and the size is synchronized with the parent's size. Setting anchors to [] makes the widget fill the parent's paint area on both axes.

Public	`property defaultfocuschild: twidget read getdefaultfocuschild write setdefaultfocuschild;`
This item has no description.

Public	`property framesize: sizety read getframesize write setframesize;`
This item has no description.

Public	`property framewidth: integer read geframewidth write setframewidth;`
This item has no description.

Public	`property frameheight: integer read getframeheight write setframeheight;`
This item has no description.

Public	`property paintsize: sizety read getpaintsize write setpaintsize;`
This item has no description.

Public	`property paintwidth: integer read getpaintwidth write setpaintwidth;`
This item has no description.

Public	`property paintheight: integer read getpaintheight write setpaintheight;`
This item has no description.

Public	`property clientrect: rectty read getclientrect;`
This item has no description.

Public	`property clientsize: sizety read getclientsize write setclientsize;`
This item has no description.

Public	`property clientwidth: integer read getclientwidth write setclientwidth;`
This item has no description.

Public	`property clientheight: integer read getclientheight write setclientheight;`
This item has no description.

Public	`property clientpos: pointty read getclientpos;`
This item has no description.

Public	`property parentclientpos: pointty read getparentclientpos write setparentclientpos;`
This item has no description.

Public property frame: tcustomframe read getframe write setframe;

Every widget has a frame and a face, both nil until instantiated (in the object inspector, by clicking the ellipse button next to the property; clicking it again frees them again). frame paints the area between widgetrect and paintrect: an outer bevel, a frame and an inner bevel, using framei_* to position client elements such as the space around the text in edit widgets or menu items. The client area itself is filled with colorclient, cl_transparent by default (no fill). tcustomcaptionframe additionally has a caption property to show a widget caption. face paints the background of the widget's client area: a color fade and an image, which can each be semi-transparent, and the image can be stretched and/or tiled; the fade can also be used to blend the image or the widget. Both tframe and tface have a template property: a tframecomp/tfacecomp copies its settings to the connected frame/face, except for properties flagged in localprops.

Public	`property face: tcustomface read getface write setface;`
This item has no description.

Public	`property optionswidget: optionswidgetty read foptionswidget write setoptionswidget default defaultoptionswidget;`
This item has no description.

Public	`property optionswidget1: optionswidget1ty read foptionswidget1 write setoptionswidget1 default defaultoptionswidget1;`
This item has no description.

Public	`property optionsskin: optionsskinty read foptionsskin write setoptionsskin default [];`
This item has no description.

Public	`property cursor: cursorshapety read fcursor write setcursor default cr_default;`
This item has no description.

Public	`property color: colorty read fcolor write setcolor default defaultwidgetcolor;`
This item has no description.

Public	`property visible: boolean read getvisible write setvisible default true;`
This item has no description.

Public	`property enabled: boolean read getenabled write setenabled default true;`
`False` disallows the widget, and its contained widgets, to receive mouse and keyboard events, including shortcuts.

Public	`property taborder: integer read ftaborder write settaborder default 0;`
This item has no description.

Public	`property hint: msestring read gethint write sethint stored ishintstored;`
This item has no description.

Public	`property zorder: integer read getzorder write setzorder;`
This item has no description.

Published	`property onnavigrequest: navigrequesteventty read fonnavigrequest write fonnavigrequest;`
This item has no description.

Published	`property skingroup: integer read fskingroup write fskingroup default 0;`
This item has no description.

Published	`property onbeforeupdateskin;`
This item has no description.

Published	`property onafterupdateskin;`
This item has no description.

Generated by PasDoc 1.0.4.

Documentation

Introduction

Class twidget

Unit

Declaration

Description

Hierarchy

Overview

Fields

Methods

Properties

Description

Fields

Methods

Properties