Class tcustombutton

Description
Hierarchy
Fields
Methods
Properties

Unit

msesimplewidgets

Declaration

type tcustombutton = class(tactionsimplebutton, iactionlink, iimagelistinfo)

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 fexeccanceled: boolean;

Methods

Protected function getdisabled(): boolean override;
Protected procedure defineproperties(filer: tfiler); override;
Protected procedure fontchanged; override;
Protected procedure setcolor(const avalue: colorty); override;
Protected procedure doidle(var again: boolean);
Protected function getactioninfopo: pactioninfoty;
Protected function shortcutseparator: msechar;
Protected procedure calccaptiontext(var ainfo: actioninfoty) virtual;
Protected procedure actionchanged;
Protected procedure setoptions(const avalue: buttonoptionsty); override;
Protected function gethint: msestring; override;
Protected procedure sethint(const Value: msestring); override;
Protected function ishintstored: boolean; override;
Protected function getassistivecaption(): msestring; override;
Protected procedure setenabled(const avalue: boolean); override;
Protected procedure setvisible(const avalue: boolean); override;
Protected procedure readstate(reader: treader); override;
Protected procedure loaded; override;
Protected procedure clientrectchanged; override;
Protected procedure doexecute; override;
Protected procedure doenter; override;
Protected procedure doexit; override;
Protected procedure dopaintforeground(const canvas: tcanvas); override;
Protected function checkfocusshortcut(var info: keyeventinfoty): boolean; override;
Protected procedure doshortcut(var info: keyeventinfoty; const sender: twidget); override;
Protected procedure getautopaintsize(var asize: sizety); override;
Protected procedure objectevent(const sender: tobject; const event: objecteventty); override;
Protected function verticalfontheightdelta: boolean; override;
Public constructor create(aowner: tcomponent); override;
Public destructor destroy; override;
Public procedure synctofontheight; override;
Public procedure doupdate;
Public procedure updatehotkeys() override;

Properties

Public property bounds_cx default defaultbuttonwidth;
Public property bounds_cy default defaultbuttonheight;
Public property font: twidgetfont read getfont write setfont stored isfontstored;
Public property modalresult: modalresultty read fmodalresult write fmodalresult default mr_none;
Public property action: tcustomaction read factioninfo.action write setaction;
Public property caption: captionty read getcaption write setcaption stored iscaptionstored;
Public property textflags: textflagsty read finfo.ca.textflags write settextflags default defaultcaptiontextflags;
Public property imagepos: imageposty read finfo.ca.imagepos write setimagepos default ip_center;
Public property captiondist: integer read finfo.ca.captiondist write setcaptiondist default defaultshapecaptiondist;
Public property imagelist: timagelist read getimagelist write setimagelist stored isimageliststored;
Public property imagenr: imagenrty read factioninfo.imagenr write setimagenr stored isimagenrstored default -1;
Public property imagenrdisabled: imagenrty read factioninfo.imagenrdisabled write setimagenrdisabled stored isimagenrdisabledstored default -2;
Public property imagedist: integer read finfo.ca.imagedist write setimagedist default 0;
Public property imagedist1: integer read finfo.ca.imagedist1 write setimagedist1 default 0;
Public property imagedist2: integer read finfo.ca.imagedist2 write setimagedist2 default 0;
Public property colorglyph: colorty read factioninfo.colorglyph write setcolorglyph stored iscolorglyphstored default cl_default;
Public property shortcut: shortcutty read getshortcut write setshortcut stored false default 0;
Public property shortcut1: shortcutty read getshortcut1 write setshortcut1 stored false default 0;
Public property shortcuts: shortcutarty read factioninfo.shortcut write setshortcuts;
Public property shortcuts1: shortcutarty read factioninfo.shortcut1 write setshortcuts1;
Public property onupdate: buttoneventty read fonupdate write fonupdate;
Public property onexecute: notifyeventty read factioninfo.onexecute write setonexecute stored isonexecutestored;
Public property onbeforeexecute: accepteventty read factioninfo.onbeforeexecute write setonbeforeexecute stored isonbeforeexecutestored;
Public property onafterexecute: notifyeventty read factioninfo.onafterexecute write setonafterexecute stored isonafterexecutestored;
Public property autosize_cx: integer read fautosize_cx write setautosize_cx default 0;
Public property autosize_cy: integer read fautosize_cy write setautosize_cy default 0;
Public property disabled: boolean read getdisabled write setdisabled;
Published property options;
Published property visible stored false;
Published property enabled stored isenabledstored;
Published property state: actionstatesty read getstate write setstate stored isstatestored default [];

Description

Fields

Protected fexeccanceled: boolean;

This item has no description.

Methods

Protected function getdisabled(): boolean override;

This item has no description.

Protected procedure defineproperties(filer: tfiler); override;

This item has no description.

Protected procedure fontchanged; override;

This item has no description.

Protected procedure setcolor(const avalue: colorty); override;

This item has no description.

Protected procedure doidle(var again: boolean);

This item has no description.

Protected function getactioninfopo: pactioninfoty;

