Merge branch 'aboutbox' into development

src/Typica.pro

@@ -1,26 +1,30 @@
-######################################################################
-# Automatically generated by qmake (2.01a) Sat May 23 23:41:13 2009
-######################################################################
-
-QT += script
-QT += xml
-QT += sql
-QT += xmlpatterns
-QT += scripttools
-QT += webkit
-
-include(3rdparty/qextserialport/src/qextserialport.pri)
-
-TEMPLATE = app
-TARGET = 
-DEPENDPATH += .
-
-# Input
-HEADERS += moc_typica.cpp
-SOURCES += typica.cpp
-
-RESOURCES += \
-    resources.qrc
-
-RC_FILE = typica.rc
-ICON = resources/icons/appicons/logo.icns
+######################################################################
+# Automatically generated by qmake (2.01a) Sat May 23 23:41:13 2009
+######################################################################
+
+QT += script
+QT += xml
+QT += sql
+QT += xmlpatterns
+QT += scripttools
+QT += webkit
+
+include(3rdparty/qextserialport/src/qextserialport.pri)
+
+TEMPLATE = app
+TARGET = 
+DEPENDPATH += .
+
+# Input
+HEADERS += moc_typica.cpp \
+    helpmenu.h \
+    abouttypica.h
+SOURCES += typica.cpp \
+    helpmenu.cpp \
+    abouttypica.cpp
+
+RESOURCES += \
+    resources.qrc
+
+RC_FILE = typica.rc
+ICON = resources/icons/appicons/logo.icns

src/abouttypica.cpp

@@ -0,0 +1,51 @@
+/*224:*/
+#line 36 "./abouttypica.w"
+
+#include "abouttypica.h"
+
+/*225:*/
+#line 45 "./abouttypica.w"
+
+AboutTypica::AboutTypica():QMainWindow(NULL)
+{
+QFile aboutFile(":/resources/html/about.html");
+aboutFile.open(QIODevice::ReadOnly);
+QByteArray content= aboutFile.readAll();
+QWebView*banner= new QWebView;
+banner->setHtml(content,QUrl("qrc:/resources/html/about.html"));
+aboutFile.close();
+setCentralWidget(banner);
+QWebPage*page= banner->page();
+page->setLinkDelegationPolicy(QWebPage::DelegateExternalLinks);
+connect(page,SIGNAL(linkClicked(QUrl)),this,SLOT(linkClicked(QUrl)));
+}
+
+/*:225*//*226:*/
+#line 63 "./abouttypica.w"
+
+void AboutTypica::linkClicked(const QUrl&url)
+{
+if(url.scheme()=="typica")
+{
+QString address(url.toEncoded());
+if(address=="typica://aboutqt")
+{
+QMessageBox::aboutQt(this);
+}
+else
+{
+qDebug()<<"Unexpected link. Got: "<<address;
+}
+}
+else
+{
+QDesktopServices::openUrl(url);
+}
+}
+#line 5656 "./typica.w"
+
+/*:226*/
+#line 39 "./abouttypica.w"
+
+
+/*:224*/

src/abouttypica.h

@@ -0,0 +1,25 @@
+/*223:*/
+#line 12 "./abouttypica.w"
+
+#include <QMainWindow> 
+#include <QWebView> 
+#include <QFile> 
+#include <QtDebug> 
+#include <QMessageBox> 
+#include <QDesktopServices> 
+
+#ifndef AboutTypicaHeader
+#define AboutTypicaHeader
+
+class AboutTypica:public QMainWindow
+{
+Q_OBJECT
+public:
+AboutTypica();
+public slots:
+void linkClicked(const QUrl&url);
+};
+
+#endif
+
+/*:223*/

src/abouttypica.w

