Main Page Modules Namespace List Class Hierarchy Compound List File List Namespace Members Compound Members Related Pages
KRun Class Reference
Opens files with their associated applications in KDE.
More...
#include <krun.h>
Inheritance diagram for KRun:
List of all members.
|
Public Methods |
| | KRun (const KURL &url, mode_t mode=0, bool isLocalFile=false, bool showProgressInfo=true) |
| virtual | ~KRun () |
| void | abort () |
| bool | autoDelete () const |
| void | setPreferredService (const QString &desktopEntryName) |
Static Public Methods |
| pid_t | run (const KService &_service, const KURL::List &_urls, bool tempFiles) |
| pid_t | run (const QString &_exec, const KURL::List &_urls, const QString &_name=QString::null, const QString &_icon=QString::null, const QString &_obsolete1=QString::null, const QString &_obsolete2=QString::null) |
| pid_t | runURL (const KURL &_url, const QString &_mimetype, bool tempFile) |
| pid_t | runCommand (QString cmd) |
| pid_t | runCommand (const QString &cmd, const QString &execName, const QString &icon) |
| bool | displayOpenWithDialog (const KURL::List &lst, bool tempFiles) |
| void | shellQuote (QString &_str) |
| QStringList | processDesktopExec (const KService &_service, const KURL::List &_urls, bool has_shell, bool tempFiles) |
| QString | binaryName (const QString &execLine, bool removePath) |
Protected Methods |
| virtual void | foundMimeType (const QString &_type) |
Protected Attributes |
| bool | m_bScanFile |
| bool | m_bInit |
Detailed Description
Opens files with their associated applications in KDE.
To open files with their associated applications in KDE, use KRun.
It can execute any desktop entry, as well as any file, using the default application or another application "bound" to the file type.
In that example, the mimetype of the file is not known by the application, so a KRun instance must be created. It will determine the mimetype by itself. If the mimetype is known, or if you even know the service (application) to use for this file, use one of the static methods.
Definition at line 52 of file krun.h.
Constructor & Destructor Documentation
| KRun::KRun |
( |
const KURL & |
url, |
|
|
mode_t |
mode = 0, |
|
|
bool |
isLocalFile = false, |
|
|
bool |
showProgressInfo = true |
|
) |
|
|
|
|
Create a KRun object to run the preferred application for a file/URL. KRun will first determine the type of the file, and will then run the associated application. - Parameters:
-
| url |
the URL of the file or directory to 'run' |
| mode |
The st_mode field of struct stat. If you don't know this set it to 0. |
| isLocalFile |
If this parameter is set to false then url is examined to find out whether it is a local URL or not. This flag is just used to improve speed, since the function KURL::isLocalFile is a bit slow. |
| showProgressInfo |
Whether to show progress information when determining the type of the file (i.e. when using KIO::stat and KIO::mimetype) Before you set this to false to avoid a dialog box, think about a very slow FTP server... It is always better to provide progress info in such cases. |
|
| virtual KRun::~KRun |
( |
|
) |
[virtual] |
|
|
|
Destructor. Don't call it yourself, since a KRun object auto-deletes itself. |
Member Function Documentation
|
|
Abort this KRun. This kills any jobs launched by it, and leads to deletion if auto-deletion is on. This is much safer than deleting the KRun (in case it's currently showing an error dialog box, for instance) |
| bool KRun::autoDelete |
( |
|
) |
const [inline] |
|
|
|
By default auto deletion is on.
Definition at line 102 of file krun.h. |
| QString KRun::binaryName |
( |
const QString & |
execLine, |
|
|
bool |
removePath |
|
) |
[static] |
|
|
|
Given a full command line (e.g. the Exec= line from a .desktop file), extract the name of the binary being run. - Parameters:
-
| execLine |
the full command line |
| removePath |
if true, remove a (relative or absolute) path. E.g. /usr/bin/ls becomes ls. |
- Since:
-
3.1
|
| bool KRun::displayOpenWithDialog |
( |
const KURL::List & |
lst, |
|
|
bool |
tempFiles |
|
) |
[static] |
|
|
|
Display the Open-With dialog for those URLs, and run the chosen application. - Parameters:
-
| lst |
the list of applications to run |
| tempFiles |
if true and lst are local files, they will be deleted when the application exits. |
- Returns:
-
false if the dialog was canceled
|
| virtual void KRun::foundMimeType |
( |
const QString & |
_type |
) |
[protected, virtual] |
|
|
|
Called if the mimetype has been detected. The function checks whether the document and appends the gzip protocol to the URL. Otherwise runURL is called to finish the job. |
| QStringList KRun::processDesktopExec |
( |
const KService & |
_service, |
|
|
const KURL::List & |
_urls, |
|
|
bool |
has_shell, |
|
|
bool |
tempFiles |
|
) |
[static] |
|
|
|
Processes a Exec= line as found in .desktop files. - Parameters:
-
| _service |
the service to extract information from. |
| _urls |
The urls the service should open. |
| has_shell |
If true, the arguments are going to be fed into a shell e.g by using system(). If false, the arguments are going to be fed into a exec() kind call. If the arguments are intended for an exec() kind of call and the Exec line contains shell commands then "/bin/sh -c" is added. |
| tempFiles |
if true and _urls are local files, they will be deleted when the application exits. |
- Returns:
-
a list of arguments suitable for either system() or exec().
|
| pid_t KRun::run |
( |
const QString & |
_exec, |
|
|
const KURL::List & |
_urls, |
|
|
const QString & |
_name = QString::null, |
|
|
const QString & |
_icon = QString::null, |
|
|
const QString & |
_obsolete1 = QString::null, |
|
|
const QString & |
_obsolete2 = QString::null |
|
) |
[static] |
|
|
|
Open a list of URLs with. - Parameters:
-
| _exec |
The name of the executable, for example "/usr/bin/netscape". |
| _name |
The logical name of the application, for example "Netscape 4.06". |
| _icon |
The icon which should be used by the application. |
| _obsolete1 |
Do not use! |
| _obsolete2 |
Do not use! |
|
| pid_t KRun::run |
( |
const KService & |
_service, |
|
|
const KURL::List & |
_urls, |
|
|
bool |
tempFiles |
|
) |
[static] |
|
|
|
Open a list of URLs with a certain service (application). - Parameters:
-
| _service |
the service to run |
| _urls |
the list of URLs, can be empty (app launched without argument) |
| tempFiles |
if true and _urls are local files, they will be deleted when the application exits. |
- Returns:
-
the process id, or 0 on error
|
| pid_t KRun::runCommand |
( |
const QString & |
cmd, |
|
|
const QString & |
execName, |
|
|
const QString & |
icon |
|
) |
[static] |
|
|
|
Same as the other runCommand, but it also takes the name of the binary, to display an error message in case it couldn't find it. - Parameters:
-
| icon |
icon for app starting notification |
|
| pid_t KRun::runCommand |
( |
QString |
cmd |
) |
[static] |
|
|
|
Run the given shell command and notifies kicker of the starting of the application. If the program to be called doesn't exist, an error box will be displayed.
_cmd must be a shell command. You must not append "&" to it, since the function will do that for you.
- Returns:
-
PID of running command, 0 if it could not be started, 0 - (PID of running command) if command was unsafe for map notification.
Use only when you know the full command line. Otherwise use the other static methods, or KRun's constructor. |
| pid_t KRun::runURL |
( |
const KURL & |
_url, |
|
|
const QString & |
_mimetype, |
|
|
bool |
tempFile |
|
) |
[static] |
|
|
|
Open the given URL.
This function is used after the mime type is found out. It will search for all services which can handle the mime type and call run() afterwards. - Parameters:
-
| _url |
the URL to open |
| _mimetype |
the mime type of the resource |
| tempFile |
if true and _url is a local file, it will be deleted when the launched application exits. |
- Returns:
-
the process id, or 0 on error
|
| void KRun::setPreferredService |
( |
const QString & |
desktopEntryName |
) |
|
|
|
|
Set the preferred service for opening this URL, after its mimetype will have been found by KRun. IMPORTANT: the service is only used if its configuration says it can handle this mimetype. This is used for instance for the X-KDE-LastOpenedWith key, for the recent documents list. - Parameters:
-
| desktopEntryName |
the desktopEntryName of the service, e.g. "kate". |
|
| void KRun::shellQuote |
( |
QString & |
_str |
) |
[static] |
|
|
|
Quotes a string for the shell |
Member Data Documentation
bool KRun::m_bInit [protected]
|
|
|
|
USed to indicate that the next action is to initialize. This action is invoked from slotTimeout
Definition at line 271 of file krun.h. |
bool KRun::m_bScanFile [protected]
|
|
|
|
Used to indicate that the next action is to scan the file. This action is invoked from slotTimeout.
Definition at line 264 of file krun.h. |
The documentation for this class was generated from the following file:
Generated on Wed Aug 13 23:30:22 2003 for kdelibs by
1.2.18