kio Library API Documentation

KPropertiesDialog Class Reference

The main properties dialog class. More...

#include <kpropertiesdialog.h>

Inheritance diagram for KPropertiesDialog:

Inheritance graph
[legend]
Collaboration diagram for KPropertiesDialog:

Collaboration graph
[legend]
List of all members.

Public Slots

virtual void slotOk ()
 Called when the user presses 'Ok'.

virtual void slotCancel ()

Signals

void propertiesClosed ()
 Emitted when we have finished with the properties (be it Apply or Cancel).

void applied ()
void canceled ()

Public Member Functions

 KPropertiesDialog (KFileItem *item, QWidget *parent=0L, const char *name=0L, bool modal=false, bool autoShow=true)
 Brings up a Properties dialog.

 KPropertiesDialog (KFileItemList _items, QWidget *parent=0L, const char *name=0L, bool modal=false, bool autoShow=true)
 Brings up a Properties dialog.

 KPropertiesDialog (const KURL &_url, mode_t _mode, QWidget *parent=0L, const char *name=0L, bool modal=false, bool autoShow=true)
 This class or method is obsolete, it is provided for compatibility only.

 KPropertiesDialog (const KURL &_url, QWidget *parent=0L, const char *name=0L, bool modal=false, bool autoShow=true)
 Brings up a Properties dialog.

 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.

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

virtual ~KPropertiesDialog ()
 Cleans up the properties dialog and frees any associated resources, including the dialog itself.

void insertPlugin (KPropsDlgPlugin *plugin)
 Adds a "3rd party" properties plugin to the dialog.

const KURLkurl () const
KFileItemitem ()
KFileItemList items () const
KDialogBasedialog ()
const KDialogBasedialog () const
const KURLcurrentDir () const
 If we are building this dialog from a template,.

const QStringdefaultName () const
 If we are building this dialog from a template,.

void 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/URL.

void rename (const QString &_name)
 #see FilePropsPlugin::applyChanges Can only be called if the dialog applies to a single file/URL.

void abortApplying ()
 To abort applying changes.

void showFileSharingPage ()
 
Since:
3.1



Static Public Member Functions

bool canDisplay (KFileItemList _items)

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 ones. 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 or change information about the file or URL.

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

Definition at line 64 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.

Normal constructor for file-manager-like applications. 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 whethr it should show itself automatically.

Definition at line 132 of file kpropertiesdialog.cpp.

References QPtrList::append(), KIO::decodeFileName(), KURL::isEmpty(), KStdAccel::name(), and KFileItem::url().

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

Brings up a Properties dialog.

Normal constructor for file-manager-like applications.

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 whethr it should show itself automatically.

Definition at line 160 of file kpropertiesdialog.cpp.

References QPtrList::append(), QPtrListIterator::current(), KIO::decodeFileName(), QPtrList::first(), KURL::isEmpty(), QPtrList::isEmpty(), and KStdAccel::name().

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

This class or method is obsolete, it is provided for compatibility only.

Brings up a Properties dialog. Convenience constructor for non-file-manager applications.

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 whethr it should show itself automatically.

Definition at line 182 of file kpropertiesdialog.cpp.

References KIO::decodeFileName(), KURL::isEmpty(), KStdAccel::name(), QDialog::result(), and KIO::stat().

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.

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 202 of file kpropertiesdialog.cpp.

References KIO::decodeFileName(), KURL::isEmpty(), KStdAccel::name(), QDialog::result(), and KIO::stat().

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

Parameters:
_templUrl 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 221 of file kpropertiesdialog.cpp.

References QPtrList::append(), KIO::decodeFileName(), KURL::isEmpty(), and KStdAccel::name().

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 149 of file kpropertiesdialog.cpp.

References KStdAccel::name().

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 304 of file kpropertiesdialog.cpp.

References QPtrList< KPropsDlgPlugin >::clear().


Member Function Documentation

bool KPropertiesDialog::canDisplay KFileItemList  _items  )  [static]
 

Returns:
whether there are any property pages available for the given file items

Definition at line 318 of file kpropertiesdialog.cpp.

References KFileMetaPropsPlugin::supports(), KFilePermissionsPropsPlugin::supports(), and KFilePropsPlugin::supports().

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 KPropsPlugin 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 PropsPlugin. The Properties dialog will do destruction for you. The KPropsPlugin MUST have been created with the KPropertiesDialog as its parent.
See also:
KPropsDlgPlugin

Definition at line 310 of file kpropertiesdialog.cpp.

References QPtrList< KPropsDlgPlugin >::append().

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

Returns:
a parsed URL. Valid only if dialog shown for one file/url.

Definition at line 202 of file kpropertiesdialog.h.

