UICommand

From UBot Studio
(Difference between revisions)
Jump to: navigation, search
(Created page with "== UICommand == The same as Command and includes: ====getHTML==== Should be set to a function that returns html for the command’s ui")
 
m (LillyT moved page UI Command to UICommand without leaving a redirect: New title needed)
 
(2 intermediate revisions by one user not shown)
Line 1: Line 1:
== UICommand ==
+
Creates a new ui command object.
  
The same as Command and includes:
+
== Properties ==
 +
 
 +
====userLevel====
 +
Determines which edition of UBot Studio can use this command
 +
 
 +
====category====
 +
Determines which toolbox category this will go in
  
 
====getHTML====
 
====getHTML====
 +
This property should be set to a function that returns html for the command’s ui
 +
 +
====generateChildren====
 +
If this is a container command, you can use this delegate function to add children automatically
 +
 +
====toolTip====
 +
The tooltip that appears when the user mouses over the command
 +
 +
====name====
 +
The name of the command, which will show as the node’s title.
 +
 +
== Functions ==
 +
 +
 +
====addParameter====
 +
=====usage=====
 +
exampleCommand.addParameter(parameterName, helperText, editorType, Optional listItems = "", Optional advanced = False)
 +
 +
editorType can be one of the following:
 +
=====Editor Types=====
  
Should be set to a function that returns html for the command’s ui
+
*''string
 +
*''element
 +
*''table
 +
*''list
 +
*''variable
 +
*''listbox
 +
*''savefile
 +
*''openfile
 +
*''openfolder
 +
*''search
 +
*''blocktext
 +
*''code
 +
*''condition

Latest revision as of 16:02, 10 January 2016

Creates a new ui command object.

Contents

[edit] Properties

[edit] userLevel

Determines which edition of UBot Studio can use this command

[edit] category

Determines which toolbox category this will go in

[edit] getHTML

This property should be set to a function that returns html for the command’s ui

[edit] generateChildren

If this is a container command, you can use this delegate function to add children automatically

[edit] toolTip

The tooltip that appears when the user mouses over the command

[edit] name

The name of the command, which will show as the node’s title.

[edit] Functions

[edit] addParameter

[edit] usage

exampleCommand.addParameter(parameterName, helperText, editorType, Optional listItems = "", Optional advanced = False)

editorType can be one of the following:

[edit] Editor Types
  • string
  • element
  • table
  • list
  • variable
  • listbox
  • savefile
  • openfile
  • openfolder
  • search
  • blocktext
  • code
  • condition
Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox