Sophie

Sophie

distrib > Fedora > 15 > i386 > by-pkgid > 1f9eb832ba1e4b88d9a5c2b384813bb4 > files > 3651

kdelibs3-apidocs-3.5.10-31.fc15.noarch.rpm

<?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>kdeui: KWordWrap Class Reference (kdeui)</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=".">kdeui</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>
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">KWordWrap Class Reference</div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="KWordWrap" -->
<p>Word-wrap algorithm that takes into account beautifulness ;)  
 <a href="classKWordWrap.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="kwordwrap_8h_source.html">kwordwrap.h</a>&gt;</code></p>

<p><a href="classKWordWrap-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">enum &#160;</td><td class="memItemRight" valign="bottom">{ <b>FadeOut</b> =  0x10000000, 
<b>Truncate</b> =  0x20000000
 }</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"><a class="elRef" href="qrect.html">QRect</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKWordWrap.html#a1a15cfeb8772853f669fcc8068d54a77">boundingRect</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="qstring.html">QString</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKWordWrap.html#a8ca308255f684edb5dc6e5aeafff406c">wrappedString</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="qstring.html">QString</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKWordWrap.html#a11ffdb6dcd3a1f3deecf33ca2ae3cfbf">truncatedString</a> (bool dots=true) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKWordWrap.html#aabac2f21fdefc8fa92b64ee5084d46e6">drawText</a> (<a class="elRef" href="qpainter.html">QPainter</a> *painter, int x, int y, int flags=Qt::AlignAuto) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKWordWrap.html#adc08e0fa511d7dcae80773d7c8b7a963">~KWordWrap</a> ()</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="classKWordWrap.html">KWordWrap</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKWordWrap.html#a744b920bb2de57381e43b6d3bdb78775">formatText</a> (<a class="elRef" href="qfontmetrics.html">QFontMetrics</a> &amp;fm, const <a class="elRef" href="qrect.html">QRect</a> &amp;r, int flags, const <a class="elRef" href="qstring.html">QString</a> &amp;str, int len=-1)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKWordWrap.html#abea9353f19669dcf2cda3b51e136532e">drawFadeoutText</a> (<a class="elRef" href="qpainter.html">QPainter</a> *p, int x, int y, int maxW, const <a class="elRef" href="qstring.html">QString</a> &amp;t)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKWordWrap.html#ad4ee3f73fd77f5d298881c1351694788">drawTruncateText</a> (<a class="elRef" href="qpainter.html">QPainter</a> *p, int x, int y, int maxW, const <a class="elRef" href="qstring.html">QString</a> &amp;t)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Word-wrap algorithm that takes into account beautifulness ;) </p>
<p>That means: </p>
<ul>
<li>not letting a letter alone on the last line, </li>
<li>breaking at punctuation signs (not only at spaces) </li>
<li>improved handling of (), [] and {} </li>
<li>improved handling of '/' (e.g. for paths)</li>
</ul>
<p>Usage: call the static method, formatText, with the text to wrap and the constraining rectangle etc., it will return an instance of <a class="el" href="classKWordWrap.html" title="Word-wrap algorithm that takes into account beautifulness ;)">KWordWrap</a> containing internal data, result of the word-wrapping. From that instance you can retrieve the boundingRect, and invoke drawing.</p>
<p>This design allows to call the word-wrap algorithm only when the text changes and not every time we want to know the bounding rect or draw the text.</p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Faure &lt;<a href="mailto:faure@kde.org">faure@kde.org</a>&gt; </dd></dl>

<p>Definition at line <a class="el" href="kwordwrap_8h_source.html#l00048">48</a> of file <a class="el" href="kwordwrap_8h_source.html">kwordwrap.h</a>.</p>
</div><hr/><h2>Member Enumeration Documentation</h2>
<a class="anchor" id="ac1740639918fd3dd1ce215c5f8cb82a5"></a><!-- doxytag: member="KWordWrap::@6" ref="ac1740639918fd3dd1ce215c5f8cb82a5" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">anonymous enum</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Use this flag in <a class="el" href="classKWordWrap.html#aabac2f21fdefc8fa92b64ee5084d46e6" title="Draw the text that has been previously wrapped, at position x,y.">drawText()</a> if you want to fade out the text if it does not fit into the constraining rectangle. </p>
<dl class="since"><dt><b>Since:</b></dt><dd>3.2 </dd></dl>