Referenced by KDevicePropsPlugin::applyChanges(), KBindingPropsPlugin::applyChanges(), KApplicationPropsPlugin::applyChanges(), KURLPropsPlugin::applyChanges(), KExecPropsPlugin::applyChanges(), KFilePropsPlugin::applyChanges(), KApplicationPropsPlugin::KApplicationPropsPlugin(), KFileMetaPropsPlugin::KFileMetaPropsPlugin(), KFilePermissionsPropsPlugin::KFilePermissionsPropsPlugin(), KFilePropsPlugin::KFilePropsPlugin(), and KURLPropsPlugin::KURLPropsPlugin().

KFileItem* KPropertiesDialog::item  )  [inline]
 

Returns:
the file item for which the dialog is shown Warning, it returns the first item of the list. This means, use this only if you are sure the dialog is used for a single item.

Definition at line 210 of file kpropertiesdialog.h.

References QPtrList::first().

Referenced by KFileMetaPropsPlugin::KFileMetaPropsPlugin(), KFilePermissionsPropsPlugin::KFilePermissionsPropsPlugin(), and KFilePropsPlugin::KFilePropsPlugin().

KFileItemList KPropertiesDialog::items  )  const [inline]
 

Returns:
the items for which the dialog is shown

Definition at line 215 of file kpropertiesdialog.h.

Referenced by KFilePermissionsPropsPlugin::applyChanges(), KFileSharePropsPlugin::applyChanges(), KFileMetaPropsPlugin::KFileMetaPropsPlugin(), KFilePermissionsPropsPlugin::KFilePermissionsPropsPlugin(), KFilePropsPlugin::KFilePropsPlugin(), and KFilePropsPlugin::postApplyChanges().

KDialogBase* KPropertiesDialog::dialog  )  [inline]
 

Returns:
a pointer to the dialog This class or method is obsolete, it is provided for compatibility only.

Definition at line 221 of file kpropertiesdialog.h.

Referenced by KApplicationPropsPlugin::KApplicationPropsPlugin(), KBindingPropsPlugin::KBindingPropsPlugin(), KExecPropsPlugin::KExecPropsPlugin(), KFilePermissionsPropsPlugin::KFilePermissionsPropsPlugin(), KFilePropsPlugin::KFilePropsPlugin(), KPropsDlgPlugin::KPropsDlgPlugin(), and KURLPropsPlugin::KURLPropsPlugin().

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

If we are building this dialog from a template,.

Returns:
the current directory QString::null means no template used

Definition at line 229 of file kpropertiesdialog.h.

Referenced by KFilePropsPlugin::KFilePropsPlugin().

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

If we are building this dialog from a template,.

Returns:
the default name (see 3rd constructor) QString::null means no template used

Definition at line 236 of file kpropertiesdialog.h.

Referenced by KFilePropsPlugin::KFilePropsPlugin().

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/URL.

Parameters:
_name new URL

Definition at line 476 of file kpropertiesdialog.cpp.

References QPtrList::count(), QPtrListIterator::current(), QPtrList::first(), KURL::isEmpty(), and KURL::url().

Referenced by rename().

void KPropertiesDialog::rename const QString _name  ) 
 

#see FilePropsPlugin::applyChanges Can only be called if the dialog applies to a single file/URL.

Parameters:
_name new filename, encoded.

Definition at line 494 of file kpropertiesdialog.cpp.

References KURL::addPath(), QString::at(), QPtrList::count(), KURL::isEmpty(), QString::length(), KURL::setFileName(), QString::truncate(), updateUrl(), and KURL::url().

Referenced by KFilePropsPlugin::applyChanges().

void KPropertiesDialog::abortApplying  ) 
 

To abort applying changes.

Definition at line 517 of file kpropertiesdialog.cpp.

Referenced by KFilePropsPlugin::applyChanges().

void KPropertiesDialog::showFileSharingPage  ) 
 

Since:
3.1

Definition at line 274 of file kpropertiesdialog.cpp.

References QPtrList< KPropsDlgPlugin >::first(), QPtrList< KPropsDlgPlugin >::next(), KFileSharePropsPlugin::page(), KDialogBase::pageIndex(), and KDialogBase::showPage().

void KPropertiesDialog::slotOk  )  [virtual, slot]
 

Called when the user presses 'Ok'.

Reimplemented from KDialogBase.

Definition at line 330 of file kpropertiesdialog.cpp.

References QDialog::accept(), KPropsDlgPlugin::applyChanges(), QObject::className(), QPtrList< KPropsDlgPlugin >::first(), KPropsDlgPlugin::isDirty(), QPtrList< KPropsDlgPlugin >::next(), KFilePropsPlugin::postApplyChanges(), propertiesClosed(), and KPropsDlgPlugin::setDirty().

void KPropertiesDialog::propertiesClosed  )  [signal]
 

Emitted when we have finished with the properties (be it Apply or Cancel).

Referenced by slotOk().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kdelibs Version 3.1.5.
Documentation copyright © 1996-2002 the KDE developers.
Generated on Wed Jan 28 13:20:20 2004 by doxygen 1.3.4 written by Dimitri van Heesch, © 1997-2001