• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.10.2 API Reference
  • KDE Home
  • Contact Us
 

KIO

Public Slots | Signals | Public Member Functions | Static Public Member Functions
KPropertiesDialog Class Reference

#include <kpropertiesdialog.h>

Inheritance diagram for KPropertiesDialog:
KPageDialog KDialog QDialog

List of all members.

Public Slots

virtual void slotCancel ()
virtual void slotOk ()
- Public Slots inherited from KPageDialog
void delayedDestruct ()
void enableButton (ButtonCode id, bool state)
void enableButtonApply (bool state)
void enableButtonCancel (bool state)
void enableButtonOk (bool state)
void enableLinkedHelp (bool state)
bool isDetailsWidgetVisible () const
virtual void setCaption (const QString &caption)
virtual void setCaption (const QString &caption, bool modified)
void setDetailsWidget (QWidget *detailsWidget)
void setDetailsWidgetVisible (bool visible)
void setHelp (const QString &anchor, const QString &appname=QString())
void setHelpLinkText (const QString &text)
virtual void setPlainCaption (const QString &caption)
- Public Slots inherited from KDialog

Signals

void applied ()
void canceled ()
void leaveModality ()
void propertiesClosed ()
void saveAs (const KUrl &oldUrl, KUrl &newUrl)
- Signals inherited from KPageDialog
void aboutToShowDetails ()
void applyClicked ()
void buttonClicked (KDialog::ButtonCode button)
void cancelClicked ()
void closeClicked ()
void currentPageChanged (KPageWidgetItem *current, KPageWidgetItem *before)
void defaultClicked ()
void finished ()
void helpClicked ()
void hidden ()
void layoutHintChanged ()
void noClicked ()
void okClicked ()
void pageRemoved (KPageWidgetItem *page)
void resetClicked ()
void tryClicked ()
void user1Clicked ()
void user2Clicked ()
void user3Clicked ()
void yesClicked ()
- Signals inherited from KDialog

Public Member Functions

 KPropertiesDialog (const KFileItem &item, QWidget *parent=0)
 KPropertiesDialog (const KFileItemList &_items, QWidget *parent=0)
 KPropertiesDialog (const KUrl &_url, QWidget *parent=0)
 KPropertiesDialog (const KUrl &_tempUrl, const KUrl &_currentDir, const QString &_defaultName, QWidget *parent=0)
 KPropertiesDialog (const QString &title, QWidget *parent=0)
virtual ~KPropertiesDialog ()
void abortApplying ()
KUrl currentDir () const
QString defaultName () const
void insertPlugin (KPropertiesDialogPlugin *plugin)
KFileItem & item ()
KFileItemList items () const
KUrl kurl () const
void rename (const QString &_name)
void setFileNameReadOnly (bool ro)
void setFileSharingPage (QWidget *page)
void showFileSharingPage ()
void updateUrl (const KUrl &_newUrl)
- Public Member Functions inherited from KPageDialog
 KPageDialog (QWidget *parent=0, Qt::WindowFlags flags=0)
 ~KDialog ()
 ~KPageDialog ()
void addPage (KPageWidgetItem *item)
KPageWidgetItem * addPage (QWidget *widget, const QString &name)
KPageWidgetItem * addSubPage (KPageWidgetItem *parent, QWidget *widget, const QString &name)
void addSubPage (KPageWidgetItem *parent, KPageWidgetItem *item)
KPushButton * button (ButtonCode id) const
KIcon buttonIcon (ButtonCode id) const
QString buttonText (ButtonCode id) const
QString buttonToolTip (ButtonCode id) const
QString buttonWhatsThis (ButtonCode id) const
KPageWidgetItem * currentPage () const
ButtonCode defaultButton () const
QString helpLinkText () const
void incrementInitialSize (const QSize &size)
KPageWidgetItem * insertPage (KPageWidgetItem *before, QWidget *widget, const QString &name)
void insertPage (KPageWidgetItem *before, KPageWidgetItem *item)
bool isButtonEnabled (ButtonCode id) const
 KDialog (QWidget *parent=0, Qt::WindowFlags flags=0)