<p>Definition at line <a class="el" href="kwordwrap_8h_source.html#l00056">56</a> of file <a class="el" href="kwordwrap_8h_source.html">kwordwrap.h</a>.</p>

</div>
</div>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="adc08e0fa511d7dcae80773d7c8b7a963"></a><!-- doxytag: member="KWordWrap::~KWordWrap" ref="adc08e0fa511d7dcae80773d7c8b7a963" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">KWordWrap::~KWordWrap </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Destructor. </p>

<p>Definition at line <a class="el" href="kwordwrap_8cpp_source.html#l00144">144</a> of file <a class="el" href="kwordwrap_8cpp_source.html">kwordwrap.cpp</a>.</p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a1a15cfeb8772853f669fcc8068d54a77"></a><!-- doxytag: member="KWordWrap::boundingRect" ref="a1a15cfeb8772853f669fcc8068d54a77" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="elRef" href="qrect.html">QRect</a> KWordWrap::boundingRect </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>the bounding rect, calculated by formatText. The width is the width of the widest text line, and never wider than the rectangle given to formatText. The height is the text block. X and Y are always 0. </dd></dl>

<p>Definition at line <a class="el" href="kwordwrap_8h_source.html#l00077">77</a> of file <a class="el" href="kwordwrap_8h_source.html">kwordwrap.h</a>.</p>

