commandLine << Previous Next >> miscellaneousFunctionality

LuaCmdPluginAPIreference

LuaCmd Plugin API reference

API functions for LuaCommander plugin.

simLuaCmd.clearHistory
simLuaCmd.setArrayMaxItemsDisplayed
simLuaCmd.setAutoAcceptCommonCompletionPrefix
simLuaCmd.setDynamicCompletion
simLuaCmd.setEnabled
simLuaCmd.setFloatPrecision
simLuaCmd.setHistoryRemoveDups
simLuaCmd.setHistorySize
simLuaCmd.setHistorySkipRepeated
simLuaCmd.setMapMaxDepth
simLuaCmd.setMapShadowBufferStrings
simLuaCmd.setMapShadowLongStrings
simLuaCmd.setMapShadowSpecialStrings
simLuaCmd.setMapSortKeysByName
simLuaCmd.setMapSortKeysByType
simLuaCmd.setPrintAllReturnedValues
simLuaCmd.setResizeStatusbarWhenFocused
simLuaCmd.setShowMatchingHistory
simLuaCmd.setStringEscapeSpecials
simLuaCmd.setStringLongLimit
simLuaCmd.setWarnAboutMultipleReturnedValues

simLuaCmd.clearHistory

Description	Clear command history
Lua synopsis	simLuaCmd.clearHistory()
Lua parameters	-
Lua return values	-
Python synopsis	simLuaCmd.clearHistory()
See also

simLuaCmd.setArrayMaxItemsDisplayed

Description	Set the maximum number of items displayed when rendering an array
Lua synopsis	simLuaCmd.setArrayMaxItemsDisplayed(int n)
Lua parameters	n (int): the maximum number of items
Lua return values	-
Python synopsis	simLuaCmd.setArrayMaxItemsDisplayed(int n)
See also

simLuaCmd.setAutoAcceptCommonCompletionPrefix

Description	If all completions have a common prefix, that is automatically accepted if this option is set to true
Lua synopsis	simLuaCmd.setAutoAcceptCommonCompletionPrefix(bool b)
Lua parameters	b (bool): if true, common prefix is accepted
Lua return values	-
Python synopsis	simLuaCmd.setAutoAcceptCommonCompletionPrefix(bool b)
See also

simLuaCmd.setDynamicCompletion

Description	Complete words using the selected script
Lua synopsis	simLuaCmd.setDynamicCompletion(bool b)
Lua parameters	b (bool): if true, dynamic completion will be used
Lua return values	-
Python synopsis	simLuaCmd.setDynamicCompletion(bool b)
See also

simLuaCmd.setEnabled

Description	Enable/disable the plugin (i.e. show or hide the UI)
Lua synopsis	simLuaCmd.setEnabled(bool b)
Lua parameters	b (bool): if true, plugin is enabled
Lua return values	-
Python synopsis	simLuaCmd.setEnabled(bool b)
See also

simLuaCmd.setFloatPrecision

Description	Number of significative digits to show
Lua synopsis	simLuaCmd.setFloatPrecision(int n)
Lua parameters	n (int): number of significative digits
Lua return values	-
Python synopsis	simLuaCmd.setFloatPrecision(int n)
See also

simLuaCmd.setHistoryRemoveDups

Description	Skip saving duplicate entries in command history
Lua synopsis	simLuaCmd.setHistoryRemoveDups(bool b)
Lua parameters	b (bool): if true, no duplicate entries will be saved
Lua return values	-
Python synopsis	simLuaCmd.setHistoryRemoveDups(bool b)
See also

simLuaCmd.setHistorySize

Description	Maximum number of items to store in command history
Lua synopsis	simLuaCmd.setHistorySize(int n)
Lua parameters	n (int): number of items
Lua return values	-
Python synopsis	simLuaCmd.setHistorySize(int n)
See also

simLuaCmd.setHistorySkipRepeated

Description	Skip saving repeated entries in command history
Lua synopsis	simLuaCmd.setHistorySkipRepeated(bool b)
Lua parameters	b (bool): if true, more than one identical consecutive entries will not be saved
Lua return values	-
Python synopsis	simLuaCmd.setHistorySkipRepeated(bool b)
See also

simLuaCmd.setMapMaxDepth

