\section{KBookmark\-Group Class Reference}
\label{classKBookmarkGroup}\index{KBookmarkGroup@{KBookmarkGroup}}
A group of bookmarks.  


{\tt \#include $<$kbookmark.h$>$}

Collaboration diagram for KBookmark\-Group:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=66pt]{classKBookmarkGroup__coll__graph}
\end{center}
\end{figure}
\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf KBookmark\-Group} ()
\item 
{\bf KBookmark\-Group} ({\bf QDom\-Element} elem)
\item 
{\bf QString} {\bf group\-Address} () const 
\item 
bool {\bf is\-Open} () const 
\item 
KBookmark {\bf first} () const 
\item 
KBookmark {\bf previous} (const KBookmark \&current) const 
\item 
KBookmark {\bf next} (const KBookmark \&current) const 
\item 
{\bf KBookmark\-Group} {\bf create\-New\-Folder} ({\bf KBookmark\-Manager} $\ast$mgr, const {\bf QString} \&text=QString::null, bool emit\-Signal=true)
\item 
KBookmark {\bf create\-New\-Separator} ()
\item 
KBookmark {\bf add\-Bookmark} ({\bf KBookmark\-Manager} $\ast$mgr, const KBookmark \&bm, bool emit\-Signal=true)
\item 
KBookmark {\bf add\-Bookmark} ({\bf KBookmark\-Manager} $\ast$mgr, const {\bf QString} \&text, const {\bf KURL} \&url, const {\bf QString} \&icon=QString::null, bool emit\-Signal=true)
\item 
bool {\bf move\-Item} (const KBookmark \&item, const KBookmark \&after)
\item 
void {\bf delete\-Bookmark} (KBookmark bk)
\item 
bool {\bf is\-Toolbar\-Group} () const 
\item 
{\bf QDom\-Element} {\bf find\-Toolbar} () const \label{classKBookmarkGroup_a14}

\item 
{\bf QValue\-List}$<$ {\bf KURL} $>$ {\bf group\-Url\-List} () const 
\end{CompactItemize}
\subsection*{Protected Member Functions}
\begin{CompactItemize}
\item 
{\bf QDom\-Element} {\bf next\-Known\-Tag} ({\bf QDom\-Element} start, bool go\-Next) const \label{classKBookmarkGroup_b0}

\end{CompactItemize}


\subsection{Detailed Description}
A group of bookmarks. 



Definition at line 191 of file kbookmark.h.

\subsection{Constructor \& Destructor Documentation}
\index{KBookmarkGroup@{KBookmark\-Group}!KBookmarkGroup@{KBookmarkGroup}}
\index{KBookmarkGroup@{KBookmarkGroup}!KBookmarkGroup@{KBookmark\-Group}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}KBookmark\-Group::KBookmark\-Group ()}\label{classKBookmarkGroup_a0}


Create an invalid group. 

This is mostly for use in {\bf QValue\-List}, and other places where we need a null group. Also used as a parent for a bookmark that doesn't have one (e.g. Netscape bookmarks) 

Definition at line 35 of file kbookmark.cc.

Referenced by create\-New\-Folder().\index{KBookmarkGroup@{KBookmark\-Group}!KBookmarkGroup@{KBookmarkGroup}}
\index{KBookmarkGroup@{KBookmarkGroup}!KBookmarkGroup@{KBookmark\-Group}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}KBookmark\-Group::KBookmark\-Group ({\bf QDom\-Element} {\em elem})}\label{classKBookmarkGroup_a1}


Create a bookmark group as specified by the given element. 



Definition at line 40 of file kbookmark.cc.

\subsection{Member Function Documentation}
\index{KBookmarkGroup@{KBookmark\-Group}!groupAddress@{groupAddress}}
\index{groupAddress@{groupAddress}!KBookmarkGroup@{KBookmark\-Group}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} KBookmark\-Group::group\-Address () const}\label{classKBookmarkGroup_a2}


Much like KBookmark::address, but caches the address into m\_\-address. 



Definition at line 45 of file kbookmark.cc.

References QString::is\-Empty().\index{KBookmarkGroup@{KBookmark\-Group}!isOpen@{isOpen}}
\index{isOpen@{isOpen}!KBookmarkGroup@{KBookmark\-Group}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KBookmark\-Group::is\-Open () const}\label{classKBookmarkGroup_a3}


