SIMPOL Documentation

Chapter 55. mrulib

The mrulib provides a viable Most Recently Used (MRU) capability for storing the information in a config file (conflib) and managing a submenu of items.

MRUList

Description

Type Tags

None

Object Value

Objects of type MRUList have no value, and it is an error to try to get or set this value.

MRUList.new()

Description

Prototype

MRUList.new ( MRUList me, string sectionname, string inifilename, wxmenu rootmenu, integer maxmenuentries, integer maxentriestotal )

Parameters

ParameterDefault valueType nameDescription
meNoneMRUList
sectionnameNonestring
inifilenameNonestring
rootmenuNonewxmenu
maxmenuentries8integer
maxentriestotal99integer

Properties

PropertyTypeDescription
_type(*)
__type(*)
_privateMRUListprivate
additemfunction
countfunction
finditemfunction
getfunction
getlistreferencefunction
inifilenamestring
maxentriestotalinteger
maxmenuentriesinteger
newfunction
onselectevent
readconfigfunction
removeitemfunction
rootmenuwxmenu
sectionnamestring
setlistreferencefunction
showdialogfunction
typetype
updatemenufunction
writeconfigfunction

Methods

additem()

Description

Prototype

MRUListvar.additem ( MRUList me, string value )

Parameters
ParameterDefault valueType nameDescription
meNoneMRUList
valueNonestring

count()

Description

Prototype

MRUListvar.count ( MRUList me )

Parameters
ParameterDefault valueType nameDescription
meNoneMRUList

finditem()

Description

Prototype

MRUListvar.finditem ( MRUList me, string value )

Parameters
ParameterDefault valueType nameDescription
meNoneMRUList
valueNonestring

get()

Description

Prototype

MRUListvar.get ( MRUList me, integer index, integer error )

Parameters
ParameterDefault valueType nameDescription
meNoneMRUList
indexNoneinteger
errorNoneinteger

getlistreference()

Description

Prototype

MRUListvar.getlistreference ( MRUList me )

Parameters
ParameterDefault valueType nameDescription
meNoneMRUList

readconfig()

Description

Prototype

MRUListvar.readconfig ( MRUList me, integer error )

Parameters
ParameterDefault valueType nameDescription
meNoneMRUList
errorNoneinteger

removeitem()

Description

Prototype

MRUListvar.removeitem ( MRUList me, integer index, integer error )

Parameters
ParameterDefault valueType nameDescription
meNoneMRUList
indexNoneinteger
errorNoneinteger

setlistreference()

Description

Prototype

MRUListvar.setlistreference ( MRUList me, dlist entries )

Parameters
ParameterDefault valueType nameDescription
meNoneMRUList
entriesNonedlist

showdialog()

Description

Prototype

MRUListvar.showdialog ( MRUList me, type(wxdialogparent) parent, string captiontext )

Parameters
ParameterDefault valueType nameDescription
meNoneMRUList
parentNonetype(wxdialogparent)
captiontextNonestring

updatemenu()

Description

Prototype

MRUListvar.updatemenu ( MRUList me, integer error )

Parameters
ParameterDefault valueType nameDescription
meNoneMRUList
errorNoneinteger

writeconfig()

Description

Prototype

MRUListvar.writeconfig ( MRUList me, integer error )

Parameters
ParameterDefault valueType nameDescription
meNoneMRUList
errorNoneinteger