KPropertiesDialog Class Reference
The main properties dialog class. More...
#include <kpropertiesdialog.h>
Inheritance diagram for KPropertiesDialog:

Public Slots | |
virtual void | slotOk () |
virtual void | slotCancel () |
Signals | |
void | propertiesClosed () |
void | applied () |
void | canceled () |
void | saveAs (const KURL &oldUrl, KURL &newUrl) |
Public Member Functions | |
KPropertiesDialog (KFileItem *item, QWidget *parent=0L, const char *name=0L, bool modal=false, bool autoShow=true) | |
KPropertiesDialog (KFileItemList _items, 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 (const KURL &_url, QWidget *parent=0L, const char *name=0L, bool modal=false, bool autoShow=true) | |
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 QString &title, QWidget *parent=0L, const char *name=0L, bool modal=false) | |
virtual | ~KPropertiesDialog () |
void | insertPlugin (KPropsDlgPlugin *plugin) |
const KURL & | kurl () const |
KFileItem * | item () |
KFileItemList | items () const |
KDE_DEPRECATED KDialogBase * | dialog () |
KDE_DEPRECATED const KDialogBase * | dialog () const |
const KURL & | currentDir () const |
const QString & | defaultName () const |
void | updateUrl (const KURL &_newUrl) |
void | rename (const QString &_name) |
void | abortApplying () |
void | showFileSharingPage () |
void | setFileSharingPage (QWidget *page) |
void | setFileNameReadOnly (bool ro) |
Static Public Member Functions | |
static bool | canDisplay (KFileItemList _items) |
static bool | showDialog (KFileItem *item, 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 (const KFileItemList &_items, 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
If you are looking for more flexibility, see KFileMetaInfo and KFileMetaInfoWidget.
Definition at line 70 of file kpropertiesdialog.h.
Constructor & Destructor Documentation
|
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.
Definition at line 152 of file kpropertiesdialog.cpp. References KURL::isEmpty(), item(), and KFileItem::url(). Referenced by showDialog(). |
|
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.
Definition at line 180 of file kpropertiesdialog.cpp. References KURL::isEmpty(). |
|
Definition at line 206 of file kpropertiesdialog.cpp. References KIO::NetAccess::stat(). |
|
Brings up a Properties dialog. Convenience constructor for non-file-manager applications, where you have a KURL rather than a KFileItem or KFileItemList.
Definition at line 226 of file kpropertiesdialog.cpp. References KIO::NetAccess::stat(). |
|
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.
Definition at line 245 of file kpropertiesdialog.cpp. References KURL::isEmpty(). |
|
Creates an empty properties dialog (for applications that want use a standard dialog, but for things not doable via the plugin-mechanism).
Definition at line 169 of file kpropertiesdialog.cpp. |
|
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 345 of file kpropertiesdialog.cpp. |
Member Function Documentation
|
Determine whether there are any property pages available for the given file items.
Definition at line 359 of file kpropertiesdialog.cpp. References KFileMetaPropsPlugin::supports(), KFilePermissionsPropsPlugin::supports(), and KFilePropsPlugin::supports(). |
|
Immediately displays a Properties dialog using constructor with the same parameters.
On MS Windows, if
Definition at line 267 of file kpropertiesdialog.cpp. References item(), KPropertiesDialog(), and KFileItem::localPath(). Referenced by showDialog(). |
|
Immediately displays a Properties dialog using constructor with the same parameters.
On MS Windows, if
Definition at line 279 of file kpropertiesdialog.cpp. References KPropertiesDialog(). |
|
Immediately displays a Properties dialog using constructor with the same parameters.
On MS Windows, if
Definition at line 290 of file kpropertiesdialog.cpp. References KPropertiesDialog(), and showDialog(). |
|
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().
Definition at line 351 of file kpropertiesdialog.cpp. |
|
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.
Definition at line 253 of file kpropertiesdialog.h. Referenced by KApplicationPropsPlugin::applyChanges(), KExecPropsPlugin::applyChanges(), KDesktopPropsPlugin::applyChanges(), KDevicePropsPlugin::applyChanges(), KBindingPropsPlugin::applyChanges(), KURLPropsPlugin::applyChanges(), KFilePropsPlugin::applyChanges(), KApplicationPropsPlugin::KApplicationPropsPlugin(), KFileMetaPropsPlugin::KFileMetaPropsPlugin(), KFilePermissionsPropsPlugin::KFilePermissionsPropsPlugin(), and KURLPropsPlugin::KURLPropsPlugin(). |
|
Definition at line 262 of file kpropertiesdialog.h. Referenced by KFileMetaPropsPlugin::KFileMetaPropsPlugin(), KFilePermissionsPropsPlugin::KFilePermissionsPropsPlugin(), KPropertiesDialog(), and showDialog(). |
|
Definition at line 267 of file kpropertiesdialog.h. Referenced by KFilePermissionsPropsPlugin::applyChanges(), KFileSharePropsPlugin::applyChanges(), KFileMetaPropsPlugin::KFileMetaPropsPlugin(), KFilePermissionsPropsPlugin::KFilePermissionsPropsPlugin(), and KFilePropsPlugin::postApplyChanges(). |
|
Definition at line 273 of file kpropertiesdialog.h. |
|
Definition at line 278 of file kpropertiesdialog.h. |
|
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.
Definition at line 287 of file kpropertiesdialog.h. |
|
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.
Definition at line 295 of file kpropertiesdialog.h. |
|
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.
Definition at line 512 of file kpropertiesdialog.cpp. References endl(), KURL::isEmpty(), kdDebug(), saveAs(), and KURL::url(). Referenced by KFilePropsPlugin::applyChanges(), and rename(). |
|
Renames the item to the specified name. This can only be called if the dialog applies to a single file or URL.
Definition at line 536 of file kpropertiesdialog.cpp. References KURL::addPath(), endl(), KURL::isEmpty(), kdDebug(), KURL::setFileName(), updateUrl(), and KURL::url(). Referenced by KFilePropsPlugin::applyChanges(). |
|
To abort applying changes.
Definition at line 559 of file kpropertiesdialog.cpp. Referenced by KFilePropsPlugin::applyChanges(), and KFileSharePropsPlugin::applyChanges(). |
|
Shows the page that was previously set by setFileSharingPage(), or does nothing if no page was set yet.
Definition at line 315 of file kpropertiesdialog.cpp. References KDialogBase::pageIndex(), and KDialogBase::showPage(). |
|
Sets the file sharing page. This page is shown when calling showFileSharingPage().
Definition at line 322 of file kpropertiesdialog.cpp. |
|
Call this to make the filename lineedit readonly, to prevent the user from renaming the file.
Definition at line 327 of file kpropertiesdialog.cpp. References KFilePropsPlugin::setFileNameReadOnly(). |
|
Called when the user presses 'Ok'.
Reimplemented from KDialogBase. Definition at line 371 of file kpropertiesdialog.cpp. References applied(), KPropsDlgPlugin::applyChanges(), endl(), KPropsDlgPlugin::isDirty(), kdDebug(), KFilePropsPlugin::postApplyChanges(), propertiesClosed(), and KPropsDlgPlugin::setDirty(). |
|
Called when the user presses 'Cancel'.
Reimplemented from KDialogBase. Definition at line 416 of file kpropertiesdialog.cpp. References canceled(), and propertiesClosed(). |
|
This signal is emitted when the Properties Dialog is closed (for example, with OK or Cancel buttons).
Referenced by slotCancel(), and slotOk(). |
|
This signal is emitted when the properties changes are applied (for example, with the OK button).
Referenced by slotOk(). |
|
This signal is emitted when the properties changes are aborted (for example, with the Cancel button).
Referenced by slotCancel(). |
|
Emitted before changes to
The receiver may change Referenced by updateUrl(). |
The documentation for this class was generated from the following files: