File indexing completed on 2024-12-08 09:41:04

 /*
     This file is part of the KDE libraries
     SPDX-FileCopyrightText: 2001, 2002, 2003 Carsten Pfeiffer <pfeiffer@kde.org>
     SPDX-FileCopyrightText: 2007 Kevin Ottens <ervin@kde.org>
 
     SPDX-License-Identifier: LGPL-2.0-only
 */
 
 #ifndef KFILEPLACEEDITDIALOG_H
 #define KFILEPLACEEDITDIALOG_H
 
 #include "kiofilewidgets_export.h"
 
 #include <KIconLoader>
 #include <QDialog>
 #include <QUrl>
 
 class QCheckBox;
 class QDialogButtonBox;
 class QLineEdit;
 class KIconButton;
 class KUrlRequester;
 
 /**
  * @class KFilePlaceEditDialog kfileplaceeditdialog.h <KFilePlaceEditDialog>
  *
  * A dialog that allows editing entries of a KFilePlacesModel.
  * The dialog offers to configure a given url, label and icon.
  * See the class-method getInformation() for easy usage.
  *
  * @author Carsten Pfeiffer <pfeiffer@kde.org>
  * @since 5.53
  */
 class KIOFILEWIDGETS_EXPORT KFilePlaceEditDialog : public QDialog
 {
     Q_OBJECT
 
 public:
     /**
      * A convenience method to show the dialog and retrieve all the
      * properties via the given parameters. The parameters are used to
      * initialize the dialog and then return the user-configured values.
      *
      * @p allowGlobal if you set this to true, the dialog will have a checkbox
      *                for the user to decide if he wants the entry to be
      *                available globally or just for the current application.
      * @p url the url of the item
      * @p label a short, translated description of the item
      * @p icon an icon for the item
      * @p appLocal tells whether the item should be local for this application
      *             or be available globally
      * @p iconSize determines the size of the icon that is shown/selectable
      * @p parent the parent-widget for the dialog
      *
      * If you leave the icon empty, the default icon for the given url will be
      * used (KMimeType::pixmapForUrl()).
      */
     static bool
     getInformation(bool allowGlobal, QUrl &url, QString &label, QString &icon, bool isAddingNewPlace, bool &appLocal, int iconSize, QWidget *parent = nullptr);
 
     /**
      * Constructs a KFilePlaceEditDialog.
      *
      * @p allowGlobal if you set this to true, the dialog will have a checkbox
      *                for the user to decide if he wants the entry to be
      *                available globally or just for the current application.
      * @p url the url of the item
      * @p label a short, translated description of the item
      * @p icon an icon for the item
      * @p appLocal tells whether the item should be local for this application
      *             or be available globally
      * @p iconSize determines the size of the icon that is shown/selectable
      * @p parent the parent-widget for the dialog
      *
      * If you leave the icon empty, the default icon for the given url will be
      * used (KMimeType::pixmapForUrl()).
      */
     KFilePlaceEditDialog(bool allowGlobal,
                          const QUrl &url,
                          const QString &label,
                          const QString &icon,
                          bool isAddingNewPlace,
                          bool appLocal = true,
                          int iconSize = KIconLoader::SizeMedium,
                          QWidget *parent = nullptr);
     /**
      * Destroys the dialog.
      */
     ~KFilePlaceEditDialog() override;
 
     /**
      * @returns the configured url
      */
     QUrl url() const;
 
     /**
      * @returns the configured label
      */
     QString label() const;
 
     /**
      * @returns the configured icon
      */
     QString icon() const;
 
 #if KIOFILEWIDGETS_ENABLE_DEPRECATED_SINCE(5, 86)
     /**
      * @returns whether the item's icon is editable, because all icons are not
      * (e.g. the Trash can display two icons, representing its full and empty states, and
      * it is simpler to make these icons non-editable rather than to provide an interface to edit them both)
      * @deprecated Since 5.86. It was not used anywhere outside KFilePlaceEditDialog
      */
     KIOFILEWIDGETS_DEPRECATED_VERSION(5, 86, "Removed since it was never used outside KFilePlaceEditDialog")
     bool isIconEditable() const;
 #endif
 
     /**
      * @returns whether the item should be local to the application or global.
      * If allowGlobal was set to false in the constructor, this will always
      * return true.
      */
     bool applicationLocal() const;
 
 public Q_SLOTS:
     void urlChanged(const QString &);
 
 private:
     /**
      * The KUrlRequester used for editing the url
      */
     KUrlRequester *m_urlEdit;
     /**
      * The QLineEdit used for editing the label
      */
     QLineEdit *m_labelEdit;
     /**
      * The KIconButton to configure the icon
      */
     KIconButton *m_iconButton;
     /**
      * The QCheckBox to modify the local/global setting
      */
     QCheckBox *m_appLocal;
 
     QDialogButtonBox *m_buttonBox;
 };
 
 #endif // KFILEPLACEEDITDIALOG_H