# class KPropertiesDialog

###

Module | kio
Namespace |
Class | KPropertiesDialog
Inherits | KPageDialog

### methods

- KPropertiesDialog (item, parent)

  returns ctor
  KDE 4.1.0 and later only

  Argument | Type | Default
  --- | --- | ---
  item | KFileItem |
  parent | QWidget | 0

  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.

  item - file item whose properties should be displayed.

  parent - is the parent of the dialog widget.

  name - is the internal name.

- KPropertiesDialog (_items, parent)

  returns ctor
  KDE 4.1.0 and later only

  Argument | Type | Default
  --- | --- | ---
  _items | KFileItemList |
  parent | QWidget | 0

  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.

  _items - list of file items whose properties should be displayed.

  parent - is the parent of the dialog widget.

  name - is the internal name.

- KPropertiesDialog (_url, parent)

  returns ctor
  KDE 4.1.0 and later only

  Argument | Type | Default
  --- | --- | ---
  _url | KUrl |
  parent | QWidget | 0

  Brings up a Properties dialog. Convenience constructor for non-file-manager applications, where you have a KUrl rather than a KFileItem or KFileItemList.

  _url - the URL whose properties should be displayed

  parent - is the parent of the dialog widget.

  name - is the internal name.

  IMPORTANT: This constructor, together with exec(), 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. TODO: Check if the above is still true with Qt4. For local files with a known mimetype, simply create a KFileItem and pass it to the other constructor.

- KPropertiesDialog (_tempUrl, _currentDir, _defaultName, parent)

  returns ctor

  Argument | Type | Default
  --- | --- | ---
  _tempUrl | KUrl |
  _currentDir | KUrl |
  _defaultName | QString |
  parent | QWidget | 0

  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.

  _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.

- KPropertiesDialog (title, parent)

  returns ctor
  KDE 4.1.0 and later only

  Argument | Type | Default
  --- | --- | ---
  title | QString |
  parent | QWidget | 0

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

  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.

- KPropertiesDialog (a0)

  returns ctor
  Not implemented

  Argument | Type | Default
  --- | --- | ---
  a0 | KPropertiesDialog |

- KPropertiesDialog (a0, a1)

  returns ctor
  before KDE 4.1.0 only

  Argument | Type | Default
  --- | --- | ---
  a0 | KFileItem |
  a1 | QWidget | 0

- KPropertiesDialog (a0, a1)

  returns ctor
  before KDE 4.1.0 only

  Argument | Type | Default
  --- | --- | ---
  a0 | KFileItemList |
  a1 | QWidget | 0

- KPropertiesDialog (a0, a1)

  returns ctor
  before KDE 4.1.0 only

  Argument | Type | Default
  --- | --- | ---
  a0 | KUrl |
  a1 | QWidget | 0

- KPropertiesDialog (a0, a1)

  returns ctor
  before KDE 4.1.0 only

  Argument | Type | Default
  --- | --- | ---
  a0 | QString |
  a1 | QWidget | 0

- abortApplying ( )

  returns Nothing

  To abort applying changes.

- applied ( )

  returns Nothing
  SIGNAL ("applied ()")

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

- canDisplay (_items)

  returns bool
  static

  Argument | Type | Default
  --- | --- | ---
  _items | KFileItemList |

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

  _items - the list of items to check. Returns true if there are any property pages, otherwise false.

- canceled ( )

  returns Nothing
  SIGNAL ("canceled ()")

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

- currentDir ( )

  returns KUrl

  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()

- defaultName ( )

  returns QString

  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 (plugin)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  plugin | KPropertiesDialogPlugin |

  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().

  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

- item ( )

  returns KFileItem

  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.

- items ( )

  returns KFileItemList

  Returns the items for which the dialog is shown

- kurl ( )

  returns KUrl

  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 ( )

  returns Nothing
  SIGNAL ("leaveModality ()")

- propertiesClosed ( )

  returns Nothing
  SIGNAL ("propertiesClosed ()")

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

- rename (_name)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  _name | QString |

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

  _name - new filename, encoded.

  See also FilePropsDialogPlugin.applyChanges

- saveAs (oldUrl, newUrl)

  returns Nothing
  SIGNAL ("saveAs (const KUrl&, KUrl&)")

  Argument | Type | Default
  --- | --- | ---
  oldUrl | KUrl |
  newUrl | KUrl |

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

- setFileNameReadOnly (ro)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  ro | bool |

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

  ro - true if the lineedit should be read only

- setFileSharingPage (page)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  page | QWidget |

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

  page - the page to set

  See also showFileSharingPage

- showDialog (item, parent, modal)

  returns bool
  static

  Argument | Type | Default
  --- | --- | ---
  item | KFileItem |
  parent | QWidget | 0
  modal | bool | 1

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

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

- showDialog (_url, parent, modal)

  returns bool
  static

  Argument | Type | Default
  --- | --- | ---
  _url | KUrl |
  parent | QWidget | 0
  modal | bool | 1

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

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

- showDialog (_items, parent, modal)

  returns bool
  static

  Argument | Type | Default
  --- | --- | ---
  _items | KFileItemList |
  parent | QWidget | 0
  modal | bool | 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 ( )

  returns Nothing

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

  See also setFileSharingPage

- slotCancel ( )

  returns Nothing

  Called when the user presses 'Cancel'.

- slotOk ( )

  returns Nothing

  Called when the user presses 'Ok'.

- updateUrl (_newUrl)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  _newUrl | KUrl |

  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.

  _newUrl - the new URL