KPropertiesDialog Class Reference

The main properties dialog class. More...

#include <kpropertiesdialog.h>

Inheritance diagram for KPropertiesDialog:


Public Slots
virtual void	slotCancel ()
virtual void	slotOk ()
Signals
void	applied ()
void	canceled ()
void	propertiesClosed ()
void	saveAs (const KURL &oldUrl, KURL &newUrl)
Public Member Functions
void	abortApplying ()
const KURL &	currentDir () const
const QString &	defaultName () const
KDE_DEPRECATED const KDialogBase *	dialog () const
KDE_DEPRECATED KDialogBase *	dialog ()
void	insertPlugin (KPropsDlgPlugin *plugin)
KFileItem *	item ()
KFileItemList	items () const
	KPropertiesDialog (const QString &title, QWidget parent=0L, const char name=0L, bool modal=false)
	KPropertiesDialog (const KURL &_tempUrl, const KURL &_currentDir, const QString &_defaultName, QWidget parent=0L, const char name=0L, bool modal=false, bool autoShow=true)
	KPropertiesDialog (const KURL &_url, QWidget parent=0L, const char name=0L, bool modal=false, bool autoShow=true)
	KPropertiesDialog (const KURL &_url, mode_t _mode, QWidget parent=0L, const char name=0L, bool modal=false, bool autoShow=true) KDE_DEPRECATED
	KPropertiesDialog (KFileItemList _items, QWidget parent=0L, const char name=0L, bool modal=false, bool autoShow=true)
	KPropertiesDialog (KFileItem item, QWidget parent=0L, const char *name=0L, bool modal=false, bool autoShow=true)
const KURL &	kurl () const
void	rename (const QString &_name)
void	setFileNameReadOnly (bool ro)
void	setFileSharingPage (QWidget *page)
void	showFileSharingPage ()
void	updateUrl (const KURL &_newUrl)
virtual	~KPropertiesDialog ()
Static Public Member Functions
static bool	canDisplay (KFileItemList _items)
static bool	showDialog (const KFileItemList &_items, QWidget parent=0, const char name=0, bool modal=false)
static bool	showDialog (const KURL &_url, QWidget parent=0, const char name=0, bool modal=false)
static bool	showDialog (KFileItem item, QWidget parent=0, const char *name=0, bool modal=false)
Protected Member Functions
virtual void	virtual_hook (int id, void *data)

Detailed Description

The main properties dialog class.

A Properties Dialog is a dialog which displays various information about a particular file or URL, or several files or URLs. This main class holds various related classes, which are instantiated in the form of tab entries in the tabbed dialog that this class provides. The various tabs themselves will let the user view, and sometimes change, information about the file or URL.

Typical KProperties Dialog

This class must be created with (void)new KPropertiesDialog(...) It will take care of deleting itself.

If you are looking for more flexibility, see KFileMetaInfo and KFileMetaInfoWidget.

Definition at line 70 of file kpropertiesdialog.h.

Constructor & Destructor Documentation

KPropertiesDialog::KPropertiesDialog	(	KFileItem *	item,
		QWidget *	parent = `0L`,
		const char *	name = `0L`,
		bool	modal = `false`,
		bool	autoShow = `true`
	)

Brings up a Properties dialog, as shown above.

This is the normal constructor for file-manager type applications, where you have a KFileItem instance to work with. Normally you will use this method rather than the one below.

Parameters:

	item	file item whose properties should be displayed.
	parent	is the parent of the dialog widget.
	name	is the internal name.
	modal	tells the dialog whether it should be modal.
	autoShow	tells the dialog whether it should show itself automatically.

Definition at line 174 of file kpropertiesdialog.cpp.

KPropertiesDialog::KPropertiesDialog	(	KFileItemList	_items,
		QWidget *	parent = `0L`,
		const char *	name = `0L`,
		bool	modal = `false`,
		bool	autoShow = `true`
	)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. You use this constructor for cases where you have a number of items, rather than a single item.

Be careful which methods you use when passing a list of files or URLs, since some of them will only work on the first item in a list.

Parameters:

	_items	list of file items whose properties should be displayed.
	parent	is the parent of the dialog widget.
	name	is the internal name.
	modal	tells the dialog whether it should be modal.
	autoShow	tells the dialog whether it should show itself automatically.

Definition at line 202 of file kpropertiesdialog.cpp.

KPropertiesDialog::KPropertiesDialog	(	const KURL &	_url,
		mode_t	_mode,
		QWidget *	parent = `0L`,
		const char *	name = `0L`,
		bool	modal = `false`,
		bool	autoShow = `true`
	)

Deprecated:: You should use the following constructor instead of this one. The only change that is required is to delete the _mode argument.

Parameters:

	_url	the URL whose properties should be displayed
	_mode	unused.
	parent	is the parent of the dialog widget.
	name	is the internal name.
	modal	tells the dialog whether it should be modal.
	autoShow	tells the dialog whether it should show itself automatically.

