@setGlobal(DESC,"Returns the list of child widgets contained in the parent widget. Set the <i>recursive</i> parameter to <i>true</i> to include widgets contained by child widgets.")
@setGlobal(DESC,"Removes all content from the widget.")
@case(DCOP::count(QString))
@setGlobal(enWidget,1)
@setGlobal(PARM1,"")
@setGlobal(PARM2,"")
@setGlobal(PARM3,"")
@setGlobal(PARM4,"")
@setGlobal(short,count)
@setGlobal(DESC,"Returns number of items in a widget such as combobox or listbox.")
@case(DCOP::currentColumn(QString))
@setGlobal(enWidget,1)
@setGlobal(PARM1,"")
@setGlobal(PARM2,"")
@setGlobal(PARM3,"")
@setGlobal(PARM4,"")
@setGlobal(short,currentColumn)
@setGlobal(DESC,"Returns index of current column.")
@case(DCOP::currentItem(QString))
@setGlobal(enWidget,1)
@setGlobal(PARM1,"")
@setGlobal(PARM2,"")
@setGlobal(PARM3,"")
@setGlobal(PARM4,"")
@setGlobal(short,currentItem)
@setGlobal(DESC,"Returns index of current item.")
@case(DCOP::currentRow(QString))
@setGlobal(enWidget,1)
@setGlobal(PARM1,"")
@setGlobal(PARM2,"")
@setGlobal(PARM3,"")
@setGlobal(PARM4,"")
@setGlobal(short,currentRow)
@setGlobal(DESC,"Returns index of current row.")
@case(DCOP::execute(QString))
@setGlobal(enWidget,1)
@setGlobal(PARM1,"")
@setGlobal(PARM2,"")
@setGlobal(PARM3,"")
@setGlobal(PARM4,"")
@setGlobal(short,execute)
@setGlobal(DESC,"Executes the script associated with the widget. With the new parser the execute method can take one or more arguments.")
@case(DCOP::findItem(QString,QString))
@setGlobal(enWidget,1)
@setGlobal(PARM1,"item")
@setGlobal(PARM2,"")
@setGlobal(PARM3,"")
@setGlobal(PARM4,"")
@setGlobal(short,findItem)
@setGlobal(DESC,"Returns the index of an item with the given text.")
@case(DCOP::insertColumn(QString,int,int))
@setGlobal(enWidget,1)
@setGlobal(PARM1,"column")
@setGlobal(PARM2,"count")
@setGlobal(PARM3,"")
@setGlobal(PARM4,"")
@setGlobal(short,insertColumn)
@setGlobal(DESC,"Inserts new column &#040;or <i>count</i> columns&#041; at <i>column</i> position.")
@case(DCOP::insertItem(QString,QString,int))
@setGlobal(enWidget,1)
@setGlobal(PARM1,"item")
@setGlobal(PARM2,"index")
@setGlobal(PARM3,"")
@setGlobal(PARM4,"")
@setGlobal(short,insertItem)
@setGlobal(DESC,"Inserts item at <i>index</i> position.")
@case(DCOP::insertItems(QString,QStringList,int))
@setGlobal(enWidget,1)
@setGlobal(PARM1,"items")
@setGlobal(PARM2,"index")
@setGlobal(PARM3,"")
@setGlobal(PARM4,"")
@setGlobal(short,insertItems)
@setGlobal(DESC,"Inserts multiple items &#040;EOL-separated&#041; at <i>index</i> position.")
@case(DCOP::insertRow(QString,int,int))
@setGlobal(enWidget,1)
@setGlobal(PARM1,"row")
@setGlobal(PARM2,"count")
@setGlobal(PARM3,"")
@setGlobal(PARM4,"")
@setGlobal(short,insertRow)
@setGlobal(DESC,"Inserts new row &#040;or <i>count</i> rows&#041; at <i>row</i> position.")
@case(DCOP::item(QString,int))
@setGlobal(enWidget,1)
@setGlobal(PARM1,"index")
@setGlobal(PARM2,"")
@setGlobal(PARM3,"")
@setGlobal(PARM4,"")
@setGlobal(short,item)
@setGlobal(DESC,"Returns the text of the item at the given index.")
@case(DCOP::itemDepth(QString,int))
@setGlobal(enWidget,1)
@setGlobal(PARM1,"index")
@setGlobal(PARM2,"")
@setGlobal(PARM3,"")
@setGlobal(PARM4,"")
@setGlobal(short,itemDepth)
@setGlobal(DESC,"Returns the depth of the current item in the tree. Root items have depth 0.")
@case(DCOP::itemPath(QString,int))
@setGlobal(enWidget,1)
@setGlobal(PARM1,"index")
@setGlobal(PARM2,"")
@setGlobal(PARM3,"")
@setGlobal(PARM4,"")
@setGlobal(short,itemPath)
@setGlobal(DESC,"Returns the slash-separated path to the given item in the tree.")
@case(DCOP::removeColumn(QString,int,int))
@setGlobal(enWidget,1)
@setGlobal(PARM1,"column")
@setGlobal(PARM2,"count")
@setGlobal(PARM3,"")
@setGlobal(PARM4,"")
@setGlobal(short,removeColumn)
@setGlobal(DESC,"Removes the column &#040;or <i>count</i> consecutive columns&#041; with the given index.")
@case(DCOP::removeItem(QString,int))
@setGlobal(enWidget,1)
@setGlobal(PARM1,"index")
@setGlobal(PARM2,"")
@setGlobal(PARM3,"")
@setGlobal(PARM4,"")
@setGlobal(short,removeItem)
@setGlobal(DESC,"Removes the item with the given index.")
@case(DCOP::removeRow(QString,int,int))
@setGlobal(enWidget,1)
@setGlobal(PARM1,"row")
@setGlobal(PARM2,"count")
@setGlobal(PARM3,"")
@setGlobal(PARM4,"")
@setGlobal(short,removeRow)
@setGlobal(DESC,"Removes the row &#040;or <i>count</i> consecutive rows&#041; with the given index.")
@case(DCOP::selection(QString))
@setGlobal(enWidget,1)
@setGlobal(PARM1,"")
@setGlobal(PARM2,"")
@setGlobal(PARM3,"")
@setGlobal(PARM4,"")
@setGlobal(short,selection)
@setGlobal(DESC,"Returns selected text or text of current item.\nIn case of Table widgets, returns the selection coordinates, separated by commas in TopRow,LeftColumn,BottomRow,RightColumn form. ")
@case(DCOP::setAssociatedText(QString,QString))
@setGlobal(enWidget,1)
@setGlobal(PARM1,"text")
@setGlobal(PARM2,"")
@setGlobal(PARM3,"")
@setGlobal(PARM4,"")
@setGlobal(short,setAssociatedText)
@setGlobal(DESC,"Sets scripts associated with widget. This is an advanced feature that would not be commonly used.")
@case(DCOP::setEnabled(QString,bool))
@setGlobal(enWidget,1)
@setGlobal(PARM1,"enabled")
@setGlobal(PARM2,"")
@setGlobal(PARM3,"")
@setGlobal(PARM4,"")
@setGlobal(short,setEnabled)
@setGlobal(DESC,"Enables or disables widget.")
@case(DCOP::setCellText(QString,int,int,QString))
@setGlobal(enWidget,1)
@setGlobal(PARM1,"row")
@setGlobal(PARM2,"col")
@setGlobal(PARM3,"text")
@setGlobal(PARM4,"")
@setGlobal(short,setCellText)
@setGlobal(DESC,"Sets text of a cell in a table.")
@setGlobal(DESC,"Sets caption of the column <i>column</i>.")
@case(DCOP::setCurrentItem(QString,int))
@setGlobal(enWidget,1)
@setGlobal(PARM1,"index")
@setGlobal(PARM2,"")
@setGlobal(PARM3,"")
@setGlobal(PARM4,"")
@setGlobal(short,setCurrentItem)
@setGlobal(DESC,"Selects the item at the specified index. Indexes are zero based.")
@case(DCOP::insertTab(QString,QString,int))
@setGlobal(enWidget,1)
@setGlobal(PARM1,"label")
@setGlobal(PARM2,"index")
@setGlobal(PARM3,"")
@setGlobal(PARM4,"")
@setGlobal(short,insertTab)
@setGlobal(DESC,"Inserts a tab to the tabwidget with the specified label at the given index. Indexes are zero based.")
@case(DCOP::setMaximum(QString,int))
@setGlobal(enWidget,1)
@setGlobal(PARM1,"value")
@setGlobal(PARM2,"")
@setGlobal(PARM3,"")
@setGlobal(PARM4,"")
@setGlobal(short,setMaximum)
@setGlobal(DESC,"Sets maximum numeric value")
@case(DCOP::setPixmap(QString,QString,int))
@setGlobal(enWidget,1)
@setGlobal(PARM1,"iconName")
@setGlobal(PARM2,"index")
@setGlobal(PARM3,"")
@setGlobal(PARM4,"")
@setGlobal(short,setPixmap)
@setGlobal(DESC,"Sets pixmap at the given index to the specified icon. Use <i>index = -1</i> to set the pixmap for all items.")
@case(DCOP::setRowCaption(QString,int,QString))
@setGlobal(enWidget,1)
@setGlobal(PARM1,"row")
@setGlobal(PARM2,"text")
@setGlobal(PARM3,"")
@setGlobal(PARM4,"")
@setGlobal(short,setRowCaption)
@setGlobal(DESC,"Sets caption of the row <i>row</i>.")
@case(DCOP::setSelection(QString,QString))
@setGlobal(enWidget,1)
@setGlobal(PARM1,"text")
@setGlobal(PARM2,"")
@setGlobal(PARM3,"")
@setGlobal(PARM4,"")
@setGlobal(short,setSelection)
@setGlobal(DESC,"Selects given text or select item containing given text.")
@case(DCOP::setText(QString,QString))
@setGlobal(enWidget,1)
@setGlobal(PARM1,"text")
@setGlobal(PARM2,"")
@setGlobal(PARM3,"")
@setGlobal(PARM4,"")
@setGlobal(short,setText)
@setGlobal(DESC,"Sets widget's content.")
@case(DCOP::setVisible(QString,bool))
@setGlobal(enWidget,1)
@setGlobal(PARM1,"visible")
@setGlobal(PARM2,"")
@setGlobal(PARM3,"")
@setGlobal(PARM4,"")
@setGlobal(short,setVisible)
@setGlobal(DESC,"Shows/hides widget.")
@case(DCOP::type(QString))
@setGlobal(enWidget,1)
@setGlobal(PARM1,"")
@setGlobal(PARM2,"")
@setGlobal(PARM3,"")
@setGlobal(PARM4,"")
@setGlobal(short,type)
@setGlobal(DESC,"Returns type&#040;class&#041; of widget.")
@case(DCOP::setEditable(QString,bool))
@setGlobal(enWidget,1)
@setGlobal(PARM1,"editable")
@setGlobal(PARM2,"")
@setGlobal(PARM3,"")
@setGlobal(PARM4,"")
@setGlobal(short,setEditable)
@setGlobal(DESC,"Makes the widget editable or read only, depending on the editable argument.")
@case(Kommander::setEditable(QString,bool))
@setGlobal(enWidget,1)
@setGlobal(PARM1,"editable")
@setGlobal(PARM2,"")
@setGlobal(PARM3,"")
@setGlobal(PARM4,"")
@setGlobal(short,setEditable)
@setGlobal(DESC,"Returns current widget's content. This was required inside widget A to return widget A content when requested by widget B. The new method is to use &#064;A.text inside B instead of just &#064;A if you just want the unaltered text.")
@case(Kommander::setEditable(QString,bool))
@setGlobal(enWidget,1)
@setGlobal(PARM1,"editable")
@setGlobal(PARM2,"")
@setGlobal(PARM3,"")
@setGlobal(PARM4,"")
@setGlobal(short,setEditable)
@setGlobal(DESC,"Returns selected text or text of current item. This is deprecated for <i>&#064;mywidget.selected</i>.")
@case(Kommander::setEditable(QString,bool))
@setGlobal(enWidget,1)
@setGlobal(PARM1,"editable")
@setGlobal(PARM2,"")
@setGlobal(PARM3,"")
@setGlobal(PARM4,"")
@setGlobal(short,setEditable)
@setGlobal(DESC,"Does nothing. This is useful if you request a CheckBox or RadioButton to return a value where a state, typically the unchecked state, has no value. The &#064;null prevents an error indicating it is empty.")
@case(Kommander::pid(QString,bool))
@setGlobal(enWidget,1)
@setGlobal(PARM1,"editable")
@setGlobal(PARM2,"")
@setGlobal(PARM3,"")
@setGlobal(PARM4,"")
@setGlobal(short,pid)
@setGlobal(DESC,"Returns the pid &#040;process ID&#041; of the current process.")
@case(Kommander::dcopid(QString,bool))
@setGlobal(enWidget,1)
@setGlobal(PARM1,"editable")
@setGlobal(PARM2,"")
@setGlobal(PARM3,"")
@setGlobal(PARM4,"")
@setGlobal(short,dcopid)
@setGlobal(DESC,"Returns DCOP identifier of current process. This is shorthand for <i>kmdr-executor-&#064;pid</i>.")
@setGlobal(DESC,"Writes <i>text</i> on stderr.")
@case(Kommander::echo(QString))
@setGlobal(enWidget,0)
@setGlobal(PARM1,"text")
@setGlobal(PARM2,"")
@setGlobal(PARM3,"")
@setGlobal(PARM4,"")
@setGlobal(short,echo)
@setGlobal(DESC,"Writes <i>text</i> on standard output.")
@case(Kommander::echo(QString))
@setGlobal(enWidget,0)
@setGlobal(PARM1,"text")
@setGlobal(PARM2,"")
@setGlobal(PARM3,"")
@setGlobal(PARM4,"")
@setGlobal(short,echo)
@setGlobal(DESC,"Executes a script block. Bash is used if no shell is given. It is primarily for use in non-button widgets where script actions are not expected. Full path is not required for the shell which may be useful for portability. <p><i>If this is used inside a button it allows alternate script languages to be used and will return a value to the main script, which may be unexpected.</i>")
@case(Kommander::env(QString))
@setGlobal(enWidget,0)
@setGlobal(PARM1,"variable")
@setGlobal(PARM2,"")
@setGlobal(PARM3,"")
@setGlobal(PARM4,"")
@setGlobal(short,env)
@setGlobal(DESC,"Returns value of an environment &#040;shell&#041; variable. Do not use <i>$</i> in the name. For example, <i>&#064;env&#040;PATH&#041;</i>.")
@case(Kommander::exec(QString))
@setGlobal(enWidget,0)
@setGlobal(PARM1,"command")
@setGlobal(PARM2,"")
@setGlobal(PARM3,"")
@setGlobal(PARM4,"")
@setGlobal(short,exec)
@setGlobal(DESC,"Executes an external shell command.")
@case(Kommander::exec(QString))
@setGlobal(enWidget,0)
@setGlobal(PARM1,"command")
@setGlobal(PARM2,"")
@setGlobal(PARM3,"")
@setGlobal(PARM4,"")
@setGlobal(short,exec)
@setGlobal(DESC,"Parses an expression and returns computed value.")
@case(Kommander::forEach(QString,QString))
@setGlobal(enWidget,0)
@setGlobal(PARM1,"variable")
@setGlobal(PARM2,"items")
@setGlobal(PARM3,"")
@setGlobal(PARM4,"")
@setGlobal(short,forEach)
@setGlobal(DESC,"Executes loop: values from <i>items</i> list &#040;passed as EOL-separated string&#041; are assigned to the variable. <br><b>Old</b><br> <i>&#064;forEach&#040;i,A\\nB\\nC\\n&#041;<br> &#064;# &#064;i=A<br>&#064;end</i><br><b>New</b><br><i>foreach i in MyArray do<br> //i = key, MyArray[i] = val<br>end ")
@case(Kommander::for(QString,int,int,int))
@setGlobal(enWidget,0)
@setGlobal(PARM1,"variable")
@setGlobal(PARM2,"start")
@setGlobal(PARM3,"end")
@setGlobal(PARM4,"step")
@setGlobal(short,for)
@setGlobal(DESC,"Executes loop: variable is set to <i>start</i> and is increased by <i>step</i> each time loop is executed. Execution stops when variable becomes larger then <i>end</i>. <br><b>Old</b><br><i>&#064;for&#040;i,1,10,1&#041;<br> &#064;# &#064;i=1<br>&#064;endif</i><br><b>New</b><br><i>for i=0 to 20 step 5 do<br> debug&#040;i&#041;<br>end</i>.")
@case(Kommander::for(QString,int,int,int))
@setGlobal(enWidget,0)
@setGlobal(PARM1,"variable")
@setGlobal(PARM2,"start")
@setGlobal(PARM3,"end")
@setGlobal(PARM4,"step")
@setGlobal(short,for)
@setGlobal(DESC,"Returns the value of a global variable.")
@case(Kommander::i18n(QString))
@setGlobal(enWidget,0)
@setGlobal(PARM1,"variable")
@setGlobal(PARM2,"")
@setGlobal(PARM3,"")
@setGlobal(PARM4,"")
@setGlobal(short,i18n)
@setGlobal(DESC,"Translates the string into the current language. Texts in GUI would be automatically extracted for translation.")
@case(Kommander::if(QString))
@setGlobal(enWidget,0)
@setGlobal(PARM1,"expression")
@setGlobal(PARM2,"")
@setGlobal(PARM3,"")
@setGlobal(PARM4,"")
@setGlobal(short,if)
@setGlobal(DESC,"Executes block if expression is true &#040;non-zero number or non-empty string.&#041; <p><b>Old</b>Close with <b>&#064;endif</b></p><p><b>New</b><br>if val == true then<br>// do op<br>elseif cond<br>// second chance<br>else<br>// cond failed<br>endif</p>")
@case(Kommander::dialog(QString,QString))
@setGlobal(enWidget,0)
@setGlobal(PARM1,"file")
@setGlobal(PARM2,"args")
@setGlobal(PARM3,"")
@setGlobal(PARM4,"")
@setGlobal(short,dialog)
@setGlobal(DESC,"Executes another Kommander dialog. Current dialog directory is used if no path is given. Arguments may be given as named arguments which will become global variables in the new dialog. For instance: <i>var=val</i>")
@case(Kommander::readSetting(QString,QString))
@setGlobal(enWidget,0)
@setGlobal(PARM1,"key")
@setGlobal(PARM2,"default")
@setGlobal(PARM3,"")
@setGlobal(PARM4,"")
@setGlobal(short,readSetting)
@setGlobal(DESC,"Reads setting from configration file for this dialog.")
@case(Kommander::setGlobal(QString,QString))
@setGlobal(enWidget,0)
@setGlobal(PARM1,"variable")
@setGlobal(PARM2,"value")
@setGlobal(PARM3,"")
@setGlobal(PARM4,"")
@setGlobal(short,setGlobal)
@setGlobal(DESC,"Sets the value of a global variable. Global variables exist for the life of the Kommander window.")
@case(Kommander::writeSetting(QString,QString))
@setGlobal(enWidget,0)
@setGlobal(PARM1,"key")
@setGlobal(PARM2,"value")
@setGlobal(PARM3,"")
@setGlobal(PARM4,"")
@setGlobal(short,writeSetting)
@setGlobal(DESC,"Stores setting in configuration file for this dialog.")
@case(Kommander::writeSetting(QString,QString))
@setGlobal(enWidget,0)
@setGlobal(PARM1,"key")
@setGlobal(PARM2,"value")
@setGlobal(PARM3,"")
@setGlobal(PARM4,"")
@setGlobal(short,writeSetting)
@setGlobal(DESC,"Begin of <b>switch</b> block. Following <b>case</b> values are compared to <i>expression</i>.<p>&#064;switch&#040;&#041;<br>&#064;case&#040;&#041;<br>&#064;end")
@setGlobal(DESC,"Returns the given string with %1, %2, %3 replaced with <i>arg1</i>, <i>arg2</i>, <i>arg3</i> accordingly.")