QWidget * mainWidget ()
virtual QSize minimumSizeHint () const
void removePage (KPageWidgetItem *item)
void restoreDialogSize (const KConfigGroup &config)
void saveDialogSize (KConfigGroup &config, KConfigGroup::WriteConfigFlags options=KConfigGroup::Normal) const
void setButtonFocus (ButtonCode id)
void setButtonGuiItem (ButtonCode id, const KGuiItem &item)
void setButtonIcon (ButtonCode id, const KIcon &icon)
void setButtonMenu (ButtonCode id, QMenu *menu, ButtonPopupMode popupmode=InstantPopup)
void setButtons (ButtonCodes buttonMask)
void setButtonsOrientation (Qt::Orientation orientation)
void setButtonText (ButtonCode id, const QString &text)
void setButtonToolTip (ButtonCode id, const QString &text)
void setButtonWhatsThis (ButtonCode id, const QString &text)
void setCurrentPage (KPageWidgetItem *item)
void setDefaultButton (ButtonCode id)
void setEscapeButton (ButtonCode id)
void setFaceType (FaceType faceType)
void setInitialSize (const QSize &size)
void setMainWidget (QWidget *widget)
void showButton (ButtonCode id, bool state)
void showButtonSeparator (bool state)
virtual QSize sizeHint () const

Static Public Member Functions

static bool canDisplay (const KFileItemList &_items)
static bool showDialog (const KFileItem &item, QWidget *parent=0, bool modal=true)
static bool showDialog (const KUrl &_url, QWidget *parent=0, bool modal=true)
static bool showDialog (const KFileItemList &_items, QWidget *parent=0, bool modal=true)
- Static Public Member Functions inherited from KPageDialog
static bool avoidArea (QWidget *widget, const QRect &area, int screen=-1)
static void centerOnScreen (QWidget *widget, int screen=-1)
static int groupSpacingHint ()
static QString makeStandardCaption (const QString &userCaption, QWidget *window=0, CaptionFlags flags=HIGCompliantCaption)
static int marginHint ()
static void resizeLayout (QLayout *lay, int margin, int spacing)
static void resizeLayout (QWidget *widget, int margin, int spacing)
static void setAllowEmbeddingInGraphicsView (bool allowEmbedding)
static int spacingHint ()

Additional Inherited Members

- Public Types inherited from KPageDialog
enum  ButtonCode
enum  ButtonPopupMode
enum  CaptionFlag
enum  FaceType
- Public Types inherited from KDialog
- Public Attributes inherited from KPageDialog
 Apply
 AppNameCaption
 Auto
 Cancel
 Close
 Default
 DelayedPopup
 Details
 Help
 HIGCompliantCaption
 InstantPopup
 List
 ModifiedCaption
 No
 NoCaptionFlags
 NoDefault
 None
 Ok
 Plain
 Reset
 Tabbed
 Tree
 Try
 User1
 User2
 User3
 Yes
- Public Attributes inherited from KDialog
- Protected Slots inherited from KPageDialog
virtual void slotButtonClicked (int button)
void updateGeometry ()
- Protected Slots inherited from KDialog
- Protected Member Functions inherited from KPageDialog
 KPageDialog (KPageWidget *widget, QWidget *parent, Qt::WindowFlags flags=0)
 KPageDialog (KPageDialogPrivate &dd, KPageWidget *widget, QWidget *parent, Qt::WindowFlags flags=0)
virtual void closeEvent (QCloseEvent *e)
virtual void hideEvent (QHideEvent *)
 KDialog (KDialogPrivate &dd, QWidget *parent, Qt::WindowFlags flags=0)
virtual void keyPressEvent (QKeyEvent *)
const KPageWidget * pageWidget () const
KPageWidget * pageWidget ()
void setPageWidget (KPageWidget *widget)
- Protected Attributes inherited from KPageDialog
KDialogPrivate *const d_ptr
- Protected Attributes inherited from KDialog

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.

kpropertiesdialog.png
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.

Definition at line 57 of file kpropertiesdialog.h.


Constructor & Destructor Documentation

KPropertiesDialog::KPropertiesDialog ( const KFileItem &  item,
QWidget *  parent = 0 
)
explicit

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.

Parameters:
itemfile item whose properties should be displayed.
parentis the parent of the dialog widget.
nameis the internal name.

Definition at line 208 of file kpropertiesdialog.cpp.

KPropertiesDialog::KPropertiesDialog ( const KFileItemList &  _items,
QWidget *  parent = 0 
)
explicit

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.

Parameters:
_itemslist of file items whose properties should be displayed.
parentis the parent of the dialog widget.
nameis the internal name.

Definition at line 232 of file kpropertiesdialog.cpp.

KPropertiesDialog::KPropertiesDialog ( const KUrl &  _url,
QWidget *  parent = 0 
)
explicit

Brings up a Properties dialog.

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

Parameters:
_urlthe URL whose properties should be displayed
parentis the parent of the dialog widget.
nameis 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.

Definition at line 250 of file kpropertiesdialog.cpp.