Definition at line 228 of file kpropertiesdialog.cpp.

KPropertiesDialog::KPropertiesDialog	(	const KURL &	_url,
		QWidget *	parent = `0L`,
		const char *	name = `0L`,
		bool	modal = `false`,
		bool	autoShow = `true`
	)

Brings up a Properties dialog.

Convenience constructor for non-file-manager applications, where you have a KURL rather than a KFileItem or KFileItemList.

Parameters:

	_url	the URL whose properties should be displayed
	parent	is the parent of the dialog widget.
	name	is the internal name.
	modal	tells the dialog whether it should be modal. IMPORTANT: This constructor, together with modal=true, leads to a grave display bug (due to KIO::stat() being run before the dialog has all the necessary information). Do not use this combination for now. For local files with a known mimetype, simply create a KFileItem and pass it to the other constructor.
	autoShow	tells the dialog whethr it should show itself automatically.

Definition at line 248 of file kpropertiesdialog.cpp.

KPropertiesDialog::KPropertiesDialog	(	const KURL &	_tempUrl,
		const KURL &	_currentDir,
		const QString &	_defaultName,
		QWidget *	parent = `0L`,
		const char *	name = `0L`,
		bool	modal = `false`,
		bool	autoShow = `true`
	)

Creates a properties dialog for a new .desktop file (whose name is not known yet), based on a template.

Special constructor for "File / New" in file-manager type applications.

Parameters:

	_tempUrl	template used for reading only
	_currentDir	directory where the file will be written to
	_defaultName	something to put in the name field, like mimetype.desktop
	parent	is the parent of the dialog widget.
	name	is the internal name.
	modal	tells the dialog whether it should be modal.
	autoShow	tells the dialog whethr it should show itself automatically.

Definition at line 267 of file kpropertiesdialog.cpp.

KPropertiesDialog::KPropertiesDialog	(	const QString &	title,
		QWidget *	parent = `0L`,
		const char *	name = `0L`,
		bool	modal = `false`
	)

Creates an empty properties dialog (for applications that want use a standard dialog, but for things not doable via the plugin-mechanism).

Parameters:

	title	is the string display as the "filename" in the caption of the dialog.
	parent	is the parent of the dialog widget.
	name	is the internal name.
	modal	tells the dialog whether it should be modal.

Definition at line 191 of file kpropertiesdialog.cpp.

KPropertiesDialog::~KPropertiesDialog ( ) [virtual]

Cleans up the properties dialog and frees any associated resources, including the dialog itself.

Note that when a properties dialog is closed it cleans up and deletes itself.

Definition at line 367 of file kpropertiesdialog.cpp.

Member Function Documentation

void KPropertiesDialog::abortApplying ( )

To abort applying changes.

Definition at line 588 of file kpropertiesdialog.cpp.

void KPropertiesDialog::applied ( ) [signal]

This signal is emitted when the properties changes are applied (for example, with the OK button).

void KPropertiesDialog::canceled ( ) [signal]

This signal is emitted when the properties changes are aborted (for example, with the Cancel button).

bool KPropertiesDialog::canDisplay ( KFileItemList _items ) [static]

Determine whether there are any property pages available for the given file items.

Parameters:

_items

the list of items to check.

Returns:: true if there are any property pages, otherwise false.

Definition at line 381 of file kpropertiesdialog.cpp.

const KURL& KPropertiesDialog::currentDir ( ) const [inline]

If the dialog is being built from a template, this method returns the current directory.

If no template, it returns QString::null. See the template form of the constructor.

Returns:: the current directory or QString::null

Definition at line 287 of file kpropertiesdialog.h.

const QString& KPropertiesDialog::defaultName ( ) const [inline]

If the dialog is being built from a template, this method returns the default name.

If no template, it returns QString::null. See the template form of the constructor.

Returns:: the default name or QString::null

Definition at line 295 of file kpropertiesdialog.h.

KDE_DEPRECATED const KDialogBase* KPropertiesDialog::dialog ( ) const [inline]

Returns:: a pointer to the dialog

Deprecated:: KPropertiesDialog directly inherits from KDialogBase, so use this instead

Definition at line 278 of file kpropertiesdialog.h.

KDE_DEPRECATED KDialogBase* KPropertiesDialog::dialog ( ) [inline]

Returns:: a pointer to the dialog

Deprecated:: KPropertiesDialog directly inherits from KDialogBase, so use this instead

Definition at line 273 of file kpropertiesdialog.h.

void KPropertiesDialog::insertPlugin ( KPropsDlgPlugin * plugin )

Adds a "3rd party" properties plugin to the dialog.

Useful for extending the properties mechanism.

To create a new plugin type, inherit from the base class KPropsDlgPlugin and implement all the methods. If you define a service .desktop file for your plugin, you do not need to call insertPlugin().

Parameters:

plugin

