.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Kephra::CommandList 3pm"
.TH Kephra::CommandList 3pm "2022-06-21" "perl v5.34.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Kephra::API::CommandList \- external API for user callable functions
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The CommandList is a dynamically changeable list, that contains all the 
function calls for every menu item, toolbar button and most other widget items.
It holds also label, help text, key binding, icon and more for each command.
All these properties have to be changed globally here in a clean way.
These commands where used by different gui elements, that allows menu and
toolbar definitions to be very compact, readable and and easy changeable.
.PP
Names of commands contain dashes as separator of namespaces.
.SH "SPECIFICATION"
.IX Header "SPECIFICATION"
CommandlistItem
.IP "\(bu" 4
\&\s-1ID\s0 \- unique identifier, hashkey, following hash is its value
.IP "\(bu" 4
call \- \s-1CODEREF :\s0 actual action, performed when this command is called
.IP "\(bu" 4
sub \- string : name of the called routine
.IP "\(bu" 4
enable \- \s-1CODEREF :\s0 returns enable status (0 for disable)
.IP "\(bu" 4
enable_event \- string : API::EventTable \s-1ID\s0 when to check to en/disable
.IP "\(bu" 4
state \- \s-1CODEREF :\s0 that returns state value (for switches)
.IP "\(bu" 4
state_event \- string : API::EventTable \s-1ID\s0 when to check is state changed
.IP "\(bu" 4
label \- string : descriptive name
.IP "\(bu" 4
help \- string : short help sentence
.IP "\(bu" 4
key \- string : label of key binding
.IP "\(bu" 4
keycode \- numeric keycode
.IP "\(bu" 4
icon \- Wx::Bitmap