\begin{Desc}
\item[Returns:]true if the bookmark folder is opened in the bookmark editor \end{Desc}


Definition at line 52 of file kbookmark.cc.\index{KBookmarkGroup@{KBookmark\-Group}!first@{first}}
\index{first@{first}!KBookmarkGroup@{KBookmark\-Group}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}KBookmark KBookmark\-Group::first () const}\label{classKBookmarkGroup_a4}


Return the first child bookmark of this group. 



Definition at line 73 of file kbookmark.cc.

Referenced by KBookmark\-Menu::fill\-Bookmark\-Menu(), KBookmark\-Manager::find\-By\-Address(), and group\-Url\-List().\index{KBookmarkGroup@{KBookmark\-Group}!previous@{previous}}
\index{previous@{previous}!KBookmarkGroup@{KBookmark\-Group}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}KBookmark KBookmark\-Group::previous (const KBookmark \& {\em current}) const}\label{classKBookmarkGroup_a5}


Return the prevous sibling of a child bookmark of this group. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em current}]has to be one of our child bookmarks. \end{description}
\end{Desc}


Definition at line 78 of file kbookmark.cc.\index{KBookmarkGroup@{KBookmark\-Group}!next@{next}}
\index{next@{next}!KBookmarkGroup@{KBookmark\-Group}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}KBookmark KBookmark\-Group::next (const KBookmark \& {\em current}) const}\label{classKBookmarkGroup_a6}


Return the next sibling of a child bookmark of this group. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em current}]has to be one of our child bookmarks. \end{description}
\end{Desc}


Definition at line 83 of file kbookmark.cc.

Referenced by KBookmark\-Menu::fill\-Bookmark\-Menu(), KBookmark\-Manager::find\-By\-Address(), and group\-Url\-List().\index{KBookmarkGroup@{KBookmark\-Group}!createNewFolder@{createNewFolder}}
\index{createNewFolder@{createNewFolder}!KBookmarkGroup@{KBookmark\-Group}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf KBookmark\-Group} KBookmark\-Group::create\-New\-Folder ({\bf KBookmark\-Manager} $\ast$ {\em mgr}, const {\bf QString} \& {\em text} = {\tt QString::null}, bool {\em emit\-Signal} = {\tt true})}\label{classKBookmarkGroup_a7}


Create a new bookmark folder, as the last child of this group. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em mgr}]the manager of the bookmark \item[{\em text}]for the folder. If empty, the user will be queried for it. \item[{\em emit\-Signal}]if true emit {\bf KBookmark\-Notifier}{\rm (p.\,\pageref{classKBookmarkNotifier})} signal \end{description}
\end{Desc}


Definition at line 110 of file kbookmark.cc.

References QDom\-Document::create\-Element(), QDom\-Document::create\-Text\-Node(), KInput\-Dialog::get\-Text(), and KBookmark\-Group().\index{KBookmarkGroup@{KBookmark\-Group}!createNewSeparator@{createNewSeparator}}
\index{createNewSeparator@{createNewSeparator}!KBookmarkGroup@{KBookmark\-Group}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}KBookmark KBookmark\-Group::create\-New\-Separator ()}\label{classKBookmarkGroup_a8}


Create a new bookmark separator. 



Definition at line 145 of file kbookmark.cc.

References QDom\-Document::create\-Element().\index{KBookmarkGroup@{KBookmark\-Group}!addBookmark@{addBookmark}}
\index{addBookmark@{addBookmark}!KBookmarkGroup@{KBookmark\-Group}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}KBookmark KBookmark\-Group::add\-Bookmark ({\bf KBookmark\-Manager} $\ast$ {\em mgr}, const KBookmark \& {\em bm}, bool {\em emit\-Signal} = {\tt true})}\label{classKBookmarkGroup_a9}


Create a new bookmark, as the last child of this group Don't forget to use KBookmark\-Manager::self()-$>$emit\-Changed( parent\-Bookmark ); if this bookmark was added interactively. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em mgr}]the manager of the bookmark \item[{\em bm}]the bookmark to add \item[{\em emit\-Signal}]if true emit {\bf KBookmark\-Notifier}{\rm (p.\,\pageref{classKBookmarkNotifier})} signal \end{description}
\end{Desc}
\begin{Desc}
\item[Since:]3.4 \end{Desc}


