documentation improvements

Koen Deforche · Koen Deforche · commit 3298ee980971 · 2013-01-28T12:39:16.000+01:00
diff --git a/INSTALL.html b/INSTALL.html
@@ -167,10 +167,15 @@ <h4>2. Configure the library</h4>
 using the interactive program:
 
 <pre>
-    $ ccmake .
+    $ ccmake ../
+</pre>
+or
+<pre>
+    $ cmake-gui ../
 </pre>
 
-<p>Variables that you may set to configure Wt's built-in boost finding
+<p>The GUI lists all variables that are configurable in Wt's build process.
+Variables that you may set to configure Wt's built-in boost finding
 method:</p>
 
 <dl>
@@ -186,7 +191,7 @@ <h4>2. Configure the library</h4>
 </dl>
 
 Other variables specify several build and configuration aspects of Wt, of which
-the most relevant ones are:
+the most relevant ones are (there are many more visible in the GUI):
 
 <dl>
 <dt><strong>CMAKE_INSTALL_PREFIX</strong></dt>
diff --git a/INSTALL.win32.html b/INSTALL.win32.html
@@ -30,17 +30,19 @@ <h2>Requirements</h2>
       build on the Express Edition, which is free (as in beer) to use.
   <li>CMake cross-platform build system (www.cmake.org): cmake-2.6.x,
       Windows version (2.8 or newer recommended).</li>
-  <li>Boost 1.36 (or later).</li>
+  <li>Boost 1.36 (or later; a recent version is recommended)</li>
 </ul>
 </p>
 
 <p>Additional and optional requirements for some of the examples
 <ul>
 <li>For https support: OpenSSL, version 0.9.8d or newer.</li>
 <li>To compress traffic: zlib 1.2.3</li>
-<li>libmysql and libmysql++-2.x (hangman)</li>
-<li><a href="http://libharu.org/">Haru Free PDF Library</a>, which is used to provide support for painting to PDF (WPdfImage).</li>
-<li><a href="http://www.graphicsmagick.org/">GraphicsMagick</a>, for supporting painting to raster images (PNG, GIF, ...) (WRasterImage).</li>
+<li>Postgres, mysql, firebird client libraries for Dbo database backends</li>
+<li><a href="http://libharu.org/">Haru Free PDF Library</a>, which is used to
+provide support for rendering PDF (WPdfImage, WPdfRenderer).</li>
+<li><a href="http://www.graphicsmagick.org/">GraphicsMagick</a>, for
+supporting painting to raster images (PNG, GIF, ...) (WRasterImage).</li>
 </ul>
 </p>
 
@@ -92,7 +94,9 @@ <h4>1. Run the example in the MSVC IDE </h4>
 on how to obtain and install ExtJs. 
 
 <p>
-These are all the command-line options that are available:
+These are all the command-line options that are available (run the examples
+with --help to see the most recent list of available options):
+
 <pre>
 General options:
   -h [ --help ]              produce help message
diff --git a/cmake/WtFindHaru.txt b/cmake/WtFindHaru.txt
@@ -81,6 +81,7 @@ ELSE(WIN32)
     PATHS
       ${HARU_PREFIX}/lib
       ${USERLIB_PREFIX}/lib