Description	Set map maximum rendering depth (use -1 for unlimited)
Lua synopsis	simLuaCmd.setMapMaxDepth(int n)
Lua parameters	n (int): maximum depth
Lua return values	-
Python synopsis	simLuaCmd.setMapMaxDepth(int n)
See also

simLuaCmd.setMapShadowBufferStrings

Description	Buffer strings (containing null chars) will be replaced by a placeholder
Lua synopsis	simLuaCmd.setMapShadowBufferStrings(bool b)
Lua parameters	b (bool): if true, buffer strings will be replaced by a placeholder
Lua return values	-
Python synopsis	simLuaCmd.setMapShadowBufferStrings(bool b)
See also

simLuaCmd.setMapShadowLongStrings

Description	Long strings will be replaced by a placeholder
Lua synopsis	simLuaCmd.setMapShadowLongStrings(bool b)
Lua parameters	b (bool): if true, long strings will be replaced by a placeholder
Lua return values	-
Python synopsis	simLuaCmd.setMapShadowLongStrings(bool b)
See also

simLuaCmd.setMapShadowSpecialStrings

Description	Strings containing special characters will be replaced by a placeholder
Lua synopsis	simLuaCmd.setMapShadowSpecialStrings(bool b)
Lua parameters	b (bool): if true, strings containing special characters will be replaced by a placeholder
Lua return values	-
Python synopsis	simLuaCmd.setMapShadowSpecialStrings(bool b)
See also

simLuaCmd.setMapSortKeysByName

Description	Sort map keys by name
Lua synopsis	simLuaCmd.setMapSortKeysByName(bool b)
Lua parameters	b (bool): if true, map keys will be sorted by name
Lua return values	-
Python synopsis	simLuaCmd.setMapSortKeysByName(bool b)
See also

simLuaCmd.setMapSortKeysByType

Description	Sort map keys by type
Lua synopsis	simLuaCmd.setMapSortKeysByType(bool b)
Lua parameters	b (bool): if true, map keys will be sorted by type
Lua return values	-
Python synopsis	simLuaCmd.setMapSortKeysByType(bool b)
See also

simLuaCmd.setPrintAllReturnedValues

Description	Set whether to print all the returned values or only the first
Lua synopsis	simLuaCmd.setPrintAllReturnedValues(bool b)
Lua parameters	b (bool): if true, all returned values will be printed
Lua return values	-
Python synopsis	simLuaCmd.setPrintAllReturnedValues(bool b)
See also

simLuaCmd.setResizeStatusbarWhenFocused

Description	Save alternative statusbar size for when the commander has the focus
Lua synopsis	simLuaCmd.setResizeStatusbarWhenFocused(bool b)
Lua parameters	b (bool): if true, alternate size will be used when widget has focus
Lua return values	-
Python synopsis	simLuaCmd.setResizeStatusbarWhenFocused(bool b)
See also

simLuaCmd.setShowMatchingHistory

Description	History entries beginning with current buffer will be shown in preview. Use UP arrow to navigate matching entries.
Lua synopsis	simLuaCmd.setShowMatchingHistory(bool b)
Lua parameters	b (bool): if true, matching entries are shown
Lua return values	-
Python synopsis	simLuaCmd.setShowMatchingHistory(bool b)
See also

simLuaCmd.setStringEscapeSpecials

Description	Escape special characters in strings
Lua synopsis	simLuaCmd.setStringEscapeSpecials(bool b)
Lua parameters	b (bool): if true, special characters will be escaped
Lua return values	-
Python synopsis	simLuaCmd.setStringEscapeSpecials(bool b)
See also

simLuaCmd.setStringLongLimit

Description	Set the length threshold for strings
Lua synopsis	simLuaCmd.setStringLongLimit(int n)
Lua parameters	n (int): the string length threshold
Lua return values	-
Python synopsis	simLuaCmd.setStringLongLimit(int n)
See also

simLuaCmd.setWarnAboutMultipleReturnedValues

Description	Set whether to print a warning is there are multiple returned values, and only one value is displayed
Lua synopsis	simLuaCmd.setWarnAboutMultipleReturnedValues(bool b)
Lua parameters	b (bool): if true, warning will be emitted
Lua return values	-
Python synopsis	simLuaCmd.setWarnAboutMultipleReturnedValues(bool b)
See also

, , , ,
commandLine << Previous Next >> miscellaneousFunctionality