@@ -0,0 +1,82 @@
+@** A Window for Displaying Information About Typica.
+
+\noindent The About window for an application typically displays a few pieces
+of information: The application logo, name, and version number, copyright and
+license information, and other assorted information. In Typica this also
+includes a list of the people and companies that have provided financial
+assistance toward the ongoing development of the software and information that
+others can use to help in this way. Some of this information would benefit
+from existing as a link which can open an external application such as a web
+browser or email client.
+
+@(abouttypica.h@>=
+#include <QMainWindow>
+#include <QWebView>
+#include <QFile>
+#include <QtDebug>
+#include <QMessageBox>
+#include <QDesktopServices>
+
+#ifndef AboutTypicaHeader
+#define AboutTypicaHeader
+
+class AboutTypica : public QMainWindow
+{
+	Q_OBJECT
+	public:
+		AboutTypica();
+	public slots:
+		void linkClicked(const QUrl &url);
+};
+
+#endif
+
+@ The implementation is in a separate file.
+
+@(abouttypica.cpp@>=
+#include "abouttypica.h"
+
+@<AboutTypica implementation@>@;
+
+@ The information provided here comes from a set of HTML documents stored as
+compiled resources and presented in a set of |QWebView| instances accessible
+through a set of tabs.
+
+@<AboutTypica implementation@>=
+AboutTypica::AboutTypica() : QMainWindow(NULL)
+{
+	QFile aboutFile(":/resources/html/about.html");
+	aboutFile.open(QIODevice::ReadOnly);
+	QByteArray content = aboutFile.readAll();
+	QWebView *banner = new QWebView;
+ 	banner->setHtml(content, QUrl("qrc:/resources/html/about.html"));
+	aboutFile.close();
+	setCentralWidget(banner);
+	QWebPage *page = banner->page();
+	page->setLinkDelegationPolicy(QWebPage::DelegateExternalLinks);
+	connect(page, SIGNAL(linkClicked(QUrl)), this, SLOT(linkClicked(QUrl)));
+}
+
+@ In order to display the About Qt window, we detect a special URL from a link
+clicked in the about box.
+
+@<AboutTypica implementation@>=
+void AboutTypica::linkClicked(const QUrl &url)
+{
+	if(url.scheme() == "typica")
+	{
+		QString address(url.toEncoded());
+		if(address == "typica://aboutqt")
+		{
+			QMessageBox::aboutQt(this);
+		}
+		else
+		{
+			qDebug() << "Unexpected link. Got: " << address;
+		}
+	}
+	else
+	{
+		QDesktopServices::openUrl(url);
+	}
+}

src/helpmenu.cpp

@@ -0,0 +1,35 @@
+/*168:*/
+#line 35 "./helpmenu.w"
+
+#include "helpmenu.h"
+#include "abouttypica.h"
+
+/*169:*/
+#line 47 "./helpmenu.w"
+
+HelpMenu::HelpMenu():QMenu()
+{
+setObjectName("helpMenu");
+setTitle(tr("Help"));
+QAction*aboutTypicaAction= new QAction(tr("About Typica"),this);
+aboutTypicaAction->setObjectName("aboutTypicaAction");
+addAction(aboutTypicaAction);
+connect(aboutTypicaAction,SIGNAL(triggered()),this,SLOT(displayAboutTypica()));
+}
+
+/*:169*//*170:*/
+#line 61 "./helpmenu.w"
+
+void HelpMenu::displayAboutTypica()
+{
+AboutTypica*aboutBox= new AboutTypica;
+aboutBox->show();
+}
+
+#line 4037 "./typica.w"
+
+/*:170*/
+#line 39 "./helpmenu.w"
+
+
+/*:168*/

src/helpmenu.h

@@ -0,0 +1,20 @@
+/*167:*/
+#line 16 "./helpmenu.w"
+
+#include <QMenu> 
+
+#ifndef HelpMenuHeader
+#define HelpMenuHeader
+
+class HelpMenu:public QMenu
+{
+Q_OBJECT
+public:
+HelpMenu();
+public slots:
+void displayAboutTypica();
+};
+
+#endif
+
+/*:167*/

src/helpmenu.w

@@ -0,0 +1,67 @@
+@* The Help Menu.
+
+\noindent Every window has a help menu that is inserted at the end of any
+configuration defined menus. At present this only serves to have a place to
+hold the "About Typica" menu item which brings up an appropriate about box, but
+there is the possibility that future developments will introduce other items
+that should be included in this menu.
+
+@<Insert help menu@>=
+HelpMenu *helpMenu = new HelpMenu();
+window->menuBar()->addMenu(helpMenu);
+
+@ Since the help menu is represented by its own class, we must have a
+declaration for that class. This is a trivial case.
+
+@(helpmenu.h@>=
+#include <QMenu>
+
+#ifndef HelpMenuHeader
+#define HelpMenuHeader
+
+class HelpMenu : public QMenu
+{
+	Q_OBJECT
+	public:
+		HelpMenu();
+	public slots:
+		void displayAboutTypica();
+};
+
+#endif
+
+@ Implementation is in a separate file.
+
+@(helpmenu.cpp@>=
+#include "helpmenu.h"
+#include "abouttypica.h"
+
+@<Help menu implementation@>@;
+
+@ The constructor sets an object name for the menu so scripts are able to look
+up the menu and add additional items. The "About Typica" menu item also has an
+object name which can be used to provide custom handling if this is desired.
+The |triggered()| signal from that item is immediately connected to a handler
+for displaying an about box.
+
+@<Help menu implementation@>=
+HelpMenu::HelpMenu() : QMenu()
+{
+	setObjectName("helpMenu");
+	setTitle(tr("Help"));
+	QAction *aboutTypicaAction = new QAction(tr("About Typica"), this);
+	aboutTypicaAction->setObjectName("aboutTypicaAction");
+	addAction(aboutTypicaAction);
+	connect(aboutTypicaAction, SIGNAL(triggered()), this, SLOT(displayAboutTypica()));
+}
+
+@ When "About Typica" is selected from the menu, we display an about box. This
+is also handled by a separate class.
+
+@<Help menu implementation@>=
+void HelpMenu::displayAboutTypica()
+{
+	AboutTypica *aboutBox = new AboutTypica;
+	aboutBox->show();
+}
+

src/resources.qrc

@@ -11,5 +11,8 @@
         <file>resources/icons/tango/scalable/actions/list-remove.svg</file>
         <file>resources/icons/tango/index.theme</file>
         <file>resources/icons/appicons/logo.svg</file>
+        <file>resources/icons/appicons/logo96.png</file>
+        <file>resources/html/about.html</file>
+        <file>resources/html/style.css</file>
     </qresource>
 </RCC>

src/resources/html/about.html

@@ -0,0 +1,132 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN" "http://www.w3.org/2002/04/xhtml-math-svg.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+	<head>
+		<title>Typica - Data for Coffee Roasters</title>
+		<link rel="stylesheet" type="text/css" href="style.css" />
+	</head>
+	<body>
+		<div id="page">
+			<div id="topmatter">
+				<div id="topbanner">
+					<img src="../icons/appicons/logo96.png" height="96px" width="96px" alt="Typica logo" />
+					<h1>Typica</h1>
+					<h2>Version 1.5</h2>
+				</div>
+			<div id="maintext">
+				<p>Copyright &copy; 2007&ndash;2013 Neal Evan Wilson</p>
+				<h3>Special Thanks</h3>
+				<p>Ongoing development of Typica is made possible through the
+				generous financial contributions from the following:</p>
+				
+				<p>Pinnacle Coffee Roasting</p>
+				
+				<h3>Get Involved</h3>
+				<p>Typica has reached a point in its development where it can
+				be considered mature with a feature set appropriate for many
+				coffee roasting firms. There is, however, considerable variety
+				among roasting firms in the equipment used, roasting styles,
+				process traceability requirements, languages understood, and
+				other preferences. There is also still considerable room for
+				improvement in many areas. The development of Typica has been
+				on a budget of approximately $0, but software development is
+				not without cost. This is especially the case for cross
+				platform development of software that interfaces with external
+				hardware. These are some of the things that could be done with
+				additional funding:
+					<ul>
+						<li>Improve development and testing infrastructure.
+						This would allow more complete testing of release
+						candidates on all platforms and greatly increase the
+						quality and speed at which new releases could be made
+						available.</li>
+						<li>Purchase additional measurement devices. Interest
+						has been expressed in using many types of hardware not
+						currently supported in Typica. Some of these
+						suggestions are quite reasonable and the only reason I
+						am not able to include support for them is simply that
+						I do not have a sample of the hardware to test my code
+						against.</li>
+						<li>Pay for web hosting. While the Internet allows
+						free software to be distributed cheaply, this is not
+						without cost.</li>
+						<li>Allow more development time. As of this writing,
+						nobody has contributed any improvements to Typica's
+						program code. This has all been designed and written
+						by a single person working on it as time is available.
+						Many of the planned improvements require nothing beyond
+						time to plan an implementation, to write the program
+						code, to integrate it with the rest of the program, and
+						to test that the feature is sound. With sufficient
+						sustained funding it would be possible to devote more
+						time to continuing development, resulting in a more
+						rapid release of features and other improvements to
+						Typica.</li>
+					</ul>
+				</p>
+				<p>Financial assistance toward these ends can be sent (checks
+				payable in US dollars preferred) to:</p>
+				<p>Neal Wilson<br />
+				c/o Wilson's Coffee &amp; Tea<br />
+				3306 Washington Ave.<br />
+				Racine, WI 53405<br />
+				USA</p>
+				<p>All who contribute in this way will be thanked in the
+				Special Thanks section seen above in the next public release,
+				so please indicate if you would like to be identified by your
+				name, your company name, or in some other way. Anonymous
+				funding can also be made through <a href="https://www.gittip.com/N3Roaster/">Gittip</a>.</p>
+				<script data-gittip-username="N3Roaster" src="http://www.gittip.com/assets/widgets/0002.js"></script>
+				<h3>License Information</h3>
+				<p>Permission is hereby granted, free of charge, to any person
+				obtaining a copy of this software and associated documentation
+				files (the "Software"), to deal in the Software without
+				restriction, including without limitation the rights to use,
+				copy, modify, merge, publish, distribute, sublicense, and/or
+				sell copies of the Software, and to permit persons to whom the
+				Software is furnished to do so, subject to the following
+				conditions:</p>
+				<p>The above copyright notice and this permission notice shall
+				be included in all copies or substantial portions of the
+				Software.</p>
+				<p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
+				KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+				WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE
+				AND NONNIFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+				HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+				WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+				FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+				OTHER DEALINGS IN THE SOFTWARE.</p>
+				<p>Parts of Typica are from
+				<a href="http://code.google.com/p/qextserialport/">QextSerialPort</a>
+				which is used under the MIT license as follows:</p>
+				<p>Copyright &copy; 2000&ndash;2003 Wayne Roth</p>
+				<p>Copyright &copy; 2004&ndash;2007 Stefan Sander</p>
+				<p>Copyright &copy; 2007 Michal Policht</p>
+				<p>Copyright &copy; 2008 Brandon Fosdick</p>
+				<p>Copyright &copy; 2009-2010 Liam Staskawicz</p>
+				<p>Copyright &copy; 2011 Debao Zhang</p>
+				<p>Permission is hereby granted, free of charge, to any person
+				obtaining a copy of this software and associated documentation
+				files (the "Software"), to deal in the Software without
+				restriction, including without limitation the rights to use,
+				copy, modify, merge, publish, distribute, sublicense, and/or
+				sell copies of the Software, and to permit persons to whom the
+				Software is furnished to do so, subject to the following
+				conditions:</p>
+				<p>The above copyright notice and this permission notice shall
+				be included in all copies or substantial portions of the
+				Software.</p>
+				<p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
+				KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+				WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE
+				AND NONNIFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+				HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+				WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+				FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+				OTHER DEALINGS IN THE SOFTWARE.</p>
+				<p>Typica also makes use of the <a href="typica://aboutqt">Qt</a>
+				framework.</p>
+			</div>
+		</div>
+	</body>
+</html>

src/resources/html/style.css

@@ -0,0 +1,36 @@
+body {
+	background-color: rgb(235,239,249);
+}
+#page {
+	background-color: rgb(255,255,255);
+}
+h1 {
+	font-size: 24px;
+}
+#topbanner {
+	background-color: rgb(235,239,249);
+	height: 96px;
+	margin-bottom: 2px;
+}
+#topbanner img {
+	float: left;
+}
+#topbanner h1 {
+	padding-top: 20px;
+	padding-bottom: 0px;
+	margin-bottom: 0px;
+}
+h2 {
+	font-size: 20px;
+	padding-top: 0px;
+	padding-bottom: 0px;
+	margin-top: 0px;
+}
+#topmatter {
+	background-color: rgb(235,239,249);
+}
+#maintext {
+	margin-left: 10px;
+	margin-right: 10px;
+	padding-bottom: 10px;
+}

