Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== CliCommand Class ======
[[https://github.com/LibreCAD/LibreCAD_3/blob/master/lcUI/widgets/clicommand.h|Github Link]]
<code cpp-qt> namespace lc::ui::widgets </code>

----

===== Add Command =====

----

==== Description ====

Add and register a new command to the command line with the given lua callback. The command is enabled on adding. Returns false if command name already exists.

  * Command - //string// , Lua Callback - //kaguya::LuaRef//
    *  //bool// (success)

==== Examples ====

  * <code lua> local clicommand = mainWindow:cliCommand()
 clicommand:addCommand("SayHi", function() message("Hi!") end) </code>

----

===== Write to Command Line =====

----

==== Description ====

Write a message to the command line. <code> message("Text") </code> function actually calls this function to print a message to the clicommand.

  * Message - //string//

==== Examples ====

  * <code lua> clicommand:write("Test Message") </code>

----

===== Run Command =====

----

==== Description ====

Run the command i.e. run the lua callback corresponding to the given command. Dosen't do anything if command is not present or disabled.

  * Command - //string//

==== Examples ====

  * <code lua> clicommand:runCommand("LINE") </code>

----

===== Enable Command =====

----

==== Description ====

Enable the given command. Dosen't do anything if command dosen't exist.

  * Command - //string//

==== Examples ====

  * <code lua> clicommand:enableCommand("LINE") </code>

----

===== Disable Command =====

----

==== Description ====

Disables the given command. Dosen't do anything if command dosen't exist.

  * Command - //string//

==== Examples ====

  * <code lua> clicommand:disableCommand("LINE") </code>

----

===== Is Command Enabled =====

----

==== Description ====

Returns a boolean indicating whether the command is enabled or disabled.

  * Command - //string//
    * returns //bool//

==== Examples ====

  * <code lua> local enab = clicommand:isCommandEnabled("LINE") </code>

----

===== Available Commands =====

----

==== Description ====

Returns a list of all available command names.

==== Examples ====

  * <code lua> local allcommands = clicommand:availableCommands()
 for k,v in pairs(allcommands) do cliCommand:runCommand(v) end </code>

----

===== Get Commands History =====

----

==== Description ====

Returns a list of all commands that have been entered since program started.

==== Examples ====

  * <code lua> local history = cliCommand:commandsHistory() </code>

----

===== Clear CliCommand Output =====

----

==== Description ====

Clear the cli command console. Can also be accessed by using command "CLEAR" in the command line.

==== Examples ====

  * <code lua> cliCommand:clear() </code>

----
Wiki

User Tools

Site Tools

Page Tools
