Class tcustomaction

Description
Hierarchy
Fields
Methods
Properties

Unit

mseact

Declaration

type tcustomaction = class(tactcomponent, istatfile, iifiexeclink)

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 finfo: actioninfoty;
Protected foptions: actionoptionsty;

Methods

Protected procedure registeronshortcut(const avalue: boolean); virtual;
Protected procedure loaded; override;
Protected procedure changed;
Protected procedure objectevent(const sender: tobject; const event: objecteventty); override;
Protected procedure receiveevent(const event: tobjectevent) override;
Protected procedure doidle(var again: boolean);
Protected procedure doasyncevent(var atag: integer); override;
Protected procedure eventfired(const sender: tobject; const ainfo: actioninfoty);
Protected procedure doafterunlink; virtual;
Protected procedure dostatread(const reader: tstatreader);
Protected procedure dostatwrite(const writer: tstatwriter);
Protected procedure statreading;
Protected procedure statread;
Protected function getstatvarname: msestring;
Protected function getstatpriority: integer;
Public constructor create(aowner: tcomponent); override;
Public destructor destroy; override;
Public procedure doupdate;
Public procedure execute(const force: boolean = false);
Public procedure asyncexecute();
Public procedure updateinfo(const sender: iactionlink);

Properties

Public property caption: captionty read getcaption write setcaption;
Public property state: actionstatesty read getstate write setstate default [];
Public property visible: boolean read getvisible write setvisible;
Public property enabled: boolean read getenabled write setenabled;
Public property checked: boolean read getchecked write setchecked;
Public property group: integer read getgroup write setgroup default 0;
Public property imagenr: imagenrty read finfo.imagenr write setimagenr default -1;
Public property imagenrdisabled: imagenrty read finfo.imagenrdisabled write setimagenrdisabled default -2;
Public property colorglyph: colorty read finfo.colorglyph write setcolorglyph default cl_default;
Public property color: colorty read finfo.color write setcolor default cl_default;
Public property imagecheckedoffset: integer read finfo.imagecheckedoffset write setimagecheckedoffset default 0;
Public property hint: msestring read finfo.hint write sethint;
Public property tagaction: integer read finfo.tag write settag default 0;
Public property options: actionoptionsty read foptions write setoptions default defaultactionoptions;
Public property statfile: tstatfile read fstatfile write setstatfile;
Public property statvarname: msestring read getstatvarname write fstatvarname;
Public property statpriority: integer read fstatpriority write fstatpriority default 0;
Public property ifilink: tifiactionlinkcomp read fifilink write setifilink;
Public property onexecute: notifyeventty read finfo.onexecute write setonexecute;
Public property onbeforeexecute: accepteventty read finfo.onbeforeexecute write setonbeforeexecute;
Public property onafterexecute: notifyeventty read finfo.onafterexecute write setonafterexecute;
Public property onexecuteaction: actioneventty read fonexecuteaction write fonexecuteaction;
Public property onupdate: actioneventty read fonupdate write fonupdate;
Public property onchange: notifyeventty read fonchange write fonchange;
Public property onasyncevent: asynceventty read fonasyncevent write fonasyncevent;

Description

Fields

Protected finfo: actioninfoty;

This item has no description.

Protected foptions: actionoptionsty;

This item has no description.

Methods

Protected procedure registeronshortcut(const avalue: boolean); virtual;

This item has no description.

Protected procedure loaded; override;

This item has no description.

Protected procedure changed;

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 doidle(var again: boolean);

This item has no description.

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

This item has no description.

Protected procedure eventfired(const sender: tobject; const ainfo: actioninfoty);

This item has no description.

Protected procedure doafterunlink; virtual;

This item has no description.

Protected procedure dostatread(const reader: tstatreader);

This item has no description.

Protected procedure dostatwrite(const writer: tstatwriter);

This item has no description.

Protected procedure statreading;

This item has no description.

Protected procedure statread;

This item has no description.

Protected function getstatvarname: msestring;

This item has no description.

Protected function getstatpriority: integer;

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 doupdate;

This item has no description.

Public procedure execute(const force: boolean = false);

This item has no description.

Public procedure asyncexecute();

This item has no description.

Public procedure updateinfo(const sender: iactionlink);

This item has no description.

Properties

Public property caption: captionty read getcaption write setcaption;

When this action is assigned to a client's action property (e.g. tbutton.action or tmenuitem.action), the client's caption, imagelist, imagenr, imagecheckedoffset, colorglyph, color, hint, shortcut, tag, group and onexecute, as well as the as_disabled, as_invisible, as_checked and as_default members of state, are kept synchronized with this action — as long as the corresponding as_local* member of the client's own state is False. Editing one of those properties directly on the client sets its as_local* member to True automatically, detaching it from the action for that property; setting it back to False restores the action's value.

Public property state: actionstatesty read getstate write setstate default [];

This item has no description.

Public property visible: boolean read getvisible write setvisible;

This item has no description.

Public property enabled: boolean read getenabled write setenabled;

This item has no description.

Public property checked: boolean read getchecked write setchecked;

This item has no description.

Public property group: integer read getgroup write setgroup default 0;

This item has no description.

Public property imagenr: imagenrty read finfo.imagenr write setimagenr default -1;

This item has no description.

Public property imagenrdisabled: imagenrty read finfo.imagenrdisabled write setimagenrdisabled default -2;

This item has no description.

Public property colorglyph: colorty read finfo.colorglyph write setcolorglyph default cl_default;

This item has no description.

Public property color: colorty read finfo.color write setcolor default cl_default;

This item has no description.

Public property imagecheckedoffset: integer read finfo.imagecheckedoffset write setimagecheckedoffset default 0;

This item has no description.

Public property hint: msestring read finfo.hint write sethint;

This item has no description.

Public property tagaction: integer read finfo.tag write settag default 0;

This item has no description.

Public property options: actionoptionsty read foptions write setoptions default defaultactionoptions;

This item has no description.

Public property statfile: tstatfile read fstatfile write setstatfile;

This item has no description.

Public property statvarname: msestring read getstatvarname write fstatvarname;

This item has no description.

Public property statpriority: integer read fstatpriority write fstatpriority default 0;

This item has no description.

Public property ifilink: tifiactionlinkcomp read fifilink write setifilink;

This item has no description.

Public property onexecute: notifyeventty read finfo.onexecute write setonexecute;

This item has no description.

Public property onbeforeexecute: accepteventty read finfo.onbeforeexecute write setonbeforeexecute;

This item has no description.

Public property onafterexecute: notifyeventty read finfo.onafterexecute write setonafterexecute;

This item has no description.

Public property onexecuteaction: actioneventty read fonexecuteaction write fonexecuteaction;

This item has no description.

Public property onupdate: actioneventty read fonupdate write fonupdate;

This item has no description.

Public property onchange: notifyeventty read fonchange write fonchange;

This item has no description.

Public property onasyncevent: asynceventty read fonasyncevent write fonasyncevent;

Called after the current main event loop round has finished processing the events posted with asyncevent, i.e. after the caller (and any other already queued events) has returned. Typical uses are freeing a component from a nested procedure of that same component, or running code only after a popup menu has finished closing.

Generated by PasDoc 1.0.4.