<?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" xml:lang="en">
<head>
<title>KCharSelect</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<link rel="stylesheet" type="text/css" href="../common/doxygen.css" />
<link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../common/kde.css" />
</head>
<body>
<div id="container">
<div id="header">
<div id="header_top">
<div>
<div>
<img alt ="" src="../common/top-kde.jpg"/>
KDE 4.9 PyKDE API Reference
</div>
</div>
</div>
<div id="header_bottom">
<div id="location">
<ul>
<li>KDE's Python API</li>
</ul>
</div>
<div id="menu">
<ul>
<li><a href="../modules.html">Overview</a></li>
<li><a href="http://techbase.kde.org/Development/Languages/Python">PyKDE Home</a></li>
<li><a href="http://kde.org/family/">Sitemap</a></li>
<li><a href="http://kde.org/contact/">Contact Us</a></li>
</ul>
</div>
</div>
</div>
<div id="body_wrapper">
<div id="body">
<div id="right">
<div class="content">
<div id="main">
<div class="clearer"> </div>
<h1>KCharSelect Class Reference</h1>
<code>from PyKDE4.kdeui import *</code>
<p>
Inherits: QWidget → QObject<br />
<h2>Detailed Description</h2>
<p>Character selection widget
</p>
<p>
This widget allows the user to select a character of a
specified font and to browse Unicode information
</p>
<p>
<div align="center"><img src="../images/kcharselect.png" /><p><strong> "Character Selection Widget" </strong></p></div>
</p>
<p>
You can specify the font whose characters should be displayed via
setCurrentFont(). Using the Controls argument in the contructor
you can create a compact version of KCharSelect if there is not enough
space and if you don't need all features.
</p>
<p>
KCharSelect displays one Unicode block at a time and provides
categorized access to them. Unicode character names and further details,
including cross references, are displayed. Additionally, there is a search
to find characters.
</p>
<p>
To get the current selected character, use the currentChar()
method. You can set the character which should be displayed with
setCurrentChar().
</p>
<p>
<dl class="author" compact><dt><b>Author:</b></dt><dd> Reginald Stadlbauer <reggie@kde.org> </dd></dl>
<dl class="author" compact><dt><b>Author:</b></dt><dd> Daniel Laidig <d.laidig@gmx.de> </dd></dl>
</p>
<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#Control">Control</a> </td><td class="memItemRight" valign="bottom">{ SearchLine, FontCombo, FontSize, BlockCombos, CharacterTable, DetailBrowser, HistoryButtons, AllGuiElements }</td></tr>
<tr><td colspan="2"><br><h2>Signals</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#charSelected">charSelected</a> (QChar c)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#currentCharChanged">currentCharChanged</a> (QChar c)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#currentFontChanged">currentFontChanged</a> (QFont font)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#displayedCharsChanged">displayedCharsChanged</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KCharSelect">__init__</a> (self, QWidget parent, <a href="../kdeui/KCharSelect.html">KCharSelect.Controls</a> controls=KCharSelect.AllGuiElements)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KCharSelect">__init__</a> (self, QWidget parent, <a href="../kdeui/KActionCollection.html">KActionCollection</a> collection, <a href="../kdeui/KCharSelect.html">KCharSelect.Controls</a> controls=KCharSelect.AllGuiElements)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QChar </td><td class="memItemRight" valign="bottom"><a class="el" href="#currentChar">currentChar</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QFont </td><td class="memItemRight" valign="bottom"><a class="el" href="#currentFont">currentFont</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">[QChar] </td><td class="memItemRight" valign="bottom"><a class="el" href="#displayedChars">displayedChars</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setCurrentChar">setCurrentChar</a> (self, QChar c)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setCurrentFont">setCurrentFont</a> (self, QFont font)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QSize </td><td class="memItemRight" valign="bottom"><a class="el" href="#sizeHint">sizeHint</a> (self)</td></tr>
</table>
<hr><h2>Signal Documentation</h2><a class="anchor" name="charSelected"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> charSelected</td>
<td>(</td>
<td class="paramtype">QChar </td>
<td class="paramname"><em>c</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>A character is selected to be inserted somewhere.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>c</em> </td><td> the selected character
</td></tr>
</table></dl>
<p>
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("charSelected(const QChar&)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="currentCharChanged"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> currentCharChanged</td>
<td>(</td>
<td class="paramtype">QChar </td>
<td class="paramname"><em>c</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>The current character is changed.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>c</em> </td><td> the new character
</td></tr>
</table></dl>
<p>
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("currentCharChanged(const QChar&)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="currentFontChanged"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> currentFontChanged</td>
<td>(</td>
<td class="paramtype">QFont </td>
<td class="paramname"><em>font</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>A new font is selected or the font size changed.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>font</em> </td><td> the new font
</td></tr>
</table></dl>
<p>
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("currentFontChanged(const QFont&)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="displayedCharsChanged"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> displayedCharsChanged</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>The currently displayed characters are changed (search results or block).
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("displayedCharsChanged()"), target_slot)</code></dd></dl></div></div><hr><h2>Method Documentation</h2><a class="anchor" name="KCharSelect"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget </td>
<td class="paramname"><em>parent</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdeui/KCharSelect.html">KCharSelect.Controls</a> </td>
<td class="paramname"><em>controls=KCharSelect.AllGuiElements</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p><dl class="deprecated" compact><dt><b>Deprecated:</b></dt><dd>
</dd></dl>
</p></div></div><a class="anchor" name="KCharSelect"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget </td>
<td class="paramname"><em>parent</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdeui/KActionCollection.html">KActionCollection</a> </td>
<td class="paramname"><em>collection</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdeui/KCharSelect.html">KCharSelect.Controls</a> </td>
<td class="paramname"><em>controls=KCharSelect.AllGuiElements</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Constructor. <b>controls</b> can be used to show a custom set of widgets.
</p>
<p>
The widget uses the following actions:
- KStandardActions.find() (edit_find)
- KStandardActions.back() (go_back)
- KStandardActions.forward() (go_forward)
</p>
<p>
If you provide a KActionCollection, this will be populated with the above actions,
which you can then manually trigger or place in menus and toolbars.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>parent</em> </td><td> the parent widget for this KCharSelect (see QWidget documentation)
<tr><td></td><td valign="top"><em>collection</em> </td><td> if this is not null, KCharSelect will place its actions into this
collection
<tr><td></td><td valign="top"><em>controls</em> </td><td> selects the visible controls on the KCharSelect widget
</td></tr>
</table></dl>
<p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.2
</dd></dl>
</p></div></div><a class="anchor" name="currentChar"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QChar currentChar</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns the currently selected character.
</p></div></div><a class="anchor" name="currentFont"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QFont currentFont</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns the currently displayed font.
</p></div></div><a class="anchor" name="displayedChars"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">[QChar] displayedChars</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns a list of currently displayed characters.
</p></div></div><a class="anchor" name="setCurrentChar"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setCurrentChar</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QChar </td>
<td class="paramname"><em>c</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Highlights the character <b>c.</b> If the character is not displayed, the block is changed.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>c</em> </td><td> the character to highlight
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="setCurrentFont"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setCurrentFont</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QFont </td>
<td class="paramname"><em>font</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Sets the font which is displayed to <b>font</b>
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>font</em> </td><td> the display font for the widget
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="sizeHint"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QSize sizeHint</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Reimplemented.
</p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="Control"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">Control</td>
</tr>
</table>
</div>
<div class="memdoc"><p>Flags to set the shown widgets
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>SearchLine</em> = 0x01</td><td><tr><td valign="top"><em>FontCombo</em> = 0x02</td><td><tr><td valign="top"><em>FontSize</em> = 0x04</td><td><tr><td valign="top"><em>BlockCombos</em> = 0x08</td><td><tr><td valign="top"><em>CharacterTable</em> = 0x10</td><td><tr><td valign="top"><em>DetailBrowser</em> = 0x20</td><td><tr><td valign="top"><em>HistoryButtons</em> = 0x40</td><td><tr><td valign="top"><em>AllGuiElements</em> = 65535</td><td></table>
</dl>
</div></div><p>
</div>
</div>
</div>
<div id="left">
<div class="menu_box">
<div class="nav_list">
<ul>
<li><a href="../allclasses.html">Full Index</a></li>
</ul>
</div>
<a name="cp-menu" /><div class="menutitle"><div>
<h2 id="cp-menu-project">Modules</h2>
</div></div>
<div class="nav_list">
<ul><li><a href="../akonadi/index.html">akonadi</a></li>
<li><a href="../dnssd/index.html">dnssd</a></li>
<li><a href="../kdecore/index.html">kdecore</a></li>
<li><a href="../kdeui/index.html">kdeui</a></li>
<li><a href="../khtml/index.html">khtml</a></li>
<li><a href="../kio/index.html">kio</a></li>
<li><a href="../knewstuff/index.html">knewstuff</a></li>
<li><a href="../kparts/index.html">kparts</a></li>
<li><a href="../kutils/index.html">kutils</a></li>
<li><a href="../nepomuk/index.html">nepomuk</a></li>
<li><a href="../phonon/index.html">phonon</a></li>
<li><a href="../plasma/index.html">plasma</a></li>
<li><a href="../polkitqt/index.html">polkitqt</a></li>
<li><a href="../solid/index.html">solid</a></li>
<li><a href="../soprano/index.html">soprano</a></li>
</ul></div></div>
</div>
</div>
<div class="clearer"/>
</div>
<div id="end_body"></div>
</div>
<div id="footer"><div id="footer_text">
This documentation is maintained by <a href="mailto:simon@simonzone.com">Simon Edwards</a>.<br />
KDE<sup>®</sup> and <a href="../images/kde_gear_black.png">the K Desktop Environment<sup>®</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" 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>
</body>
</html>
