Sophie

Sophie

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

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>kparts: KParts::GenericFactory&lt; T &gt; Class Template Reference (kparts)</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=".">kparts</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="namespaceKParts.html">KParts</a>::<a class="el" href="classKParts_1_1GenericFactory.html">GenericFactory</a></div>
<h1>KParts::GenericFactory&lt; T &gt; Class Template Reference</h1><!-- doxytag: class="KParts::GenericFactory" --><!-- doxytag: inherits="KParts::GenericFactoryBase" --><code>#include &lt;<a class="el" href="genericfactory_8h-source.html">genericfactory.h</a>&gt;</code>
<p>
<p>Inheritance diagram for KParts::GenericFactory&lt; T &gt;:
<p><center><img src="classKParts_1_1GenericFactory.png" usemap="#KParts::GenericFactory< T >_map" border="0" alt=""></center>
<map name="KParts::GenericFactory< T >_map">
<area href="classKParts_1_1GenericFactoryBase.html" alt="KParts::GenericFactoryBase< T >" shape="rect" coords="0,168,203,192">
<area href="classKParts_1_1Factory.html" alt="KParts::Factory" shape="rect" coords="0,112,203,136">
<area doxygen="kdecore.tag:../../kdecore/html/" href="../../kdecore/html/classKLibFactory.html" alt="KLibFactory" shape="rect" coords="0,56,203,80">
<area doxygen="qt.tag:" href="qobject.html" alt="QObject" shape="rect" coords="0,0,203,24">
</map>
<a href="classKParts_1_1GenericFactory-members.html">List of all members.</a><hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class T&gt;<br>
 class KParts::GenericFactory&lt; T &gt;</h3>

A template for a <a class="el" href="classKParts_1_1Factory.html">KParts::Factory</a> implementation. 
<p>
It implements the pure virtual createPartObject method by instantiating the template argument when requested through the className field. In addition it is a container for a part's <a class="elRef" doxygen="kdecore.tag:../../kdecore/html/" href="../../kdecore/html/classKInstance.html">KInstance</a> object, by providing a static <a class="elRef" doxygen="kdecore.tag:../../kdecore/html/" href="../../kdecore/html/classKInstance.html">KInstance</a> *instance() method.<p>
The template argument has to inherit from <a class="el" href="classKParts_1_1Part.html">KParts::Part</a> and has to implement two methods: 1) There needs to be a public constructor with the following signature: MyPart( QWidget *parentWidget, const char *widgetName, QObject *parent, const char *name, const QStringList&amp; args )<p>
2) It needs to provide one static method to create a <a class="elRef" doxygen="kdecore.tag:../../kdecore/html/" href="../../kdecore/html/classKAboutData.html">KAboutData</a> object per request, holding information about the component's name, its authors, license, etc. The signature of that static method has to be <a class="elRef" doxygen="kdecore.tag:../../kdecore/html/" href="../../kdecore/html/classKAboutData.html">KAboutData</a> *createAboutData()<p>
The template will take care of memory management of the <a class="elRef" doxygen="kdecore.tag:../../kdecore/html/" href="../../kdecore/html/classKInstance.html">KInstance</a> and the <a class="elRef" doxygen="kdecore.tag:../../kdecore/html/" href="../../kdecore/html/classKAboutData.html">KAboutData</a> object, meaning ownership of what createAboutData returns is passed to the caller (this template) .<p>
For advanced use you can also inherit from the template and re-implement additionally the virtual <a class="elRef" doxygen="kdecore.tag:../../kdecore/html/" href="../../kdecore/html/classKInstance.html">KInstance</a> *createInstance() method, for example in case you want to extend the paths of your instance's <a class="elRef" doxygen="kdecore.tag:../../kdecore/html/" href="../../kdecore/html/classKStandardDirs.html">KStandardDirs</a> object.<p>
If a <a class="el" href="classKParts_1_1ReadOnlyPart.html">KParts::ReadOnlyPart</a> is requested through this factory and the template argument implements a <a class="el" href="classKParts_1_1ReadWritePart.html">KParts::ReadWritePart</a> then setReadWrite( false ) will automatically be called in createPartObject.<p>
Use the factory through the K_EXPORT_COMPONENT_FACTORY macro, like that: <div class="fragment"><pre class="fragment"> <span class="keyword">typedef</span> <a class="code" href="classKParts_1_1GenericFactory.html">KParts::GenericFactory</a>&amp;lt;YourKPart&amp;gt; YourKPartFactory;
 K_EXPORT_COMPONENT_FACTORY( yourlibrary, YourKPartFactory )
</pre></div> yourlibrary is the library name that you compiled your KPart into.
<p>

<p>
Definition at line <a class="el" href="genericfactory_8h-source.html#l00095">95</a> of file <a class="el" href="genericfactory_8h-source.html">genericfactory.h</a>.<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a0"></a><!-- doxytag: member="KParts::GenericFactory::GenericFactory" ref="a0" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKParts_1_1GenericFactory.html#a0">GenericFactory</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classKParts_1_1Part.html">KParts::Part</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKParts_1_1GenericFactory.html#a1">createPartObject</a> (<a class="elRef" doxygen="qt.tag:" href="qwidget.html">QWidget</a> *parentWidget, const char *widgetName, <a class="elRef" doxygen="qt.tag:" href="qobject.html">QObject</a> *<a class="elRef" doxygen="qt.tag:" href="qobject.html#parent">parent</a>, const char *<a class="elRef" doxygen="qt.tag:" href="qobject.html#name">name</a>, const char *<a class="elRef" doxygen="qt.tag:" href="qobject.html#className">className</a>, const <a class="elRef" doxygen="qt.tag:" href="qstringlist.html">QStringList</a> &amp;args)</td></tr>