This item has no description.

Protected function shortcutseparator: msechar;

This item has no description.

Protected procedure calccaptiontext(var ainfo: actioninfoty) virtual;

This item has no description.

Protected procedure actionchanged;

This item has no description.

Protected procedure setoptions(const avalue: buttonoptionsty); override;

This item has no description.

Protected function gethint: msestring; override;

This item has no description.

Protected procedure sethint(const Value: msestring); override;

This item has no description.

Protected function ishintstored: boolean; override;

This item has no description.

Protected function getassistivecaption(): msestring; override;

This item has no description.

Protected procedure setenabled(const avalue: boolean); override;

This item has no description.

Protected procedure setvisible(const avalue: boolean); override;

This item has no description.

Protected procedure readstate(reader: treader); override;

This item has no description.

Protected procedure loaded; override;

This item has no description.

Protected procedure clientrectchanged; override;

This item has no description.

Protected procedure doexecute; 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 dopaintforeground(const canvas: tcanvas); override;

This item has no description.

Protected function checkfocusshortcut(var info: keyeventinfoty): boolean; 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 getautopaintsize(var asize: sizety); override;

This item has no description.

Protected procedure objectevent(const sender: tobject; const event: objecteventty); override;

This item has no description.

Protected function verticalfontheightdelta: boolean; override;

This item has no description.

Public constructor create(aowner: tcomponent); override;

This item has no description.

Public destructor destroy; override;

This item has no description.

Public procedure synctofontheight; override;

This item has no description.

Public procedure doupdate;

This item has no description.

Public procedure updatehotkeys() override;

This item has no description.

Properties

Public property bounds_cx default defaultbuttonwidth;

This item has no description.

Public property bounds_cy default defaultbuttonheight;

This item has no description.

Public property font: twidgetfont read getfont write setfont stored isfontstored;

This item has no description.

Public property modalresult: modalresultty read fmodalresult write fmodalresult default mr_none;

Setting modalresult to mr_none prevents the button from closing the form: only a non-mr_none value triggers the form's modal close.

Public property action: tcustomaction read factioninfo.action write setaction;

This item has no description.

Public property caption: captionty read getcaption write setcaption stored iscaptionstored;

This item has no description.

Public property textflags: textflagsty read finfo.ca.textflags write settextflags default defaultcaptiontextflags;

This item has no description.

Public property imagepos: imageposty read finfo.ca.imagepos write setimagepos default ip_center;

This item has no description.

Public property captiondist: integer read finfo.ca.captiondist write setcaptiondist default defaultshapecaptiondist;

This item has no description.

Public property imagelist: timagelist read getimagelist write setimagelist stored isimageliststored;

This item has no description.

Public property imagenr: imagenrty read factioninfo.imagenr write setimagenr stored isimagenrstored default -1;

This item has no description.

Public property imagenrdisabled: imagenrty read factioninfo.imagenrdisabled write setimagenrdisabled stored isimagenrdisabledstored default -2;

This item has no description.

Public property imagedist: integer read finfo.ca.imagedist write setimagedist default 0;

This item has no description.

Public property imagedist1: integer read finfo.ca.imagedist1 write setimagedist1 default 0;

This item has no description.

Public property imagedist2: integer read finfo.ca.imagedist2 write setimagedist2 default 0;

This item has no description.

Public property colorglyph: colorty read factioninfo.colorglyph write setcolorglyph stored iscolorglyphstored default cl_default;

This item has no description.

Public property shortcut: shortcutty read getshortcut write setshortcut stored false default 0;

This item has no description.

Public property shortcut1: shortcutty read getshortcut1 write setshortcut1 stored false default 0;

This item has no description.

Public property shortcuts: shortcutarty read factioninfo.shortcut write setshortcuts;

This item has no description.

Public property shortcuts1: shortcutarty read factioninfo.shortcut1 write setshortcuts1;

This item has no description.

Public property onupdate: buttoneventty read fonupdate write fonupdate;

This item has no description.

Public property onexecute: notifyeventty read factioninfo.onexecute write setonexecute stored isonexecutestored;

This item has no description.

Public property onbeforeexecute: accepteventty read factioninfo.onbeforeexecute write setonbeforeexecute stored isonbeforeexecutestored;

This item has no description.

Public property onafterexecute: notifyeventty read factioninfo.onafterexecute write setonafterexecute stored isonafterexecutestored;

This item has no description.

Public property autosize_cx: integer read fautosize_cx write setautosize_cx default 0;

This item has no description.

Public property autosize_cy: integer read fautosize_cy write setautosize_cy default 0;

This item has no description.

Public property disabled: boolean read getdisabled write setdisabled;

This item has no description.

Published property options;

This item has no description.

Published property visible stored false;

This item has no description.

Published property enabled stored isenabledstored;

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

False disallows the widget, and its contained widgets, to receive mouse and keyboard events, including shortcuts.

Published property state: actionstatesty read getstate write setstate stored isstatestored default [];

This item has no description.

Generated by PasDoc 1.0.4.