+      /lib/x86_64-linux-gnu
   )
 
   FIND_LIBRARY(Z_LIB
@@ -103,8 +104,10 @@ IF(HARU_LIB AND HARU_INCLUDE_DIR AND HARU_SUPPORT_LIBS_FOUND)
   SET(HARU_FOUND TRUE)
   SET(HARU_INCLUDE_DIRS ${HARU_INCLUDE_DIR})
   SET(HARU_LIBRARIES ${HARU_LIB} ${HARU_SUPPORT_LIBS})
+  MESSAGE(STATUS "Found libharu libraries")
 ELSE(HARU_LIB AND HARU_INCLUDE_DIR AND HARU_SUPPORT_LIBS_FOUND)
   SET(HARU_FOUND FALSE)
+  MESSAGE(STATUS "libharu libraries not found - set HARU_PREFIX")
 ENDIF(HARU_LIB AND HARU_INCLUDE_DIR AND HARU_SUPPORT_LIBS_FOUND)
 
 
diff --git a/examples/CMakeLists.txt b/examples/CMakeLists.txt
@@ -168,11 +168,11 @@ IF(MSVC_VERSION)
   ENDIF(MSVC_VERSION GREATER 1600)
 ENDIF(MSVC_VERSION)
 IF(CMAKE_COMPILER_IS_GNUCXX)
-  execute_process(COMMAND ${CMAKE_C_COMPILER} -dumpversion
+  execute_process(COMMAND ${CMAKE_C_COMPILER} "-dumpversion"
                   OUTPUT_VARIABLE GCC_VERSION)
-  IF(${GCC_VERSION} VERSION_GREATER "4.6.0")
+  IF(${GCC_VERSION} VERSION_GREATER "4.5.99")
     SET(HAS_CXX11 ON)
-  ENDIF(${GCC_VERSION} VERSION_GREATER "4.6.0")
+  ENDIF(${GCC_VERSION} VERSION_GREATER "4.5.99")
 ENDIF(CMAKE_COMPILER_IS_GNUCXX)
 
 IF(HAS_CXX11)
@@ -182,5 +182,3 @@ IF(HAS_CXX11)
 ELSE(HAS_CXX11)
   MESSAGE("Not building widget gallery; a C++11 compiler is required (gcc > 4.6 or MSVS 2012)")
 ENDIF(HAS_CXX11)
-
-
diff --git a/examples/widgetgallery/CMakeLists.txt b/examples/widgetgallery/CMakeLists.txt
@@ -34,7 +34,6 @@ ENDIF(NOT WIN32)
 WT_ADD_EXAMPLE(widgetgallery.wt
   ${WIDGETGALLERY_SOURCES}
 )
-TARGET_LINK_LIBRARIES(widgetgallery.wt wtext)
 
 IF (HAVE_HARU)
   INCLUDE_DIRECTORIES(${HARU_INCLUDE_DIRS})
diff --git a/examples/widgetgallery/TreesTables.C b/examples/widgetgallery/TreesTables.C
@@ -107,6 +107,12 @@ Wt::WWidget *TreesTables::tableViews()
   return result;  
 }
 
+#ifndef WT_TARGET_JAVA
+#define GIT_REPOSITORY "../../.git"
+#else
+#define GIT_REPOSITORY "../../.git"
+#endif
+
 #ifndef _WIN32
 #include "examples/GitModel.cpp"
 #include "examples/TreeView.cpp"
diff --git a/examples/widgetgallery/approot/src.xml b/examples/widgetgallery/approot/src.xml
diff --git a/examples/widgetgallery/approot/text.xml b/examples/widgetgallery/approot/text.xml
@@ -4567,7 +4567,7 @@ the correct page.-->
     </p>
     <p>
       The trailer used in the examples below is
-      <a href="http://durian.blender.org/" target="blank">Sintel</a>, &copy;
+      <a href="http://durian.blender.org/" target="blank">Sintel</a>, &#169;
       copyright Blender Foundation | durian.blender.org
     </p>
 
diff --git a/examples/widgetgallery/examples/CheckBoxInline.cpp b/examples/widgetgallery/examples/CheckBoxInline.cpp
@@ -1,6 +1,5 @@
-
 #include <Wt/WCheckBox>
-#include <Wt/WTemplate>
+#include <Wt/WContainerWidget>
 
 SAMPLE_BEGIN(CheckBoxInline)
 
diff --git a/examples/widgetgallery/examples/CheckBoxStack.cpp b/examples/widgetgallery/examples/CheckBoxStack.cpp
@@ -1,6 +1,5 @@
-
 #include <Wt/WCheckBox>
-#include <Wt/WTemplate>
+#include <Wt/WContainerWidget>
 
 SAMPLE_BEGIN(CheckBoxStack)
 
diff --git a/examples/widgetgallery/examples/DateEdit.cpp b/examples/widgetgallery/examples/DateEdit.cpp
@@ -1,4 +1,5 @@
 #include <Wt/WContainerWidget>
+#include <Wt/WCalendar>
 #include <Wt/WDate>
 #include <Wt/WDateEdit>
 #include <Wt/WLabel>
diff --git a/examples/widgetgallery/examples/DatePicker.cpp b/examples/widgetgallery/examples/DatePicker.cpp
@@ -1,4 +1,5 @@
 #include <Wt/WContainerWidget>
+#include <Wt/WCalendar>
 #include <Wt/WDate>
 #include <Wt/WDatePicker>
 #include <Wt/WLabel>
diff --git a/examples/widgetgallery/examples/EmwebLogo.cpp b/examples/widgetgallery/examples/EmwebLogo.cpp
diff --git a/examples/widgetgallery/examples/Flash.cpp b/examples/widgetgallery/examples/Flash.cpp
@@ -1,4 +1,5 @@
 #include <Wt/WContainerWidget>
+#include <Wt/WImage>
 #include <Wt/WFlashObject>
 
 SAMPLE_BEGIN(Flash)
diff --git a/examples/widgetgallery/examples/GitModel.cpp b/examples/widgetgallery/examples/GitModel.cpp
@@ -56,19 +56,19 @@ class GitModel : public Wt::WAbstractItemModel
     return createIndex(row, column, parentId);
   }
 
