mirror of https://github.com/pbek/QOwnNotes.git synced 2025-06-29 13:29:52 +00:00

History

Patrizio Bekerle cfad3844ff added some information		2016-05-12 19:47:05 +02:00
..
absolute-media-links.qml	added a new script function `insertingFromMimeDataHook` and renamed function `modifyMediaMarkdown` to `insertMediaHook`	2016-05-12 18:50:18 +02:00
example.qml	improved the script	2016-05-12 19:13:02 +02:00
execute-command-after-note-update.qml	more scripting implementation	2016-05-12 11:44:29 +02:00
note-text-from-5pm-mail.qml	added some information	2016-05-12 19:47:05 +02:00
README.md	added more information	2016-05-12 12:20:22 +02:00

README.md

QOwnNotes Scripting

you may need to restart QOwnNotes to let changes in a script take action
if you need access to a certain functionality in QOwnNotes or have questions or ideas please open an issue on the QOwnNotes issue page

Methods and objects QOwnNotes provides

Starting an external program in the background

Parameters

/**
 * QML wrapper to start a detached process
 *
 * @param executablePath the path of the executable
 * @param parameters a list of parameter strings
 * @return true on success, false otherwise
 */
bool startDetachedProcess(QString executablePath, QStringList parameters);

Usage in QML

script.startDetachedProcess("/path/to/my/program", ["my parameter"]);

Getting the path of the current note folder

Parameters

/**
 * QML wrapper to get the current note folder path
 *
 * @return the path of the current note folder
 */
QString currentNoteFolderPath();

Usage in QML

var path = script.currentNoteFolderPath();