is a pointer to the KPropsDlgPlugin. The Properties dialog will do destruction for you. The KPropsDlgPlugin must have been created with the KPropertiesDialog as its parent.

See also:: KPropsDlgPlugin

Definition at line 373 of file kpropertiesdialog.cpp.

KFileItem* KPropertiesDialog::item ( ) [inline]

Returns:: the file item for which the dialog is shown

Warning: this method returns the first item of the list. This means that you should use this only if you are sure the dialog is used for a single item. Otherwise, you probably want items() instead.

Definition at line 262 of file kpropertiesdialog.h.

KFileItemList KPropertiesDialog::items ( ) const [inline]

Returns:: the items for which the dialog is shown

Definition at line 267 of file kpropertiesdialog.h.

const KURL& KPropertiesDialog::kurl ( ) const [inline]

The URL of the file that has its properties being displayed.

This is only valid if the KPropertiesDialog was created/shown for one file or URL.

Returns:: a parsed URL.

Definition at line 253 of file kpropertiesdialog.h.

void KPropertiesDialog::propertiesClosed ( ) [signal]

This signal is emitted when the Properties Dialog is closed (for example, with OK or Cancel buttons).

void KPropertiesDialog::rename ( const QString & _name )

Renames the item to the specified name.

This can only be called if the dialog applies to a single file or URL.

Parameters:

_name

new filename, encoded.

See also:: FilePropsDlgPlugin::applyChanges

Definition at line 565 of file kpropertiesdialog.cpp.

void KPropertiesDialog::saveAs	(	const KURL &	oldUrl,
		KURL &	newUrl
	)			`[signal]`

Emitted before changes to oldUrl are saved as newUrl.

The receiver may change newUrl to point to an alternative save location.

void KPropertiesDialog::setFileNameReadOnly ( bool ro )

Call this to make the filename lineedit readonly, to prevent the user from renaming the file.

Parameters:

ro

true if the lineedit should be read only

Since:: 3.2

Definition at line 349 of file kpropertiesdialog.cpp.

void KPropertiesDialog::setFileSharingPage ( QWidget * page )

Sets the file sharing page.

This page is shown when calling showFileSharingPage().

Parameters:

page

the page to set

See also:: showFileSharingPage

Since:: 3.3

Definition at line 344 of file kpropertiesdialog.cpp.

bool KPropertiesDialog::showDialog	(	const KFileItemList &	_items,
		QWidget *	parent = `0`,
		const char *	name = `0`,
		bool	modal = `false`
	)			`[static]`

Immediately displays a Properties dialog using constructor with the same parameters.

On MS Windows, if _items has one element and this element points to a local file, native (non modal) property dialog is displayed (parent and modal are ignored in this case).

Returns:: true on succesfull dialog displaying (can be false on win32).

Since:: 3.4

Definition at line 312 of file kpropertiesdialog.cpp.

bool KPropertiesDialog::showDialog	(	const KURL &	_url,
		QWidget *	parent = `0`,
		const char *	name = `0`,
		bool	modal = `false`
	)			`[static]`

Immediately displays a Properties dialog using constructor with the same parameters.

On MS Windows, if _url points to a local file, native (non modal) property dialog is displayed (parent and modal are ignored in this case).

Returns:: true on succesfull dialog displaying (can be false on win32).

Since:: 3.4

Definition at line 301 of file kpropertiesdialog.cpp.

bool KPropertiesDialog::showDialog	(	KFileItem *	item,
		QWidget *	parent = `0`,
		const char *	name = `0`,
		bool	modal = `false`
	)			`[static]`

Immediately displays a Properties dialog using constructor with the same parameters.

On MS Windows, if item points to a local file, native (non modal) property dialog is displayed (parent and modal are ignored in this case).

Returns:: true on succesfull dialog displaying (can be false on win32).

Since:: 3.4

Definition at line 289 of file kpropertiesdialog.cpp.

void KPropertiesDialog::showFileSharingPage ( )

Shows the page that was previously set by setFileSharingPage(), or does nothing if no page was set yet.

See also:: setFileSharingPage

Since:: 3.1

Definition at line 337 of file kpropertiesdialog.cpp.

void KPropertiesDialog::slotCancel ( ) [virtual, slot]

Called when the user presses 'Cancel'.

Definition at line 439 of file kpropertiesdialog.cpp.

void KPropertiesDialog::slotOk ( ) [virtual, slot]

Called when the user presses 'Ok'.

Definition at line 394 of file kpropertiesdialog.cpp.

void KPropertiesDialog::updateUrl ( const KURL & _newUrl )

Updates the item URL (either called by rename or because a global apps/mimelnk desktop file is being saved) Can only be called if the dialog applies to a single file or URL.

Parameters:

_newUrl

the new URL

Definition at line 541 of file kpropertiesdialog.cpp.

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

Definition at line 3550 of file kpropertiesdialog.cpp.

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

kio

KPropertiesDialog Class Reference

Public Slots

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

kio

API Reference