-  virtual int columnCount(const Wt::WModelIndex& index = Wt::WModelIndex()) const {
+  virtual int columnCount(const Wt::WModelIndex& parent = Wt::WModelIndex()) const {
     return 2;
   }
 
-  virtual int rowCount(const Wt::WModelIndex& index = Wt::WModelIndex()) const {
+  virtual int rowCount(const Wt::WModelIndex& parent = Wt::WModelIndex()) const {
     int treeId;
 
-    if (index.isValid()) {
-      if (index.column() != 0)
+    if (parent.isValid()) {
+      if (parent.column() != 0)
 	return 0;
-      Git::Object o = getObject(index);
+      Git::Object o = getObject(parent);
       if (o.type == Git::Tree) { // is a folder
-	treeId = getTreeId(index.internalId(), index.row());
+	treeId = getTreeId(parent.internalId(), parent.row());
       } else                     // is a file
 	return 0;
     } else {
diff --git a/examples/widgetgallery/examples/ImageArea.cpp b/examples/widgetgallery/examples/ImageArea.cpp
@@ -1,3 +1,4 @@
+#include <Wt/WBreak>
 #include <Wt/WCircleArea>
 #include <Wt/WContainerWidget>
 #include <Wt/WImage>
diff --git a/examples/widgetgallery/examples/InPlaceEdit.cpp b/examples/widgetgallery/examples/InPlaceEdit.cpp
@@ -1,3 +1,4 @@
+#include <Wt/WContainerWidget>
 #include <Wt/WInPlaceEdit>
 #include <Wt/WText>
 
diff --git a/examples/widgetgallery/examples/InPlaceEditButtons.cpp b/examples/widgetgallery/examples/InPlaceEditButtons.cpp
@@ -1,3 +1,4 @@
+#include <Wt/WContainerWidget>
 #include <Wt/WInPlaceEdit>
 #include <Wt/WText>
 
diff --git a/examples/widgetgallery/examples/LargeTableView.cpp b/examples/widgetgallery/examples/LargeTableView.cpp
@@ -1,5 +1,9 @@
 #include <Wt/WTableView>
 
+#ifdef WT_EXAMPLE
+#include "VirtualModel.cpp"
+#endif // WT_EXAMPLE
+
 SAMPLE_BEGIN(LargeTableView)
 
 Wt::WTableView *tableView = new Wt::WTableView();
diff --git a/examples/widgetgallery/examples/MessageBox.cpp b/examples/widgetgallery/examples/MessageBox.cpp
@@ -15,24 +15,24 @@ out->setMargin(10, Wt::Left);
 button->clicked().connect(std::bind([=] () {
       out->setText("The status button is clicked.");
 
-      Wt::WMessageBox *mb = new Wt::WMessageBox
+      Wt::WMessageBox *messageBox = new Wt::WMessageBox
 	  ("Status",
 	   "<p>Ready to launch the rocket...</p>"
 	   "<p>Launch the rocket immediately?</p>",
 	   Wt::Information, Wt::Yes | Wt::No);
 
-      mb->setModal(false);
+      messageBox->setModal(false);
 
-      mb->buttonClicked().connect(std::bind([=] () {
-	    if (mb->buttonResult() == Wt::Yes)
+      messageBox->buttonClicked().connect(std::bind([=] () {
+	    if (messageBox->buttonResult() == Wt::Yes)
 	        out->setText("The rocket is launched!");
 	    else
 	        out->setText("The rocket is ready for launch...");
 
-	    delete mb;
+	    delete messageBox;
       }));
 
-      mb->show();
+      messageBox->show();
 }));
 
 SAMPLE_END(return container)
diff --git a/examples/widgetgallery/examples/NavigationBar.cpp b/examples/widgetgallery/examples/NavigationBar.cpp
@@ -5,6 +5,7 @@
 #include <Wt/WPopupMenu>
 #include <Wt/WPopupMenuItem>
 #include <Wt/WStackedWidget>
+#include <Wt/WText>
 
 SAMPLE_BEGIN(NavigationBar)
 
diff --git a/examples/widgetgallery/examples/Paintbrush.cpp b/examples/widgetgallery/examples/Paintbrush.cpp
@@ -2,8 +2,10 @@
 #include <Wt/WColor>
 #include <Wt/WContainerWidget>
 #include <Wt/WEvent>
+#include <Wt/WPainter>
 #include <Wt/WPaintedWidget>
 #include <Wt/WPainterPath>
+#include <Wt/WPen>
 #include <Wt/WPointF>
 #include <Wt/WPushButton>
 #include <Wt/WRectF>
diff --git a/examples/widgetgallery/examples/Popup.cpp b/examples/widgetgallery/examples/Popup.cpp
@@ -53,12 +53,12 @@ subMenu->addItem("Index")->triggered().connect(std::bind([=] () {
 }));
 subMenu->addSeparator();
 subMenu->addItem("About")->triggered().connect(std::bind([=] () {
-      Wt::WMessageBox *mb = new Wt::WMessageBox
+      Wt::WMessageBox *messageBox = new Wt::WMessageBox
 	("About", "<p>This is a program to make connections.</p>",
 	 Wt::Information, Wt::Ok);
-      mb->show();
-      mb->buttonClicked().connect(std::bind([=] () {
-	  delete mb;
+      messageBox->show();
+      messageBox->buttonClicked().connect(std::bind([=] () {
+	  delete messageBox;
       }));
 }));
 
diff --git a/examples/widgetgallery/examples/Slider.cpp b/examples/widgetgallery/examples/Slider.cpp
@@ -1,4 +1,5 @@
 #include <Wt/WContainerWidget>
+#include <Wt/WBreak>
 #include <Wt/WSlider>
 #include <Wt/WText>
 
diff --git a/examples/widgetgallery/examples/SmallTableView.cpp b/examples/widgetgallery/examples/SmallTableView.cpp
@@ -1,5 +1,7 @@
+#include <Wt/WApplication>
 #include <Wt/WStandardItemModel>
 #include <Wt/WTableView>
+#include "../treeview-dragdrop/CsvUtil.h"
 
 SAMPLE_BEGIN(SmallTableView)
 Wt::WTableView *tableView = new Wt::WTableView();
diff --git a/examples/widgetgallery/examples/StyledTable.cpp b/examples/widgetgallery/examples/StyledTable.cpp
@@ -6,6 +6,27 @@
 
 namespace {
 
+#ifdef WT_EXAMPLE
+    struct Employee {
+	std::string firstName;
+	std::string lastName;
+	double pay;
+
+        Employee(const std::string& aFirstName, 
+		 const std::string& aLastName,
+		 double aPay)
+	  : firstName(aFirstName),
+	    lastName(aLastName),
+	    pay(aPay) { }
+    };
+
+    Employee employees[] = {
+      Employee("Mark", "Otto", 100),
+      Employee("Jacob", "Thornton", 50),
+      Employee("Larry the Bird", "", 10)
+    };
+#endif // WT_EXAMPLE
+
 extern 
     void addOptionToggle(Wt::WWidget *widget, const char *option, 
 			 const char *styleClass, Wt::WContainerWidget *parent) {
diff --git a/examples/widgetgallery/examples/TextEditors.cpp b/examples/widgetgallery/examples/TextEditors.cpp
@@ -1,3 +1,4 @@
+#include <Wt/WContainerWidget>
 #include <Wt/WLineEdit>
 #include <Wt/WTextEdit>
 
@@ -9,7 +10,6 @@ Wt::WLineEdit *le = new Wt::WLineEdit(container);
 le->setEmptyText("Edit me");
 
 Wt::WLineEdit *out = new Wt::WLineEdit(container);
-out->emptyText("");
 out->setReadOnly(true);
 
 le->keyWentUp().connect(std::bind([=] () {
diff --git a/examples/widgetgallery/examples/Tree.cpp b/examples/widgetgallery/examples/Tree.cpp
@@ -1,4 +1,5 @@
 #include <Wt/WIconPair>
+#include <Wt/WText>
 #include <Wt/WTree>
 #include <Wt/WTreeNode>
 
diff --git a/examples/widgetgallery/examples/TreeTable.cpp b/examples/widgetgallery/examples/TreeTable.cpp
@@ -1,4 +1,6 @@
 #include <Wt/WIconPair>
+#include <Wt/WText>
+#include <Wt/WTree>
 #include <Wt/WTreeTable>
 #include <Wt/WTreeTableNode>
 
diff --git a/examples/widgetgallery/examples/TreeView.cpp b/examples/widgetgallery/examples/TreeView.cpp
@@ -1,10 +1,15 @@
 #include <Wt/WTreeView>
 
+#ifdef WT_EXAMPLE
+#include "GitModel.cpp"
+#define GIT_REPOSITORY "/path/to/repository/.git"
+#endif // WT_EXAMPLE
+
 SAMPLE_BEGIN(TreeView)
 Wt::WTreeView *treeView = new Wt::WTreeView();
 treeView->resize(600, 400);
 
-Wt::WAbstractItemModel *model = new GitModel("../../.git", treeView);
+Wt::WAbstractItemModel *model = new GitModel(GIT_REPOSITORY, treeView);
 treeView->setModel(model);
 
 treeView->setRowHeight(24);
diff --git a/examples/widgetgallery/examples/ValidationDate.cpp b/examples/widgetgallery/examples/ValidationDate.cpp
@@ -1,3 +1,4 @@
+#include <Wt/WBreak>
 #include <Wt/WContainerWidget>
 #include <Wt/WDate>
 #include <Wt/WDatePicker>
diff --git a/examples/widgetgallery/examples/makexml.sh b/examples/widgetgallery/examples/makexml.sh
@@ -6,7 +6,7 @@ echo "<messages>" >> $DEST
 for i in *.cpp; do
   echo $i;
   echo "  <message id=\"src-`basename $i .cpp`\">" >> $DEST
-  cat $i | sed -e 's/extern //g' | grep -v SAMPLE_ | pygmentize -l cpp -f html >> $DEST
+  cat $i | sed -e 's/extern //g' | grep -v SAMPLE_ | grep -v 'ifdef' | grep -v 'endif' | pygmentize -l cpp -f html >> $DEST
   echo "  </message>" >> $DEST
 done
 
diff --git a/examples/widgetgallery/examples/pdfImageWrite.cpp b/examples/widgetgallery/examples/pdfImageWrite.cpp
diff --git a/src/Wt/WLocale b/src/Wt/WLocale
diff --git a/src/Wt/WWebWidget.C b/src/Wt/WWebWidget.C

Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,6 @@ ENDIF(NOT WIN32)`
`34`	`34`	`WT_ADD_EXAMPLE(widgetgallery.wt`
`35`	`35`	`${WIDGETGALLERY_SOURCES}`
`36`	`36`	`)`
`37`		`-TARGET_LINK_LIBRARIES(widgetgallery.wt wtext)`
`38`	`37`
`39`	`38`	`IF (HAVE_HARU)`
`40`	`39`	`INCLUDE_DIRECTORIES(${HARU_INCLUDE_DIRS})`