<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=utf-8">
<title>libkonq Library: FaviconsModule Class Reference (libkonq Library)</title>
<link href="../../common/doxygen.css" rel="stylesheet" type="text/css">
</head>
<div class="header">
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td rowspan="2" width="92">
<a href="../../index.html" title="The API documentation main page"><img src="../../common/docheadergears.png" style="border:0px;" alt=""></a>
</td>
<td width="95%">
<h1>libkonq Library API Documentation</h1>
</td>
</tr>
<tr>
<td valign="bottom">
<table class="links" border=0 cellspacing=0>
<tr>
<td><a href="index.html">Overview</a></td>
<td><a href="hierarchy.html" title="Inheritance list, sorted roughly alphabetically">Class Hierarchy</a></td>
<td><a href="classes.html" title="Alphabetical list of classes">Classes</a></td>
<td><a href="annotated.html" title="Classes, structs, unions and interfaces with brief descriptions">Classes (annotated)</a></td>
<td><a href="functions.html" title="Documented class members with links to the classes they belong to">Members</a></td>
<td><a href="namespaces.html" title="All documented namespaces with brief descriptions">Namespaces</a></td>
<td><a href="files.html" title="A list of all documented files with brief descriptions">Source Files</a></td>
</tr>
</table>
</td></tr></table>
</div>
<div id="hgrad"></div>
<div class="text">
<!-- Generated by Doxygen 1.4.4 -->
<h1>FaviconsModule Class Reference</h1><!-- doxytag: class="FaviconsModule" --><!-- doxytag: inherits="KDEDModule" -->KDED Module to handle shortcut icons ("favicons") FaviconsModule implements a KDED Module that handles the association of URLs and hosts with shortcut icons and the icons' downloads in a central place.KDED Module for favicons.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="favicons_8h-source.html">favicons.h</a>></code>
<p>
<a href="classFaviconsModule-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>DCOP Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classFaviconsModule.html#z0">iconForURL</a> (const KURL &url)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">ASYNC </td><td class="memItemRight" valign="bottom"><a class="el" href="classFaviconsModule.html#z1">setIconForURL</a> (const KURL &url, const KURL &iconURL)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">ASYNC </td><td class="memItemRight" valign="bottom"><a class="el" href="classFaviconsModule.html#z2">downloadHostIcon</a> (const KURL &url)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="z3"></a><!-- doxytag: member="FaviconsModule::infoMessage" ref="z3" args="(KURL iconURL, QString msg)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classFaviconsModule.html#z3">infoMessage</a> (KURL iconURL, QString msg)</td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a0"></a><!-- doxytag: member="FaviconsModule::FaviconsModule" ref="a0" args="(const QCString &obj)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classFaviconsModule.html#a0">FaviconsModule</a> (const QCString &obj)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1"></a><!-- doxytag: member="FaviconsModule::~FaviconsModule" ref="a1" args="()" -->
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classFaviconsModule.html#a1">~FaviconsModule</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o0"></a><!-- doxytag: member="FaviconsModule::__pad0__" ref="o0" args="" -->
k_dcop_signals </td><td class="memItemRight" valign="bottom"><a class="el" href="classFaviconsModule.html#o0">__pad0__</a>: void iconChanged(bool isHost</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o1"></a><!-- doxytag: member="FaviconsModule::hostOrURL" ref="o1" args="" -->
k_dcop_signals QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classFaviconsModule.html#o1">hostOrURL</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="o2"></a><!-- doxytag: member="FaviconsModule::iconName" ref="o2" args="" -->
k_dcop_signals QString QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classFaviconsModule.html#o2">iconName</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
KDED Module to handle shortcut icons ("favicons") FaviconsModule implements a KDED Module that handles the association of URLs and hosts with shortcut icons and the icons' downloads in a central place.KDED Module for favicons.
<p>
After a successful download, the DCOP signal iconChanged() is emitted. It has the signature void iconChanged(bool, QString, QString); The first parameter is true if the icon is a "host" icon, that is it is the default icon for all URLs on the given host. In this case, the second parameter is a host name, otherwise the second parameter is the URL which is associated with the icon. The third parameter is the KIconLoader friendly name of the downloaded icon, the same as <a class="el" href="classFaviconsModule.html#z0">iconForURL</a> will from now on return for any matching URL.<p>
<dl compact><dt><b>Author:</b></dt><dd>Malte Starostik <<a href="mailto:malte@kde.org">malte@kde.org</a>></dd></dl>
<p>
<p>
Definition at line <a class="el" href="favicons_8h-source.html#l00045">45</a> of file <a class="el" href="favicons_8h-source.html">favicons.h</a>.<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z0"></a><!-- doxytag: member="FaviconsModule::iconForURL" ref="z0" args="(const KURL &url)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">QString FaviconsModule::iconForURL </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const KURL & </td>
<td class="mdname1" valign="top" nowrap> <em>url</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Looks up an icon name for a given URL.
<p>
This function does not initiate any download. If no icon for the URL or its host has been downloaded yet, QString::null is returned.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>url</em> </td><td>the URL for which the icon is queried </td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>the icon name suitable to pass to KIconLoader or QString::null if no icon for this URL was found.</dd></dl>
<p>
Definition at line <a class="el" href="favicons_8cpp-source.html#l00092">92</a> of file <a class="el" href="favicons_8cpp-source.html">favicons.cpp</a>. </td>
</tr>
</table>
<a class="anchor" name="z1"></a><!-- doxytag: member="FaviconsModule::setIconForURL" ref="z1" args="(const KURL &url, const KURL &iconURL)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void FaviconsModule::setIconForURL </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const KURL & </td>
<td class="mdname" nowrap> <em>url</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const KURL & </td>
<td class="mdname" nowrap> <em>iconURL</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Assiciates an icon with the given URL.
<p>
If the icon was not downloaded before or the downloaded was too long ago, a download attempt will be started and the iconChanged() DCOP signal is emitted after the download finished successfully.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>url</em> </td><td>the URL which will be associated with the icon </td></tr>
<tr><td valign="top"></td><td valign="top"><em>iconURL</em> </td><td>the URL of the icon to be downloaded</td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="favicons_8cpp-source.html#l00156">156</a> of file <a class="el" href="favicons_8cpp-source.html">favicons.cpp</a>. </td>
</tr>
</table>
<a class="anchor" name="z2"></a><!-- doxytag: member="FaviconsModule::downloadHostIcon" ref="z2" args="(const KURL &url)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void FaviconsModule::downloadHostIcon </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">const KURL & </td>
<td class="mdname1" valign="top" nowrap> <em>url</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Downloads the icon for a given host if it was not downloaded before or the download was too long ago.
<p>
If the download finishes successfully, the iconChanged() DCOP signal is emitted.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>url</em> </td><td>any URL on the host for which the icon is to be downloaded</td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="favicons_8cpp-source.html#l00173">173</a> of file <a class="el" href="favicons_8cpp-source.html">favicons.cpp</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="favicons_8h-source.html">favicons.h</a><li><a class="el" href="favicons_8cpp-source.html">favicons.cpp</a><li><a class="el" href="favicons__skel_8cpp-source.html">favicons_skel.cpp</a></ul>
</div>
<div id="bottom-nav">
<img src="../../common/bottom2.png" align="right" height="59" width="227" alt="KDE Logo">
</div>
<div class="bottom">
This file is part of the documentation for libkonq Library Version 3.4.2.
</div>
<div class="bottom" style="color:#cccccc">
Documentation copyright © 1996-2004 the KDE developers.<br>
Generated on Wed Jun 14 19:05:22 2006 by
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.4.4 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, © 1997-2003
</div>
</body>
</html>