src/typica.w

@@ -848,6 +848,13 @@ various Qt modules.
 #include <QtXmlPatterns>
 #include <QtWebKit>
 
+@ New code is being written in separate files in a long term effort to improve
+organization of the code. The result of this is that some additional headers
+are required here.
+
+@<Header files to include@>=
+#include "helpmenu.h"
+
 @** The Scripting Engine.
 
 \noindent The main enhancement of \pn{} version 1.1 is the introduction of a
@@ -3900,14 +3907,8 @@ if(element.hasChildNodes())
 {
 	@<Process window children@>@;
 }
-if(window)
-{
-	window->show();
-}
-else
-{
-	qDebug() << "Error! Window invalidated";
-}
+@<Insert help menu@>@;
+window->show();
 
 @ Three element types make sense as top level children of a {\tt <window>}
 element. An element representing a layout element can be used to apply that
@@ -4032,6 +4033,8 @@ while(j < menuItems.count())
 	j++;
 }
 
+@i helpmenu.w
+
 @ A layout can contain a number of different elements including a variety of
 widget types and other layouts. This function is responsible for applying any
 layout class to the widget currently being populated and processing children of
@@ -5649,6 +5652,8 @@ QScriptValue QComboBox_findText(QScriptContext *context, QScriptEngine *engine)
 	return QScriptValue(engine, self->findText(argument<QString>(0, context)));
 }
 
