kdelibs/kio/bookmarks/kbookmarkdialog.h
Ivailo Monev 61333c4671 generic: namespaced Qt4/Katie build fixes
most of the changes were done trought Katie's namefsck script which
convertes forward class declarations to include directives, however
other fixes here and there were needed as well as some questionable
changes to Q_DECLARE_TYPEINFO() macro calls because they most likely
have to do the namespacing themselfs (QT_BEGIN/END_NAMESPACE, and
probably will be in Katie) meaning that some of the changes may be
temporary and reverted later.

Signed-off-by: Ivailo Monev <xakepa10@gmail.com>
2017-08-04 09:24:39 +00:00

140 lines
4.6 KiB
C++

// -*- c-basic-offset:4; indent-tabs-mode:nil -*-
// vim: set ts=4 sts=4 sw=4 et:
/* This file is part of the KDE libraries
Copyright 2007 Daniel Teske <teske@squorn.de>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License version 2 as published by the Free Software Foundation.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef KBOOKMARKDIALOG_H
#define KBOOKMARKDIALOG_H
#include "kbookmark.h"
#include <kdialog.h>
#include <kurl.h>
class KBookmarkManager;
#include <QWidget>
#include <QLabel>
#include <QTreeWidget>
class KLineEdit;
#include <QTreeWidgetItem>
#include <QGridLayout>
/**
* This class provides a Dialog for editing properties, adding Bookmarks and creating new folders.
* It can be used to show dialogs for common tasks with bookmarks.
*
* It is used by KBookmarkMenu to show a dialog for "Properties", "Add Bookmark" and "Create New Folder".
* If you want to customize those dialogs, derive from KBookmarkOwner and reimplement bookmarkDialog(),
* return a KBookmarkDialog subclass and reimplement initLayout(), aboutToShow() and save().
**/
class KIO_EXPORT KBookmarkDialog : public KDialog
{
Q_OBJECT
public:
/**
* Creates a new KBookmarkDialog
*/
KBookmarkDialog( KBookmarkManager *, QWidget * = 0);
/**
* shows a propeties dialog
* Note: That this updates the bookmark and calls KBookmarkManager::emitChanged
*/
KBookmark editBookmark(const KBookmark & bm);
/**
* shows a add Bookmark dialog
* Note: That this updates the bookmark and calls KBookmarkManager::emitChanged
*/
KBookmark addBookmark(const QString & title, const KUrl & url, KBookmark parent = KBookmark());
/**
* Creates a folder from a list of bookmarks
* Note: That this updates the bookmark and calls KBookmarkManager::emitChanged
*/
KBookmarkGroup addBookmarks(const QList< QPair<QString, QString> > & list, const QString & name = QString(), KBookmarkGroup parent = KBookmarkGroup());
/**
* A dialog to create a new folder.
*/
KBookmarkGroup createNewFolder(const QString & name, KBookmark parent = KBookmark());
/**
* A dialog to select a folder.
*/
KBookmarkGroup selectFolder(KBookmark start = KBookmark());
protected:
typedef enum { NewFolder, NewBookmark, EditBookmark, NewMultipleBookmarks, SelectFolder } BookmarkDialogMode;
/**
* initLayout is called to set the dialog up, indepent from the mode
* If you want to add widgets or a custom layout, reimplement this function.
* The default implementation is rather simple, take a look at the source.
*
*/
virtual void initLayout();
/**
* aboutToShow is called immediately before exec()
* Reimplement this to show or hide UI elements for certain modes.
*
*/
virtual void aboutToShow(BookmarkDialogMode mode);
/**
* save all your custom data in this method
* This is called after the users has accepted() the dialog.
*
*/
virtual void save(BookmarkDialogMode mode, const KBookmark &);
/**
* selects the specified bookmark in the folder tree
*/
void setParentBookmark(const KBookmark & bm);
/**
* returns the selected bookmark in the folder tree, or the root (top-level)
* bookmark if none was selected
*/
KBookmarkGroup parentBookmark();
void slotButtonClicked(int);
// TODO KDE5: move all these variables to a d pointer; make as many methods private as possible.
BookmarkDialogMode m_mode;
void fillGroup( QTreeWidgetItem * parentItem, const KBookmarkGroup &group);
QWidget * m_main;
KLineEdit * m_url;
KLineEdit * m_title;
KLineEdit * m_comment;
QLabel * m_titleLabel;
QLabel * m_urlLabel;
QLabel * m_commentLabel;
QTreeWidget * m_folderTree;
KBookmarkManager * m_mgr;
KBookmark m_bm;
QList<QPair<QString, QString> > m_list;
bool m_layout;
// WARNING: do not add new member variables here; replace one of the pointers with a d pointer,
// assuming that variable isn't used anywhere in apps...
void initLayoutPrivate();
protected Q_SLOTS:
void newFolderButton();
private:
void fillGroup(QTreeWidgetItem* parentItem, const KBookmarkGroup& group, const KBookmarkGroup& selectGroup);
};
#endif