File: draganddrop-delayedencoding.html

package info (click to toggle)
qt4-x11 4%3A4.8.2%2Bdfsg-11
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 701,696 kB
  • sloc: cpp: 2,686,179; ansic: 375,485; python: 25,859; sh: 19,349; xml: 17,091; perl: 14,765; yacc: 5,383; asm: 5,038; makefile: 1,259; lex: 555; ruby: 526; objc: 347; cs: 112; pascal: 112; php: 54; sed: 34
file content (167 lines) | stat: -rw-r--r-- 13,058 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
<?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" />
<!-- delayedencoding.qdoc -->
  <title>Qt 4.8: Delayed Encoding Example</title>
  <link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="content"> 
    <a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
  </div>
  <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>Delayed Encoding Example</li>
    </ul>
  </div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#sourcewidget-class-definition">SourceWidget Class Definition</a></li>
<li class="level1"><a href="#sourcewidget-class-implementation">SourceWidget Class Implementation</a></li>
<li class="level1"><a href="#mimedata-class-definition">MimeData Class Definition</a></li>
<li class="level1"><a href="#mimedata-class-implementation">MimeData Class Implementation</a></li>
</ul>
</div>
<h1 class="title">Delayed Encoding Example</h1>
<span class="subtitle"></span>
<!-- $$$draganddrop/delayedencoding-description -->
<div class="descr"> <a name="details"></a>
<p>Files:</p>
<ul>
<li><a href="draganddrop-delayedencoding-mimedata-cpp.html">draganddrop/delayedencoding/mimedata.cpp</a></li>
<li><a href="draganddrop-delayedencoding-mimedata-h.html">draganddrop/delayedencoding/mimedata.h</a></li>
<li><a href="draganddrop-delayedencoding-sourcewidget-cpp.html">draganddrop/delayedencoding/sourcewidget.cpp</a></li>
<li><a href="draganddrop-delayedencoding-sourcewidget-h.html">draganddrop/delayedencoding/sourcewidget.h</a></li>
<li><a href="draganddrop-delayedencoding-images-example-svg.html">draganddrop/delayedencoding/images/example.svg</a></li>
<li><a href="draganddrop-delayedencoding-main-cpp.html">draganddrop/delayedencoding/main.cpp</a></li>
<li><a href="draganddrop-delayedencoding-delayedencoding-pro.html">draganddrop/delayedencoding/delayedencoding.pro</a></li>
<li><a href="draganddrop-delayedencoding-delayedencoding-qrc.html">draganddrop/delayedencoding/delayedencoding.qrc</a></li>
</ul>
<p>Images:</p>
<ul>
<li><a href="images/used-in-examples/draganddrop/delayedencoding/images/drag.png">draganddrop/delayedencoding/images/drag.png</a></li>
</ul>
<p>The Delayed Encoding example shows how to delay preparing of data for drag and drop operations until a drop target is found.<p class="centerAlign"><img src="images/delayedecoding-example.png" alt="" /></p><p>The <b>Export</b> push button is pressed down to start the drag. The data for the drag and drop operation is not processed until the user of the application has found a valid drop target. This removes redundant processing if the operation is aborted. In our case, we have an SVG image that we wish to send as the <tt>&quot;image/png&quot;</tt> MIME type. It is the conversion from SVG to PNG we wish to delay - it can be quite expensive.</p>
<p>The example is implemented in two classes: <tt>SourceWidget</tt> and <tt>MimeData</tt>. The <tt>SourceWidget</tt> class sets up the GUI and starts the drag operation on request. The <tt>MimeData</tt> class, which inherits <a href="qmimedata.html">QMimeData</a>, sends a signal when a drop target is found. This signal is connected to a slot in <tt>SourceWidget</tt>, which does the conversion from SVG to PNG.</p>
<a name="sourcewidget-class-definition"></a>
<h2>SourceWidget Class Definition</h2>
<p>The <tt>SourceWidget</tt> class starts drag and drop operations and also does the image conversion.</p>
<pre class="cpp"> <span class="keyword">public</span> <span class="keyword">slots</span>:
     <span class="type">void</span> createData(<span class="keyword">const</span> <span class="type"><a href="qstring.html">QString</a></span> <span class="operator">&amp;</span>mimetype);
     <span class="type">void</span> startDrag();

 <span class="keyword">private</span>:
     <span class="type"><a href="qbytearray.html">QByteArray</a></span> imageData;
     <span class="type"><a href="qsvgwidget.html">QSvgWidget</a></span> <span class="operator">*</span>imageLabel;
     MimeData <span class="operator">*</span>mimeData;</pre>