+@i abouttypica.w
+
 @** A representation of temperature measurements.
 
 \noindent Most of the information in a roast log will be temperature
@@ -8171,6 +8176,7 @@ The first measurement is always added to each model.
 @<ZoomLog Implementation@>=
 void ZoomLog::newMeasurement(Measurement measure, int tempcolumn)
 {
+	@<Synthesize measurements for slow hardware@>@;
 	model_ms->newMeasurement(measure, tempcolumn);
 	if(lastMeasurement.contains(tempcolumn))
 	{
@@ -8221,6 +8227,37 @@ foreach(m, modelSet)
 	m->newMeasurement(measure, tempcolumn);
 }
 
+@ Some measurement hardware in use cannot guarantee delivery of at least one
+measurement per second. This causes problems for the current |ZoomLog|
+implementation as, for example, if there is no measurement at a time where
+the seconds are divisible by 5, there will be no entry in that view. This can
+result in situations where the |ZoomLog| at its default view of one measurement
+every 30 seconds might not display any data at all aside from the first
+measurement, the last measurement, and any measurement that happens to have an
+annotation associated with it. The solution in this case is to synthesize
+measurements so that the |ZoomLog| thinks it gets at least one measurement
+every second.
+
+The current approach simply replicates the last measurement every second until
+the time for the most recent measurement is reached, however it would likely be
+better to interpolate values between the two most recent real measurements as
+this would match the graphic representation rather than altering it when later
+reviewing the batch.
+
+@<Synthesize measurements for slow hardware@>=
+if(lastMeasurement[tempcolumn].time() < measure.time())
+{
+	QList<QTime> timelist;
+	for(QTime i = lastMeasurement[tempcolumn].time().addSecs(1); i < measure.time(); i = i.addSecs(1))
+	{
+		timelist.append(i);
+	}
+	for(int i = 0; i < timelist.size(); i++)
+	{
+		newMeasurement(Measurement(measure.temperature(), timelist[i], measure.scale()), tempcolumn);
+	}
+}
+
 @ New to \pn{} 1.4 is the concept of a current column set. This was added to
 improve support for devices where measurements on different data series may not
 arrive at exactly the same time and for multi-device configurations where