Warning, /office/kile/kile-remote-control.txt is written in an unsupported language. File is not indexed.
0001 This document describes Kile's DBUS interface and the parts of the Lyx protocol known by Kile.
0002
0003 1. Kile's DBUS interface
0004
0005 Open a file either by absolute or relative path:
0006 virtual void openDocument(const QString &);
0007
0008 Insert text at the cursor position in the current document; this can be used to replace Lyx's pipe mechanism:
0009 virtual void insertText(const QString &);
0010
0011 Close the current document:
0012 virtual void closeDocument();
0013
0014 Open a Kile project file, either by absolute or relative path:
0015 virtual void openProject(const QString &);
0016
0017 Jump to the given line in the current document; please note that the parameter is not of the type 'int' but of 'QString' instead:
0018 virtual void setLine(const QString &);
0019
0020 Raise Kile's main window; does not steal the focus:
0021 virtual void setActive();
0022
0023 Run the given tool; the return values are { Running = 0, ConfigureFailed, NoLauncherInstalled, NoValidTarget, NoValidSource, TargetHasWrongPermissions, NoValidPrereqs, CouldNotLaunch, SelfCheckFailed}:
0024 virtual int run(const QString &);
0025
0026 Run the given tool with a specific configuration as second parameter; returns the same values as the function above:
0027 virtual int runWith(const QString &, const QString &);
0028
0029
0030 2. Kile's Lyx Pipe emulation
0031
0032 The following Lyx commands are understood by Kile.
0033
0034 Insert the citations $Name1, Name2, ... at the current cursor postion; the citation command is hard coded to '\cite':
0035 :citation-insert:$Name1,$Name2
0036
0037 Insert the command \bibliography with the files named $myBib1, $myBib2, ... at the current cursor position:
0038 :bibtex-database-add:$myBib
0039
0040 Insert the string $text at the current cursor position:
0041 :paste:$text
0042
0043 Valid for Kile 2.1, written at 6/9/2009
0044
0045 The Kile Development Team
0046