<p>The <b>Export</b> push button is connected to the <tt>startDrag()</tt> slot. The <tt>createData()</tt> slot will be invoked when data for the drag and drop operation is to be created.</p>
<a name="sourcewidget-class-implementation"></a>
<h2>SourceWidget Class Implementation</h2>
<p>Let's start our code tour with a look at the <tt>startDrag()</tt> slot.</p>
<pre class="cpp"> <span class="type">void</span> SourceWidget<span class="operator">::</span>startDrag()
 {
     mimeData <span class="operator">=</span> <span class="keyword">new</span> MimeData;

     connect(mimeData<span class="operator">,</span> SIGNAL(dataRequested(<span class="type"><a href="qstring.html">QString</a></span>))<span class="operator">,</span>
             <span class="keyword">this</span><span class="operator">,</span> SLOT(createData(<span class="type"><a href="qstring.html">QString</a></span>))<span class="operator">,</span> <span class="type"><a href="qt.html">Qt</a></span><span class="operator">::</span>DirectConnection);

     <span class="type"><a href="qdrag.html">QDrag</a></span> <span class="operator">*</span>drag <span class="operator">=</span> <span class="keyword">new</span> <span class="type"><a href="qdrag.html">QDrag</a></span>(<span class="keyword">this</span>);
     drag<span class="operator">-</span><span class="operator">&gt;</span>setMimeData(mimeData);
     drag<span class="operator">-</span><span class="operator">&gt;</span>setPixmap(<span class="type"><a href="qpixmap.html">QPixmap</a></span>(<span class="string">&quot;:/images/drag.png&quot;</span>));

     drag<span class="operator">-</span><span class="operator">&gt;</span>exec(<span class="type"><a href="qt.html">Qt</a></span><span class="operator">::</span>CopyAction);
 }</pre>
<p>We emit <tt>dataRequested()</tt> from <tt>MimeData</tt> when the operation has found a valid drop target.</p>
<p>We gallop along to <tt>createData()</tt>:</p>
<pre class="cpp"> <span class="type">void</span> SourceWidget<span class="operator">::</span>createData(<span class="keyword">const</span> <span class="type"><a href="qstring.html">QString</a></span> <span class="operator">&amp;</span>mimeType)
 {
     <span class="keyword">if</span> (mimeType <span class="operator">!</span><span class="operator">=</span> <span class="string">&quot;image/png&quot;</span>)
         <span class="keyword">return</span>;

     <span class="type"><a href="qimage.html">QImage</a></span> image(imageLabel<span class="operator">-</span><span class="operator">&gt;</span>size()<span class="operator">,</span> <span class="type"><a href="qimage.html">QImage</a></span><span class="operator">::</span>Format_RGB32);
     <span class="type"><a href="qpainter.html">QPainter</a></span> painter;
     painter<span class="operator">.</span>begin(<span class="operator">&amp;</span>image);
     imageLabel<span class="operator">-</span><span class="operator">&gt;</span>renderer()<span class="operator">-</span><span class="operator">&gt;</span>render(<span class="operator">&amp;</span>painter);
     painter<span class="operator">.</span>end();

     <span class="type"><a href="qbytearray.html">QByteArray</a></span> data;
     <span class="type"><a href="qbuffer.html">QBuffer</a></span> buffer(<span class="operator">&amp;</span>data);
     buffer<span class="operator">.</span>open(<span class="type"><a href="qiodevice.html">QIODevice</a></span><span class="operator">::</span>WriteOnly);
     image<span class="operator">.</span>save(<span class="operator">&amp;</span>buffer<span class="operator">,</span> <span class="string">&quot;PNG&quot;</span>);
     buffer<span class="operator">.</span>close();

     mimeData<span class="operator">-</span><span class="operator">&gt;</span>setData(<span class="string">&quot;image/png&quot;</span><span class="operator">,</span> data);
 }</pre>