Definition at line 178 of file kbookmark.cc.

References QDom\-Node::append\-Child().

Referenced by add\-Bookmark(), and KBookmark\-Manager::add\-Bookmark\-Dialog().\index{KBookmarkGroup@{KBookmark\-Group}!addBookmark@{addBookmark}}
\index{addBookmark@{addBookmark}!KBookmarkGroup@{KBookmark\-Group}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}KBookmark KBookmark\-Group::add\-Bookmark ({\bf KBookmark\-Manager} $\ast$ {\em mgr}, const {\bf QString} \& {\em text}, const {\bf KURL} \& {\em url}, const {\bf QString} \& {\em icon} = {\tt QString::null}, bool {\em emit\-Signal} = {\tt true})}\label{classKBookmarkGroup_a10}


Create a new bookmark, as the last child of this group Don't forget to use KBookmark\-Manager::self()-$>$emit\-Changed( parent\-Bookmark ); if this bookmark was added interactively. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em mgr}]the manager of the bookmark \item[{\em text}]for the bookmark \item[{\em url}]the URL that the bookmark points to \item[{\em icon}]the name of the icon to associate with the bookmark. A suitable default will be determined from the URL if not specified. \item[{\em emit\-Signal}]if true emit {\bf KBookmark\-Notifier}{\rm (p.\,\pageref{classKBookmarkNotifier})} signal \end{description}
\end{Desc}


Definition at line 195 of file kbookmark.cc.

References add\-Bookmark(), QDom\-Document::create\-Element(), QDom\-Document::create\-Text\-Node(), KMime\-Type::icon\-For\-URL(), QString::is\-Empty(), QDom\-Node::owner\-Document(), and QDom\-Element::set\-Attribute().\index{KBookmarkGroup@{KBookmark\-Group}!moveItem@{moveItem}}
\index{moveItem@{moveItem}!KBookmarkGroup@{KBookmark\-Group}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KBookmark\-Group::move\-Item (const KBookmark \& {\em item}, const KBookmark \& {\em after})}\label{classKBookmarkGroup_a11}


Moves {\tt item} after {\tt after} (which should be a child of ours). 

If item is null, {\tt item} is moved as the first child. 

Definition at line 155 of file kbookmark.cc.

References QDom\-Node::append\-Child(), QDom\-Node::insert\-After(), QDom\-Node::insert\-Before(), and QDom\-Node::is\-Null().\index{KBookmarkGroup@{KBookmark\-Group}!deleteBookmark@{deleteBookmark}}
\index{deleteBookmark@{deleteBookmark}!KBookmarkGroup@{KBookmark\-Group}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KBookmark\-Group::delete\-Bookmark (KBookmark {\em bk})}\label{classKBookmarkGroup_a12}


Delete a bookmark - it has to be one of our children ! 



Definition at line 213 of file kbookmark.cc.\index{KBookmarkGroup@{KBookmark\-Group}!isToolbarGroup@{isToolbarGroup}}
\index{isToolbarGroup@{isToolbarGroup}!KBookmarkGroup@{KBookmark\-Group}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}bool KBookmark\-Group::is\-Toolbar\-Group () const}\label{classKBookmarkGroup_a13}


\begin{Desc}
\item[Returns:]true if this is the toolbar group \end{Desc}


Definition at line 218 of file kbookmark.cc.

Referenced by KBookmark\-Manager::save\-As().\index{KBookmarkGroup@{KBookmark\-Group}!groupUrlList@{groupUrlList}}
\index{groupUrlList@{groupUrlList}!KBookmarkGroup@{KBookmark\-Group}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QValue\-List}$<$ {\bf KURL} $>$ KBookmark\-Group::group\-Url\-List () const}\label{classKBookmarkGroup_a15}


\begin{Desc}
\item[Returns:]the list of urls of bookmarks at top level of the group \end{Desc}
\begin{Desc}
\item[Since:]3.2 \end{Desc}


Definition at line 246 of file kbookmark.cc.

References first(), and next().

The documentation for this class was generated from the following files:\begin{CompactItemize}
\item 
kbookmark.h\item 
kbookmark.cc\end{CompactItemize}
