<!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>AlbumShaper: Annotating Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.2 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>Annotating Class Reference</h1><!-- doxytag: class="Annotating" -->
<p><code>#include <<a class="el" href="annotating_8h_source.html">annotating.h</a>></code></p>
<p><a href="classAnnotating-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static QString </td><td class="memItemRight" valign="bottom"><a class="el" href="classAnnotating.html#ad3e66eafc25b6a6111de970f976c251c">filename</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">returns the html filename <a href="#ad3e66eafc25b6a6111de970f976c251c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classAnnotating.html#a171892c7f268378d11a3fe55f734ce39">generateHTML</a> (QTextStream::Encoding type, QString charSet)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">generates the html file <a href="#a171892c7f268378d11a3fe55f734ce39"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Definition at line <a class="el" href="annotating_8h_source.html#l00016">16</a> of file <a class="el" href="annotating_8h_source.html">annotating.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ad3e66eafc25b6a6111de970f976c251c"></a><!-- doxytag: member="Annotating::filename" ref="ad3e66eafc25b6a6111de970f976c251c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">QString Annotating::filename </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>returns the html filename </p>
<p>Definition at line <a class="el" href="annotating_8cpp_source.html#l00024">24</a> of file <a class="el" href="annotating_8cpp_source.html">annotating.cpp</a>.</p>
<p>References <a class="el" href="config_8cpp_source.html#l00023">TEMP_DIR</a>.</p>
<p>Referenced by <a class="el" href="annotating_8cpp_source.html#l00029">generateHTML()</a>, and <a class="el" href="helpWindow_8cpp_source.html#l00181">HelpWindow::showCurrentPage()</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00025"></a>00025 {
<a name="l00026"></a>00026 <span class="keywordflow">return</span> QString(<span class="stringliteral">"%1/annotating.html"</span>).arg(<a class="code" href="config_8cpp.html#a8e603096352908a187b5364096a8d581">TEMP_DIR</a>);
<a name="l00027"></a>00027 }
</pre></div></p>
</div>
</div>
<a class="anchor" id="a171892c7f268378d11a3fe55f734ce39"></a><!-- doxytag: member="Annotating::generateHTML" ref="a171892c7f268378d11a3fe55f734ce39" args="(QTextStream::Encoding type, QString charSet)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Annotating::generateHTML </td>
<td>(</td>
<td class="paramtype">QTextStream::Encoding </td>
<td class="paramname"> <em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"> <em>charSet</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>generates the html file </p>
<p>Definition at line <a class="el" href="annotating_8cpp_source.html#l00029">29</a> of file <a class="el" href="annotating_8cpp_source.html">annotating.cpp</a>.</p>
<p>References <a class="el" href="annotating_8cpp_source.html#l00024">filename()</a>, and <a class="el" href="config_8cpp_source.html#l00018">IMAGE_PATH</a>.</p>
<p>Referenced by <a class="el" href="helpWindow_8cpp_source.html#l00039">HelpWindow::HelpWindow()</a>.</p>
<p><div class="fragment"><pre class="fragment"><a name="l00030"></a>00030 {
<a name="l00031"></a>00031 <span class="comment">//create/open html file</span>
<a name="l00032"></a>00032 QFile file( <a class="code" href="classAnnotating.html#ad3e66eafc25b6a6111de970f976c251c" title="returns the html filename">filename</a>() );
<a name="l00033"></a>00033 <span class="keywordflow">if</span>(file.open(IO_WriteOnly))
<a name="l00034"></a>00034 {
<a name="l00035"></a>00035 <span class="comment">//-----</span>
<a name="l00036"></a>00036 QTextStream stream;
<a name="l00037"></a>00037 stream.setEncoding( type );
<a name="l00038"></a>00038 stream.setDevice( &file );
<a name="l00039"></a>00039 <span class="comment">//-----</span>
<a name="l00040"></a>00040 stream << <span class="stringliteral">"<html><head>\n"</span>;
<a name="l00041"></a>00041 stream << <span class="stringliteral">"<meta http-equiv='Content-Type' content='text/html; charset="</span> << charSet << <span class="stringliteral">"'>\n"</span>;
<a name="l00042"></a>00042 stream << <span class="stringliteral">"</head><body>\n"</span>;
<a name="l00043"></a>00043 stream << <span class="stringliteral">"<table cellpadding='4'><tr>\n"</span>;
<a name="l00044"></a>00044 stream << <span class="stringliteral">"<td><img src='"</span> << <a class="code" href="config_8cpp.html#a59e02362a9a29a755712dc830a3eb513">IMAGE_PATH</a> << <span class="stringliteral">"helpImages/asHelpLogoSmall.png'></td>\n"</span>;
<a name="l00045"></a>00045 stream << <span class="stringliteral">"<td valign='middle'><font face='Arial, sans-serif' size='+3'>"</span>;
<a name="l00046"></a>00046 stream << HelpWindow::tr(<span class="stringliteral">"Annotating Albums"</span>) << <span class="stringliteral">"</font></td>\n"</span>;
<a name="l00047"></a>00047 stream << <span class="stringliteral">"</tr></table>\n"</span>;
<a name="l00048"></a>00048
<a name="l00049"></a>00049 stream << <span class="stringliteral">"<font face='Arial, sans-serif'>\n"</span>;
<a name="l00050"></a>00050 stream << <span class="stringliteral">"<table cellspacing='10' cellpadding='0'><tr><td>\n"</span>;
<a name="l00051"></a>00051 <span class="comment">//------------------------------------------------------------------ </span>
<a name="l00052"></a>00052 stream << <span class="stringliteral">" <table width='100%' cellpadding='4' cellspacing='0'><tr><td bgcolor='lightgray'>\n"</span>;
<a name="l00053"></a>00053 stream << <span class="stringliteral">" <font size='+1'><b>"</span> << HelpWindow::tr(<span class="stringliteral">"Labeling Photos:"</span>) <<<span class="stringliteral">"</b></font>\n"</span>;
<a name="l00054"></a>00054 stream << <span class="stringliteral">" </td></tr></table>\n"</span>;
<a name="l00055"></a>00055
<a name="l00056"></a>00056 stream << <span class="stringliteral">"<table cellpadding='4' cellspacing='0'><tr><td valign='middle'>\n"</span>;
<a name="l00057"></a>00057 stream << <span class="stringliteral">" <p align='justify'>\n"</span>;
<a name="l00058"></a>00058 stream << HelpWindow::tr(<span class="stringliteral">"Labeling photos is easy in Album Shaper! Hover over a picture and click the little info button that appears in the lower right corner. The photo will expand to give you a better view and provide space for writing the caption. When you're done, click elsewhere in the collection, or just hit Escape. Alternatively, you can just use the keyboard. The arrow keys will move the current selection. Enter expands the currently selected photo to edit its caption. Escape applies the photo caption and returns to organizing."</span>);
<a name="l00059"></a>00059
<a name="l00060"></a>00060 stream << <span class="stringliteral">"</td><td valign='middle'>\n"</span>;
<a name="l00061"></a>00061 stream << <span class="stringliteral">" <img src='"</span> << IMAGE_PATH << <span class="stringliteral">"helpImages/settingPhotoDescription.png'>\n"</span>;
<a name="l00062"></a>00062 stream << <span class="stringliteral">"</td></tr></table>\n"</span>;
<a name="l00063"></a>00063
<a name="l00064"></a>00064 stream << <span class="stringliteral">" <p align='justify'>\n"</span>;
<a name="l00065"></a>00065 stream << HelpWindow::tr(<span class="stringliteral">"Album Shaper provides a number of tools that operate on multiple photos at once. If you want to remove a number of photos descriptions at once, select which photos you intend to affect, and select <font color='red'>Photos &rarr; Remove Description</font>."</span>);
<a name="l00066"></a>00066
<a name="l00067"></a>00067 <span class="comment">//------------------------------------------------------------------ </span>
<a name="l00068"></a>00068 stream << <span class="stringliteral">"</td></tr><tr><td>\n"</span>;
<a name="l00069"></a>00069 <span class="comment">//------------------------------------------------------------------ </span>
<a name="l00070"></a>00070
<a name="l00071"></a>00071 stream << <span class="stringliteral">" <table width='100%' cellpadding='4' cellspacing='0'><tr><td bgcolor='lightgray'>\n"</span>;
<a name="l00072"></a>00072 stream << <span class="stringliteral">" <font size='+1'><b>"</span> << HelpWindow::tr(<span class="stringliteral">"Album and Collection Information:"</span>) << <span class="stringliteral">"</b></font>\n"</span>;
<a name="l00073"></a>00073
<a name="l00074"></a>00074 stream << <span class="stringliteral">" </td></tr></table>\n"</span>;
<a name="l00075"></a>00075 stream << <span class="stringliteral">"<table cellpadding='4' cellspacing='0'><tr><td valign='middle'>\n"</span>;
<a name="l00076"></a>00076 stream << <span class="stringliteral">" <img src='"</span> << IMAGE_PATH << <span class="stringliteral">"helpImages/albumInfo.png'>\n"</span>;
<a name="l00077"></a>00077 stream << <span class="stringliteral">"</td><td valign='middle'>\n"</span>;
<a name="l00078"></a>00078 stream << <span class="stringliteral">" <p align='justify'>\n"</span>;
<a name="l00079"></a>00079
<a name="l00080"></a>00080 stream << HelpWindow::tr(<span class="stringliteral">"At the top left your album's name, description, and author can be specified."</span>);
<a name="l00081"></a>00081
<a name="l00082"></a>00082 stream << <span class="stringliteral">"</td></tr></table>\n"</span>;
<a name="l00083"></a>00083
<a name="l00084"></a>00084 <span class="comment">//------------------------------------------------------------------ </span>
<a name="l00085"></a>00085 stream << <span class="stringliteral">"</td></tr><tr><td>\n"</span>;
<a name="l00086"></a>00086 <span class="comment">//------------------------------------------------------------------ </span>
<a name="l00087"></a>00087
<a name="l00088"></a>00088 stream << <span class="stringliteral">"<table cellpadding='4' cellspacing='0'><tr><td valign='middle'>\n"</span>;
<a name="l00089"></a>00089 stream << <span class="stringliteral">" <p align='justify'>\n"</span>;
<a name="l00090"></a>00090 stream << HelpWindow::tr(<span class="stringliteral">"To modify a collection's information, first select the collection within the collections listing on the left, then fill in its name and description at the top right."</span>);
<a name="l00091"></a>00091 stream << <span class="stringliteral">"</td><td valign='middle'>\n"</span>;
<a name="l00092"></a>00092 stream << <span class="stringliteral">" <img src='"</span> << IMAGE_PATH << <span class="stringliteral">"helpImages/collectionInfo.png'>\n"</span>;
<a name="l00093"></a>00093 stream << <span class="stringliteral">"</td></tr></table>\n"</span>;
<a name="l00094"></a>00094
<a name="l00095"></a>00095 <span class="comment">//------------------------------------------------------------------ </span>
<a name="l00096"></a>00096 stream << <span class="stringliteral">"</td></tr><tr><td>\n"</span>;
<a name="l00097"></a>00097 <span class="comment">//------------------------------------------------------------------ </span>
<a name="l00098"></a>00098 stream << <span class="stringliteral">" <table width='100%' cellpadding='4' cellspacing='0'><tr><td bgcolor='lightgray'>\n"</span>;
<a name="l00099"></a>00099 stream << <span class="stringliteral">" <font size='+1'><b>"</span> << HelpWindow::tr(<span class="stringliteral">"Cover Images:"</span>) << <span class="stringliteral">"</b></font>\n"</span>;
<a name="l00100"></a>00100 stream << <span class="stringliteral">" </td></tr></table>\n"</span>;
<a name="l00101"></a>00101
<a name="l00102"></a>00102 stream << <span class="stringliteral">"<table cellpadding='4' cellspacing='0'><tr><td valign='middle'>\n"</span>;
<a name="l00103"></a>00103 stream << <span class="stringliteral">" <img src='"</span> << IMAGE_PATH << <span class="stringliteral">"helpImages/setRepImage.png'>\n"</span>;
<a name="l00104"></a>00104 stream << <span class="stringliteral">"</td><td valign='middle'>\n"</span>;
<a name="l00105"></a>00105 stream << <span class="stringliteral">" <p align='justify'>\n"</span>;
<a name="l00106"></a>00106
<a name="l00107"></a>00107 stream << HelpWindow::tr(<span class="stringliteral">"It is easier to distinguish between albums and collections using images rather than text, and Album Shaper allows you to do that by setting album and collection cover images."</span>);
<a name="l00108"></a>00108
<a name="l00109"></a>00109 stream << <span class="stringliteral">"<p align='justify'>\n"</span>;
<a name="l00110"></a>00110
<a name="l00111"></a>00111 stream << HelpWindow::tr(<span class="stringliteral">"To use a photo to represent your album, drag and drop it to the left of the album name, description, and author fields. A small version of the photo should slide in from the left, and will be used when creating web galleries in the future."</span>);
<a name="l00112"></a>00112
<a name="l00113"></a>00113 stream << <span class="stringliteral">"<p align='justify'>\n"</span>;
<a name="l00114"></a>00114
<a name="l00115"></a>00115 stream << HelpWindow::tr(<span class="stringliteral">"A collection's cover image can be set in a similar fashion by dragging and dropping a photo to the left of the collection name and description fields. One can accomplish either of these tasks by right clicking on a photo."</span>);
<a name="l00116"></a>00116
<a name="l00117"></a>00117 stream << <span class="stringliteral">"</td></tr></table>\n"</span>;
<a name="l00118"></a>00118 <span class="comment">//------------------------------------------------------------------ </span>
<a name="l00119"></a>00119 stream << <span class="stringliteral">"</td></tr><tr><td>\n"</span>;
<a name="l00120"></a>00120 <span class="comment">//------------------------------------------------------------------ </span>
<a name="l00121"></a>00121 stream << <span class="stringliteral">"<table cellpadding='4' cellspacing='0'><tr><td valign='middle'>\n"</span>;
<a name="l00122"></a>00122 stream << <span class="stringliteral">" <p align='justify'>\n"</span>;
<a name="l00123"></a>00123 stream << HelpWindow::tr(<span class="stringliteral">"You can replace cover images in the future by dropping a new photo on top of the original cover image. A cover image can be removed by hovering over and clicking the red button that appears."</span>) << <span class="stringliteral">"\n"</span>;
<a name="l00124"></a>00124 stream << <span class="stringliteral">"</td><td valign='middle'>\n"</span>;
<a name="l00125"></a>00125 stream << <span class="stringliteral">" <img src='"</span> << IMAGE_PATH << <span class="stringliteral">"helpImages/removeCollectionImage.png'>\n"</span>;
<a name="l00126"></a>00126 stream << <span class="stringliteral">"</td></tr>\n"</span>;
<a name="l00127"></a>00127 <span class="comment">//-----------------------</span>
<a name="l00128"></a>00128 stream << <span class="stringliteral">"</table></font>\n"</span>;
<a name="l00129"></a>00129 stream << <span class="stringliteral">"</body></html>\n"</span>;
<a name="l00130"></a>00130 file.close();
<a name="l00131"></a>00131 }
<a name="l00132"></a>00132 }
</pre></div></p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="annotating_8h_source.html">annotating.h</a></li>
<li><a class="el" href="annotating_8cpp_source.html">annotating.cpp</a></li>
</ul>
</div>
<hr size="1"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
</body>
</html>
