KDEDesktopMimeType Class Reference

Mime type for desktop files. More...

#include <kmimetype.h>

Inheritance diagram for KDEDesktopMimeType:

[legend]

List of all members.

Classes
struct	Service
	Structure representing a service, in the list of services returned by builtinServices and userDefinedServices. More...
Public Types
enum	ServiceType { ST_MOUNT, ST_UNMOUNT, ST_USER_DEFINED }
Public Member Functions
virtual QString	comment (const KURL &_url, bool _is_local) const
virtual QString	comment (const QString &_url, bool _is_local) const
virtual QString	icon (const KURL &_url, bool _is_local) const
virtual QString	icon (const QString &_url, bool _is_local) const
	KDEDesktopMimeType (QDataStream &_str, int offset)
	KDEDesktopMimeType (KDesktopFile *config)
virtual QPixmap	pixmap (const KURL &_url, KIcon::Group _group, int _force_size=0, int _state=0, QString *_path=0L) const
Static Public Member Functions
static QValueList< Service >	builtinServices (const KURL &_url)
static void	executeService (const KURL::List &urls, KDEDesktopMimeType::Service &service)
static void	executeService (const QString &path, KDEDesktopMimeType::Service &service) KDE_DEPRECATED
static pid_t	run (const KURL &_url, bool _is_local)
static QValueList< Service >	userDefinedServices (const QString &path, KConfig &config, bool bLocalFiles, const KURL::List &file_list)
static QValueList< Service >	userDefinedServices (const QString &path, KConfig &config, bool bLocalFiles)
static QValueList< Service >	userDefinedServices (const QString &path, bool bLocalFiles)
Protected Member Functions
virtual QPixmap	pixmap (KIcon::Group group, int force_size=0, int state=0, QString *path=0L) const
virtual void	virtual_hook (int id, void *data)
Static Protected Member Functions
static pid_t	runApplication (const KURL &_url, const QString &_serviceFile)
static pid_t	runFSDevice (const KURL &_url, const KSimpleConfig &cfg)
static pid_t	runLink (const KURL &_url, const KSimpleConfig &cfg)
static pid_t	runMimeType (const KURL &_url, const KSimpleConfig &cfg)

---

Detailed Description

Mime type for desktop files.

Handles mount/umount icon, and user-defined properties. Mimetype for a .desktop file

Definition at line 506 of file kmimetype.h.

---

Member Enumeration Documentation

enum KDEDesktopMimeType::ServiceType

Enumerator:

ST_MOUNT
ST_UNMOUNT
ST_USER_DEFINED

Definition at line 511 of file kmimetype.h.

---

Constructor & Destructor Documentation

KDEDesktopMimeType::KDEDesktopMimeType

(

KDesktopFile *

config

)

[inline]

Construct a desktop mimetype and take all information from a desktop file.

Parameters:

config

the desktop configuration file that describes the mime type

Definition at line 534 of file kmimetype.h.

KDEDesktopMimeType::KDEDesktopMimeType	(	QDataStream &	_str,
		int	offset
	)			[inline]

For internal use only.

Definition at line 536 of file kmimetype.h.

---

Member Function Documentation

QValueList< KDEDesktopMimeType::Service > KDEDesktopMimeType::builtinServices

(

const KURL &

_url

)

[static]

Returns a list of services for the given .desktop file that are handled by kio itself.

Namely mount/unmount for FSDevice files.

Returns:

the list of services

Definition at line 914 of file kmimetype.cpp.

QString KDEDesktopMimeType::comment	(	const KURL &	,
		bool
	)			const [virtual]

Returns the descriptive comment associated with the MIME type.

The arguments are unused, but provided so that KMimeType derived classes can use them.

Returns:

The descriptive comment associated with the MIME type, if any.

Reimplemented from KMimeType.

Definition at line 770 of file kmimetype.cpp.

QString KDEDesktopMimeType::comment	(	const QString &	,
		bool
	)			const [virtual]

Returns the descriptive comment associated with the MIME type.

The arguments are unused, but provided so that KMimeType derived classes can use them.

Returns:

The descriptive comment associated with the MIME type, if any.

Reimplemented from KMimeType.

Definition at line 761 of file kmimetype.cpp.

void KDEDesktopMimeType::executeService	(	const KURL::List &	urls,
		KDEDesktopMimeType::Service &	service
	)			[static]

Execute service on the list of urls.

Parameters:

	urls	the list of urls
	service	the service to execute

Definition at line 1090 of file kmimetype.cpp.

void KDEDesktopMimeType::executeService	(	const QString &	path,
		KDEDesktopMimeType::Service &	service
	)			[static]

Parameters:

	path	is the path of the desktop entry.
	service	the service to execute

Deprecated:

, see the other executeService

Definition at line 1081 of file kmimetype.cpp.

QString KDEDesktopMimeType::icon	(	const KURL &	,
		bool
	)			const [virtual]

Return the filename of the icon associated with the mimetype.

The arguments are unused, but provided so that KMimeType-derived classes can use them (e.g. KFolderType uses the URL to return one out of 2 icons)

Returns:

The path to the icon associated with this MIME type.

Reimplemented from KMimeType.

Definition at line 704 of file kmimetype.cpp.

