KBookmarkDialog Class Reference

#include <kbookmarkdialog.h>

Inheritance diagram for KBookmarkDialog:

Public Member Functions
	KBookmarkDialog (KBookmarkManager *, QWidget *=0)
KBookmark	addBookmark (const QString &title, const KUrl &url, KBookmark parent=KBookmark())
KBookmarkGroup	addBookmarks (const QList< QPair< QString, QString > > &list, const QString &name=QString(), KBookmarkGroup parent=KBookmarkGroup())
KBookmarkGroup	createNewFolder (const QString &name, KBookmark parent=KBookmark())
KBookmark	editBookmark (const KBookmark &bm)
KBookmarkGroup	selectFolder (KBookmark start=KBookmark())

Protected Types
enum	BookmarkDialogMode {   NewFolder, NewBookmark, EditBookmark, NewMultipleBookmarks,   SelectFolder }

Protected Slots
void	newFolderButton ()

Protected Member Functions
virtual void	aboutToShow (BookmarkDialogMode mode)
void	fillGroup (QTreeWidgetItem *parentItem, const KBookmarkGroup &group)
virtual void	initLayout ()
void	initLayoutPrivate ()
KBookmarkGroup	parentBookmark ()
virtual void	save (BookmarkDialogMode mode, const KBookmark &)
void	setParentBookmark (const KBookmark &bm)
void	slotButtonClicked (int)

Protected Attributes
KBookmark	m_bm
KLineEdit *	m_comment
QLabel *	m_commentLabel
QTreeWidget *	m_folderTree
bool	m_layout
QList< QPair< QString, QString > >	m_list
QWidget *	m_main
KBookmarkManager *	m_mgr
BookmarkDialogMode	m_mode
KLineEdit *	m_title
QLabel *	m_titleLabel
KLineEdit *	m_url
QLabel *	m_urlLabel

Detailed Description

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

Definition at line 44 of file kbookmarkdialog.h.

Member Enumeration Documentation

enum KBookmarkDialog::BookmarkDialogMode

protected

Enumerator
NewFolder
NewBookmark
EditBookmark
NewMultipleBookmarks
SelectFolder

Definition at line 78 of file kbookmarkdialog.h.

Constructor & Destructor Documentation

KBookmarkDialog::KBookmarkDialog	(	KBookmarkManager *	mgr,
		QWidget *	parent = 0
	)

Creates a new KBookmarkDialog.

Definition at line 320 of file kbookmarkdialog.cc.

Member Function Documentation

void KBookmarkDialog::aboutToShow ( BookmarkDialogMode  mode )

protectedvirtual

aboutToShow is called immediately before exec() Reimplement this to show or hide UI elements for certain modes.

Definition at line 264 of file kbookmarkdialog.cc.

KBookmark KBookmarkDialog::addBookmark	(	const QString &	title,
		const KUrl &	url,
		KBookmark	parent = KBookmark()
	)

shows a add Bookmark dialog Note: That this updates the bookmark and calls KBookmarkManager::emitChanged

Definition at line 63 of file kbookmarkdialog.cc.

KBookmarkGroup KBookmarkDialog::addBookmarks	(	const QList< QPair< QString, QString > > &	list,
		const QString &	name = QString(),
		KBookmarkGroup	parent = KBookmarkGroup()
	)

Creates a folder from a list of bookmarks Note: That this updates the bookmark and calls KBookmarkManager::emitChanged.

Definition at line 92 of file kbookmarkdialog.cc.

KBookmarkGroup KBookmarkDialog::createNewFolder	(	const QString &	name,
		KBookmark	parent = KBookmark()
	)

A dialog to create a new folder.

Definition at line 151 of file kbookmarkdialog.cc.

KBookmark KBookmarkDialog::editBookmark

(

const KBookmark &

bm

)

shows a propeties dialog Note: That this updates the bookmark and calls KBookmarkManager::emitChanged

Definition at line 36 of file kbookmarkdialog.cc.

void KBookmarkDialog::fillGroup ( QTreeWidgetItem *  parentItem, const KBookmarkGroup &  group  )

protected

Definition at line 350 of file kbookmarkdialog.cc.

void KBookmarkDialog::initLayout ( )

protectedvirtual

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.

Definition at line 269 of file kbookmarkdialog.cc.

void KBookmarkDialog::initLayoutPrivate ( )

protected

Definition at line 284 of file kbookmarkdialog.cc.

void KBookmarkDialog::newFolderButton ( )

protectedslot

Definition at line 327 of file kbookmarkdialog.cc.

KBookmarkGroup KBookmarkDialog::parentBookmark ( )

protected

returns the selected bookmark in the folder tree, or the root (top-level) bookmark if none was selected

Definition at line 201 of file kbookmarkdialog.cc.

void KBookmarkDialog::save ( BookmarkDialogMode  mode, const KBookmark &    )

protectedvirtual

save all your custom data in this method This is called after the users has accepted() the dialog.

Definition at line 259 of file kbookmarkdialog.cc.

KBookmarkGroup KBookmarkDialog::selectFolder

(

KBookmark

start = KBookmark()

)

A dialog to select a folder.

Definition at line 123 of file kbookmarkdialog.cc.

void KBookmarkDialog::setParentBookmark ( const KBookmark &  bm )

protected

selects the specified bookmark in the folder tree

Definition at line 178 of file kbookmarkdialog.cc.

void KBookmarkDialog::slotButtonClicked ( int  button )

protected

Definition at line 210 of file kbookmarkdialog.cc.

Member Data Documentation

KBookmark KBookmarkDialog::m_bm

protected

Definition at line 124 of file kbookmarkdialog.h.

KLineEdit* KBookmarkDialog::m_comment

protected

Definition at line 118 of file kbookmarkdialog.h.

QLabel* KBookmarkDialog::m_commentLabel

protected

Definition at line 121 of file kbookmarkdialog.h.

QTreeWidget* KBookmarkDialog::m_folderTree

protected

Definition at line 122 of file kbookmarkdialog.h.

bool KBookmarkDialog::m_layout

protected

Definition at line 126 of file kbookmarkdialog.h.

QList<QPair<QString, QString> > KBookmarkDialog::m_list

protected

Definition at line 125 of file kbookmarkdialog.h.

QWidget* KBookmarkDialog::m_main

protected

Definition at line 115 of file kbookmarkdialog.h.

KBookmarkManager* KBookmarkDialog::m_mgr

protected

Definition at line 123 of file kbookmarkdialog.h.

BookmarkDialogMode KBookmarkDialog::m_mode

protected

Definition at line 113 of file kbookmarkdialog.h.

KLineEdit* KBookmarkDialog::m_title

protected

Definition at line 117 of file kbookmarkdialog.h.

QLabel* KBookmarkDialog::m_titleLabel

protected

Definition at line 119 of file kbookmarkdialog.h.

KLineEdit* KBookmarkDialog::m_url

protected

Definition at line 116 of file kbookmarkdialog.h.

QLabel* KBookmarkDialog::m_urlLabel

protected

Definition at line 120 of file kbookmarkdialog.h.

---

The documentation for this class was generated from the following files:

• kbookmarkdialog.h
• kbookmarkdialog.cc