</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a1"></a><!-- doxytag: member="KParts::GenericFactory::createPartObject" ref="a1" args="(QWidget *parentWidget, const char *widgetName, QObject *parent, const char *name, const char *className, const QStringList &amp;args)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="mdPrefix" colspan="4">
template&lt;class T&gt; </td>
        </tr>
        <tr>
          <td class="md" nowrap valign="top">virtual <a class="el" href="classKParts_1_1Part.html">KParts::Part</a>* <a class="el" href="classKParts_1_1GenericFactory.html">KParts::GenericFactory</a>&lt; T &gt;::createPartObject           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="elRef" doxygen="qt.tag:" href="qwidget.html">QWidget</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>parentWidget</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>const char *&nbsp;</td>
          <td class="mdname" nowrap> <em>widgetName</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap><a class="elRef" doxygen="qt.tag:" href="qobject.html">QObject</a> *&nbsp;</td>
          <td class="mdname" nowrap> <em>parent</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>const char *&nbsp;</td>
          <td class="mdname" nowrap> <em>name</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>const char *&nbsp;</td>
          <td class="mdname" nowrap> <em>className</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>const <a class="elRef" doxygen="qt.tag:" href="qstringlist.html">QStringList</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap> <em>args</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [inline, virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Reimplement this method in your implementation to create the <a class="el" href="classKParts_1_1Part.html">Part</a>. 
<p>
The <a class="elRef" doxygen="qt.tag:" href="qstringlist.html">QStringList</a> can be used to pass additional arguments to the part. If the part needs additional arguments, it should take them as name="value" pairs. This is the way additional arguments will get passed to the part from eg. khtml. You can for example emebed the part into HTML by using the following code: <div class="fragment"><pre class="fragment">    &lt;object type=<span class="stringliteral">"my_mimetype"</span> data=<span class="stringliteral">"url_to_my_data"</span>&gt;
        &lt;param name=<span class="stringliteral">"name1"</span> value=<span class="stringliteral">"value1"</span>&gt;
        &lt;param name=<span class="stringliteral">"name2"</span> value=<span class="stringliteral">"value2"</span>&gt;
    &lt;/object&gt;
</pre></div> This could result in a call to <div class="fragment"><pre class="fragment">     <a class="code" href="classKParts_1_1Factory.html#a2">createPart</a>( parentWidget, name, parentObject, parentName, <span class="stringliteral">"Kparts::Part"</span>,
                 <a class="codeRef" doxygen="qt.tag:" href="qstringlist.html">QStringList</a>(<span class="stringliteral">"name1="</span>value1<span class="stringliteral">""</span>, <span class="stringliteral">"name2="</span>value2<span class="stringliteral">") );</span>
</pre></div><p>
<dl compact><dt><b>Returns:</b></dt><dd>the newly created part.</dd></dl>

<p>
Implements <a class="el" href="classKParts_1_1Factory.html#b0">KParts::Factory</a>.
<p>
Definition at line <a class="el" href="genericfactory_8h-source.html#l00100">100</a> of file <a class="el" href="genericfactory_8h-source.html">genericfactory.h</a>.    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="genericfactory_8h-source.html">genericfactory.h</a></ul>
    </div></div>


      </td>
  </tr>
  <tr>
    <td valign="top" id="leftmenu" width="25%">
      <a name="navigation"></a>
      <div class="menu_box"><h2>kparts</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="classKParts_1_1BrowserExtension.html">kparts::browserextension</option>,  <option value="classKParts_1_1BrowserHostExtension.html">kparts::browserhostextension</option>,  <option value="classKParts_1_1BrowserInterface.html">kparts::browserinterface</option>,  <option value="classKParts_1_1BrowserRun.html">kparts::browserrun</option>,  <option value="classKParts_1_1DockMainWindow.html">kparts::dockmainwindow</option>,  <option value="classKParts_1_1Event.html">kparts::event</option>,  <option value="classKParts_1_1Factory.html">kparts::factory</option>,  <option value="classKParts_1_1GenericFactory.html">kparts::genericfactory</option>,  <option value="classKParts_1_1GenericFactory_3_01KTypeList_3_01T1_00_01T2_01_4_01_4.html">kparts::genericfactory< ktypelist< t1, t2 > ></option>,  <option value="classKParts_1_1GenericFactoryBase.html">kparts::genericfactorybase</option>,  <option value="classKParts_1_1GUIActivateEvent.html">kparts::guiactivateevent</option>,  <option value="classKParts_1_1HistoryProvider.html">kparts::historyprovider</option>,  <option value="classKParts_1_1LiveConnectExtension.html">kparts::liveconnectextension</option>,  <option value="classKParts_1_1MainWindow.html">kparts::mainwindow</option>,  <option value="classKParts_1_1OpenURLEvent.html">kparts::openurlevent</option>,  <option value="classKParts_1_1Part.html">kparts::part</option>,  <option value="classKParts_1_1PartActivateEvent.html">kparts::partactivateevent</option>,  <option value="classKParts_1_1PartBase.html">kparts::partbase</option>,  <option value="classKParts_1_1PartManager.html">kparts::partmanager</option>,  <option value="classKParts_1_1PartSelectEvent.html">kparts::partselectevent</option>,  <option value="classKParts_1_1Plugin.html">kparts::plugin</option>,  <option value="classKParts_1_1ReadOnlyPart.html">kparts::readonlypart</option>,  <option value="classKParts_1_1ReadWritePart.html">kparts::readwritepart</option>,  <option value="classKParts_1_1StatusBarExtension.html">kparts::statusbarextension</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>