<?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" />
<!-- dockwidgets.qdoc -->
<title>Qt 4.8: Dock Widgets Example</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="all-examples.html">Examples</a></li>
<li>Dock Widgets Example</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="#mainwindow-class-definition">MainWindow Class Definition</a></li>
<li class="level1"><a href="#mainwindow-class-implementation">MainWindow Class Implementation</a></li>
</ul>
</div>
<h1 class="title">Dock Widgets Example</h1>
<span class="subtitle"></span>
<!-- $$$mainwindows/dockwidgets-description -->
<div class="descr"> <a name="details"></a>
<p>Files:</p>
<ul>
<li><a href="mainwindows-dockwidgets-mainwindow-cpp.html">mainwindows/dockwidgets/mainwindow.cpp</a></li>
<li><a href="mainwindows-dockwidgets-mainwindow-h.html">mainwindows/dockwidgets/mainwindow.h</a></li>
<li><a href="mainwindows-dockwidgets-main-cpp.html">mainwindows/dockwidgets/main.cpp</a></li>
<li><a href="mainwindows-dockwidgets-dockwidgets-pro.html">mainwindows/dockwidgets/dockwidgets.pro</a></li>
<li><a href="mainwindows-dockwidgets-dockwidgets-qrc.html">mainwindows/dockwidgets/dockwidgets.qrc</a></li>
</ul>
<p>Images:</p>
<ul>
<li><a href="images/used-in-examples/mainwindows/dockwidgets/images/new.png">mainwindows/dockwidgets/images/new.png</a></li>
<li><a href="images/used-in-examples/mainwindows/dockwidgets/images/print.png">mainwindows/dockwidgets/images/print.png</a></li>
<li><a href="images/used-in-examples/mainwindows/dockwidgets/images/save.png">mainwindows/dockwidgets/images/save.png</a></li>
<li><a href="images/used-in-examples/mainwindows/dockwidgets/images/undo.png">mainwindows/dockwidgets/images/undo.png</a></li>
</ul>
<p>The Dock Widgets example shows how to add dock windows to an application. It also shows how to use Qt's rich text engine.<p class="centerAlign"><img src="images/dockwidgets-example.png" alt="Screenshot of the Dock Widgets example" /></p><p>The application presents a simple business letter template, and has a list of customer names and addresses and a list of standard phrases in two dock windows. The user can click a customer to have their name and address inserted into the template, and click one or more of the standard phrases. Errors can be corrected by clicking the Undo button. Once the letter has been prepared it can be printed or saved as HTML.</p>
<a name="mainwindow-class-definition"></a>
<h2>MainWindow Class Definition</h2>
<p>Here's the class definition:</p>
<pre class="cpp"> <span class="keyword">class</span> MainWindow : <span class="keyword">public</span> <span class="type"><a href="qmainwindow.html">QMainWindow</a></span>
{
Q_OBJECT
<span class="keyword">public</span>:
MainWindow();
<span class="keyword">private</span> <span class="keyword">slots</span>:
<span class="type">void</span> newLetter();
<span class="type">void</span> save();
<span class="type">void</span> print();
<span class="type">void</span> undo();
<span class="type">void</span> about();
<span class="type">void</span> insertCustomer(<span class="keyword">const</span> <span class="type"><a href="qstring.html">QString</a></span> <span class="operator">&</span>customer);
<span class="type">void</span> addParagraph(<span class="keyword">const</span> <span class="type"><a href="qstring.html">QString</a></span> <span class="operator">&</span>paragraph);
<span class="keyword">private</span>:
<span class="type">void</span> createActions();
<span class="type">void</span> createMenus();
<span class="type">void</span> createToolBars();
<span class="type">void</span> createStatusBar();
<span class="type">void</span> createDockWindows();
<span class="type"><a href="qtextedit.html">QTextEdit</a></span> <span class="operator">*</span>textEdit;
<span class="type"><a href="qlistwidget.html">QListWidget</a></span> <span class="operator">*</span>customerList;
<span class="type"><a href="qlistwidget.html">QListWidget</a></span> <span class="operator">*</span>paragraphsList;
<span class="type"><a href="qmenu.html">QMenu</a></span> <span class="operator">*</span>fileMenu;
<span class="type"><a href="qmenu.html">QMenu</a></span> <span class="operator">*</span>editMenu;
<span class="type"><a href="qmenu.html">QMenu</a></span> <span class="operator">*</span>viewMenu;
<span class="type"><a href="qmenu.html">QMenu</a></span> <span class="operator">*</span>helpMenu;
<span class="type"><a href="qtoolbar.html">QToolBar</a></span> <span class="operator">*</span>fileToolBar;
<span class="type"><a href="qtoolbar.html">QToolBar</a></span> <span class="operator">*</span>editToolBar;
<span class="type"><a href="qaction.html">QAction</a></span> <span class="operator">*</span>newLetterAct;
<span class="type"><a href="qaction.html">QAction</a></span> <span class="operator">*</span>saveAct;
<span class="type"><a href="qaction.html">QAction</a></span> <span class="operator">*</span>printAct;
<span class="type"><a href="qaction.html">QAction</a></span> <span class="operator">*</span>undoAct;
<span class="type"><a href="qaction.html">QAction</a></span> <span class="operator">*</span>aboutAct;
<span class="type"><a href="qaction.html">QAction</a></span> <span class="operator">*</span>aboutQtAct;
<span class="type"><a href="qaction.html">QAction</a></span> <span class="operator">*</span>quitAct;
};</pre>
<p>We will now review each function in turn.</p>
<a name="mainwindow-class-implementation"></a>
<h2>MainWindow Class Implementation</h2>
<pre class="cpp"> <span class="preprocessor">#include <QtGui></span>
<span class="preprocessor">#include "mainwindow.h"</span></pre>
<p>We start by including <tt><QtGui></tt>, a header file that contains the definition of all classes in the <a href="qtcore.html">QtCore</a> and <a href="qtgui.html">QtGui</a> libraries. This saves us from having to include every class individually and is especially convenient if we add new widgets. We also include <tt>mainwindow.h</tt>.</p>
<pre class="cpp"> MainWindow<span class="operator">::</span>MainWindow()
{
textEdit <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="qtextedit.html">QTextEdit</a></span>;
setCentralWidget(textEdit);
createActions();
createMenus();
createToolBars();
createStatusBar();
createDockWindows();
setWindowTitle(tr(<span class="string">"Dock Widgets"</span>));
newLetter();
setUnifiedTitleAndToolBarOnMac(<span class="keyword">true</span>);
}</pre>
<p>In the constructor, we start by creating a <a href="qtextedit.html">QTextEdit</a> widget. Then we call <a href="qmainwindow.html#setCentralWidget">QMainWindow::setCentralWidget</a>(). This function passes ownership of the <a href="qtextedit.html">QTextEdit</a> to the <tt>MainWindow</tt> and tells the <tt>MainWindow</tt> that the <a href="qtextedit.html">QTextEdit</a> will occupy the <tt>MainWindow</tt>'s central area.</p>
<p>Then we call <tt>createActions()</tt>, <tt>createMenus()</tt>, <tt>createToolBars()</tt>, <tt>createStatusBar()</tt>, and <tt>createDockWindows()</tt> to set up the user interface. Finally we call <tt>setWindowTitle()</tt> to give the application a title, and <tt>newLetter()</tt> to create a new letter template.</p>
<p>We won't quote the <tt>createActions()</tt>, <tt>createMenus()</tt>, <tt>createToolBars()</tt>, and <tt>createStatusBar()</tt> functions since they follow the same pattern as all the other Qt examples.</p>
<pre class="cpp"> <span class="type">void</span> MainWindow<span class="operator">::</span>createDockWindows()
{
<span class="type"><a href="qdockwidget.html">QDockWidget</a></span> <span class="operator">*</span>dock <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="qdockwidget.html">QDockWidget</a></span>(tr(<span class="string">"Customers"</span>)<span class="operator">,</span> <span class="keyword">this</span>);
dock<span class="operator">-</span><span class="operator">></span>setAllowedAreas(<span class="type"><a href="qt.html">Qt</a></span><span class="operator">::</span>LeftDockWidgetArea <span class="operator">|</span> <span class="type"><a href="qt.html">Qt</a></span><span class="operator">::</span>RightDockWidgetArea);
customerList <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="qlistwidget.html">QListWidget</a></span>(dock);
customerList<span class="operator">-</span><span class="operator">></span>addItems(<span class="type"><a href="qstringlist.html">QStringList</a></span>()
<span class="operator"><</span><span class="operator"><</span> <span class="string">"John Doe, Harmony Enterprises, 12 Lakeside, Ambleton"</span>
<span class="operator"><</span><span class="operator"><</span> <span class="string">"Jane Doe, Memorabilia, 23 Watersedge, Beaton"</span>
<span class="operator"><</span><span class="operator"><</span> <span class="string">"Tammy Shea, Tiblanka, 38 Sea Views, Carlton"</span>
<span class="operator"><</span><span class="operator"><</span> <span class="string">"Tim Sheen, Caraba Gifts, 48 Ocean Way, Deal"</span>
<span class="operator"><</span><span class="operator"><</span> <span class="string">"Sol Harvey, Chicos Coffee, 53 New Springs, Eccleston"</span>
<span class="operator"><</span><span class="operator"><</span> <span class="string">"Sally Hobart, Tiroli Tea, 67 Long River, Fedula"</span>);
dock<span class="operator">-</span><span class="operator">></span>setWidget(customerList);
addDockWidget(<span class="type"><a href="qt.html">Qt</a></span><span class="operator">::</span>RightDockWidgetArea<span class="operator">,</span> dock);
viewMenu<span class="operator">-</span><span class="operator">></span>addAction(dock<span class="operator">-</span><span class="operator">></span>toggleViewAction());
dock <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="qdockwidget.html">QDockWidget</a></span>(tr(<span class="string">"Paragraphs"</span>)<span class="operator">,</span> <span class="keyword">this</span>);
paragraphsList <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="qlistwidget.html">QListWidget</a></span>(dock);
paragraphsList<span class="operator">-</span><span class="operator">></span>addItems(<span class="type"><a href="qstringlist.html">QStringList</a></span>()
<span class="operator"><</span><span class="operator"><</span> <span class="string">"Thank you for your payment which we have received today."</span>
<span class="operator"><</span><span class="operator"><</span> <span class="string">"Your order has been dispatched and should be with you "</span>
<span class="string">"within 28 days."</span>
<span class="operator"><</span><span class="operator"><</span> <span class="string">"We have dispatched those items that were in stock. The "</span>
<span class="string">"rest of your order will be dispatched once all the "</span>
<span class="string">"remaining items have arrived at our warehouse. No "</span>
<span class="string">"additional shipping charges will be made."</span>
<span class="operator"><</span><span class="operator"><</span> <span class="string">"You made a small overpayment (less than $5) which we "</span>
<span class="string">"will keep on account for you, or return at your request."</span>
<span class="operator"><</span><span class="operator"><</span> <span class="string">"You made a small underpayment (less than $1), but we have "</span>
<span class="string">"sent your order anyway. We'll add this underpayment to "</span>
<span class="string">"your next bill."</span>
<span class="operator"><</span><span class="operator"><</span> <span class="string">"Unfortunately you did not send enough money. Please remit "</span>
<span class="string">"an additional $. Your order will be dispatched as soon as "</span>
<span class="string">"the complete amount has been received."</span>
<span class="operator"><</span><span class="operator"><</span> <span class="string">"You made an overpayment (more than $5). Do you wish to "</span>
<span class="string">"buy more items, or should we return the excess to you?"</span>);
dock<span class="operator">-</span><span class="operator">></span>setWidget(paragraphsList);
addDockWidget(<span class="type"><a href="qt.html">Qt</a></span><span class="operator">::</span>RightDockWidgetArea<span class="operator">,</span> dock);
viewMenu<span class="operator">-</span><span class="operator">></span>addAction(dock<span class="operator">-</span><span class="operator">></span>toggleViewAction());
connect(customerList<span class="operator">,</span> SIGNAL(currentTextChanged(<span class="type"><a href="qstring.html">QString</a></span>))<span class="operator">,</span>
<span class="keyword">this</span><span class="operator">,</span> SLOT(insertCustomer(<span class="type"><a href="qstring.html">QString</a></span>)));
connect(paragraphsList<span class="operator">,</span> SIGNAL(currentTextChanged(<span class="type"><a href="qstring.html">QString</a></span>))<span class="operator">,</span>
<span class="keyword">this</span><span class="operator">,</span> SLOT(addParagraph(<span class="type"><a href="qstring.html">QString</a></span>)));
}</pre>
<p>We create the customers dock window first, and in addition to a window title, we also pass it a <tt>this</tt> pointer so that it becomes a child of <tt>MainWindow</tt>. Normally we don't have to pass a parent because widgets are parented automatically when they are laid out: but dock windows aren't laid out using layouts.</p>
<p>We've chosen to restrict the customers dock window to the left and right dock areas. (So the user cannot drag the dock window to the top or bottom dock areas.) The user can drag the dock window out of the dock areas entirely so that it becomes a free floating window. We can change this (and whether the dock window is moveable or closable) using <a href="qdockwidget.html#features-prop">QDockWidget::setFeatures</a>().</p>
<p>Once we've created the dock window we create a list widget with the dock window as parent, then we populate the list and make it the dock window's widget. Finally we add the dock widget to the <tt>MainWindow</tt> using <tt>addDockWidget()</tt>, choosing to put it in the right dock area.</p>
<p>We undertake a similar process for the paragraphs dock window, except that we don't restrict which dock areas it can be dragged to.</p>
<p>Finally we set up the signal-slot connections. If the user clicks a customer or a paragraph their <tt>currentTextChanged()</tt> signal will be emitted and we connect these to <tt>insertCustomer()</tt> and addParagraph() passing the text that was clicked.</p>
<p>We briefly discuss the rest of the implementation, but have now covered everything relating to dock windows.</p>
<pre class="cpp"> <span class="type">void</span> MainWindow<span class="operator">::</span>newLetter()
{
textEdit<span class="operator">-</span><span class="operator">></span>clear();
<span class="type"><a href="qtextcursor.html">QTextCursor</a></span> cursor(textEdit<span class="operator">-</span><span class="operator">></span>textCursor());
cursor<span class="operator">.</span>movePosition(<span class="type"><a href="qtextcursor.html">QTextCursor</a></span><span class="operator">::</span>Start);
<span class="type"><a href="qtextframe.html">QTextFrame</a></span> <span class="operator">*</span>topFrame <span class="operator">=</span> cursor<span class="operator">.</span>currentFrame();
<span class="type"><a href="qtextframeformat.html">QTextFrameFormat</a></span> topFrameFormat <span class="operator">=</span> topFrame<span class="operator">-</span><span class="operator">></span>frameFormat();
topFrameFormat<span class="operator">.</span>setPadding(<span class="number">16</span>);
topFrame<span class="operator">-</span><span class="operator">></span>setFrameFormat(topFrameFormat);
<span class="type"><a href="qtextcharformat.html">QTextCharFormat</a></span> textFormat;
<span class="type"><a href="qtextcharformat.html">QTextCharFormat</a></span> boldFormat;
boldFormat<span class="operator">.</span>setFontWeight(<span class="type"><a href="qfont.html">QFont</a></span><span class="operator">::</span>Bold);
<span class="type"><a href="qtextcharformat.html">QTextCharFormat</a></span> italicFormat;
italicFormat<span class="operator">.</span>setFontItalic(<span class="keyword">true</span>);
<span class="type"><a href="qtexttableformat.html">QTextTableFormat</a></span> tableFormat;
tableFormat<span class="operator">.</span>setBorder(<span class="number">1</span>);
tableFormat<span class="operator">.</span>setCellPadding(<span class="number">16</span>);
tableFormat<span class="operator">.</span>setAlignment(<span class="type"><a href="qt.html">Qt</a></span><span class="operator">::</span>AlignRight);
cursor<span class="operator">.</span>insertTable(<span class="number">1</span><span class="operator">,</span> <span class="number">1</span><span class="operator">,</span> tableFormat);
cursor<span class="operator">.</span>insertText(<span class="string">"The Firm"</span><span class="operator">,</span> boldFormat);
cursor<span class="operator">.</span>insertBlock();
cursor<span class="operator">.</span>insertText(<span class="string">"321 City Street"</span><span class="operator">,</span> textFormat);
cursor<span class="operator">.</span>insertBlock();
cursor<span class="operator">.</span>insertText(<span class="string">"Industry Park"</span>);
cursor<span class="operator">.</span>insertBlock();
cursor<span class="operator">.</span>insertText(<span class="string">"Some Country"</span>);
cursor<span class="operator">.</span>setPosition(topFrame<span class="operator">-</span><span class="operator">></span>lastPosition());
cursor<span class="operator">.</span>insertText(<span class="type"><a href="qdate.html">QDate</a></span><span class="operator">::</span>currentDate()<span class="operator">.</span>toString(<span class="string">"d MMMM yyyy"</span>)<span class="operator">,</span> textFormat);
cursor<span class="operator">.</span>insertBlock();
cursor<span class="operator">.</span>insertBlock();
cursor<span class="operator">.</span>insertText(<span class="string">"Dear "</span><span class="operator">,</span> textFormat);
cursor<span class="operator">.</span>insertText(<span class="string">"NAME"</span><span class="operator">,</span> italicFormat);
cursor<span class="operator">.</span>insertText(<span class="string">","</span><span class="operator">,</span> textFormat);
<span class="keyword">for</span> (<span class="type">int</span> i <span class="operator">=</span> <span class="number">0</span>; i <span class="operator"><</span> <span class="number">3</span>; <span class="operator">+</span><span class="operator">+</span>i)
cursor<span class="operator">.</span>insertBlock();
cursor<span class="operator">.</span>insertText(tr(<span class="string">"Yours sincerely,"</span>)<span class="operator">,</span> textFormat);
<span class="keyword">for</span> (<span class="type">int</span> i <span class="operator">=</span> <span class="number">0</span>; i <span class="operator"><</span> <span class="number">3</span>; <span class="operator">+</span><span class="operator">+</span>i)
cursor<span class="operator">.</span>insertBlock();
cursor<span class="operator">.</span>insertText(<span class="string">"The Boss"</span><span class="operator">,</span> textFormat);
cursor<span class="operator">.</span>insertBlock();
cursor<span class="operator">.</span>insertText(<span class="string">"ADDRESS"</span><span class="operator">,</span> italicFormat);
}</pre>
<p>In this function we clear the <a href="qtextedit.html">QTextEdit</a> so that it is empty. Next we create a <a href="qtextcursor.html">QTextCursor</a> on the <a href="qtextedit.html">QTextEdit</a>. We move the cursor to the start of the document and create and format a frame. We then create some character formats and a table format. We insert a table into the document and insert the company's name and address into a table using the table and character formats we created earlier. Then we insert the skeleton of the letter including two markers <tt>NAME</tt> and <tt>ADDRESS</tt>. We will also use the <tt>Yours sincerely,</tt> text as a marker.</p>
<pre class="cpp"> <span class="type">void</span> MainWindow<span class="operator">::</span>insertCustomer(<span class="keyword">const</span> <span class="type"><a href="qstring.html">QString</a></span> <span class="operator">&</span>customer)
{
<span class="keyword">if</span> (customer<span class="operator">.</span>isEmpty())
<span class="keyword">return</span>;
<span class="type"><a href="qstringlist.html">QStringList</a></span> customerList <span class="operator">=</span> customer<span class="operator">.</span>split(<span class="string">", "</span>);
<span class="type"><a href="qtextdocument.html">QTextDocument</a></span> <span class="operator">*</span>document <span class="operator">=</span> textEdit<span class="operator">-</span><span class="operator">></span>document();
<span class="type"><a href="qtextcursor.html">QTextCursor</a></span> cursor <span class="operator">=</span> document<span class="operator">-</span><span class="operator">></span>find(<span class="string">"NAME"</span>);
<span class="keyword">if</span> (<span class="operator">!</span>cursor<span class="operator">.</span>isNull()) {
cursor<span class="operator">.</span>beginEditBlock();
cursor<span class="operator">.</span>insertText(customerList<span class="operator">.</span>at(<span class="number">0</span>));
<span class="type"><a href="qtextcursor.html">QTextCursor</a></span> oldcursor <span class="operator">=</span> cursor;
cursor <span class="operator">=</span> document<span class="operator">-</span><span class="operator">></span>find(<span class="string">"ADDRESS"</span>);
<span class="keyword">if</span> (<span class="operator">!</span>cursor<span class="operator">.</span>isNull()) {
<span class="keyword">for</span> (<span class="type">int</span> i <span class="operator">=</span> <span class="number">1</span>; i <span class="operator"><</span> customerList<span class="operator">.</span>size(); <span class="operator">+</span><span class="operator">+</span>i) {
cursor<span class="operator">.</span>insertBlock();
cursor<span class="operator">.</span>insertText(customerList<span class="operator">.</span>at(i));
}
cursor<span class="operator">.</span>endEditBlock();
}
<span class="keyword">else</span>
oldcursor<span class="operator">.</span>endEditBlock();
}
}</pre>
<p>If the user clicks a customer we split the customer details into pieces. We then look for the <tt>NAME</tt> marker using the <tt>find()</tt> function. This function selects the text it finds, so when we call <tt>insertText()</tt> with the customer's name the name replaces the marker. We then look for the <tt>ADDRESS</tt> marker and replace it with each line of the customer's address. Notice that we wrapped all the insertions between a <tt>beginEditBlock()</tt> and <tt>endEditBlock()</tt> pair. This means that the entire name and address insertion is treated as a single operation by the <a href="qtextedit.html">QTextEdit</a>, so a single undo will revert all the insertions.</p>
<pre class="cpp"> <span class="type">void</span> MainWindow<span class="operator">::</span>addParagraph(<span class="keyword">const</span> <span class="type"><a href="qstring.html">QString</a></span> <span class="operator">&</span>paragraph)
{
<span class="keyword">if</span> (paragraph<span class="operator">.</span>isEmpty())
<span class="keyword">return</span>;
<span class="type"><a href="qtextdocument.html">QTextDocument</a></span> <span class="operator">*</span>document <span class="operator">=</span> textEdit<span class="operator">-</span><span class="operator">></span>document();
<span class="type"><a href="qtextcursor.html">QTextCursor</a></span> cursor <span class="operator">=</span> document<span class="operator">-</span><span class="operator">></span>find(tr(<span class="string">"Yours sincerely,"</span>));
<span class="keyword">if</span> (cursor<span class="operator">.</span>isNull())
<span class="keyword">return</span>;
cursor<span class="operator">.</span>beginEditBlock();
cursor<span class="operator">.</span>movePosition(<span class="type"><a href="qtextcursor.html">QTextCursor</a></span><span class="operator">::</span>PreviousBlock<span class="operator">,</span> <span class="type"><a href="qtextcursor.html">QTextCursor</a></span><span class="operator">::</span>MoveAnchor<span class="operator">,</span> <span class="number">2</span>);
cursor<span class="operator">.</span>insertBlock();
cursor<span class="operator">.</span>insertText(paragraph);
cursor<span class="operator">.</span>insertBlock();
cursor<span class="operator">.</span>endEditBlock();
}</pre>
<p>This function works in a similar way to <tt>insertCustomer()</tt>. First we look for the marker, in this case, <tt>Yours sincerely,</tt>, and then replace it with the standard paragraph that the user clicked. Again we use a <tt>beginEditBlock()</tt> ... <tt>endEditBlock()</tt> pair so that the insertion can be undone as a single operation.</p>
<pre class="cpp"> <span class="type">void</span> MainWindow<span class="operator">::</span>print()
{
<span class="preprocessor">#ifndef QT_NO_PRINTDIALOG</span>
<span class="type"><a href="qtextdocument.html">QTextDocument</a></span> <span class="operator">*</span>document <span class="operator">=</span> textEdit<span class="operator">-</span><span class="operator">></span>document();
<span class="type"><a href="qprinter.html">QPrinter</a></span> printer;
<span class="type"><a href="qprintdialog.html">QPrintDialog</a></span> <span class="operator">*</span>dlg <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="qprintdialog.html">QPrintDialog</a></span>(<span class="operator">&</span>printer<span class="operator">,</span> <span class="keyword">this</span>);
<span class="keyword">if</span> (dlg<span class="operator">-</span><span class="operator">></span>exec() <span class="operator">!</span><span class="operator">=</span> <span class="type"><a href="qdialog.html">QDialog</a></span><span class="operator">::</span>Accepted)
<span class="keyword">return</span>;
document<span class="operator">-</span><span class="operator">></span>print(<span class="operator">&</span>printer);
statusBar()<span class="operator">-</span><span class="operator">></span>showMessage(tr(<span class="string">"Ready"</span>)<span class="operator">,</span> <span class="number">2000</span>);
<span class="preprocessor">#endif</span>
}</pre>
<p>Qt's <a href="qtextdocument.html">QTextDocument</a> class makes printing documents easy. We simply take the <a href="qtextedit.html">QTextEdit</a>'s <a href="qtextdocument.html">QTextDocument</a>, set up the printer and print the document.</p>
<pre class="cpp"> <span class="type">void</span> MainWindow<span class="operator">::</span>save()
{
<span class="type"><a href="qstring.html">QString</a></span> fileName <span class="operator">=</span> <span class="type"><a href="qfiledialog.html">QFileDialog</a></span><span class="operator">::</span>getSaveFileName(<span class="keyword">this</span><span class="operator">,</span>
tr(<span class="string">"Choose a file name"</span>)<span class="operator">,</span> <span class="string">"."</span><span class="operator">,</span>
tr(<span class="string">"HTML (*.html *.htm)"</span>));
<span class="keyword">if</span> (fileName<span class="operator">.</span>isEmpty())
<span class="keyword">return</span>;
<span class="type"><a href="qfile.html">QFile</a></span> file(fileName);
<span class="keyword">if</span> (<span class="operator">!</span>file<span class="operator">.</span>open(<span class="type"><a href="qfile.html">QFile</a></span><span class="operator">::</span>WriteOnly <span class="operator">|</span> <span class="type"><a href="qfile.html">QFile</a></span><span class="operator">::</span>Text)) {
<span class="type"><a href="qmessagebox.html">QMessageBox</a></span><span class="operator">::</span>warning(<span class="keyword">this</span><span class="operator">,</span> tr(<span class="string">"Dock Widgets"</span>)<span class="operator">,</span>
tr(<span class="string">"Cannot write file %1:\n%2."</span>)
<span class="operator">.</span>arg(fileName)
<span class="operator">.</span>arg(file<span class="operator">.</span>errorString()));
<span class="keyword">return</span>;
}
<span class="type"><a href="qtextstream.html">QTextStream</a></span> out(<span class="operator">&</span>file);
<span class="type"><a href="qapplication.html">QApplication</a></span><span class="operator">::</span>setOverrideCursor(<span class="type"><a href="qt.html">Qt</a></span><span class="operator">::</span>WaitCursor);
out <span class="operator"><</span><span class="operator"><</span> textEdit<span class="operator">-</span><span class="operator">></span>toHtml();
<span class="type"><a href="qapplication.html">QApplication</a></span><span class="operator">::</span>restoreOverrideCursor();
statusBar()<span class="operator">-</span><span class="operator">></span>showMessage(tr(<span class="string">"Saved '%1'"</span>)<span class="operator">.</span>arg(fileName)<span class="operator">,</span> <span class="number">2000</span>);
}</pre>
<p><a href="qtextedit.html">QTextEdit</a> can output its contents in HTML format, so we prompt the user for the name of an HTML file and if they provide one we simply write the <a href="qtextedit.html">QTextEdit</a>'s contents in HTML format to the file.</p>
<pre class="cpp"> <span class="type">void</span> MainWindow<span class="operator">::</span>undo()
{
<span class="type"><a href="qtextdocument.html">QTextDocument</a></span> <span class="operator">*</span>document <span class="operator">=</span> textEdit<span class="operator">-</span><span class="operator">></span>document();
document<span class="operator">-</span><span class="operator">></span>undo();
}</pre>
<p>If the focus is in the <a href="qtextedit.html">QTextEdit</a>, pressing <b>Ctrl+Z</b> undoes as expected. But for the user's convenience we provide an application-wide undo function that simply calls the <a href="qtextedit.html">QTextEdit</a>'s undo: this means that the user can undo regardless of where the focus is in the application.</p>
</div>
<!-- @@@mainwindows/dockwidgets -->
</div>
</div>
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2015 The Qt Company Ltd.
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>
Qt and respective logos are trademarks of The Qt Company Ltd
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>