QString KDEDesktopMimeType::icon	(	const QString &	,
		bool
	)			const [virtual]

Return the filename of the icon associated with the mimetype.

The arguments are unused, but provided so that KMimeType-derived classes can use them (e.g. KFolderType uses the URL to return one out of 2 icons)

Returns:

The path to the icon associated with this MIME type.

Reimplemented from KMimeType.

Definition at line 695 of file kmimetype.cpp.

virtual QPixmap KDEDesktopMimeType::pixmap	(	KIcon::Group	group,
		int	force_size = 0,
		int	state = 0,
		QString *	path = 0L
	)			const [inline, protected, virtual]

Use this function only if you don't have a special URL for which you search a pixmap.

This function is useful to find out, which icon is usually chosen for a certain mime type. Since no URL is passed, it is impossible to obey icon hints in desktop entries for example.

Parameters:

	group	The icon group where the icon is going to be used.
	force_size	Override globallly configured icon size. Use 0 for the default size
	state	The icon state, one of: KIcon::DefaultState, KIcon::ActiveState or KIcon::DisabledState.
	path	Output parameter to get the full path. Seldom needed. Ignored if 0

Returns:

the pixmap of the mime type, can be a default icon if not found

Reimplemented from KMimeType.

Definition at line 606 of file kmimetype.h.

QPixmap KDEDesktopMimeType::pixmap	(	const KURL &	_url,
		KIcon::Group	_group,
		int	_force_size = 0,
		int	_state = 0,
		QString *	_path = 0L
	)			const [virtual]

Find the pixmap for a given file of this mimetype.

Convenience method that uses icon(), but also locates and load the pixmap.

Parameters:

	_url	URL for the file.
	_group	The icon group where the icon is going to be used.
	_force_size	Override globallly configured icon size. Use 0 for the default size
	_state	The icon state, one of: KIcon::DefaultState, KIcon::ActiveState or KIcon::DisabledState.
	_path	Output parameter to get the full path. Seldom needed. Ignored if 0

Returns:

the pixmap of the URL, can be a default icon if not found

Reimplemented from KMimeType.

Definition at line 749 of file kmimetype.cpp.

pid_t KDEDesktopMimeType::run	(	const KURL &	_url,
		bool	_is_local
	)			[static]

Invokes the default action for the desktop entry.

If the desktop entry is not local, then only false is returned. Otherwise we would create a security problem. Only types Link and Mimetype could be followed.

Parameters:

	_url	the url to run
	_is_local	true if the URL is local, false otherwise

Returns:

true on success and false on failure.

See also:

KRun::runURL

Definition at line 784 of file kmimetype.cpp.

pid_t KDEDesktopMimeType::runApplication	(	const KURL &	_url,
		const QString &	_serviceFile
	)			[static, protected]

Definition at line 861 of file kmimetype.cpp.

pid_t KDEDesktopMimeType::runFSDevice	(	const KURL &	_url,
		const KSimpleConfig &	cfg
	)			[static, protected]

Definition at line 823 of file kmimetype.cpp.

pid_t KDEDesktopMimeType::runLink	(	const KURL &	_url,
		const KSimpleConfig &	cfg
	)			[static, protected]

Definition at line 872 of file kmimetype.cpp.

pid_t KDEDesktopMimeType::runMimeType	(	const KURL &	_url,
		const KSimpleConfig &	cfg
	)			[static, protected]

Definition at line 895 of file kmimetype.cpp.

QValueList< KDEDesktopMimeType::Service > KDEDesktopMimeType::userDefinedServices	(	const QString &	path,
		KConfig &	config,
		bool	bLocalFiles,
		const KURL::List &	file_list
	)			[static]

Overload of userDefinedServices but also allows you to pass a list of urls for this file.

This allows for the menu to be changed depending on the exact files via the X-KDE-GetActionMenu extension.

Since:

3.5

Definition at line 978 of file kmimetype.cpp.

QValueList< KDEDesktopMimeType::Service > KDEDesktopMimeType::userDefinedServices	(	const QString &	path,
		KConfig &	config,
		bool	bLocalFiles
	)			[static]

Overload of userDefinedServices for speed purposes: it takes a KConfig* so that the caller can check things in the file without having it parsed twice.

Since:

3.4

Definition at line 973 of file kmimetype.cpp.

QValueList< KDEDesktopMimeType::Service > KDEDesktopMimeType::userDefinedServices	(	const QString &	path,
		bool	bLocalFiles
	)			[static]

Returns a list of services defined by the user as possible actions on the given .desktop file.

May include empty actions which represent where visual separators should appear in user-visible representations of those actions, such as separators in a menu.

Parameters:

	path	the path to the desktop file describing the services
	bLocalFiles	true if those services are to be applied to local files only (if false, services that don't have u or U in the Exec line won't be taken into account).

Returns:

the list of user deviced actions

Definition at line 967 of file kmimetype.cpp.

void KDEDesktopMimeType::virtual_hook	(	int	id,
		void *	data
	)			[protected, virtual]

Reimplemented from KMimeType.

Definition at line 1167 of file kmimetype.cpp.

---

The documentation for this class was generated from the following files:

• kmimetype.h
• kmimetype.cpp