KPropertiesDialog::KPropertiesDialog ( const KUrl &  _tempUrl,
const KUrl &  _currentDir,
const QString &  _defaultName,
QWidget *  parent = 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.

Parameters:
_tempUrltemplate used for reading only
_currentDirdirectory where the file will be written to
_defaultNamesomething to put in the name field, like mimetype.desktop
parentis the parent of the dialog widget.
nameis the internal name.

Definition at line 265 of file kpropertiesdialog.cpp.

KPropertiesDialog::KPropertiesDialog ( const QString &  title,
QWidget *  parent = 0 
)
explicit

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

Parameters:
titleis the string display as the "filename" in the caption of the dialog.
parentis the parent of the dialog widget.
nameis the internal name.
modaltells the dialog whether it should be modal.

Definition at line 223 of file kpropertiesdialog.cpp.

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


Member Function Documentation

void KPropertiesDialog::abortApplying ( )

To abort applying changes.

Definition at line 601 of file kpropertiesdialog.cpp.

void KPropertiesDialog::applied ( )
signal

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

void KPropertiesDialog::canceled ( )
signal

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

bool KPropertiesDialog::canDisplay ( const KFileItemList &  _items)
static

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

Parameters:
_itemsthe list of items to check.
Returns:
true if there are any property pages, otherwise false.

Definition at line 420 of file kpropertiesdialog.cpp.

KUrl KPropertiesDialog::currentDir ( ) const

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

Definition at line 410 of file kpropertiesdialog.cpp.

QString KPropertiesDialog::defaultName ( ) const

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

Definition at line 415 of file kpropertiesdialog.cpp.

void KPropertiesDialog::insertPlugin ( 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:
pluginis 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

Definition at line 387 of file kpropertiesdialog.cpp.

KFileItem & KPropertiesDialog::item ( )
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.

Definition at line 400 of file kpropertiesdialog.cpp.

KFileItemList KPropertiesDialog::items ( ) const
Returns:
the items for which the dialog is shown

Definition at line 405 of file kpropertiesdialog.cpp.

KUrl KPropertiesDialog::kurl ( ) const

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.

Definition at line 395 of file kpropertiesdialog.cpp.

void KPropertiesDialog::leaveModality ( )
signal
void KPropertiesDialog::propertiesClosed ( )
signal

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

void KPropertiesDialog::rename ( const 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:
_namenew filename, encoded.
See also:
FilePropsDialogPlugin::applyChanges

Definition at line 579 of file kpropertiesdialog.cpp.

void KPropertiesDialog::saveAs ( const KUrl &  oldUrl,
KUrl &  newUrl 
)
signal

Emitted before changes to oldUrl are saved as newUrl.

The receiver may change newUrl to point to an alternative save location.

void KPropertiesDialog::setFileNameReadOnly ( bool  ro)

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

Parameters:
rotrue if the lineedit should be read only

Definition at line 367 of file kpropertiesdialog.cpp.

void KPropertiesDialog::setFileSharingPage ( QWidget *  page)

Sets the file sharing page.

This page is shown when calling showFileSharingPage().

Parameters:
pagethe page to set
See also:
showFileSharingPage

Definition at line 362 of file kpropertiesdialog.cpp.

bool KPropertiesDialog::showDialog ( const KFileItem &  item,
QWidget *  parent = 0,
bool  modal = true 
)
static

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

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

Definition at line 282 of file kpropertiesdialog.cpp.

bool KPropertiesDialog::showDialog ( const KUrl &  _url,
QWidget *  parent = 0,
bool  modal = true 
)
static

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

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

Definition at line 302 of file kpropertiesdialog.cpp.

bool KPropertiesDialog::showDialog ( const KFileItemList &  _items,
QWidget *  parent = 0,
bool  modal = true 
)
static

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

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

Definition at line 319 of file kpropertiesdialog.cpp.

void KPropertiesDialog::showFileSharingPage ( )

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

See also:
setFileSharingPage

Definition at line 354 of file kpropertiesdialog.cpp.

void KPropertiesDialog::slotCancel ( )
virtualslot

Called when the user presses 'Cancel'.

Definition at line 478 of file kpropertiesdialog.cpp.

void KPropertiesDialog::slotOk ( )
virtualslot

Called when the user presses 'Ok'.

Definition at line 432 of file kpropertiesdialog.cpp.

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

Parameters:
_newUrlthe new URL

Definition at line 555 of file kpropertiesdialog.cpp.


The documentation for this class was generated from the following files:
  • kpropertiesdialog.h
  • kpropertiesdialog.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2013 The KDE developers.
Generated on Sun Apr 28 2013 14:27:37 by doxygen 1.8.1.1 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KIO

Skip menu "KIO"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdelibs-4.10.2 API Reference

Skip menu "kdelibs-4.10.2 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal