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())
Public Member Functions inherited from KDialog
	KDialog (QWidget *parent=0, Qt::WindowFlags flags=0)
	~KDialog ()
KPushButton *	button (ButtonCode id) const
KIcon	buttonIcon (ButtonCode id) const
QString	buttonText (ButtonCode id) const
QString	buttonToolTip (ButtonCode id) const
QString	buttonWhatsThis (ButtonCode id) const
ButtonCode	defaultButton () const
QString	helpLinkText () const
void	incrementInitialSize (const QSize &size)
bool	isButtonEnabled (ButtonCode id) const
QWidget *	mainWidget ()
virtual QSize	minimumSizeHint () const
void	restoreDialogSize (const KConfigGroup &config)
void	saveDialogSize (KConfigGroup &config, KConfigGroup::WriteConfigFlags options=KConfigGroup::Normal) const
void	setButtonFocus (ButtonCode id)
void	setButtonGuiItem (ButtonCode id, const KGuiItem &item)
void	setButtonIcon (ButtonCode id, const KIcon &icon)
void	setButtonMenu (ButtonCode id, QMenu *menu, ButtonPopupMode popupmode=InstantPopup)
void	setButtons (ButtonCodes buttonMask)
void	setButtonsOrientation (Qt::Orientation orientation)
void	setButtonText (ButtonCode id, const QString &text)
void	setButtonToolTip (ButtonCode id, const QString &text)
void	setButtonWhatsThis (ButtonCode id, const QString &text)
void	setDefaultButton (ButtonCode id)
void	setEscapeButton (ButtonCode id)
void	setInitialSize (const QSize &size)
void	setMainWidget (QWidget *widget)
void	showButton (ButtonCode id, bool state)
void	showButtonSeparator (bool state)
virtual QSize	sizeHint () const

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

Protected Slots
void	newFolderButton ()
Protected Slots inherited from KDialog
void	updateGeometry ()

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 Member Functions inherited from KDialog
	KDialog (KDialogPrivate &dd, QWidget *parent, Qt::WindowFlags flags=0)
virtual void	closeEvent (QCloseEvent *e)
virtual void	hideEvent (QHideEvent *)
virtual void	keyPressEvent (QKeyEvent *)

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
Protected Attributes inherited from KDialog
KDialogPrivate *const	d_ptr

Additional Inherited Members
Public Types inherited from KDialog
enum	ButtonCode
enum	ButtonPopupMode
enum	CaptionFlag
Public Slots inherited from KDialog
void	delayedDestruct ()
void	enableButton (ButtonCode id, bool state)
void	enableButtonApply (bool state)
void	enableButtonCancel (bool state)
void	enableButtonOk (bool state)
void	enableLinkedHelp (bool state)
bool	isDetailsWidgetVisible () const
virtual void	setCaption (const QString &caption)
virtual void	setCaption (const QString &caption, bool modified)
void	setDetailsWidget (QWidget *detailsWidget)
void	setDetailsWidgetVisible (bool visible)
void	setHelp (const QString &anchor, const QString &appname=QString())
void	setHelpLinkText (const QString &text)
virtual void	setPlainCaption (const QString &caption)
Signals inherited from KDialog
void	aboutToShowDetails ()
void	applyClicked ()
void	buttonClicked (KDialog::ButtonCode button)
void	cancelClicked ()
void	closeClicked ()
void	defaultClicked ()
void	finished ()
void	helpClicked ()
void	hidden ()
void	layoutHintChanged ()
void	noClicked ()
void	okClicked ()
void	resetClicked ()
void	tryClicked ()
void	user1Clicked ()
void	user2Clicked ()
void	user3Clicked ()
void	yesClicked ()
Static Public Member Functions inherited from KDialog
static bool	avoidArea (QWidget *widget, const QRect &area, int screen=-1)
static void	centerOnScreen (QWidget *widget, int screen=-1)
static int	groupSpacingHint ()
static QString	makeStandardCaption (const QString &userCaption, QWidget *window=0, CaptionFlags flags=HIGCompliantCaption)
static int	marginHint ()
static void	resizeLayout (QLayout *lay, int margin, int spacing)
static void	resizeLayout (QWidget *widget, int margin, int spacing)
static void	setAllowEmbeddingInGraphicsView (bool allowEmbedding)
static int	spacingHint ()
Public Attributes inherited from KDialog
	Apply
	AppNameCaption
	Cancel
	Close
	Default
	DelayedPopup
	Details
	Help
	HIGCompliantCaption
	InstantPopup
	ModifiedCaption
	No
	NoCaptionFlags
	NoDefault
	None
	Ok
	Reset
	Try
	User1
	User2
	User3
	Yes

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

