<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- formbuilder.cpp -->
<title>Qt 4.8: QFormBuilder Class Reference</title>
<link rel="stylesheet" type="text/css" href="style/style.css" />
<script src="scripts/jquery.js" type="text/javascript"></script>
<script src="scripts/functions.js" type="text/javascript"></script>
<link rel="stylesheet" type="text/css" href="style/superfish.css" />
<link rel="stylesheet" type="text/css" href="style/narrow.css" />
<!--[if IE]>
<meta name="MSSmartTagsPreventParsing" content="true">
<meta http-equiv="imagetoolbar" content="no">
<![endif]-->
<!--[if lt IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie6.css">
<![endif]-->
<!--[if IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie7.css">
<![endif]-->
<!--[if IE 8]>
<link rel="stylesheet" type="text/css" href="style/style_ie8.css">
<![endif]-->
<script src="scripts/superfish.js" type="text/javascript"></script>
<script src="scripts/narrow.js" type="text/javascript"></script>
</head>
<body class="" onload="CheckEmptyAndLoadList();">
<div class="header" id="qtdocheader">
<div class="content">
<div id="nav-logo">
<a href="index.html">Home</a></div>
<a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
<div id="narrowsearch"></div>
<div id="nav-topright">
<ul>
<li class="nav-topright-home"><a href="http://qt.digia.com/">Qt HOME</a></li>
<li class="nav-topright-dev"><a href="http://qt-project.org/">DEV</a></li>
<li class="nav-topright-doc nav-topright-doc-active"><a href="http://qt-project.org/doc/">
DOC</a></li>
<li class="nav-topright-blog"><a href="http://blog.qt.digia.com/">BLOG</a></li>
</ul>
</div>
<div id="shortCut">
<ul>
<li class="shortCut-topleft-inactive"><span><a href="index.html">Qt 4.8</a></span></li>
<li class="shortCut-topleft-active"><a href="http://qt-project.org/doc/">ALL VERSIONS </a></li>
</ul>
</div>
<ul class="sf-menu" id="narrowmenu">
<li><a href="#">API Lookup</a>
<ul>
<li><a href="classes.html">Class index</a></li>
<li><a href="functions.html">Function index</a></li>
<li><a href="modules.html">Modules</a></li>
<li><a href="namespaces.html">Namespaces</a></li>
<li><a href="qtglobal.html">Global Declarations</a></li>
<li><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</li>
<li><a href="#">Qt Topics</a>
<ul>
<li><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li><a href="supported-platforms.html">Supported Platforms</a></li>
<li><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</li>
<li><a href="#">Examples</a>
<ul>
<li><a href="all-examples.html">Examples</a></li>
<li><a href="tutorials.html">Tutorials</a></li>
<li><a href="demos.html">Demos</a></li>
<li><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="wrapper">
<div class="hd">
<span></span>
</div>
<div class="bd group">
<div class="sidebar">
<div class="searchlabel">
Search index:</div>
<div class="search" id="sidebarsearch">
<form id="qtdocsearch" action="" onsubmit="return false;">
<fieldset>
<input type="text" name="searchstring" id="pageType" value="" />
<div id="resultdialog">
<a href="#" id="resultclose">Close</a>
<p id="resultlinks" class="all"><a href="#" id="showallresults">All</a> | <a href="#" id="showapiresults">API</a> | <a href="#" id="showarticleresults">Articles</a> | <a href="#" id="showexampleresults">Examples</a></p>
<p id="searchcount" class="all"><span id="resultcount"></span><span id="apicount"></span><span id="articlecount"></span><span id="examplecount"></span> results:</p>
<ul id="resultlist" class="all">
</ul>
</div>
</fieldset>
</form>
</div>
<div class="box first bottombar" id="lookup">
<h2 title="API Lookup"><span></span>
API Lookup</h2>
<div id="list001" class="list">
<ul id="ul001" >
<li class="defaultLink"><a href="classes.html">Class index</a></li>
<li class="defaultLink"><a href="functions.html">Function index</a></li>
<li class="defaultLink"><a href="modules.html">Modules</a></li>
<li class="defaultLink"><a href="namespaces.html">Namespaces</a></li>
<li class="defaultLink"><a href="qtglobal.html">Global Declarations</a></li>
<li class="defaultLink"><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</div>
</div>
<div class="box bottombar" id="topics">
<h2 title="Qt Topics"><span></span>
Qt Topics</h2>
<div id="list002" class="list">
<ul id="ul002" >
<li class="defaultLink"><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li class="defaultLink"><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li class="defaultLink"><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li class="defaultLink"><a href="supported-platforms.html">Supported Platforms</a></li>
<li class="defaultLink"><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li class="defaultLink"><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</div>
</div>
<div class="box" id="examples">
<h2 title="Examples"><span></span>
Examples</h2>
<div id="list003" class="list">
<ul id="ul003">
<li class="defaultLink"><a href="all-examples.html">Examples</a></li>
<li class="defaultLink"><a href="tutorials.html">Tutorials</a></li>
<li class="defaultLink"><a href="demos.html">Demos</a></li>
<li class="defaultLink"><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</div>
</div>
</div>
<div class="wrap">
<div class="toolbar">
<div class="breadcrumb toolblock">
<ul>
<li class="first"><a href="index.html">Home</a></li>
<!-- Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtdesigner.html">QtDesigner</a></li>
<li>QFormBuilder</li>
</ul>
</div>
<div class="toolbuttons toolblock">
<ul>
<li id="smallA" class="t_button">A</li>
<li id="medA" class="t_button active">A</li>
<li id="bigA" class="t_button">A</li>
<li id="print" class="t_button"><a href="javascript:this.print();">
<span>Print</span></a></li>
</ul>
</div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QFormBuilder Class Reference</h1>
<!-- $$$QFormBuilder-brief -->
<p>The QFormBuilder class is used to dynamically construct user interfaces from UI files at run-time. <a href="#details">More...</a></p>
<!-- @@@QFormBuilder -->
<pre class="cpp"> <span class="preprocessor">#include <QFormBuilder></span></pre><p><b>Inherits: </b><a href="qabstractformbuilder.html">QAbstractFormBuilder</a>.</p>
<ul>
<li><a href="qformbuilder-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qformbuilder.html#QFormBuilder">QFormBuilder</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qformbuilder.html#dtor.QFormBuilder">~QFormBuilder</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qformbuilder.html#addPluginPath">addPluginPath</a></b> ( const QString & <i>pluginPath</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qformbuilder.html#clearPluginPaths">clearPluginPaths</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QList<QDesignerCustomWidgetInterface *> </td><td class="memItemRight bottomAlign"><b><a href="qformbuilder.html#customWidgets">customWidgets</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QStringList </td><td class="memItemRight bottomAlign"><b><a href="qformbuilder.html#pluginPaths">pluginPaths</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qformbuilder.html#setPluginPath">setPluginPath</a></b> ( const QStringList & <i>pluginPaths</i> )</td></tr>
</table>
<ul>
<li class="fn">4 public functions inherited from <a href="qabstractformbuilder.html#public-functions">QAbstractFormBuilder</a></li>
</ul>
<a name="details"></a>
<!-- $$$QFormBuilder-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QFormBuilder class is used to dynamically construct user interfaces from UI files at run-time.</p>
<p>The QFormBuilder class provides a mechanism for dynamically creating user interfaces at run-time, based on UI files created with <i>Qt Designer</i>. For example:</p>
<pre class="cpp"> MyForm<span class="operator">::</span>MyForm(<span class="type"><a href="qwidget.html">QWidget</a></span> <span class="operator">*</span>parent)
: <span class="type"><a href="qwidget.html">QWidget</a></span>(parent)
{
<span class="type">QFormBuilder</span> builder;
<span class="type"><a href="qfile.html">QFile</a></span> file(<span class="string">":/forms/myWidget.ui"</span>);
file<span class="operator">.</span>open(<span class="type"><a href="qfile.html">QFile</a></span><span class="operator">::</span>ReadOnly);
<span class="type"><a href="qwidget.html">QWidget</a></span> <span class="operator">*</span>myWidget <span class="operator">=</span> builder<span class="operator">.</span>load(<span class="operator">&</span>file<span class="operator">,</span> <span class="keyword">this</span>);
file<span class="operator">.</span>close();
<span class="type"><a href="qvboxlayout.html">QVBoxLayout</a></span> <span class="operator">*</span>layout <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="qvboxlayout.html">QVBoxLayout</a></span>;
layout<span class="operator">-</span><span class="operator">></span>addWidget(myWidget);
setLayout(layout);
}</pre>
<p>By including the user interface in the example's resources (<tt>myForm.qrc</tt>), we ensure that it will be present when the example is run:</p>
<pre class="cpp"> <span class="operator"><</span><span class="operator">!</span>DOCTYPE RCC<span class="operator">></span><span class="operator"><</span>RCC version<span class="operator">=</span><span class="string">"1.0"</span><span class="operator">></span>
<span class="operator"><</span>qresource prefix<span class="operator">=</span><span class="string">"/forms"</span><span class="operator">></span>
<span class="operator"><</span>file<span class="operator">></span>mywidget<span class="operator">.</span>ui<span class="operator"><</span><span class="operator">/</span>file<span class="operator">></span>
<span class="operator"><</span><span class="operator">/</span>qresource<span class="operator">></span>
<span class="operator"><</span><span class="operator">/</span>RCC<span class="operator">></span></pre>
<p>QFormBuilder extends the <a href="qabstractformbuilder.html">QAbstractFormBuilder</a> base class with a number of functions that are used to support custom widget plugins:</p>
<ul>
<li><a href="qformbuilder.html#pluginPaths">pluginPaths</a>() returns the list of paths that the form builder searches when loading custom widget plugins.</li>
<li><a href="qformbuilder.html#addPluginPath">addPluginPath</a>() allows additional paths to be registered with the form builder.</li>
<li><a href="qformbuilder.html#setPluginPath">setPluginPath</a>() is used to replace the existing list of paths with a list obtained from some other source.</li>
<li><a href="qformbuilder.html#clearPluginPaths">clearPluginPaths</a>() removes all paths registered with the form builder.</li>
<li><a href="qformbuilder.html#customWidgets">customWidgets</a>() returns a list of interfaces to plugins that can be used to create new instances of registered custom widgets.</li>
</ul>
<p>The QFormBuilder class is typically used by custom components and applications that embed <i>Qt Designer</i>. Standalone applications that need to dynamically generate user interfaces at run-time use the <a href="quiloader.html">QUiLoader</a> class, found in the <a href="qtuitools.html">QtUiTools</a> module.</p>
</div>
<p><b>See also </b><a href="qabstractformbuilder.html">QAbstractFormBuilder</a> and <a href="qtuitools.html">QtUiTools Module</a>.</p>
<!-- @@@QFormBuilder -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QFormBuilder[overload1]$$$QFormBuilder -->
<h3 class="fn"><a name="QFormBuilder"></a>QFormBuilder::<span class="name">QFormBuilder</span> ()</h3>
<p>Constructs a new form builder.</p>
<!-- @@@QFormBuilder -->
<!-- $$$~QFormBuilder[overload1]$$$~QFormBuilder -->
<h3 class="fn"><a name="dtor.QFormBuilder"></a>QFormBuilder::<span class="name">~QFormBuilder</span> ()<tt> [virtual]</tt></h3>
<p>Destroys the form builder.</p>
<!-- @@@~QFormBuilder -->
<!-- $$$addPluginPath[overload1]$$$addPluginPathconstQString& -->
<h3 class="fn"><a name="addPluginPath"></a><span class="type">void</span> QFormBuilder::<span class="name">addPluginPath</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>pluginPath</i> )</h3>
<p>Adds a new plugin path specified by <i>pluginPath</i> to the list of paths that will be searched by the form builder when loading a custom widget plugin.</p>
<p><b>See also </b><a href="qformbuilder.html#setPluginPath">setPluginPath</a>() and <a href="qformbuilder.html#clearPluginPaths">clearPluginPaths</a>().</p>
<!-- @@@addPluginPath -->
<!-- $$$clearPluginPaths[overload1]$$$clearPluginPaths -->
<h3 class="fn"><a name="clearPluginPaths"></a><span class="type">void</span> QFormBuilder::<span class="name">clearPluginPaths</span> ()</h3>
<p>Clears the list of paths that the form builder uses to search for custom widget plugins.</p>
<p><b>See also </b><a href="qformbuilder.html#pluginPaths">pluginPaths</a>().</p>
<!-- @@@clearPluginPaths -->
<!-- $$$customWidgets[overload1]$$$customWidgets -->
<h3 class="fn"><a name="customWidgets"></a><span class="type"><a href="qlist.html">QList</a></span><<span class="type"><a href="qdesignercustomwidgetinterface.html">QDesignerCustomWidgetInterface</a></span> *> QFormBuilder::<span class="name">customWidgets</span> () const</h3>
<p>Returns a list of the available plugins.</p>
<!-- @@@customWidgets -->
<!-- $$$pluginPaths[overload1]$$$pluginPaths -->
<h3 class="fn"><a name="pluginPaths"></a><span class="type"><a href="qstringlist.html">QStringList</a></span> QFormBuilder::<span class="name">pluginPaths</span> () const</h3>
<p>Returns the list of paths the form builder searches for plugins.</p>
<p><b>See also </b><a href="qformbuilder.html#addPluginPath">addPluginPath</a>().</p>
<!-- @@@pluginPaths -->
<!-- $$$setPluginPath[overload1]$$$setPluginPathconstQStringList& -->
<h3 class="fn"><a name="setPluginPath"></a><span class="type">void</span> QFormBuilder::<span class="name">setPluginPath</span> ( const <span class="type"><a href="qstringlist.html">QStringList</a></span> & <i>pluginPaths</i> )</h3>
<p>Sets the list of plugin paths to the list specified by <i>pluginPaths</i>.</p>
<p><b>See also </b><a href="qformbuilder.html#addPluginPath">addPluginPath</a>().</p>
<!-- @@@setPluginPath -->
</div>
</div>
</div>
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2013 Digia Plc and/or its
subsidiaries. Documentation contributions included herein are the copyrights of
their respective owners.</p>
<br />
<p>
The documentation provided herein is licensed under the terms of the
<a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation
License version 1.3</a> as published by the Free Software Foundation.</p>
<p>
Documentation sources may be obtained from <a href="http://www.qt-project.org">
www.qt-project.org</a>.</p>
<br />
<p>
Digia, Qt and their respective logos are trademarks of Digia Plc
in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. <a title="Privacy Policy"
href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
<script src="scripts/functions.js" type="text/javascript"></script>
</body>
</html>
