Class tdockformwidget

Description
Hierarchy
Properties

Unit

mseforms

Declaration

type tdockformwidget = class(tcustomdockform)

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

Properties

Published property optionswidget;
Published property optionsskin;
Published property optionswindow;
Published property mainmenu;
Published property color;
Published property font;
Published property fontempty;
Published property options;
Published property statfile;
Published property statvarname;
Published property statpriority;
Published property caption;
Published property icon;
Published property dockingareacaption;
Published property oncreate;
Published property oncreated;
Published property onloaded;
Published property oneventloopstart;
Published property ondestroy;
Published property ondestroyed;
Published property onbeforeclosequery;
Published property onclosequery;
Published property onclose;
Published property onidle;
Published property onwidgetactivechanged;
Published property onwindowactivechanged;
Published property onwindowdestroyed;
Published property onapplicationactivechanged;
Published property onterminatequery;
Published property onterminated;
Published property onmouseevent;
Published property onclientmouseevent;
Published property onchildmouseevent;
Published property onmousewheelevent;
Published property onkeydown;
Published property onkeyup;
Published property onshortcut;
Published property onbeforepaint;
Published property onpaint;
Published property onafterpaint;
Published property onmove;
Published property onresize;
Published property onshow;
Published property onactivate;
Published property onenter;
Published property onexit;
Published property onfocusedwidgetchanged;
Published property ondeactivate;
Published property onhide;
Published property onevent;
Published property oncomponentevent;
Published property onasyncevent;
Published property onstatupdate;
Published property onstatread;
Published property onstatbeforeread;
Published property onstatafterread;
Published property onstatwrite;
Published property onstatbeforewrite;
Published property onstatafterwrite;
Published property onfontheightdelta;
Published property onlayout;
Published property onsysevent;
Published property onsyswindowevent;

Description

Properties

Published property optionswidget;

This item has no description.

Published property optionsskin;

This item has no description.

Published property optionswindow;

This item has no description.

Published property mainmenu;

This item has no description.

Published property color;

This item has no description.

Published property font;

This item has no description.

Published property fontempty;

This item has no description.

Published property options;

This item has no description.

Published property statfile;

This item has no description.

Published property statvarname;

This item has no description.

Published property statpriority;

This item has no description.

Published property caption;

This item has no description.

Published property icon;

This item has no description.

Published property dockingareacaption;

This item has no description.

Published property oncreate;

This item has no description. Showing description inherited from tcustommseform.oncreate.

oncreate is called before the loaded procedures of the form's components are called; onloaded is called after. Many components do part of their initialization in loaded, so their event properties are not active yet when oncreate fires.

Published property oncreated;

This item has no description.

Published property onloaded;

This item has no description.

Published property oneventloopstart;

This item has no description. Showing description inherited from tcustommseform.oneventloopstart.

Not to be confused with onloaded: oneventloopstart fires once the main event loop starts, i.e. after application.run — it was in fact named onloaded before being renamed, when the current, earlier-firing onloaded was introduced.

Published property ondestroy;

This item has no description.

Published property ondestroyed;

This item has no description.

Published property onbeforeclosequery;

This item has no description.

Published property onclosequery;

This item has no description. Showing description inherited from tcustommseform.onclosequery.

Fires from canclose, with amodalresult set to the pending modalresult (or mr_canclose if none is pending yet). Setting amodalresult to mr_none cancels closing the form (and onclose is not called); any other value lets the form close with that modalresult.

Published property onclose;

This item has no description.

Published property onidle;

This item has no description. Showing description inherited from tcustommseform.onidle.

Called whenever the GUI event queue becomes empty, useful for low priority background processing (e.g. MSEide's own source highlighter processes a block of lines on each call). The again parameter is False by default; set it to True to be called again immediately once the queue is empty, until the background task is done. Since onidle runs from the main event loop, calling a modal function such as showmessage from it starts a nested event loop, which calls onidle again recursively — and calling sleep from it suspends GUI event processing for the whole application.

Published property onwidgetactivechanged;

This item has no description.

Published property onwindowactivechanged;

This item has no description.

Published property onwindowdestroyed;

This item has no description.

Published property onapplicationactivechanged;

This item has no description.

Published property onterminatequery;

This item has no description. Showing description inherited from tcustommseform.onterminatequery.

Fires on an attempt to terminate the application, whether from application.terminate (used e.g. by fo_terminateonclose) or from the OS asking to shut down; setting terminate to False cancels it (on Windows, this also cancels the OS shutdown).

Published property onterminated;

This item has no description. Showing description inherited from tcustommseform.onterminated.

Called when the application terminates, not when the form closes or is destroyed — it never fires if the form has already been freed by then.

Published property onmouseevent;

This item has no description.

Published property onclientmouseevent;

This item has no description.

Published property onchildmouseevent;

This item has no description.

Published property onmousewheelevent;

This item has no description.

Published property onkeydown;

This item has no description.

Published property onkeyup;

This item has no description.

Published property onshortcut;

This item has no description.

Published property onbeforepaint;

This item has no description.

Published property onpaint;

This item has no description.

Published property onafterpaint;

This item has no description.

Published property onmove;

This item has no description. Showing description inherited from tactionwidget.onmove.

Fires once the widget has actually been moved, i.e. only if its x or y position really changed (not on every call that sets the widget's bounds).

Published property onresize;

This item has no description.

Published property onshow;

This item has no description.

Published property onactivate;

This item has no description.

Published property onenter;

This item has no description. Showing description inherited from tactionwidget.onenter.

Focus and activation events, common to most widgets since they are declared on tactionwidget: onenter fires when input focus goes to the widget or a child; onexit when it leaves the widget (and all its children); onfocus only when the widget itself gets input focus; ondefocus when it loses it; onactivate/ ondeactivate when the widget or a child is activated/deactivated; onfocusedwidgetchanged (on teventwidget, tmseform and tgroupbox) whenever the widget or a child gets or loses input focus. teventwidget publishes most internal events and can be used to build a custom widget without writing a new class.

On a focus change, onenter fires first (bottom-up from the common ancestor to the new focus), then onfocus on the new focus itself, then onactivate (only while the window is the active one). On the widget losing focus, ondefocus fires first, then ondeactivate and onexit (bottom-up through its ancestors up to the common ancestor).

Published property onexit;

This item has no description.

Published property onfocusedwidgetchanged;

This item has no description.

Published property ondeactivate;

This item has no description.

Published property onhide;

This item has no description.

Published property onevent;

This item has no description.

Published property oncomponentevent;

This item has no description.

Published property onasyncevent;

This item has no description.

Published property onstatupdate;

This item has no description.

Published property onstatread;

This item has no description.

Published property onstatbeforeread;

This item has no description.

Published property onstatafterread;

This item has no description.

Published property onstatwrite;

This item has no description.

Published property onstatbeforewrite;

This item has no description.

Published property onstatafterwrite;

This item has no description.

Published property onfontheightdelta;

This item has no description.

Published property onlayout;

This item has no description.

Published property onsysevent;

This item has no description.

Published property onsyswindowevent;

This item has no description.

Generated by PasDoc 1.0.4.