BookmarkDialogMode

enum KBookmarkDialog::BookmarkDialogMode

protected

Enumerator
NewFolder
NewBookmark
EditBookmark
NewMultipleBookmarks
SelectFolder

Definition at line 78 of file kbookmarkdialog.h.

Constructor & Destructor Documentation

KBookmarkDialog()

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

Creates a new KBookmarkDialog.

Definition at line 320 of file kbookmarkdialog.cc.

Member Function Documentation

aboutToShow()

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.

addBookmark()

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.

addBookmarks()

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.

createNewFolder()

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

A dialog to create a new folder.

Definition at line 151 of file kbookmarkdialog.cc.

editBookmark()

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.

fillGroup()

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

protected

Definition at line 350 of file kbookmarkdialog.cc.

initLayout()

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.

initLayoutPrivate()

void KBookmarkDialog::initLayoutPrivate ( )

protected

Definition at line 284 of file kbookmarkdialog.cc.

newFolderButton

void KBookmarkDialog::newFolderButton ( )

protectedslot

Definition at line 327 of file kbookmarkdialog.cc.

parentBookmark()

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.

save()

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.

selectFolder()

KBookmarkGroup KBookmarkDialog::selectFolder

(

KBookmark

start = KBookmark()

)

A dialog to select a folder.

Definition at line 123 of file kbookmarkdialog.cc.

setParentBookmark()

void KBookmarkDialog::setParentBookmark ( const KBookmark & bm )

protected

selects the specified bookmark in the folder tree

Definition at line 178 of file kbookmarkdialog.cc.

slotButtonClicked()

void KBookmarkDialog::slotButtonClicked ( int button )

protectedvirtual

Reimplemented from KDialog.

Definition at line 210 of file kbookmarkdialog.cc.

Member Data Documentation

m_bm

KBookmark KBookmarkDialog::m_bm

protected

Definition at line 124 of file kbookmarkdialog.h.

m_comment

KLineEdit* KBookmarkDialog::m_comment

protected

Definition at line 118 of file kbookmarkdialog.h.

m_commentLabel

QLabel* KBookmarkDialog::m_commentLabel

protected

Definition at line 121 of file kbookmarkdialog.h.

m_folderTree

QTreeWidget* KBookmarkDialog::m_folderTree

protected

Definition at line 122 of file kbookmarkdialog.h.

m_layout

bool KBookmarkDialog::m_layout

protected

Definition at line 126 of file kbookmarkdialog.h.

m_list

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

protected

Definition at line 125 of file kbookmarkdialog.h.

m_main

QWidget* KBookmarkDialog::m_main

protected

Definition at line 115 of file kbookmarkdialog.h.

m_mgr

KBookmarkManager* KBookmarkDialog::m_mgr

protected

Definition at line 123 of file kbookmarkdialog.h.

m_mode

BookmarkDialogMode KBookmarkDialog::m_mode

protected

Definition at line 113 of file kbookmarkdialog.h.

m_title

KLineEdit* KBookmarkDialog::m_title

protected

Definition at line 117 of file kbookmarkdialog.h.

m_titleLabel

QLabel* KBookmarkDialog::m_titleLabel

protected

Definition at line 119 of file kbookmarkdialog.h.

m_url

KLineEdit* KBookmarkDialog::m_url

protected

Definition at line 116 of file kbookmarkdialog.h.

m_urlLabel

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