</div>
</div>
<a class="anchor" id="abea9353f19669dcf2cda3b51e136532e"></a><!-- doxytag: member="KWordWrap::drawFadeoutText" ref="abea9353f19669dcf2cda3b51e136532e" args="(QPainter *p, int x, int y, int maxW, const QString &amp;t)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void KWordWrap::drawFadeoutText </td>
          <td>(</td>
          <td class="paramtype"><a class="elRef" href="qpainter.html">QPainter</a> *&#160;</td>
          <td class="paramname"><em>p</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>y</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>maxW</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> &amp;&#160;</td>
          <td class="paramname"><em>t</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Draws the string <code>t</code> at the given coordinates, if it does not <code>fit</code> into <code>maxW</code> the text will be faded out. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">p</td><td>the painter to use. Must have set the pen for the text color and the background for the color to fade out </td></tr>
    <tr><td class="paramname">x</td><td>the horizontal position of the text </td></tr>
    <tr><td class="paramname">y</td><td>the vertical position of the text </td></tr>
    <tr><td class="paramname">maxW</td><td>the maximum width of the text (including the fade-out effect) </td></tr>
    <tr><td class="paramname">t</td><td>the text to draw </td></tr>
  </table>
  </dd>
</dl>
<dl class="since"><dt><b>Since:</b></dt><dd>3.2 </dd></dl>

<p>Definition at line <a class="el" href="kwordwrap_8cpp_source.html#l00181">181</a> of file <a class="el" href="kwordwrap_8cpp_source.html">kwordwrap.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="aabac2f21fdefc8fa92b64ee5084d46e6"></a><!-- doxytag: member="KWordWrap::drawText" ref="aabac2f21fdefc8fa92b64ee5084d46e6" args="(QPainter *painter, int x, int y, int flags=Qt::AlignAuto) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void KWordWrap::drawText </td>
          <td>(</td>
          <td class="paramtype"><a class="elRef" href="qpainter.html">QPainter</a> *&#160;</td>
          <td class="paramname"><em>painter</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>y</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>flags</em> = <code>Qt::AlignAuto</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Draw the text that has been previously wrapped, at position x,y. </p>
<p>Flags are for alignment, e.g. Qt::AlignHCenter. Default is Qt::AlignAuto. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">painter</td><td>the <a class="elRef" href="qpainter.html">QPainter</a> to use. </td></tr>
    <tr><td class="paramname">x</td><td>the horizontal position of the text </td></tr>
    <tr><td class="paramname">y</td><td>the vertical position of the text </td></tr>
    <tr><td class="paramname">flags</td><td>the ORed text alignment flags from the <a class="elRef" href="qt.html">Qt</a> namespace, ORed with FadeOut if you want the text to fade out if it does not fit (the <code>painter's</code> background must be set accordingly) </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="kwordwrap_8cpp_source.html#l00219">219</a> of file <a class="el" href="kwordwrap_8cpp_source.html">kwordwrap.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="ad4ee3f73fd77f5d298881c1351694788"></a><!-- doxytag: member="KWordWrap::drawTruncateText" ref="ad4ee3f73fd77f5d298881c1351694788" args="(QPainter *p, int x, int y, int maxW, const QString &amp;t)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void KWordWrap::drawTruncateText </td>
          <td>(</td>
          <td class="paramtype"><a class="elRef" href="qpainter.html">QPainter</a> *&#160;</td>
          <td class="paramname"><em>p</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>y</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>maxW</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> &amp;&#160;</td>
          <td class="paramname"><em>t</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Draws the string <code>t</code> at the given coordinates, if it does not <code>fit</code> into <code>maxW</code> the text will be truncated. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">p</td><td>the painter to use </td></tr>
    <tr><td class="paramname">x</td><td>the horizontal position of the text </td></tr>
    <tr><td class="paramname">y</td><td>the vertical position of the text </td></tr>
    <tr><td class="paramname">maxW</td><td>the maximum width of the text (including the '...') </td></tr>
    <tr><td class="paramname">t</td><td>the text to draw </td></tr>
  </table>
  </dd>
</dl>
<dl class="since"><dt><b>Since:</b></dt><dd>3.3 </dd></dl>

<p>Definition at line <a class="el" href="kwordwrap_8cpp_source.html#l00213">213</a> of file <a class="el" href="kwordwrap_8cpp_source.html">kwordwrap.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a744b920bb2de57381e43b6d3bdb78775"></a><!-- doxytag: member="KWordWrap::formatText" ref="a744b920bb2de57381e43b6d3bdb78775" args="(QFontMetrics &amp;fm, const QRect &amp;r, int flags, const QString &amp;str, int len=&#45;1)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classKWordWrap.html">KWordWrap</a> * KWordWrap::formatText </td>
          <td>(</td>
          <td class="paramtype"><a class="elRef" href="qfontmetrics.html">QFontMetrics</a> &amp;&#160;</td>
          <td class="paramname"><em>fm</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="elRef" href="qrect.html">QRect</a> &amp;&#160;</td>
          <td class="paramname"><em>r</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>flags</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> &amp;&#160;</td>
          <td class="paramname"><em>str</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>len</em> = <code>-1</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Main method for wrapping text. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">fm</td><td>Font metrics, for the chosen font. Better cache it, creating a <a class="elRef" href="qfontmetrics.html">QFontMetrics</a> is expensive. </td></tr>
    <tr><td class="paramname">r</td><td>Constraining rectangle. Only the width and height matter. With negative height the complete text will be rendered </td></tr>
    <tr><td class="paramname">flags</td><td>currently unused </td></tr>
    <tr><td class="paramname">str</td><td>The text to be wrapped. </td></tr>
    <tr><td class="paramname">len</td><td>Length of text to wrap (default is -1 for all). </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>a <a class="el" href="classKWordWrap.html" title="Word-wrap algorithm that takes into account beautifulness ;)">KWordWrap</a> instance. The caller is responsible for storing and deleting the result. </dd></dl>

<p>Definition at line <a class="el" href="kwordwrap_8cpp_source.html#l00034">34</a> of file <a class="el" href="kwordwrap_8cpp_source.html">kwordwrap.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a11ffdb6dcd3a1f3deecf33ca2ae3cfbf"></a><!-- doxytag: member="KWordWrap::truncatedString" ref="a11ffdb6dcd3a1f3deecf33ca2ae3cfbf" args="(bool dots=true) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="elRef" href="qstring.html">QString</a> KWordWrap::truncatedString </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>dots</em> = <code>true</code></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>the original string, truncated to the first line. If <code>dots</code> was set, '...' is appended in case the string was truncated. Bug: Note that the '...' come out of the bounding rect. </dd></dl>

<p>Definition at line <a class="el" href="kwordwrap_8cpp_source.html#l00164">164</a> of file <a class="el" href="kwordwrap_8cpp_source.html">kwordwrap.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a8ca308255f684edb5dc6e5aeafff406c"></a><!-- doxytag: member="KWordWrap::wrappedString" ref="a8ca308255f684edb5dc6e5aeafff406c" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="elRef" href="qstring.html">QString</a> KWordWrap::wrappedString </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>the original string, with '<br/>
' inserted where the text is broken by the wordwrap algorithm. </dd></dl>

<p>Definition at line <a class="el" href="kwordwrap_8cpp_source.html#l00148">148</a> of file <a class="el" href="kwordwrap_8cpp_source.html">kwordwrap.cpp</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="kwordwrap_8h_source.html">kwordwrap.h</a></li>
<li><a class="el" href="kwordwrap_8cpp_source.html">kwordwrap.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>kdeui</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="namespacemembers.html">Namespace Members</a></li><li><a href="functions.html">Class Members</a></li><li><a href="pages.html">Related Pages</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="classKAboutApplication.html">kaboutapplication</option>,  <option value="classKAboutContainer.html">kaboutcontainer</option>,  <option value="classKAboutContainerBase.html">kaboutcontainerbase</option>,  <option value="classKAboutContributor.html">kaboutcontributor</option>,  <option value="classKAboutDialog.html">kaboutdialog</option>,  <option value="classKAboutKDE.html">kaboutkde</option>,  <option value="classKAboutWidget.html">kaboutwidget</option>,  <option value="classKAccelGen_1_1Deref.html">kaccelgen::deref</option>,  <option value="classKAccelGen_1_1Deref__Key.html">kaccelgen::deref__key</option>,  <option value="classKAction.html">kaction</option>,  <option value="classKActionCollection.html">kactioncollection</option>,  <option value="classKActionMenu.html">kactionmenu</option>,  <option value="classKActionSelector.html">kactionselector</option>,  <option value="classKActiveLabel.html">kactivelabel</option>,  <option value="classKAnimWidget.html">kanimwidget</option>,  <option value="classKArrowButton.html">karrowbutton</option>,  <option value="classKAuthIcon.html">kauthicon</option>,  <option value="classKBugReport.html">kbugreport</option>,  <option value="classKButtonBox.html">kbuttonbox</option>,  <option value="classKCharSelect.html">kcharselect</option>,  <option value="classKCharSelectTable.html">kcharselecttable</option>,  <option value="classKCModule.html">kcmodule</option>,  <option value="classKColor.html">kcolor</option>,  <option value="classKColorButton.html">kcolorbutton</option>,  <option value="classKColorCells.html">kcolorcells</option>,  <option value="classKColorCombo.html">kcolorcombo</option>,  <option value="classKColorDialog.html">kcolordialog</option>,  <option value="classKColorDrag.html">kcolordrag</option>,  <option value="classKColorPatch.html">kcolorpatch</option>,  <option value="classKComboBox.html">kcombobox</option>,  <option value="classKCommand.html">kcommand</option>,  <option value="classKCommandHistory.html">kcommandhistory</option>,  <option value="classKCompletionBox.html">kcompletionbox</option>,  <option value="classKConfigDialog.html">kconfigdialog</option>,  <option value="classKContextMenuManager.html">kcontextmenumanager</option>,  <option value="classKCursor.html">kcursor</option>,  <option value="classKCursorPrivate.html">kcursorprivate</option>,  <option value="classKCursorPrivateAutoHideEventFilter.html">kcursorprivateautohideeventfilter</option>,  <option value="classKDateInternalMonthPicker.html">kdateinternalmonthpicker</option>,  <option value="classKDateInternalWeekSelector.html">kdateinternalweekselector</option>,  <option value="classKDateInternalYearSelector.html">kdateinternalyearselector</option>,  <option value="classKDatePicker.html">kdatepicker</option>,  <option value="classKDateTable.html">kdatetable</option>,  <option value="classKDateTimeWidget.html">kdatetimewidget</option>,  <option value="classKDateValidator.html">kdatevalidator</option>,  <option value="classKDateWidget.html">kdatewidget</option>,  <option value="classKDCOPActionProxy.html">kdcopactionproxy</option>,  <option value="classKDEPrivate_1_1ToolBarHandler.html">kdeprivate::toolbarhandler</option>,  <option value="classKDialog.html">kdialog</option>,  <option value="classKDialogBase.html">kdialogbase</option>,  <option value="classKDialogBaseButton.html">kdialogbasebutton</option>,  <option value="classKDialogBaseTile.html">kdialogbasetile</option>,  <option value="classKDictSpellingHighlighter.html">kdictspellinghighlighter</option>,  <option value="classKDockButton__Private.html">kdockbutton__private</option>,  <option value="classKDockMainWindow.html">kdockmainwindow</option>,  <option value="classKDockManager.html">kdockmanager</option>,  <option value="classKDockSplitter.html">kdocksplitter</option>,  <option value="classKDockTabGroup.html">kdocktabgroup</option>,  <option value="classKDockWidget.html">kdockwidget</option>,  <option value="classKDockWidgetAbstractHeader.html">kdockwidgetabstractheader</option>,  <option value="classKDockWidgetAbstractHeaderDrag.html">kdockwidgetabstractheaderdrag</option>,  <option value="classKDockWidgetHeader.html">kdockwidgetheader</option>,  <option value="classKDockWidgetHeaderDrag.html">kdockwidgetheaderdrag</option>,  <option value="classKDockWidgetPrivate.html">kdockwidgetprivate</option>,  <option value="classKDockWindow.html">kdockwindow</option>,  <option value="classKDoubleNumInput.html">kdoublenuminput</option>,  <option value="classKDoubleSpinBox.html">kdoublespinbox</option>,  <option value="classKDoubleValidator.html">kdoublevalidator</option>,  <option value="classKDualColorButton.html">kdualcolorbutton</option>,  <option value="classKEdit.html">kedit</option>,  <option value="classKEditListBox.html">keditlistbox</option>,  <option value="classKEditListBox_1_1CustomEditor.html">keditlistbox::customeditor</option>,  <option value="classKEditToolbar.html">kedittoolbar</option>,  <option value="classKEditToolbarWidget.html">kedittoolbarwidget</option>,  <option value="classKFloatValidator.html">kfloatvalidator</option>,  <option value="classKFontChooser.html">kfontchooser</option>,  <option value="classKFontCombo.html">kfontcombo</option>,  <option value="classKFontDialog.html">kfontdialog</option>,  <option value="classKFontRequester.html">kfontrequester</option>,  <option value="classKGradientSelector.html">kgradientselector</option>,  <option value="classKGuiItem.html">kguiitem</option>,  <option value="classKHelpMenu.html">khelpmenu</option>,  <option value="classKHistoryCombo.html">khistorycombo</option>,  <option value="classKHSSelector.html">khsselector</option>,  <option value="classKIconView.html">kiconview</option>,  <option value="classKIconViewItem.html">kiconviewitem</option>,  <option value="classKIconViewSearchLine.html">kiconviewsearchline</option>,  <option value="classKImageTrackLabel.html">kimagetracklabel</option>,  <option value="classKInputDialog.html">kinputdialog</option>,  <option value="classKIntNumInput.html">kintnuminput</option>,  <option value="classKIntSpinBox.html">kintspinbox</option>,  <option value="classKIntValidator.html">kintvalidator</option>,  <option value="classKJanusWidget.html">kjanuswidget</option>,  <option value="classKKeyButton.html">kkeybutton</option>,  <option value="classKKeyChooser.html">kkeychooser</option>,  <option value="classKKeyDialog.html">kkeydialog</option>,  <option value="classKLanguageButton.html">klanguagebutton</option>,  <option value="classKLed.html">kled</option>,  <option value="classKLineEdit.html">klineedit</option>,  <option value="classKLineEditDlg.html">klineeditdlg</option>,  <option value="classKListAction.html">klistaction</option>,  <option value="classKListBox.html">klistbox</option>,  <option value="classKListView.html">klistview</option>,  <option value="classKListViewItem.html">klistviewitem</option>,  <option value="classKListViewLineEdit.html">klistviewlineedit</option>,  <option value="classKListViewSearchLine.html">klistviewsearchline</option>,  <option value="classKListViewSearchLineWidget.html">klistviewsearchlinewidget</option>,  <option value="classKMacroCommand.html">kmacrocommand</option>,  <option value="classKMainWindow.html">kmainwindow</option>,  <option value="classKMainWindowInterface.html">kmainwindowinterface</option>,  <option value="classKMenuBar.html">kmenubar</option>,  <option value="classKMessageBox.html">kmessagebox</option>,  <option value="classKMimeTypeValidator.html">kmimetypevalidator</option>,  <option value="classKNamedCommand.html">knamedcommand</option>,  <option value="classKNumInput.html">knuminput</option>,  <option value="classKPaletteTable.html">kpalettetable</option>,  <option value="classKPanelApplet.html">kpanelapplet</option>,  <option value="classKPanelAppMenu.html">kpanelappmenu</option>,  <option value="classKPanelExtension.html">kpanelextension</option>,  <option value="classKPanelMenu.html">kpanelmenu</option>,  <option value="classKPassivePopup.html">kpassivepopup</option>,  <option value="classKPasswordDialog.html">kpassworddialog</option>,  <option value="classKPasswordEdit.html">kpasswordedit</option>,  <option value="classKPasteTextAction.html">kpastetextaction</option>,  <option value="classKPixmapIO.html">kpixmapio</option>,  <option value="classKPixmapRegionSelectorDialog.html">kpixmapregionselectordialog</option>,  <option value="classKPixmapRegionSelectorWidget.html">kpixmapregionselectorwidget</option>,  <option value="classKPopupFrame.html">kpopupframe</option>,  <option value="classKPopupMenu.html">kpopupmenu</option>,  <option value="classKPopupTitle.html">kpopuptitle</option>,  <option value="classKProgress.html">kprogress</option>,  <option value="classKProgressDialog.html">kprogressdialog</option>,  <option value="classKPushButton.html">kpushbutton</option>,  <option value="classKRadioAction.html">kradioaction</option>,  <option value="classKRecentFilesAction.html">krecentfilesaction</option>,  <option value="classKRestrictedLine.html">krestrictedline</option>,  <option value="classKRootPermsIcon.html">krootpermsicon</option>,  <option value="classKRootPixmap.html">krootpixmap</option>,  <option value="classKRuler.html">kruler</option>,  <option value="classKScrollView.html">kscrollview</option>,  <option value="classKSelectAction.html">kselectaction</option>,  <option value="classKSelector.html">kselector</option>,  <option value="classKSeparator.html">kseparator</option>,  <option value="classKShortcutDialog.html">kshortcutdialog</option>,  <option value="classKSpell.html">kspell</option>,  <option value="classKSpellConfig.html">kspellconfig</option>,  <option value="classKSplashScreen.html">ksplashscreen</option>,  <option value="classKSqueezedTextLabel.html">ksqueezedtextlabel</option>,  <option value="classKStatusBar.html">kstatusbar</option>,  <option value="classKStatusBarLabel.html">kstatusbarlabel</option>,  <option value="classKStdGuiItem.html">kstdguiitem</option>,  <option value="classKStringListValidator.html">kstringlistvalidator</option>,  <option value="classKSwitchLanguageDialog.html">kswitchlanguagedialog</option>,  <option value="classKSyntaxHighlighter.html">ksyntaxhighlighter</option>,  <option value="classKSystemTray.html">ksystemtray</option>,  <option value="classKTabBar.html">ktabbar</option>,  <option value="classKTabCtl.html">ktabctl</option>,  <option value="classKTabWidget.html">ktabwidget</option>,  <option value="classKTextBrowser.html">ktextbrowser</option>,  <option value="classKTextEdit.html">ktextedit</option>,  <option value="classKTimeWidget.html">ktimewidget</option>,  <option value="classKTimezoneWidget.html">ktimezonewidget</option>,  <option value="classKTipDatabase.html">ktipdatabase</option>,  <option value="classKTipDialog.html">ktipdialog</option>,  <option value="classKToggleAction.html">ktoggleaction</option>,  <option value="classKToggleFullScreenAction.html">ktogglefullscreenaction</option>,  <option value="classKToggleToolBarAction.html">ktoggletoolbaraction</option>,  <option value="classKToolBar.html">ktoolbar</option>,  <option value="classKToolBarButton.html">ktoolbarbutton</option>,  <option value="classKToolBarButtonList.html">ktoolbarbuttonlist</option>,  <option value="classKToolBarLabelAction.html">ktoolbarlabelaction</option>,  <option value="classKToolBarPopupAction.html">ktoolbarpopupaction</option>,  <option value="classKToolBarRadioGroup.html">ktoolbarradiogroup</option>,  <option value="classKURLLabel.html">kurllabel</option>,  <option value="classKValueSelector.html">kvalueselector</option>,  <option value="classKWidgetAction.html">kwidgetaction</option>,  <option value="classKWindowInfo.html">kwindowinfo</option>,  <option value="classKWizard.html">kwizard</option>,  <option value="classKWordWrap.html">kwordwrap</option>,  <option value="classKWritePermsIcon.html">kwritepermsicon</option>,  <option value="classKXMLGUIBuilder.html">kxmlguibuilder</option>,  <option value="classKXMLGUIClient.html">kxmlguiclient</option>,  <option value="classKXMLGUIFactory.html">kxmlguifactory</option>,  <option value="classKXYSelector.html">kxyselector</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>&nbsp;&nbsp;&nbsp;&nbsp;<a href="../../interfaces/kimproxy/interface/html/index.html">interface</a></li><li>&nbsp;&nbsp;&nbsp;&nbsp;<a href="../../interfaces/kimproxy/library/html/index.html">library</a></li><li>&nbsp;&nbsp;<a href="../../interfaces/kspeech/html/index.html">kspeech</a></li><li>&nbsp;&nbsp;<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>&nbsp;&nbsp;<a href="../../kio/bookmarks/html/index.html">bookmarks</a></li><li>&nbsp;&nbsp;<a href="../../kio/httpfilter/html/index.html">httpfilter</a></li><li>&nbsp;&nbsp;<a href="../../kio/kfile/html/index.html">kfile</a></li><li>&nbsp;&nbsp;<a href="../../kio/kio/html/index.html">kio</a></li><li>&nbsp;&nbsp;<a href="../../kio/kioexec/html/index.html">kioexec</a></li><li>&nbsp;&nbsp;<a href="../../kio/kpasswdserver/html/index.html">kpasswdserver</a></li><li>&nbsp;&nbsp;<a href="../../kio/kssl/html/index.html">kssl</a></li><li><a href="../../kioslave/html/index.html">kioslave</a></li><li>&nbsp;&nbsp;<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>&nbsp;&nbsp;<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="&#109;&#97;&#105;&#108;&#116;&#111;&#58;groo&#116;&#64;kde&#46;or&#x67;">Adriaan de Groot</a>
and
<a href="&#109;a&#105;&#108;&#116;&#111;&#58;w&#105;nter&#64;kde&#46;or&#x67">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>