src/editbookmarkdialog.h

   1 /***************************************************************************
   2  *   Copyright (C) 2006 by Peter Penz                                      *
   3  *   peter.penz@gmx.at                                                     *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  19  ***************************************************************************/
  20 #ifndef EDITBOOKMARKDIALOG_H
  21 #define EDITBOOKMARKDIALOG_H
  22
  23 #include <kbookmark.h>
  24 #include <kdialogbase.h>
  25
  26 class Bookmark;
  27 class QLineEdit;
  28 class QPushButton;
  29
  30 /**
  31  * @brief Allows to edit the icon, URL and name of a bookmark.
  32  *
  33  * The default usage is like this:
  34  * \code
  35  * KBookmark bookmark = EditBookmarkDialog::getBookmark(i18n("Add Bookmark"),
  36  *                                                      i18n("New bookmark"),
  37  *                                                      KURL(),
  38  *                                                      "bookmark");
  39  * if (!bookmark.isNull()) {
  40  *     // ...
  41  * }
  42  * \endcode
  43  */
  44 class EditBookmarkDialog : public KDialogBase
  45 {
  46     Q_OBJECT
  47
  48 public:
  49     virtual ~EditBookmarkDialog();
  50
  51     /**
  52      * Opens a dialog where the current icon, URL and name of
  53      * an URL are editable. The title of the dialog is set to \a title.
  54      * @return A valid bookmark, if the user has pressed OK. Otherwise
  55      *         a null bookmark is returned (see Bookmark::isNull()).
  56      */
  57     static KBookmark getBookmark(const QString& title,
  58                                  const QString& name,
  59                                  const KURL& url,
  60                                  const QString& icon);
  61
  62 protected slots:
  63     virtual void slotOk();
  64
  65 protected:
  66     EditBookmarkDialog(const QString& title,
  67                        const QString& name,
  68                        const KURL& url,
  69                        const QString& icon);
  70
  71 private slots:
  72     void selectIcon();
  73     void selectLocation();
  74
  75 private:
  76     QString m_iconName;
  77     QPushButton* m_iconButton;
  78     QLineEdit* m_name;
  79     QLineEdit* m_location;
  80     KBookmark m_bookmark;
  81 };
  82 #endif