<p>Fortunately, Qt provides <a href="qsvgrenderer.html">QSvgRenderer</a>, which can render the SVG image to any <a href="qpaintdevice.html">QPaintDevice</a>. Also, <a href="qimage.html">QImage</a> has no problems saving to the PNG format.</p>
<p>Finally, we can give the data to <tt>MimeData</tt>.</p>
<a name="mimedata-class-definition"></a>
<h2>MimeData Class Definition</h2>
<p>The <tt>MimeData</tt> class inherits <a href="qmimedata.html">QMimeData</a> and makes it possible to delay preparing of the data for a drag and drop operation.</p>
<pre class="cpp"> <span class="keyword">class</span> MimeData : <span class="keyword">public</span> <span class="type"><a href="qmimedata.html">QMimeData</a></span>
 {
     Q_OBJECT

 <span class="keyword">public</span>:
     MimeData();
     <span class="type"><a href="qstringlist.html">QStringList</a></span> formats() <span class="keyword">const</span>;

 <span class="keyword">signals</span>:
     <span class="type">void</span> dataRequested(<span class="keyword">const</span> <span class="type"><a href="qstring.html">QString</a></span> <span class="operator">&amp;</span>mimeType) <span class="keyword">const</span>;

 <span class="keyword">protected</span>:
     <span class="type"><a href="qvariant.html">QVariant</a></span> retrieveData(<span class="keyword">const</span> <span class="type"><a href="qstring.html">QString</a></span> <span class="operator">&amp;</span>mimetype<span class="operator">,</span> <span class="type"><a href="qvariant.html">QVariant</a></span><span class="operator">::</span>Type type) <span class="keyword">const</span>;
 };</pre>
<p>We will look closer at <tt>retrieveData()</tt> and <tt>formats()</tt> in the next section.</p>
<a name="mimedata-class-implementation"></a>
<h2>MimeData Class Implementation</h2>
<pre class="cpp"> <span class="type"><a href="qstringlist.html">QStringList</a></span> MimeData<span class="operator">::</span>formats() <span class="keyword">const</span>
 {
     <span class="keyword">return</span> <span class="type"><a href="qmimedata.html">QMimeData</a></span><span class="operator">::</span>formats() <span class="operator">&lt;</span><span class="operator">&lt;</span> <span class="string">&quot;image/png&quot;</span>;
 }</pre>
<p>In the <tt>formats()</tt> function, we return the format of the data we provide. This is the <tt>image/png</tt> MIME type.</p>
<pre class="cpp"> <span class="type"><a href="qvariant.html">QVariant</a></span> MimeData<span class="operator">::</span>retrieveData(<span class="keyword">const</span> <span class="type"><a href="qstring.html">QString</a></span> <span class="operator">&amp;</span>mimeType<span class="operator">,</span> <span class="type"><a href="qvariant.html">QVariant</a></span><span class="operator">::</span>Type type)
          <span class="keyword">const</span>
 {
     <span class="keyword">emit</span> dataRequested(mimeType);

     <span class="keyword">return</span> <span class="type"><a href="qmimedata.html">QMimeData</a></span><span class="operator">::</span>retrieveData(mimeType<span class="operator">,</span> type);
 }</pre>
<p><tt>retrieveData()</tt> is reimplemented from <a href="qmimedata.html">QMimeData</a> and is called when the data is requested by the drag and drop operation. Fortunately for us, this happens when the operation is finishing, i.e&#x2e;, when a drop target has been found.</p>
<p>We emit the <tt>dataRequested()</tt> signal, which is picked up by <tt>SourceWidget</tt>. The <tt>SourceWidget</tt> (as already explained) sets the data on <tt>MimeData</tt> with <a href="qmimedata.html#setData">setData()</a>.</p>
</div>
<!-- @@@draganddrop/delayedencoding -->
  <div class="ft">
    <span></span>
  </div>
</div> 
<div class="footer">
    <p>
      <acronym title="Copyright">&copy;</acronym> 2012 Nokia Corporation 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>
      Nokia, Qt and their respective logos are trademarks of Nokia Corporation 
      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>
</body>
</html>