Class tactionwidget

Description
Hierarchy
Methods
Properties

Unit

msewidgets

Declaration

type tactionwidget = class(twidget)

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

Methods

Protected procedure mouseevent(var info: mouseeventinfoty); override;
Protected procedure clientmouseevent(var info: mouseeventinfoty); override;
Protected procedure childmouseevent(const sender: twidget; var info: mouseeventinfoty); override;
Protected procedure domousewheelevent(var info: mousewheeleventinfoty); override;
Protected procedure dobeforepaint(const canvas: tcanvas); override;
Protected procedure doonpaintbackground(const canvas: tcanvas); override;
Protected procedure doonpaint(const canvas: tcanvas); override;
Protected procedure doafterpaint(const canvas: tcanvas); override;
Protected procedure showhint(const aid: int32; var info: hintinfoty); override;
Protected procedure getpopuppos(var apos: pointty); virtual;
Protected procedure updatepopupmenu(var amenu: tpopupmenu; var mouseinfo: mouseeventinfoty); virtual;
Protected procedure dopopup(var amenu: tpopupmenu; var mouseinfo: mouseeventinfoty); virtual;
Protected procedure doafterpopupmenu(var amenu: tpopupmenu; var mouseinfo: mouseeventinfoty); virtual;
Protected procedure poschanged; override;
Protected procedure sizechanged; override;
Protected procedure doloaded; override;
Protected procedure doenter; override;
Protected procedure doexit; override;
Protected procedure dofocus; override;
Protected procedure dodefocus; override;
Protected procedure dofocuschanged(const oldwidget: twidget; const newwidget: twidget); override;
Protected procedure doactivate; override;
Protected procedure dodeactivate; override;
Protected procedure dohide; override;
Protected procedure doshow; override;
Protected procedure doonkeydown(var info: keyeventinfoty);
Protected procedure dokeydown(var info: keyeventinfoty); override;
Protected procedure dokeyup(var info: keyeventinfoty); override;
Protected procedure doshortcut(var info: keyeventinfoty; const sender: twidget); override;
Protected procedure receiveevent(const event: tobjectevent); override;
Protected procedure componentevent(const event: tcomponentevent) override;
Protected procedure doasyncevent(var atag: integer); override;
Protected procedure internalcreateframe; override;
Protected procedure enabledchanged; override;
Public function canclose(const newfocus: twidget = nil): boolean; override;

Properties

Protected property frame: tcaptionframe read getframe write setframe;
Protected property face: tface read getface write setface;
Protected property popupmenu: tpopupmenu read fpopupmenu write setpopupmenu;
Protected property onpopup: popupeventty read fonpopup write fonpopup;
Protected property onshowhint: showhinteventty read fonshowhint write fonshowhint;
Protected property onenter: notifyeventty read fonenter write fonenter;
Protected property onexit: notifyeventty read fonexit write fonexit;
Protected property onfocus: notifyeventty read fonfocus write fonfocus;
Protected property ondefocus: notifyeventty read fondefocus write fondefocus;
Protected property onactivate: notifyeventty read fonactivate write fonactivate;
Protected property ondeactivate: notifyeventty read fondeactivate write fondeactivate;
Protected property onfocusedwidgetchanged: widgetchangeeventty read fonfocusedwidgetchanged write fonfocusedwidgetchanged;
Protected property onmouseevent: mouseeventty read fonmouseevent write fonmouseevent;
Protected property onchildmouseevent: mouseeventty read fonchildmouseevent write fonchildmouseevent;
Protected property onclientmouseevent: mouseeventty read fonclientmouseevent write fonclientmouseevent;
Protected property onmousewheelevent: mousewheeleventty read fonmousewheelevent write fonmousewheelevent;
Protected property onkeydown: keyeventty read fonkeydown write fonkeydown;
Protected property onkeyup: keyeventty read fonkeyup write fonkeyup;
Protected property onshortcut: shortcuteventty read fonshortcut write fonshortcut;
Protected property onloaded: notifyeventty read fonloaded write fonloaded;
Protected property onbeforepaint: painteventty read fonbeforepaint write fonbeforepaint;
Protected property onpaintbackground: painteventty read fonpaintbackground write fonpaintbackground;
Protected property onpaint: painteventty read fonpaint write fonpaint;
Protected property onafterpaint: painteventty read fonafterpaint write fonafterpaint;
Protected property onshow: notifyeventty read fonshow write fonshow;
Protected property onhide: notifyeventty read fonhide write fonhide;
Protected property onresize: notifyeventty read fonresize write fonresize;
Protected property onmove: notifyeventty read fonmove write fonmove;
Protected property onclosequery: queryeventty read fonclosequery write fonclosequery;
Protected property onevent: eventeventty read fonevent write fonevent;
Protected property oncomponentevent: componenteventeventty read foncomponentevent write foncomponentevent;
Protected property onasyncevent: asynceventeventty read fonasyncevent write fonasyncevent;

Description

Methods

Protected procedure mouseevent(var info: mouseeventinfoty); override;

This item has no description.

Protected procedure clientmouseevent(var info: mouseeventinfoty); override;

This item has no description.

Protected procedure childmouseevent(const sender: twidget; var info: mouseeventinfoty); override;

This item has no description.

Protected procedure domousewheelevent(var info: mousewheeleventinfoty); override;

This item has no description.

Protected procedure dobeforepaint(const canvas: tcanvas); override;

This item has no description.

Protected procedure doonpaintbackground(const canvas: tcanvas); override;

This item has no description.

Protected procedure doonpaint(const canvas: tcanvas); override;

This item has no description.

