Sophie

Sophie

distrib > PLD > ac > amd64 > media > dist > by-pkgid > 90467ea6a387df728f7218a11e972208 > files > 9510

kdelibs-apidocs-3.5.6-3.amd64.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>kunittest: module.h File Reference (kunittest)</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=".">kunittest</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.4.4 -->
<div class="nav">
<a class="el" href="dir_000000.html">kunittest</a></div>
<h1>module.h File Reference</h1><hr><a name="_details"></a><h2>Detailed Description</h2>
Provides macros to ease building unit tests as shared libraries
<p>
Definition in file <a class="el" href="module_8h-source.html">module.h</a>.
<p>
<code>#include &lt;qstring.h&gt;</code><br>
<code>#include &lt;klibloader.h&gt;</code><br>
<code>#include &lt;<a class="el" href="runner_8h-source.html">kunittest/runner.h</a>&gt;</code><br>

<p>
<a href="module_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Namespaces</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">namespace &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceKUnitTest.html">KUnitTest</a></td></tr>

<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="module_8h.html#a0">KUNITTEST_MODULE</a>(library, suite)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="module_8h.html#a1">KUNITTEST_MODULE_REGISTER_TESTER</a>(tester)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="module_8h.html#a2">KUNITTEST_MODULE_REGISTER_NAMEDTESTER</a>(name, tester)</td></tr>

</table>
<hr><h2>Define Documentation</h2>
<a class="anchor" name="a0"></a><!-- doxytag: member="module.h::KUNITTEST_MODULE" ref="a0" args="(library, suite)" --><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">#define KUNITTEST_MODULE          </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">library,         <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>suite&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Use this macro if you are creating a <a class="el" href="namespaceKUnitTest.html">KUnitTest</a> module named library. This macro creates a module-class named a factory class. The module will appear under the name suite in the test runner. There is no need in calling the K_EXPORT_COMPONENT_FACTORY macro, this is taken care of automatically.<p>
<div class="fragment"><pre class="fragment"> <a class="code" href="module_8h.html#a0">KUNITTEST_MODULE</a>(kunittest_samplemodule,<span class="stringliteral">"TestSuite"</span>) 
</pre></div>
<p>
Definition at line <a class="el" href="module_8h-source.html#l00050">50</a> of file <a class="el" href="module_8h-source.html">module.h</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a2"></a><!-- doxytag: member="module.h::KUNITTEST_MODULE_REGISTER_NAMEDTESTER" ref="a2" args="(name, tester)" --><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">#define KUNITTEST_MODULE_REGISTER_NAMEDTESTER          </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">name,         <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>tester&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
<b>Value:</b><div class="fragment"><pre class="fragment"><span class="keyword">static</span> <span class="keyword">class </span>tester##ModuleAutoregister                                                   \
    {                                                                                         \
    <span class="keyword">public</span>:                                                                                   \
        tester##ModuleAutoregister()                                                          \
        {                                                                                     \
            <a class="codeRef" doxygen="qt.tag:" href="qstring.html">QString</a> fullName = s_kunittest_suite + <a class="codeRef" doxygen="qt.tag:" href="qstring.html">QString</a>(<span class="stringliteral">"::"</span>) + <a class="codeRef" doxygen="qt.tag:" href="qstring.html#fromLocal8Bit">QString::fromLocal8Bit</a>(name); \
            <a class="code" href="classKUnitTest_1_1Tester.html">KUnitTest::Tester</a> *test = <span class="keyword">new</span> tester(fullName.<a class="codeRef" doxygen="qt.tag:" href="qstring.html#local8Bit">local8Bit</a>());                       \
            kunittest_registerModuleTester(fullName.<a class="codeRef" doxygen="qt.tag:" href="qstring.html#local8Bit">local8Bit</a>(), test);                       \
        }                                                                                     \
    } tester##ModuleAutoregisterInstance;
</pre></div>Use this macro to add a tester class, with specified name, to your module..<p>
<div class="fragment"><pre class="fragment"> <a class="code" href="module_8h.html#a1">KUNITTEST_MODULE_REGISTER_TESTER</a>(<span class="stringliteral">"SubSuite::PrettyName"</span>,SimpleSampleTester) 
</pre></div>
<p>
Definition at line <a class="el" href="module_8h-source.html#l00107">107</a> of file <a class="el" href="module_8h-source.html">module.h</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a1"></a><!-- doxytag: member="module.h::KUNITTEST_MODULE_REGISTER_TESTER" ref="a1" args="(tester)" --><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">#define KUNITTEST_MODULE_REGISTER_TESTER          </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">tester&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
<b>Value:</b><div class="fragment"><pre class="fragment"><span class="keyword">static</span> <span class="keyword">class </span>tester##ModuleAutoregister                                                     \
    {                                                                                           \
    <span class="keyword">public</span>:                                                                                     \
        tester##ModuleAutoregister()                                                            \
        {                                                                                       \
            <a class="code" href="classKUnitTest_1_1Tester.html">KUnitTest::Tester</a> *test = <span class="keyword">new</span> tester();                                             \
            <a class="codeRef" doxygen="qt.tag:" href="qstring.html">QString</a> name = s_kunittest_suite + <a class="codeRef" doxygen="qt.tag:" href="qstring.html#fromLatin1">QString::fromLatin1</a>(<span class="stringliteral">"::"</span>) + <a class="codeRef" doxygen="qt.tag:" href="qstring.html#fromLocal8Bit">QString::fromLocal8Bit</a>(#tester); \
            test-&gt;<a class="codeRef" doxygen="qt.tag:" href="qobject.html#setName">setName</a>(name.<a class="codeRef" doxygen="qt.tag:" href="qstring.html#local8Bit">local8Bit</a>());                                                    \
            kunittest_registerModuleTester(name.<a class="codeRef" doxygen="qt.tag:" href="qstring.html#local8Bit">local8Bit</a>(), test );                            \
        }                                                                                       \
    } tester##ModuleAutoregisterInstance;
</pre></div>Use this macro to add a tester class to your module. The name of the tester will be identical to the class name.<p>
<div class="fragment"><pre class="fragment"> <a class="code" href="module_8h.html#a1">KUNITTEST_MODULE_REGISTER_TESTER</a>(SimpleSampleTester) 
</pre></div>
<p>
Definition at line <a class="el" href="module_8h-source.html#l00089">89</a> of file <a class="el" href="module_8h-source.html">module.h</a>.    </td>
  </tr>
</table>
    </div></div>


      </td>
  </tr>
  <tr>
    <td valign="top" id="leftmenu" width="25%">
      <a name="navigation"></a>
      <div class="menu_box"><h2>kunittest</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="dirs.html">Directories</a></li><li><a href="namespacemembers.html">Namespace Members</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="classKUnitTest_1_1Runner.html">kunittest::runner</option>,  <option value="classKUnitTest_1_1SlotTester.html">kunittest::slottester</option>,  <option value="classKUnitTest_1_1Tester.html">kunittest::tester</option>,  <option value="classKUnitTest_1_1TesterAutoregister.html">kunittest::testerautoregister</option>,  <option value="classKUnitTest_1_1TestResults.html">kunittest::testresults</option>,  <option value="classSampleTester.html">sampletester</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>