.TH "KBookmarkOwner" 3 "28 Jan 2004" "kio Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KBookmarkOwner \- The \fBKBookmarkMenu\fP and \fBKBookmarkBar\fP classes gives the user the ability to either edit bookmarks or add their own.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kbookmarkmanager.h>\fP
.PP
Inherited by KFileBookmarkHandler.
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "virtual void \fBopenBookmarkURL\fP (const  \fBQString\fP &_url)"
.br
.RI "\fIThis function is called if the user selects a bookmark. \fP"
.ti -1c
.RI "virtual \fBQString\fP \fBcurrentTitle\fP () const "
.br
.RI "\fIThis function is called whenever the user wants to add the current page to the bookmarks list. \fP"
.ti -1c
.RI "virtual \fBQString\fP \fBcurrentURL\fP () const "
.br
.RI "\fIThis function is called whenever the user wants to add the current page to the bookmarks list. \fP"
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "virtual void \fBvirtual_hook\fP (int id, void *data)"
.br
.in -1c
.SH "Detailed Description"
.PP 
The \fBKBookmarkMenu\fP and \fBKBookmarkBar\fP 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 \fImust\fP supply the name and the URL for the bookmark.
.PP
This class gives the app this callback-like ability.
.PP
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:
.PP
\fC bookmarks = new \fBKBookmarkMenu\fP(new KBookmarkOwner(), ...) \fP
.PP
If you wish to use your own editor or allow the user to add bookmarks, you must overload this class. 
.PP
Definition at line 236 of file kbookmarkmanager.h.
.SH "Member Function Documentation"
.PP 
.SS "void KBookmarkOwner::openBookmarkURL (const \fBQString\fP & _url)\fC [virtual]\fP"
.PP
This function is called if the user selects a bookmark. It will open up the bookmark in a default fashion unless you override it. Definition at line 407 of file kbookmarkmanager.cc.
.SS "virtual \fBQString\fP KBookmarkOwner::currentTitle () const\fC [inline, virtual]\fP"
.PP
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.
.PP
\fBReturns:\fP
.RS 4
the title of the current page. 
.RE
.PP
Definition at line 253 of file kbookmarkmanager.h.
.SS "virtual \fBQString\fP KBookmarkOwner::currentURL () const\fC [inline, virtual]\fP"
.PP
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.
.PP
\fBReturns:\fP
.RS 4
the URL of the current page. 
.RE
.PP
Definition at line 263 of file kbookmarkmanager.h.

.SH "Author"
.PP 
Generated automatically by Doxygen for kio Library from the source code.