Protected procedure doafterpaint(const canvas: tcanvas); override;

This item has no description. Showing description inherited from twidget.doafterpaint.

Override doafterpaint to draw over the widget's child widgets, after they have painted.

Protected procedure showhint(const aid: int32; var info: hintinfoty); override;

This item has no description.

Protected procedure getpopuppos(var apos: pointty); virtual;

This item has no description.

Protected procedure updatepopupmenu(var amenu: tpopupmenu; var mouseinfo: mouseeventinfoty); virtual;

This item has no description.

Protected procedure dopopup(var amenu: tpopupmenu; var mouseinfo: mouseeventinfoty); virtual;

This item has no description.

Protected procedure doafterpopupmenu(var amenu: tpopupmenu; var mouseinfo: mouseeventinfoty); virtual;

This item has no description.

Protected procedure poschanged; override;

This item has no description.

Protected procedure sizechanged; override;

This item has no description.

Protected procedure doloaded; override;

This item has no description.

Protected procedure doenter; override;

This item has no description.

Protected procedure doexit; override;

This item has no description.

Protected procedure dofocus; override;

This item has no description.

Protected procedure dodefocus; override;

This item has no description.

Protected procedure dofocuschanged(const oldwidget: twidget; const newwidget: twidget); override;

This item has no description.

Protected procedure doactivate; override;

This item has no description.

Protected procedure dodeactivate; override;

This item has no description.

Protected procedure dohide; override;

This item has no description.

Protected procedure doshow; override;

This item has no description.

Protected procedure doonkeydown(var info: keyeventinfoty);

This item has no description.

Protected procedure dokeydown(var info: keyeventinfoty); override;

This item has no description.

Protected procedure dokeyup(var info: keyeventinfoty); override;

This item has no description.

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

This item has no description. Showing description inherited from twidget.doshortcut.

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 procedure receiveevent(const event: tobjectevent); override;

This item has no description.

Protected procedure componentevent(const event: tcomponentevent) override;

This item has no description.

Protected procedure doasyncevent(var atag: integer); override;

This item has no description.

Protected procedure internalcreateframe; override;

This item has no description.

Protected procedure enabledchanged; override;

This item has no description.

Public function canclose(const newfocus: twidget = nil): boolean; override;

This item has no description.

Properties

Protected property frame: tcaptionframe read getframe write setframe;

This item has no description.

Protected property face: tface read getface write setface;

This item has no description.

Protected property popupmenu: tpopupmenu read fpopupmenu write setpopupmenu;

This item has no description.

Protected property onpopup: popupeventty read fonpopup write fonpopup;

Fires when a popup menu is about to be shown (e.g. on right-click), once the items of the current menu level are built but before its submenus are. amenu is passed by reference, so the handler can replace it.

Protected property onshowhint: showhinteventty read fonshowhint write fonshowhint;

Fires after the default hint handling has filled in info, letting the handler inspect or override the hint text or position before it is actually shown.

Protected property onenter: notifyeventty read fonenter write fonenter;

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).

Protected property onexit: notifyeventty read fonexit write fonexit;

This item has no description.

Protected property onfocus: notifyeventty read fonfocus write fonfocus;

This item has no description.

Protected property ondefocus: notifyeventty read fondefocus write fondefocus;

This item has no description.

Protected property onactivate: notifyeventty read fonactivate write fonactivate;

This item has no description.

Protected property ondeactivate: notifyeventty read fondeactivate write fondeactivate;

This item has no description.

Protected property onfocusedwidgetchanged: widgetchangeeventty read fonfocusedwidgetchanged write fonfocusedwidgetchanged;

This item has no description.

Protected property onmouseevent: mouseeventty read fonmouseevent write fonmouseevent;

This item has no description.

Protected property onchildmouseevent: mouseeventty read fonchildmouseevent write fonchildmouseevent;

This item has no description.

Protected property onclientmouseevent: mouseeventty read fonclientmouseevent write fonclientmouseevent;

This item has no description.

Protected property onmousewheelevent: mousewheeleventty read fonmousewheelevent write fonmousewheelevent;

This item has no description.

Protected property onkeydown: keyeventty read fonkeydown write fonkeydown;

This item has no description.

Protected property onkeyup: keyeventty read fonkeyup write fonkeyup;

This item has no description.

Protected property onshortcut: shortcuteventty read fonshortcut write fonshortcut;

This item has no description.

Protected property onloaded: notifyeventty read fonloaded write fonloaded;

This item has no description.

Protected property onbeforepaint: painteventty read fonbeforepaint write fonbeforepaint;

This item has no description.

Protected property onpaintbackground: painteventty read fonpaintbackground write fonpaintbackground;

This item has no description.

Protected property onpaint: painteventty read fonpaint write fonpaint;

This item has no description.

Protected property onafterpaint: painteventty read fonafterpaint write fonafterpaint;

This item has no description.

Protected property onshow: notifyeventty read fonshow write fonshow;

This item has no description.

Protected property onhide: notifyeventty read fonhide write fonhide;

This item has no description.

Protected property onresize: notifyeventty read fonresize write fonresize;

This item has no description.

Protected property onmove: notifyeventty read fonmove write fonmove;

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).

Protected property onclosequery: queryeventty read fonclosequery write fonclosequery;

This item has no description.

Protected property onevent: eventeventty read fonevent write fonevent;

This item has no description.

Protected property oncomponentevent: componenteventeventty read foncomponentevent write foncomponentevent;

This item has no description.

Protected property onasyncevent: asynceventeventty read fonasyncevent write fonasyncevent;

This item has no description.

Generated by PasDoc 1.0.4.