class KPropertiesDialog

The main properties dialog class. More...

Full nameKIO::KPropertiesDialog
Definition#include <kpropsdlg.h>
InheritsQObject (kdecore)
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Public Slots

Signals

Public Static Methods


Detailed Description

The main properties dialog class. A Properties Dialog is a dialog which displays various information about a particular file or URL. 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 PropertiesDialog(...) It will take care of deleting itself.

bool  canDisplay ( KFileItemList _items )

[static]

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

 KPropertiesDialog ( KFileItem * item )

Bring up a Properties dialog. Normal constructor for file-manager-like applications. Normally you will use this method rather than the one below.

Parameters:
itemfile item whose properties should be displayed.

 KPropertiesDialog ( KFileItemList _items )

Bring up a Properties dialog. Normal constructor for file-manager-like applications.

Parameters:
_itemslist of file items whose properties should be displayed. NOTE : the current limitations of PropertiesDialog makes it use only the FIRST item in the list. This method is provided for future expansion when the properties dialog may be able to get/set properties for a group of items all at once.

KPropertiesDialog ()

[virtual]

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

/** Create 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.

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

Parameters:
_urlthe URL whose properties should be displayed
_modethe mode, as returned by stat(). Don't set if unknown. */ KPropertiesDialog( const KURL& _url, mode_t _mode = (mode_t) -1 );
_templUrltemplate used for reading only
_currentDirdirectory where the file will be written to
_defaultNamesomething to put in the name field, like mimetype.desktop */ KPropertiesDialog( const KURL& _tempUrl, const KURL& _currentDir, const QString& _defaultName );

void  addPage (KPropsPage *page)

Adds a "3rd party" properties page to the dialog. Useful for extending the properties mechanism.

To create a new page type, inherit from the base class PropsPage and implement all the methods.

Parameters:
pageis a pointer to the PropsPage widget. The Properties dialog will do destruction for you. The PropsPage MUST have been created with the Properties Dialog as its parent.

const KURL&  kurl ()

[const]

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

KFileItemitem ()

Returns: the file item for which the dialog is shown HACK : returns the first item of the list

KDialogBase*  dialog ()

[const]

Returns: a pointer to the dialog

const KURL&  currentDir ()

[const]

If we are building this dialog from a template,

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

const QString&  defaultName ()

[const]

If we are building this dialog from a template,

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

void  updateUrl ( const KURL& _newUrl )

Updates the item url (either called by rename or because a global apps/mimelnk desktop file is being saved)

Parameters:
_namenew URL

void  rename ( const QString& _name )

#see FilePropsPage::applyChanges

Parameters:
_namenew filename, encoded.

void  slotApply ()

[slot]

Called when the user presses 'Ok'.

void  propertiesClosed ()

[signal]

Notify that we have finished with the properties (be it Apply or Cancel)


Generated by: root@porky.devel.redhat.com on Wed May 10 08:56:57 2000, using kdoc 2.0a35.