KDE 4.4 PyKDE API Reference
  • KDE's Python API
  • Overview
  • PyKDE Home
  • Sitemap
  • Contact Us
 

KPropertiesDialog Class Reference

from PyKDE4.kio import *

Inherits: KPageDialog → KDialog → QDialog → QWidget → QObject

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"

The best way to display the properties dialog is to use showDialog(). Otherwise, you should use (void)new KPropertiesDialog(...) It will take care of deleting itself when closed.

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


Signals

 applied ()
 canceled ()
 leaveModality ()
 propertiesClosed ()
 saveAs (KUrl oldUrl, KUrl newUrl)

Methods

 __init__ (self, KFileItem item, QWidget parent=0)
 __init__ (self, KFileItemList _items, QWidget parent=0)
 __init__ (self, KUrl _url, QWidget parent=0)
 __init__ (self, KUrl _tempUrl, KUrl _currentDir, QString _defaultName, QWidget parent=0)
 __init__ (self, QString title, QWidget parent=0)
 __init__ (self, KPropertiesDialog a0)
 abortApplying (self)
 applied (self)
bool canDisplay (self, KFileItemList _items)
 canceled (self)
KUrl currentDir (self)
QString defaultName (self)
 insertPlugin (self, KPropertiesDialogPlugin plugin)
KFileItem item (self)
KFileItemList items (self)
KUrl kurl (self)
 leaveModality (self)
 propertiesClosed (self)
 rename (self, QString _name)
 saveAs (self, KUrl oldUrl, KUrl newUrl)
 setFileNameReadOnly (self, bool ro)
 setFileSharingPage (self, QWidget page)
bool showDialog (self, KFileItem item, QWidget parent=0, bool modal=1)
bool showDialog (self, KUrl _url, QWidget parent=0, bool modal=1)
bool showDialog (self, KFileItemList _items, QWidget parent=0, bool modal=1)
 showFileSharingPage (self)
 slotCancel (self)
 slotOk (self)
 updateUrl (self, KUrl _newUrl)

Method Documentation

__init__ (  self,
KFileItem  item,
QWidget  parent=0
)
__init__ (  self,
KFileItemList  _items,
QWidget  parent=0
)
__init__ (  self,
KUrl  _url,
QWidget  parent=0
)
__init__ (  self,
KUrl  _tempUrl,
KUrl  _currentDir,
QString  _defaultName,
QWidget  parent=0
)
__init__ (  self,
QString  title,
QWidget  parent=0
)
__init__ (  self,
KPropertiesDialog  a0
)
abortApplying (   self )

To abort applying changes.

applied (   self )

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

Signal syntax:
QObject.connect(source, SIGNAL("applied()"), target_slot)
bool canDisplay (  self,
KFileItemList  _items
)

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.

canceled (   self )

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

Signal syntax:
QObject.connect(source, SIGNAL("canceled()"), target_slot)
KUrl currentDir (   self )

If the dialog is being built from a template, this method returns the current directory. If no template, it returns QString(). See the template form of the constructor.

Returns:
the current directory or QString()

QString defaultName (   self )

If the dialog is being built from a template, this method returns the default name. If no template, it returns QString(). See the template form of the constructor.

Returns:
the default name or QString()

insertPlugin (  self,
KPropertiesDialogPlugin  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 KPropertiesDialogPlugin 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 KPropertiesDialogPlugin. The Properties dialog will do destruction for you. The KPropertiesDialogPlugin must have been created with the KPropertiesDialog as its parent.

See also:
KPropertiesDialogPlugin

KFileItem item (   self )

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.

KFileItemList items (   self )

Returns:
the items for which the dialog is shown

KUrl kurl (   self )

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.

leaveModality (   self )
Signal syntax:
QObject.connect(source, SIGNAL("leaveModality()"), target_slot)
propertiesClosed (   self )

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

Signal syntax:
QObject.connect(source, SIGNAL("propertiesClosed()"), target_slot)
rename (  self,
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:
FilePropsDialogPlugin.applyChanges

saveAs (  self,
KUrl  oldUrl,
KUrl  newUrl
)

Emitted before changes to oldUrl are saved as newUrl. The receiver may change newUrl to point to an alternative save location.

Signal syntax:
QObject.connect(source, SIGNAL("saveAs(const const KUrl&, KUrl&)"), target_slot)
setFileNameReadOnly (  self,
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

setFileSharingPage (  self,
QWidget  page
)

Sets the file sharing page. This page is shown when calling showFileSharingPage().

Parameters:
page  the page to set

See also:
showFileSharingPage

bool showDialog (  self,
KFileItem  item,
QWidget  parent=0,
bool  modal=1
)

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 (@p parent and modal are ignored in this case).

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

bool showDialog (  self,
KUrl  _url,
QWidget  parent=0,
bool  modal=1
)

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 (@p parent and modal are ignored in this case).

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

bool showDialog (  self,
KFileItemList  _items,
QWidget  parent=0,
bool  modal=1
)

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 (@p parent and modal are ignored in this case).

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

showFileSharingPage (   self )

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

See also:
setFileSharingPage

slotCancel (   self )

Called when the user presses 'Cancel'.

slotOk (   self )

Called when the user presses 'Ok'.

updateUrl (  self,
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

  • Full Index

Modules

  • akonadi
  • dnssd
  • kdecore
  • kdeui
  • khtml
  • kio
  • knewstuff
  • kparts
  • kutils
  • nepomuk
  • phonon
  • plasma
  • polkitqt
  • solid
  • soprano
This documentation is maintained by Simon Edwards.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal