Skip to content
Snippets Groups Projects
Commit b7095140 authored by hluk's avatar hluk
Browse files

Update autocompletion help 


Signed-off-by: default avatarLukas Holecek <hluk@email.cz>
parent 52226368
No related branches found
No related tags found
No related merge requests found
Hide whitespace changes
Inline Side-by-side
src/gui/commandcompleterdocumentation.h
+ 25
− 19
View file @ b7095140
......@@ -21,18 +21,19 @@ void addDocumentation(AddDocumentationCallback addDocumentation)
addDocumentation("visible", "bool visible()", "Returns true only if main window is visible.");
addDocumentation("focused", "bool focused()", "Returns true only if main window has focus.");
addDocumentation("filter", "filter(filterText)", "Sets text for filtering items in main window.");
addDocumentation("filter", "String filter()", "Returns current text for filtering items in main window.");
addDocumentation("ignore", "ignore()", "Ignores current clipboard content (used for automatic commands).");
addDocumentation("clipboard", "ByteArray clipboard([mimeType])", "Returns clipboard data for MIME type (default is text).");
addDocumentation("selection", "ByteArray selection([mimeType])", "Same as `clipboard()` for Linux/X11 mouse selection.");
addDocumentation("hasClipboardFormat", "bool hasClipboardFormat(mimeType)", "Returns true only if clipboard contains MIME type.");
addDocumentation("hasSelectionFormat", "bool hasSelectionFormat(mimeType)", "Same as `hasClipboardFormat()` for Linux/X11 mouse selection.");
addDocumentation("isClipboard", "bool isClipboard()", "Returns true only in automatic command triggered by clipboard change.");
addDocumentation("copy", "bool copy(text)", "Sets clipboard plain text.");
addDocumentation("copy", "bool copy(mimeType, data, [mimeType, data]...)", "Sets clipboard data.");
addDocumentation("copy", "bool copy()", "Sends `Ctrl+C` to current window.");
addDocumentation("copySelection", "ByteArray copySelection(...)", "Same as `copy(...)` for Linux/X11 mouse selection.");
addDocumentation("copy", "copy(text)", "Sets clipboard plain text.");
addDocumentation("copy", "copy(mimeType, data, [mimeType, data]...)", "Sets clipboard data.");
addDocumentation("copy", "copy()", "Sends `Ctrl+C` to current window.");
addDocumentation("copySelection", "copySelection(...)", "Same as `copy(...)` for Linux/X11 mouse selection.");
addDocumentation("paste", "paste()", "Pastes current clipboard.");
addDocumentation("tab", "Array tab()", "Returns array of with tab names.");
addDocumentation("tab", "String[] tab()", "Returns array of tab names.");
addDocumentation("tab", "tab(tabName)", "Sets current tab for the script.");
addDocumentation("removeTab", "removeTab(tabName)", "Removes tab.");
addDocumentation("renameTab", "renameTab(tabName, newTabName)", "Renames tab.");
......@@ -46,8 +47,8 @@ void addDocumentation(AddDocumentationCallback addDocumentation)
addDocumentation("insert", "insert(row, text|item...)", "Inserts new items to current tab.");
addDocumentation("remove", "remove(row, ...)", "Removes items in current tab.");
addDocumentation("edit", "edit([row|text] ...)", "Edits items in current tab.");
addDocumentation("read", "ByteArray read([mimeType]);", "Same as `clipboard()`.");
addDocumentation("read", "ByteArray read(mimeType, row, ...);", "Returns concatenated data from items or clipboard if row is negative.");
addDocumentation("read", "ByteArray read([mimeType])", "Same as `clipboard()`.");
addDocumentation("read", "ByteArray read(mimeType, row, ...)", "Returns concatenated data from items, or clipboard if row is negative.");
addDocumentation("write", "write(row, mimeType, data, [mimeType, data]...)", "Inserts new item to current tab.");
addDocumentation("change", "change(row, mimeType, data, [mimeType, data]...)", "Changes data in item in current tab.");
addDocumentation("separator", "String separator()", "Returns item separator (used when concatenating item data).");
......@@ -68,7 +69,8 @@ void addDocumentation(AddDocumentationCallback addDocumentation)
addDocumentation("info", "String info([pathName])", "Returns paths and flags used by the application.");
addDocumentation("eval", "Value eval(script)", "Evaluates script and returns result.");
addDocumentation("source", "Value source(fileName)", "Evaluates script file and returns result of last expression in the script.");
addDocumentation("currentPath", "String currentPath([path])", "Get or set current path.");
addDocumentation("currentPath", "currentPath([path])", "Set current path.");
addDocumentation("currentPath", "String currentPath()", "Get current path.");
addDocumentation("str", "String str(value)", "Converts a value to string.");
addDocumentation("input", "ByteArray input()", "Returns standard input passed to the script.");
addDocumentation("toUnicode", "String toUnicode(ByteArray, encodingName)", "Returns string for bytes with given encoding.");
......@@ -77,18 +79,19 @@ void addDocumentation(AddDocumentationCallback addDocumentation)
addDocumentation("data", "ByteArray data(mimeType)", "Returns data for automatic commands or selected items.");
addDocumentation("setData", "ByteArray setData(mimeType, data)", "Modifies data for `data()` and new clipboard item.");
addDocumentation("removeData", "ByteArray removeData(mimeType)", "Removes data for `data()` and new clipboard item.");
addDocumentation("dataFormats", "Array dataFormats()", "Returns formats available for `data()`.");
addDocumentation("dataFormats", "String[] dataFormats()", "Returns formats available for `data()`.");
addDocumentation("print", "print(value)", "Prints value to standard output.");
addDocumentation("serverLog", "serverLog(value)", "Prints value to application log.");
addDocumentation("abort", "abort()", "Aborts script evaluation.");
addDocumentation("fail", "fail()", "Aborts script evaluation with nonzero exit code.");
addDocumentation("setCurrentTab", "setCurrentTab(tabName)", "Focus tab without showing main window.");
addDocumentation("selectItems", "selectItems(row, ...)", "Selects items in current tab.");
addDocumentation("selectedTab", "String selectedTab()", "Returns tab that was selected when script was executed.");
addDocumentation("selectedItems", "[row, ...] selectedItems()", "Returns selected rows in current tab.");
addDocumentation("selectedItems", "int[] selectedItems()", "Returns selected rows in current tab.");
addDocumentation("selectedItemData", "Item selectedItemData(index)", "Returns data for given selected item.");
addDocumentation("setSelectedItemData", "bool setSelectedItemData(index, item)", "Set data for given selected item.");
addDocumentation("selectedItemsData", "Item[] selectedItemsData()", "Returns data for all selected item.");
addDocumentation("setSelectedItemsData", "void setSelectedItemsData(item[])", "Set data to all selected items.");
addDocumentation("selectedItemsData", "Item[] selectedItemsData()", "Returns data for all selected items.");
addDocumentation("setSelectedItemsData", "setSelectedItemsData(item[])", "Set data to all selected items.");
addDocumentation("currentItem", "int currentItem(), int index()", "Returns current row in current tab.");
addDocumentation("escapeHtml", "String escapeHtml(text)", "Returns text with special HTML characters escaped.");
addDocumentation("unpack", "Item unpack(data)", "Returns deserialized object from serialized items.");
......@@ -101,7 +104,7 @@ void addDocumentation(AddDocumentationCallback addDocumentation)
addDocumentation("execute", "FinishedCommand execute(argument, ..., null, stdinData, ...)", "Executes a command.");
addDocumentation("currentWindowTitle", "String currentWindowTitle()", "Returns window title of currently focused window.");
addDocumentation("dialog", "Value dialog(...)", "Shows messages or asks user for input.");
addDocumentation("settings", "Array settings()", "Returns array with names of all custom options.");
addDocumentation("settings", "String[] settings()", "Returns array with names of all custom options.");
addDocumentation("settings", "Value settings(optionName)", "Returns value for an option.");
addDocumentation("settings", "settings(optionName, value)", "Sets value for a new option or overrides existing option.");
addDocumentation("dateString", "String dateString(format)", "Returns text representation of current date and time.");
......@@ -115,17 +118,20 @@ void addDocumentation(AddDocumentationCallback addDocumentation)
addDocumentation("setEnv", "bool setEnv(name, value)", "Sets environment variable with given name to given value.");
addDocumentation("sleep", "sleep(time)", "Wait for given time in milliseconds.");
addDocumentation("afterMilliseconds", "afterMilliseconds(time, function)", "Executes function after given time in milliseconds.");
addDocumentation("screenNames", "String[] screenNames()", "Returns list of available screen names.");
addDocumentation("screenshot", "ByteArray screenshot(format='png', [screenName])", "Returns image data with screenshot.");
addDocumentation("screenshotSelect", "ByteArray screenshotSelect(format='png', [screenName])", "Same as `screenshot()` but allows to select an area on screen.");
addDocumentation("screenNames", "String[] screenNames()", "Returns list of available screen names.");
addDocumentation("queryKeyboardModifiers", "String[] queryKeyboardModifiers()", "Returns list of currently pressed keyboard modifiers which can be 'Ctrl', 'Shift', 'Alt', 'Meta'.");
addDocumentation("iconColor", "iconColor([colorName])", "Get or set current tray and window icon color name.");
addDocumentation("iconTag", "iconTag([tag])", "Get or set current tray and window tag text.");
addDocumentation("iconTagColor", "iconTagColor([colorName])", "Get or set current tray and window tag color name.");
addDocumentation("iconColor", "String iconColor()", "Get current tray and window icon color name.");
addDocumentation("iconColor", "iconColor(colorName)", "Set current tray and window icon color name.");
addDocumentation("iconTag", "String iconTag()", "Get current tray and window tag text.");
addDocumentation("iconTag", "iconTag(tag)", "Set current tray and window tag text.");
addDocumentation("iconTagColor", "String iconTagColor()", "Get current tray and window tag color name.");
addDocumentation("iconTagColor", "iconTagColor(colorName)", "Set current tray and window tag color name.");
addDocumentation("onClipboardChanged", "onClipboardChanged()", "Called when clipboard or X11 selection changes.");
addDocumentation("onOwnClipboardChanged", "onOwnClipboardChanged()", "Called when clipboard or X11 selection changes by a CopyQ instance.");
addDocumentation("onHiddenClipboardChanged", "onHiddenClipboardChanged()", "Called when hidden clipboard or X11 selection changes.");
addDocumentation("runAutomaticCommands", "runAutomaticCommands()", "Executes automatic commands on current data.");
addDocumentation("runAutomaticCommands", "bool runAutomaticCommands()", "Executes automatic commands on current data.");
addDocumentation("clearClipboardData", "clearClipboardData()", "Clear clipboard visibility in GUI.");
addDocumentation("updateTitle", "updateTitle()", "Update main window title and tool tip from current data.");
addDocumentation("updateClipboardData", "updateClipboardData()", "Sets current clipboard data for tray menu, window title and notification.");
......@@ -134,7 +140,7 @@ void addDocumentation(AddDocumentationCallback addDocumentation)
addDocumentation("synchronizeToSelection", "synchronizeToSelection(text)", "Synchronize current data from clipboard to X11 selection.");
addDocumentation("synchronizeFromSelection", "synchronizeFromSelection(text)", "Synchronize current data from X11 selection to clipboard.");
addDocumentation("saveData", "saveData()", "Save current data (depends on `mimeOutputTab`).");
addDocumentation("hasData", "hasData()", "Returns true only if some non-empty data can be returned by data().");
addDocumentation("hasData", "bool hasData()", "Returns true only if some non-empty data can be returned by data().");
addDocumentation("showDataNotification", "showDataNotification()", "Show notification for current data.");
addDocumentation("hideDataNotification", "hideDataNotification()", "Hide notification for current data.");
addDocumentation("setClipboardData", "setClipboardData()", "Sets clipboard data for menu commands.");
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment