KPropertiesDialog
#include <KPropertiesDialog>

Signals | |
void | applied () |
void | canceled () |
void | leaveModality () |
void | propertiesClosed () |
void | saveAs (const QUrl &oldUrl, QUrl &newUrl) |
![]() | |
void | currentPageChanged (KPageWidgetItem *current, KPageWidgetItem *before) |
void | pageRemoved (KPageWidgetItem *page) |
Public Slots | |
void | accept () override |
void | reject () override |
virtual void | slotCancel () |
virtual void | slotOk () |
Public Member Functions | |
KPropertiesDialog (const KFileItem &item, QWidget *parent=nullptr) | |
KPropertiesDialog (const KFileItemList &_items, QWidget *parent=nullptr) | |
KPropertiesDialog (const QList< QUrl > &urls, QWidget *parent=nullptr) | |
KPropertiesDialog (const QString &title, QWidget *parent=nullptr) | |
KPropertiesDialog (const QUrl &_tempUrl, const QUrl &_currentDir, const QString &_defaultName, QWidget *parent=nullptr) | |
KPropertiesDialog (const QUrl &url, QWidget *parent=nullptr) | |
~KPropertiesDialog () override | |
void | abortApplying () |
QDialogButtonBox * | buttonBox () |
const QDialogButtonBox * | buttonBox () const |
QUrl | currentDir () const |
QString | defaultName () const |
void | insertPlugin (KPropertiesDialogPlugin *plugin) |
KFileItem & | item () |
KFileItemList | items () const |
QUrl | kurl () const |
void | rename (const QString &_name) |
void | setFileNameReadOnly (bool ro) |
void | setFileSharingPage (QWidget *page) |
void | showFileSharingPage () |
void | updateUrl (const QUrl &newUrl) |
QUrl | url () const |
![]() | |
KPageDialog (QWidget *parent=nullptr, Qt::WindowFlags flags=Qt::WindowFlags()) | |
void | addActionButton (QAbstractButton *button) |
void | addPage (KPageWidgetItem *item) |
KPageWidgetItem * | addPage (QWidget *widget, const QString &name) |
void | addSubPage (KPageWidgetItem *parent, KPageWidgetItem *item) |
KPageWidgetItem * | addSubPage (KPageWidgetItem *parent, QWidget *widget, const QString &name) |
QPushButton * | button (QDialogButtonBox::StandardButton which) const |
KPageWidgetItem * | currentPage () const |
void | insertPage (KPageWidgetItem *before, KPageWidgetItem *item) |
KPageWidgetItem * | insertPage (KPageWidgetItem *before, QWidget *widget, const QString &name) |
void | removePage (KPageWidgetItem *item) |
void | setCurrentPage (KPageWidgetItem *item) |
void | setFaceType (FaceType faceType) |
void | setStandardButtons (QDialogButtonBox::StandardButtons buttons) |
![]() | |
QDialog (QWidget *parent, Qt::WindowFlags f) | |
virtual void | accept () |
void | accepted () |
virtual void | done (int r) |
virtual int | exec () |
QWidget * | extension () const const |
void | finished (int result) |
bool | isSizeGripEnabled () const const |
virtual QSize | minimumSizeHint () const const override |
virtual void | open () |
Qt::Orientation | orientation () const const |
virtual void | reject () |
void | rejected () |
int | result () const const |
void | setExtension (QWidget *extension) |
void | setModal (bool modal) |
void | setOrientation (Qt::Orientation orientation) |
void | setResult (int i) |
void | setSizeGripEnabled (bool) |
virtual void | setVisible (bool visible) override |
void | showExtension (bool showIt) |
virtual QSize | sizeHint () const const override |
![]() | |
QWidget (QWidget *parent, Qt::WindowFlags f) | |
bool | acceptDrops () const const |
QString | accessibleDescription () const const |
QString | accessibleName () const const |
QList< QAction * > | actions () const const |
void | activateWindow () |
void | addAction (QAction *action) |
void | addActions (QList< QAction * > actions) |
void | adjustSize () |
bool | autoFillBackground () const const |
QPalette::ColorRole | backgroundRole () const const |
QBackingStore * | backingStore () const const |
QSize | baseSize () const const |
QWidget * | childAt (const QPoint &p) const const |
QWidget * | childAt (int x, int y) const const |
QRect | childrenRect () const const |
QRegion | childrenRegion () const const |
void | clearFocus () |
void | clearMask () |
bool | close () |
QMargins | contentsMargins () const const |
QRect | contentsRect () const const |
Qt::ContextMenuPolicy | contextMenuPolicy () const const |
QCursor | cursor () const const |
void | customContextMenuRequested (const QPoint &pos) |
WId | effectiveWinId () const const |
void | ensurePolished () const const |
Qt::FocusPolicy | focusPolicy () const const |
QWidget * | focusProxy () const const |
QWidget * | focusWidget () const const |
const QFont & | font () const const |
QFontInfo | fontInfo () const const |
QFontMetrics | fontMetrics () const const |
QPalette::ColorRole | foregroundRole () const const |
QRect | frameGeometry () const const |
QSize | frameSize () const const |
const QRect & | geometry () const const |
void | getContentsMargins (int *left, int *top, int *right, int *bottom) const const |
QPixmap | grab (const QRect &rectangle) |
void | grabGesture (Qt::GestureType gesture, Qt::GestureFlags flags) |
void | grabKeyboard () |
void | grabMouse () |
void | grabMouse (const QCursor &cursor) |
int | grabShortcut (const QKeySequence &key, Qt::ShortcutContext context) |
QGraphicsEffect * | graphicsEffect () const const |
QGraphicsProxyWidget * | graphicsProxyWidget () const const |
bool | hasEditFocus () const const |
bool | hasFocus () const const |
virtual bool | hasHeightForWidth () const const |
bool | hasMouseTracking () const const |
bool | hasTabletTracking () const const |
int | height () const const |
virtual int | heightForWidth (int w) const const |
void | hide () |
Qt::InputMethodHints | inputMethodHints () const const |
virtual QVariant | inputMethodQuery (Qt::InputMethodQuery query) const const |
void | insertAction (QAction *before, QAction *action) |
void | insertActions (QAction *before, QList< QAction * > actions) |
bool | isActiveWindow () const const |
bool | isAncestorOf (const QWidget *child) const const |
bool | isEnabled () const const |
bool | isEnabledTo (const QWidget *ancestor) const const |
bool | isEnabledToTLW () const const |
bool | isFullScreen () const const |
bool | isHidden () const const |
bool | isMaximized () const const |
bool | isMinimized () const const |
bool | isModal () const const |
bool | isTopLevel () const const |
bool | isVisible () const const |
bool | isVisibleTo (const QWidget *ancestor) const const |
bool | isWindow () const const |
bool | isWindowModified () const const |
QLayout * | layout () const const |
Qt::LayoutDirection | layoutDirection () const const |
QLocale | locale () const const |
void | lower () |
QPoint | mapFrom (const QWidget *parent, const QPoint &pos) const const |
QPoint | mapFromGlobal (const QPoint &pos) const const |
QPoint | mapFromParent (const QPoint &pos) const const |
QPoint | mapTo (const QWidget *parent, const QPoint &pos) const const |
QPoint | mapToGlobal (const QPoint &pos) const const |
QPoint | mapToParent (const QPoint &pos) const const |
QRegion | mask () const const |
int | maximumHeight () const const |
QSize | maximumSize () const const |
int | maximumWidth () const const |
int | minimumHeight () const const |
QSize | minimumSize () const const |
int | minimumWidth () const const |
void | move (const QPoint &) |
void | move (int x, int y) |
QWidget * | nativeParentWidget () const const |
QWidget * | nextInFocusChain () const const |
QRect | normalGeometry () const const |
void | overrideWindowFlags (Qt::WindowFlags flags) |
virtual QPaintEngine * | paintEngine () const const override |
const QPalette & | palette () const const |
QWidget * | parentWidget () const const |
QPoint | pos () const const |
QWidget * | previousInFocusChain () const const |
QWIDGETSIZE_MAX QWIDGETSIZE_MAX | |
void | raise () |
QRect | rect () const const |
void | releaseKeyboard () |
void | releaseMouse () |
void | releaseShortcut (int id) |
void | removeAction (QAction *action) |
void | render (QPaintDevice *target, const QPoint &targetOffset, const QRegion &sourceRegion, QWidget::RenderFlags renderFlags) |
void | render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, QWidget::RenderFlags renderFlags) |
void | repaint () |
void | repaint (const QRect &rect) |
void | repaint (const QRegion &rgn) |
void | repaint (int x, int y, int w, int h) |
void | resize (const QSize &) |
void | resize (int w, int h) |
bool | restoreGeometry (const QByteArray &geometry) |
QByteArray | saveGeometry () const const |
QScreen * | screen () const const |
void | scroll (int dx, int dy) |
void | scroll (int dx, int dy, const QRect &r) |
void | setAcceptDrops (bool on) |
void | setAccessibleDescription (const QString &description) |
void | setAccessibleName (const QString &name) |
void | setAttribute (Qt::WidgetAttribute attribute, bool on) |
void | setAutoFillBackground (bool enabled) |
void | setBackgroundRole (QPalette::ColorRole role) |
void | setBaseSize (const QSize &) |
void | setBaseSize (int basew, int baseh) |
void | setContentsMargins (const QMargins &margins) |
void | setContentsMargins (int left, int top, int right, int bottom) |
void | setContextMenuPolicy (Qt::ContextMenuPolicy policy) |
void | setCursor (const QCursor &) |
void | setDisabled (bool disable) |
void | setEditFocus (bool enable) |
void | setEnabled (bool) |
void | setFixedHeight (int h) |
void | setFixedSize (const QSize &s) |
void | setFixedSize (int w, int h) |
void | setFixedWidth (int w) |
void | setFocus () |
void | setFocus (Qt::FocusReason reason) |
void | setFocusPolicy (Qt::FocusPolicy policy) |
void | setFocusProxy (QWidget *w) |
void | setFont (const QFont &) |
void | setForegroundRole (QPalette::ColorRole role) |
void | setGeometry (const QRect &) |
void | setGeometry (int x, int y, int w, int h) |
void | setGraphicsEffect (QGraphicsEffect *effect) |
void | setHidden (bool hidden) |
void | setInputMethodHints (Qt::InputMethodHints hints) |
void | setLayout (QLayout *layout) |
void | setLayoutDirection (Qt::LayoutDirection direction) |
void | setLocale (const QLocale &locale) |
void | setMask (const QBitmap &bitmap) |
void | setMask (const QRegion ®ion) |
void | setMaximumHeight (int maxh) |
void | setMaximumSize (const QSize &) |
void | setMaximumSize (int maxw, int maxh) |
void | setMaximumWidth (int maxw) |
void | setMinimumHeight (int minh) |
void | setMinimumSize (const QSize &) |
void | setMinimumSize (int minw, int minh) |
void | setMinimumWidth (int minw) |
void | setMouseTracking (bool enable) |
void | setPalette (const QPalette &) |
void | setParent (QWidget *parent) |
void | setParent (QWidget *parent, Qt::WindowFlags f) |
void | setShortcutAutoRepeat (int id, bool enable) |
void | setShortcutEnabled (int id, bool enable) |
void | setSizeIncrement (const QSize &) |
void | setSizeIncrement (int w, int h) |
void | setSizePolicy (QSizePolicy) |
void | setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical) |
void | setStatusTip (const QString &) |
void | setStyle (QStyle *style) |
void | setStyleSheet (const QString &styleSheet) |
void | setTabletTracking (bool enable) |
void | setToolTip (const QString &) |
void | setToolTipDuration (int msec) |
void | setUpdatesEnabled (bool enable) |
void | setupUi (QWidget *widget) |
void | setWhatsThis (const QString &) |
void | setWindowFilePath (const QString &filePath) |
void | setWindowFlag (Qt::WindowType flag, bool on) |
void | setWindowFlags (Qt::WindowFlags type) |
void | setWindowIcon (const QIcon &icon) |
void | setWindowIconText (const QString &) |
void | setWindowModality (Qt::WindowModality windowModality) |
void | setWindowModified (bool) |
void | setWindowOpacity (qreal level) |
void | setWindowRole (const QString &role) |
void | setWindowState (Qt::WindowStates windowState) |
void | setWindowTitle (const QString &) |
void | show () |
void | showFullScreen () |
void | showMaximized () |
void | showMinimized () |
void | showNormal () |
QSize | size () const const |
QSize | sizeIncrement () const const |
QSizePolicy | sizePolicy () const const |
void | stackUnder (QWidget *w) |
QString | statusTip () const const |
QStyle * | style () const const |
QString | styleSheet () const const |
bool | testAttribute (Qt::WidgetAttribute attribute) const const |
QString | toolTip () const const |
int | toolTipDuration () const const |
QWidget * | topLevelWidget () const const |
bool | underMouse () const const |
void | ungrabGesture (Qt::GestureType gesture) |
void | unsetCursor () |
void | unsetLayoutDirection () |
void | unsetLocale () |
void | update () |
void | update (const QRect &rect) |
void | update (const QRegion &rgn) |
void | update (int x, int y, int w, int h) |
void | updateGeometry () |
bool | updatesEnabled () const const |
QRegion | visibleRegion () const const |
QString | whatsThis () const const |
int | width () const const |
QWidget * | window () const const |
QString | windowFilePath () const const |
Qt::WindowFlags | windowFlags () const const |
QWindow * | windowHandle () const const |
QIcon | windowIcon () const const |
void | windowIconChanged (const QIcon &icon) |
QString | windowIconText () const const |
void | windowIconTextChanged (const QString &iconText) |
Qt::WindowModality | windowModality () const const |
qreal | windowOpacity () const const |
QString | windowRole () const const |
Qt::WindowStates | windowState () const const |
QString | windowTitle () const const |
void | windowTitleChanged (const QString &title) |
Qt::WindowType | windowType () const const |
WId | winId () const const |
int | x () const const |
int | y () const const |
![]() | |
QObject (QObject *parent) | |
bool | blockSignals (bool block) |
const QObjectList & | children () const const |
QMetaObject::Connection | connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const |
void | deleteLater () |
void | destroyed (QObject *obj) |
bool | disconnect (const char *signal, const QObject *receiver, const char *method) const const |
bool | disconnect (const QObject *receiver, const char *method) const const |
void | dumpObjectInfo () |
void | dumpObjectInfo () const const |
void | dumpObjectTree () |
void | dumpObjectTree () const const |
QList< QByteArray > | dynamicPropertyNames () const const |
T | findChild (const QString &name, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QRegExp ®Exp, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QString &name, Qt::FindChildOptions options) const const |
bool | inherits (const char *className) const const |
void | installEventFilter (QObject *filterObj) |
bool | isWidgetType () const const |
bool | isWindowType () const const |
void | killTimer (int id) |
virtual const QMetaObject * | metaObject () const const |
void | moveToThread (QThread *targetThread) |
QString | objectName () const const |
void | objectNameChanged (const QString &objectName) |
QObject * | parent () const const |
QVariant | property (const char *name) const const |
Q_CLASSINFO (Name, Value) | |
Q_DISABLE_COPY (Class) | |
Q_DISABLE_COPY_MOVE (Class) | |
Q_DISABLE_MOVE (Class) | |
Q_EMIT Q_EMIT | |
Q_ENUM (...) | |
Q_ENUM_NS (...) | |
Q_ENUMS (...) | |
Q_FLAG (...) | |
Q_FLAG_NS (...) | |
Q_FLAGS (...) | |
Q_GADGET Q_GADGET | |
Q_INTERFACES (...) | |
Q_INVOKABLE Q_INVOKABLE | |
Q_NAMESPACE Q_NAMESPACE | |
Q_NAMESPACE_EXPORT (EXPORT_MACRO) | |
Q_OBJECT Q_OBJECT | |
Q_PROPERTY (...) | |
Q_REVISION Q_REVISION | |
Q_SET_OBJECT_NAME (Object) | |
Q_SIGNAL Q_SIGNAL | |
Q_SIGNALS Q_SIGNALS | |
Q_SLOT Q_SLOT | |
Q_SLOTS Q_SLOTS | |
T | qFindChild (const QObject *obj, const QString &name) |
QList< T > | qFindChildren (const QObject *obj, const QRegExp ®Exp) |
QList< T > | qFindChildren (const QObject *obj, const QString &name) |
T | qobject_cast (const QObject *object) |
T | qobject_cast (QObject *object) |
QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT | |
void | removeEventFilter (QObject *obj) |
void | setObjectName (const QString &name) |
void | setParent (QObject *parent) |
bool | setProperty (const char *name, const QVariant &value) |
bool | signalsBlocked () const const |
int | startTimer (int interval, Qt::TimerType timerType) |
int | startTimer (std::chrono::milliseconds time, Qt::TimerType timerType) |
QThread * | thread () const const |
![]() | |
int | colorCount () const const |
int | depth () const const |
int | devicePixelRatio () const const |
qreal | devicePixelRatioF () const const |
int | height () const const |
int | heightMM () const const |
int | logicalDpiX () const const |
int | logicalDpiY () const const |
bool | paintingActive () const const |
int | physicalDpiX () const const |
int | physicalDpiY () const const |
int | width () const const |
int | widthMM () const const |
Static Public Member Functions | |
static bool | canDisplay (const KFileItemList &_items) |
static bool | showDialog (const KFileItem &item, QWidget *parent=nullptr, bool modal=true) |
static bool | showDialog (const KFileItemList &_items, QWidget *parent=nullptr, bool modal=true) |
static bool | showDialog (const QList< QUrl > &urls, QWidget *parent=nullptr, bool modal=true) |
static bool | showDialog (const QUrl &_url, QWidget *parent=nullptr, bool modal=true) |
![]() | |
QWidget * | createWindowContainer (QWindow *window, QWidget *parent, Qt::WindowFlags flags) |
QWidget * | find (WId id) |
QWidget * | keyboardGrabber () |
QWidget * | mouseGrabber () |
void | setTabOrder (QWidget *first, QWidget *second) |
![]() | |
QMetaObject::Connection | connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, PointerToMemberFunction signal, Functor functor) |
bool | disconnect (const QMetaObject::Connection &connection) |
bool | disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method) |
bool | disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method) |
bool | disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method) |
QString | tr (const char *sourceText, const char *disambiguation, int n) |
QString | trUtf8 (const char *sourceText, const char *disambiguation, int n) |
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.

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.
This respects the "editfiletype", "run_desktop_files" and "shell_access" Kiosk action restrictions (see KAuthorized::authorize()).
Definition at line 56 of file kpropertiesdialog.h.
Constructor & Destructor Documentation
◆ KPropertiesDialog() [1/6]
|
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
-
item file item whose properties should be displayed. parent is the parent of the dialog widget.
Definition at line 230 of file kpropertiesdialog.cpp.
◆ KPropertiesDialog() [2/6]
|
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
-
_items list of file items whose properties should be displayed. parent is the parent of the dialog widget.
Definition at line 254 of file kpropertiesdialog.cpp.
◆ KPropertiesDialog() [3/6]
Brings up a Properties dialog.
Convenience constructor for non-file-manager applications, where you have a QUrl rather than a KFileItem or KFileItemList.
- Parameters
-
url the URL whose properties should be displayed parent is the parent of the dialog widget.
For local files with a known MIME type, simply create a KFileItem and pass it to the other constructor.
Definition at line 273 of file kpropertiesdialog.cpp.
◆ KPropertiesDialog() [4/6]
|
explicit |
Brings up a Properties dialog.
Convenience constructor for non-file-manager applications, where you have a list of QUrls rather than a KFileItemList.
- Parameters
-
urls list of URLs whose properties should be displayed (must contain at least one non-empty URL) parent is the parent of the dialog widget.
For local files with a known MIME type, simply create a KFileItemList and pass it to the other constructor.
- Since
- 5.10
Definition at line 290 of file kpropertiesdialog.cpp.
◆ KPropertiesDialog() [5/6]
KPropertiesDialog::KPropertiesDialog | ( | const QUrl & | _tempUrl, |
const QUrl & | _currentDir, | ||
const QString & | _defaultName, | ||
QWidget * | parent = nullptr |
||
) |
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
-
_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.
Definition at line 317 of file kpropertiesdialog.cpp.
◆ KPropertiesDialog() [6/6]
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 title of the dialog. parent is the parent of the dialog widget.
Definition at line 245 of file kpropertiesdialog.cpp.
◆ ~KPropertiesDialog()
|
override |
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 465 of file kpropertiesdialog.cpp.
Member Function Documentation
◆ abortApplying()
void KPropertiesDialog::abortApplying | ( | ) |
To abort applying changes.
Definition at line 757 of file kpropertiesdialog.cpp.
◆ accept
|
overrideslot |
◆ applied
|
signal |
This signal is emitted when the properties changes are applied (for example, with the OK button)
◆ canceled
|
signal |
This signal is emitted when the properties changes are aborted (for example, with the Cancel button)
◆ canDisplay()
|
static |
Determine whether there are any property pages available for the given file items.
- Parameters
-
_items the list of items to check.
- Returns
- true if there are any property pages, otherwise false.
Definition at line 503 of file kpropertiesdialog.cpp.
◆ currentDir()
QUrl 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 493 of file kpropertiesdialog.cpp.
◆ defaultName()
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 498 of file kpropertiesdialog.cpp.
◆ insertPlugin()
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
-
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
Definition at line 471 of file kpropertiesdialog.cpp.
◆ item()
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 483 of file kpropertiesdialog.cpp.
◆ items()
KFileItemList KPropertiesDialog::items | ( | ) | const |
- Returns
- the items for which the dialog is shown
Definition at line 488 of file kpropertiesdialog.cpp.
◆ kurl()
|
inline |
- Deprecated:
- since 5.0, use url()
Definition at line 222 of file kpropertiesdialog.h.
◆ leaveModality
|
signal |
- Deprecated:
- Since 5.82, not used anymore.
◆ propertiesClosed
|
signal |
This signal is emitted when the Properties Dialog is closed (for example, with OK or Cancel buttons)
◆ reject
|
overrideslot |
Called when the user presses 'Cancel' or Esc.
- Since
- 5.25
Definition at line 610 of file kpropertiesdialog.cpp.
◆ rename()
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
-
_name new filename, encoded.
- See also
- FilePropsDialogPlugin::applyChanges
Definition at line 738 of file kpropertiesdialog.cpp.
◆ saveAs
Emitted before changes to oldUrl
are saved as newUrl
.
The receiver may change newUrl
to point to an alternative save location.
◆ setFileNameReadOnly()
void KPropertiesDialog::setFileNameReadOnly | ( | bool | ro | ) |
Call this to make the filename lineedit readonly, to prevent the user from renaming the file.
- Parameters
-
ro true if the lineedit should be read only
Definition at line 454 of file kpropertiesdialog.cpp.
◆ setFileSharingPage()
void KPropertiesDialog::setFileSharingPage | ( | QWidget * | page | ) |
Sets the file sharing page.
This page is shown when calling showFileSharingPage().
- Parameters
-
page the page to set
- Note
- This should only be called by KPropertiesDialog plugins.
- See also
- showFileSharingPage
Definition at line 449 of file kpropertiesdialog.cpp.
◆ showDialog() [1/4]
|
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 363 of file kpropertiesdialog.cpp.
◆ showDialog() [2/4]
|
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 400 of file kpropertiesdialog.cpp.
◆ showDialog() [3/4]
|
static |
Immediately displays a Properties dialog using constructor with the same parameters.
On MS Windows, if _urls
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).
- Parameters
-
urls list of URLs whose properties should be displayed (must contain at least one non-empty URL) parent is the parent of the dialog widget. modal tells the dialog whether it should be modal.
- Returns
- true on successful dialog displaying (can be false on win32).
- Since
- 5.10
Definition at line 421 of file kpropertiesdialog.cpp.
◆ showDialog() [4/4]
|
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 383 of file kpropertiesdialog.cpp.
◆ showFileSharingPage()
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 442 of file kpropertiesdialog.cpp.
◆ slotCancel
|
virtualslot |
Called when the user presses 'Cancel'.
- Deprecated:
- since 5.25, use reject()
Definition at line 605 of file kpropertiesdialog.cpp.
◆ slotOk
|
virtualslot |
Called when the user presses 'Ok'.
- Deprecated:
- since 5.25, use accept()
Definition at line 514 of file kpropertiesdialog.cpp.
◆ updateUrl()
void KPropertiesDialog::updateUrl | ( | const QUrl & | 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
-
newUrl the new URL
Definition at line 718 of file kpropertiesdialog.cpp.
◆ url()
QUrl KPropertiesDialog::url | ( | ) | 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
- the single URL.
Definition at line 478 of file kpropertiesdialog.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2023 The KDE developers.
Generated on Tue Nov 28 2023 03:55:14 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.