• Skip to content
  • Skip to link menu
KDE 4.3 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KIO

KBookmarkOwner Class Reference

The KBookmarkMenu and KBookmarkBar classes gives the user the ability to either edit bookmarks or add their own. More...

#include <kbookmarkmanager.h>

Inheritance diagram for KBookmarkOwner:
KonqBookmarkOwner

List of all members.

Public Types

enum  BookmarkOption { ShowAddBookmark, ShowEditBookmark }

Public Member Functions

virtual KBookmarkDialog * bookmarkDialog (KBookmarkManager *mgr, QWidget *parent)
virtual QList< QPair< QString,
QString > > 
currentBookmarkList () const
virtual QString currentTitle () const
virtual QString currentUrl () const
virtual bool enableOption (BookmarkOption option) const
virtual void openBookmark (const KBookmark &bm, Qt::MouseButtons mb, Qt::KeyboardModifiers km)=0
virtual void openFolderinTabs (const KBookmarkGroup &bm)
virtual bool supportsTabs () const
virtual ~KBookmarkOwner ()

Detailed Description

The KBookmarkMenu and KBookmarkBar classes gives the user the ability to either edit bookmarks or add their own.

In the first case, the app may want to open the bookmark in a special way. In the second case, the app must supply the name and the URL for the bookmark.

This class gives the app this callback-like ability.

If your app does not give the user the ability to add bookmarks and you don't mind using the default bookmark editor to edit your bookmarks, then you don't need to overload this class at all. Rather, just use something like:

bookmarks = new KBookmarkMenu( mgr, 0, menu, actioncollec )

If you wish to use your own editor or allow the user to add bookmarks, you must overload this class.

Definition at line 348 of file kbookmarkmanager.h.


Member Enumeration Documentation

enum KBookmarkOwner::BookmarkOption
Enumerator:
ShowAddBookmark 
ShowEditBookmark 

Definition at line 384 of file kbookmarkmanager.h.


Constructor & Destructor Documentation

virtual KBookmarkOwner::~KBookmarkOwner (  )  [inline, virtual]

Definition at line 351 of file kbookmarkmanager.h.


Member Function Documentation

KBookmarkDialog * KBookmarkOwner::bookmarkDialog ( KBookmarkManager *  mgr,
QWidget *  parent 
) [virtual]

Definition at line 685 of file kbookmarkmanager.cc.

virtual QList<QPair<QString, QString> > KBookmarkOwner::currentBookmarkList (  )  const [inline, virtual]

Returns a list of title, URL pairs of the open tabs.

Definition at line 382 of file kbookmarkmanager.h.

virtual QString KBookmarkOwner::currentTitle (  )  const [inline, virtual]

This function is called whenever the user wants to add the current page to the bookmarks list.

The title will become the "name" of the bookmark. You must overload this function if you wish to give your users the ability to add bookmarks.

Returns:
the title of the current page.

Definition at line 361 of file kbookmarkmanager.h.

virtual QString KBookmarkOwner::currentUrl (  )  const [inline, virtual]

This function is called whenever the user wants to add the current page to the bookmarks list.

The URL will become the URL of the bookmark. You must overload this function if you wish to give your users the ability to add bookmarks.

Returns:
the URL of the current page.

Definition at line 371 of file kbookmarkmanager.h.

bool KBookmarkOwner::enableOption ( BookmarkOption  option  )  const [virtual]

Returns true if action should be shown in the menu The default is to show both a add and editBookmark Entry //TODO ContextMenuAction? to disable the contextMenu? Delete and Propeties to disable those in the context menu?

Definition at line 676 of file kbookmarkmanager.cc.

virtual void KBookmarkOwner::openBookmark ( const KBookmark &  bm,
Qt::MouseButtons  mb,
Qt::KeyboardModifiers  km 
) [pure virtual]

Called if a bookmark is selected.

You need to override this.

void KBookmarkOwner::openFolderinTabs ( const KBookmarkGroup &  bm  )  [virtual]

Called if the user wants to open every bookmark in this folder in a new tab.

The default implementation does nothing. This is only called if supportsTabs() returns true

Definition at line 690 of file kbookmarkmanager.cc.

virtual bool KBookmarkOwner::supportsTabs (  )  const [inline, virtual]

This function returns whether the owner supports tabs.

Definition at line 377 of file kbookmarkmanager.h.


The documentation for this class was generated from the following files:
  • kbookmarkmanager.h
  • kbookmarkmanager.cc

KIO

Skip menu "KIO"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.6.1
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal