KDE 4.2 PyKDE API Reference
  • KDE's Python API
  • Overview
  • PyKDE Home
  • Sitemap
  • Contact Us
 

KBookmarkOwner Class Reference

from PyKDE4.kio import *

Subclasses: KonqBookmarkOwner

Detailed Description

Abstract class:
This class can be used as a base class for new classes, but can not be instantiated directly.

Enumerations

BookmarkOption { ShowAddBookmark, ShowEditBookmark }

Methods

KBookmarkDialog bookmarkDialog (self, KBookmarkManager mgr, QWidget parent)
[QPair] currentBookmarkList (self)
QString currentTitle (self)
QString currentUrl (self)
bool enableOption (self, KBookmarkOwner.BookmarkOption option)
 openBookmark (self, KBookmark bm, Qt.MouseButtons mb, Qt.KeyboardModifiers km)
 openFolderinTabs (self, KBookmarkGroup bm)
bool supportsTabs (self)

Method Documentation

KBookmarkDialog bookmarkDialog (  self,
KBookmarkManager  mgr,
QWidget  parent
)
[QPair] currentBookmarkList (   self )

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

QString currentTitle (   self )

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.

QString currentUrl (   self )

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.

bool enableOption (  self,
KBookmarkOwner.BookmarkOption  option
)

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?

openBookmark (  self,
KBookmark  bm,
Qt.MouseButtons  mb,
Qt.KeyboardModifiers  km
)
Abstract method:
This method is abstract and can be overridden but not called directly.

Called if a bookmark is selected. You need to override this.

openFolderinTabs (  self,
KBookmarkGroup  bm
)

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

bool supportsTabs (   self )

This function returns whether the owner supports tabs.


Enumeration Documentation

BookmarkOption
Enumerator:
ShowAddBookmark 
ShowEditBookmark 

  • Full Index

Modules

  • akonadi
  • dnssd
  • kdecore
  • kdeui
  • khtml
  • kio
  • knewstuff
  • kparts
  • kutils
  • nepomuk
  • phonon
  • plasma
  • solid
  • soprano
This documentation is maintained by Simon Edwards.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal