<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en_US" xml:lang="en_US">
<head>
<title>kspell2: KSpell2::Broker Class Reference (kspell2)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<meta http-equiv="pics-label" content='(pics-1.1 "http://www.icra.org/ratingsv02.html" comment "ICRAonline DE v2.0" l gen true for "http://www.kde.org" r (nz 1 vz 1 lz 1 oz 1 cb 1) "http://www.rsac.org/ratingsv01.html" l gen true for "http://www.kde.org" r (n 0 s 0 v 0 l 0))' />
<meta name="trademark" content="KDE e.V." />
<meta name="description" content="K Desktop Environment Homepage, KDE.org" />
<meta name="MSSmartTagsPreventParsing" content="true" />
<meta name="robots" content="all" />
<link rel="shortcut icon" href="../../favicon.ico" />
<link rel="stylesheet" media="screen" type="text/css" title="APIDOX" href="doxygen.css" />
</head>
<body>
<div id="nav_header_top" align="right">
<a href="#content" class="doNotDisplay" accesskey="2">Skip to main content ::</a>
<a href="../.."><img id="nav_header_logo" alt="Home" align="left" src="../../kde_gear_64.png" border="0" /></a>
<span class="doNotDisplay">::</span>
<div id="nav_header_title" align="left">KDE API Reference</div>
</div>
<div id="nav_header_bottom" align="right">
<span class="doNotDisplay">:: <a href="#navigation" accesskey="5">Skip to Link Menu</a><br/></span>
<div id="nav_header_bottom_right" style="text-align: left;">
/ <a href="../..">API Reference</a>
/ <a href=".">kspell2</a>
</div>
</div>
<table id="main" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td valign="top" class="menuheader" height="0"></td>
<td id="contentcolumn" valign="top" rowspan="2" >
<div id="content" style="padding-top: 0px;"><div style="width:100%; margin: 0px; padding: 0px;">
<a name="content"></a>
<!-- Generated by Doxygen 1.7.4 -->
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceKSpell2.html">KSpell2</a> </li>
<li class="navelem"><a class="el" href="classKSpell2_1_1Broker.html">Broker</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#signals">Signals</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#friends">Friends</a> </div>
<div class="headertitle">
<div class="title">KSpell2::Broker Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="KSpell2::Broker" --><!-- doxytag: inherits="QObject,KShared" -->
<p>Class used to deal with dictionaries.
<a href="classKSpell2_1_1Broker.html#details">More...</a></p>
<p><code>#include <<a class="el" href="broker_8h_source.html">broker.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for KSpell2::Broker:</div>
<div class="dyncontent">
<div class="center">
<img src="classKSpell2_1_1Broker.png" usemap="#KSpell2::Broker_map" alt=""/>
<map id="KSpell2::Broker_map" name="KSpell2::Broker_map">
<area href="qobject.html" alt="QObject" shape="rect" coords="0,0,99,24"/>
</map>
</div></div>
<p><a href="classKSpell2_1_1Broker-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a619e9ea1139847d4531d9206607ab0bb"></a><!-- doxytag: member="KSpell2::Broker::Ptr" ref="a619e9ea1139847d4531d9206607ab0bb" args="" -->
typedef KSharedPtr< <a class="el" href="classKSpell2_1_1Broker.html">Broker</a> > </td><td class="memItemRight" valign="bottom"><b>Ptr</b></td></tr>
<tr><td colspan="2"><h2><a name="signals"></a>
Signals</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKSpell2_1_1Broker.html#a5f33f79659ed4b1c2144396239d33b83">configurationChanged</a> ()</td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">DefaultDictionary * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKSpell2_1_1Broker.html#ac17c415520a566250827219de5e3bec9">defaultDictionary</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classKSpell2_1_1Dictionary.html">Dictionary</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKSpell2_1_1Broker.html#a3ff999f84b591cc66eae5a467dfe163f">dictionary</a> (const <a class="elRef" href="qstring.html">QString</a> &language=QString::null, const <a class="elRef" href="qstring.html">QString</a> &client=QString::null) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="qstringlist.html">QStringList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKSpell2_1_1Broker.html#a85945fb5673671d6976cdfbe62b2ba08">clients</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="qstringlist.html">QStringList</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKSpell2_1_1Broker.html#aaf6597846f8c02fdeabec9ddd9056f97">languages</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Settings * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKSpell2_1_1Broker.html#a7015479936e1e5768648034b99f37171">settings</a> () const </td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classKSpell2_1_1Broker.html">Broker</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classKSpell2_1_1Broker.html#a7e2ecb1f8b58ef7711dbb03866cf019e">openBroker</a> (KSharedConfig *config=0)</td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a898af3f80d29b5ac194a2bd44cad9afd"></a><!-- doxytag: member="KSpell2::Broker::changed" ref="a898af3f80d29b5ac194a2bd44cad9afd" args="()" -->
void </td><td class="memItemRight" valign="bottom"><b>changed</b> ()</td></tr>
<tr><td colspan="2"><h2><a name="friends"></a>
Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a720761556766a2d77ad9125743710d4c"></a><!-- doxytag: member="KSpell2::Broker::Settings" ref="a720761556766a2d77ad9125743710d4c" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>Settings</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Class used to deal with dictionaries. </p>
<p>This class manages all dictionaries. It's the top level <a class="el" href="namespaceKSpell2.html" title="Copyright 2006 Zack Rusin <zack@kde.org> KDE 3 backport Copyright 2007 Kevin Kofler <Kevin@tigcc...">KSpell2</a> class, you can think of it as the kernel or manager of the <a class="el" href="namespaceKSpell2.html" title="Copyright 2006 Zack Rusin <zack@kde.org> KDE 3 backport Copyright 2007 Kevin Kofler <Kevin@tigcc...">KSpell2</a> architecture. </p>
<p>Definition at line <a class="el" href="broker_8h_source.html#l00048">48</a> of file <a class="el" href="broker_8h_source.html">broker.h</a>.</p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a85945fb5673671d6976cdfbe62b2ba08"></a><!-- doxytag: member="KSpell2::Broker::clients" ref="a85945fb5673671d6976cdfbe62b2ba08" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="qstringlist.html">QStringList</a> KSpell2::Broker::clients </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns names of all supported clients (e.g. </p>
<p>ISpell, ASpell) </p>
<p>Definition at line <a class="el" href="broker_8cpp_source.html#l00159">159</a> of file <a class="el" href="broker_8cpp_source.html">broker.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a5f33f79659ed4b1c2144396239d33b83"></a><!-- doxytag: member="KSpell2::Broker::configurationChanged" ref="a5f33f79659ed4b1c2144396239d33b83" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KSpell2::Broker::configurationChanged </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [signal]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Signal is emitted whenever the Settings object associated with this <a class="el" href="classKSpell2_1_1Broker.html" title="Class used to deal with dictionaries.">Broker</a> changes. </p>
</div>
</div>
<a class="anchor" id="ac17c415520a566250827219de5e3bec9"></a><!-- doxytag: member="KSpell2::Broker::defaultDictionary" ref="ac17c415520a566250827219de5e3bec9" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">DefaultDictionary * KSpell2::Broker::defaultDictionary </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Function returns the so-called DefaultDictionary. </p>
<p>It's a special form a dictionary which automatically mutates according to changes tot the KSpell2::Settings object. You also can't delete it like other dictionaries since it's owned by the <a class="el" href="classKSpell2_1_1Broker.html" title="Class used to deal with dictionaries.">Broker</a> and it will take care of it. </p>
<p>Definition at line <a class="el" href="broker_8cpp_source.html#l00109">109</a> of file <a class="el" href="broker_8cpp_source.html">broker.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a3ff999f84b591cc66eae5a467dfe163f"></a><!-- doxytag: member="KSpell2::Broker::dictionary" ref="a3ff999f84b591cc66eae5a467dfe163f" args="(const QString &language=QString::null, const QString &client=QString::null) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classKSpell2_1_1Dictionary.html">Dictionary</a> * KSpell2::Broker::dictionary </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> & </td>
<td class="paramname"><em>language</em> = <code>QString::null</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> & </td>
<td class="paramname"><em>client</em> = <code>QString::null</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns dictionary for the given language and preferred client. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">language</td><td>specifies the language of the dictionary. If an empty string will be passed the default language will be used. Has to be one of the values returned by <a class="el" href="classKSpell2_1_1Broker.html#aaf6597846f8c02fdeabec9ddd9056f97">languages()</a> </td></tr>
<tr><td class="paramname">client</td><td>specifies the preferred client. If no client is specified a client which supports the given language is picked. If a few clients supports the same language the one with the biggest reliability value is returned. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="broker_8cpp_source.html#l00114">114</a> of file <a class="el" href="broker_8cpp_source.html">broker.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aaf6597846f8c02fdeabec9ddd9056f97"></a><!-- doxytag: member="KSpell2::Broker::languages" ref="aaf6597846f8c02fdeabec9ddd9056f97" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="qstringlist.html">QStringList</a> KSpell2::Broker::languages </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a list of supported languages. </p>
<p>Definition at line <a class="el" href="broker_8cpp_source.html#l00164">164</a> of file <a class="el" href="broker_8cpp_source.html">broker.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a7e2ecb1f8b58ef7711dbb03866cf019e"></a><!-- doxytag: member="KSpell2::Broker::openBroker" ref="a7e2ecb1f8b58ef7711dbb03866cf019e" args="(KSharedConfig *config=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classKSpell2_1_1Broker.html">Broker</a> * KSpell2::Broker::openBroker </td>
<td>(</td>
<td class="paramtype">KSharedConfig * </td>
<td class="paramname"><em>config</em> = <code>0</code></td><td>)</td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructs the broker. </p>
<p>It's very important that you assign it to Broker::Ptr as soon as possible. <a class="el" href="classKSpell2_1_1Broker.html" title="Class used to deal with dictionaries.">Broker</a> is reference counted so if you don't want to have it deleted under you simply have to hold it in a Broker::Ptr for as long as you're using it.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">config</td><td>is the name of config file which broker should use to read default language and default client values. If no value will be passed <a class="el" href="classKSpell2_1_1Broker.html" title="Class used to deal with dictionaries.">Broker</a> will use global kspellrc file. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="broker_8cpp_source.html#l00059">59</a> of file <a class="el" href="broker_8cpp_source.html">broker.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a7015479936e1e5768648034b99f37171"></a><!-- doxytag: member="KSpell2::Broker::settings" ref="a7015479936e1e5768648034b99f37171" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Settings * KSpell2::Broker::settings </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the Settings object used by the broker. </p>
<p>Definition at line <a class="el" href="broker_8cpp_source.html#l00169">169</a> of file <a class="el" href="broker_8cpp_source.html">broker.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="broker_8h_source.html">broker.h</a></li>
<li><a class="el" href="broker_8cpp_source.html">broker.cpp</a></li>
</ul>
</div>
</div></div>
</td>
</tr>
<tr>
<td valign="top" id="leftmenu" width="25%">
<a name="navigation"></a>
<div class="menu_box"><h2>kspell2</h2>
<div class="nav_list">
<ul><li><a href="index.html">Main Page</a></li><li><a href="namespaces.html">Namespace List</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="files.html">File List</a></li><li><a href="functions.html">Class Members</a></li></ul>
<!--
<h2>Class Picker</h2>
<div style="text-align: center;">
<form name="guideform">
<select name="guidelinks" style="width:100%;" onChange="window.location=document.guideform.guidelinks.options[document.guideform.guidelinks.selectedIndex].value">
<option value="annotated.html">-- Choose --</option>
<option value="classASpellDict.html">aspelldict</option>, <option value="classHSpellDict.html">hspelldict</option>, <option value="classKSpell2_1_1BackgroundChecker.html">kspell2::backgroundchecker</option>, <option value="classKSpell2_1_1Broker.html">kspell2::broker</option>, <option value="classKSpell2_1_1Client.html">kspell2::client</option>, <option value="classKSpell2_1_1Dictionary.html">kspell2::dictionary</option>, <option value="classKSpell2_1_1Filter.html">kspell2::filter</option>,
</select>
</form>
</div>
-->
</div></div>
<div class="menu_box"><h2>API Dox</h2>
<div class="nav_list">
<ul>
<li><a href="../../arts/html/index.html">arts</a></li><li><a href="../../dcop/html/index.html">dcop</a></li><li><a href="../../dnssd/html/index.html">dnssd</a></li><li><a href="../../interfaces/html/index.html">interfaces</a></li><li> <a href="../../interfaces/kimproxy/interface/html/index.html">interface</a></li><li> <a href="../../interfaces/kimproxy/library/html/index.html">library</a></li><li> <a href="../../interfaces/kspeech/html/index.html">kspeech</a></li><li> <a href="../../interfaces/ktexteditor/html/index.html">ktexteditor</a></li><li><a href="../../kabc/html/index.html">kabc</a></li><li><a href="../../kate/html/index.html">kate</a></li><li><a href="../../kcmshell/html/index.html">kcmshell</a></li><li><a href="../../kdecore/html/index.html">kdecore</a></li><li><a href="../../kded/html/index.html">kded</a></li><li><a href="../../kdefx/html/index.html">kdefx</a></li><li><a href="../../kdeprint/html/index.html">kdeprint</a></li><li><a href="../../kdesu/html/index.html">kdesu</a></li><li><a href="../../kdeui/html/index.html">kdeui</a></li><li><a href="../../kdoctools/html/index.html">kdoctools</a></li><li><a href="../../khtml/html/index.html">khtml</a></li><li><a href="../../kimgio/html/index.html">kimgio</a></li><li><a href="../../kinit/html/index.html">kinit</a></li><li><a href="../../kio/html/index.html">kio</a></li><li> <a href="../../kio/bookmarks/html/index.html">bookmarks</a></li><li> <a href="../../kio/httpfilter/html/index.html">httpfilter</a></li><li> <a href="../../kio/kfile/html/index.html">kfile</a></li><li> <a href="../../kio/kio/html/index.html">kio</a></li><li> <a href="../../kio/kioexec/html/index.html">kioexec</a></li><li> <a href="../../kio/kpasswdserver/html/index.html">kpasswdserver</a></li><li> <a href="../../kio/kssl/html/index.html">kssl</a></li><li><a href="../../kioslave/html/index.html">kioslave</a></li><li> <a href="../../kioslave/http/html/index.html">http</a></li><li><a href="../../kjs/html/index.html">kjs</a></li><li><a href="../../kmdi/html/index.html">kmdi</a></li><li> <a href="../../kmdi/kmdi/html/index.html">kmdi</a></li><li><a href="../../knewstuff/html/index.html">knewstuff</a></li><li><a href="../../kparts/html/index.html">kparts</a></li><li><a href="../../kresources/html/index.html">kresources</a></li><li><a href="../../kspell2/html/index.html">kspell2</a></li><li><a href="../../kunittest/html/index.html">kunittest</a></li><li><a href="../../kutils/html/index.html">kutils</a></li><li><a href="../../kwallet/html/index.html">kwallet</a></li><li><a href="../../libkmid/html/index.html">libkmid</a></li><li><a href="../../libkscreensaver/html/index.html">libkscreensaver</a></li>
</ul></div></div>
</td>
</tr>
</table>
<span class="doNotDisplay">
<a href="http://www.kde.org/" accesskey="8">KDE Home</a> |
<a href="http://accessibility.kde.org/" accesskey="9">KDE Accessibility Home</a> |
<a href="http://www.kde.org/media/accesskeys.php" accesskey="0">Description of Access Keys</a>
</span>
<div style="height: 8px"></div>
<div id="footer">
<div id="footer_left">
Maintained by <a href="mailto:groot@kde.org">Adriaan de Groot</a>
and
<a href="mailto:winter@kde.org">Allen Winter</a>.
<br/>
KDE and K Desktop Environment are trademarks of <a href="http://www.kde.org/areas/kde-ev/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
</div>
<div id="footer_right"><img src="/media/images/footer_right.png" style="margin: 0px" alt="" /></div>
</div>
<!--
WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL
BE BLOCKED INSTANTLY AND PERMANENTLY!
<a href="mailto:aaaatrap-425acc3b5374943f@kde.org">Block me</a>
WARNING END
-->
</body>
</html>
