User Reference:Custom GUI Commands

BCI2000's Operator Module Scripting capabilities include the ability to prompt the user for specific pieces of information via modal Qt dialogs.

The expanded form of this documentation is still under construction. For now, here is the short summary:

CHOOSE [INPUT] FILE[S] [OF TYPE <.ext1> [<.ext2> ...]] [STARTING AT <dir>] [WITH PROMPT <message>]

Via the Qt graphical user interface, prompt the user to select an existing file (or multiple files, if the keyword FILES is used). Print the resulting file path(s).

CHOOSE [OUTPUT] FILE [OF TYPE <.ext1> [<.ext2> ...]] [STARTING AT <dir>] [WITH PROMPT <message>]

Via the Qt graphical user interface, prompt the user to specify a file into which data can be saved (with an overwrite confirmation dialog if it already exists). Print the resulting file path.

CHOOSE DIRECTORY [STARTING AT <dir>] [WITH PROMPT <message>]

Via the Qt graphical user interface, prompt the user to specify a directory. Print the resulting directory path.

CUSTOM DIALOG [MESSAGE <msg>] [VAR <varname> <label> {[<options>]} ] [BUTTONS {<buttons>}] ...

Via the Qt graphical user interface, prompt the user with a modal dialog that can be flexibly customized.