Differences

This shows you the differences between two versions of the page.

--- qt:mainwindow-buildicon [2011/05/12 13:30] – mithat
+++ qt:mainwindow-buildicon [2011/05/13 12:24] – mithat
@@ Line 1: / Line 1: @@
+Something like this:
-Append a regularly defined set of differently sized icon images to a QIcon.
+<code cpp-qt MainWindow::buildIcon>
+/**
-theIcon is a pointer to the icon that will be built/appened to.
+ * @brief Append a regularly defined set of sized icon images to a QIcon.
+ *
-iconRscTemplate is a string that provides a template for the icon resource. Two tags are recognized in iconRscTemplate: %size and %dim%. When the template string is expanded, the tag %dim% by {iconSize} and %size% will be replaced by {iconSize}x{iconSize}, where {iconSize} is a string cast of an element in sizeList.
+ * The following usage example assumes the resources ":myIcons/16x16/exit.png",
+ * ":myIcons/24x24/exit.png", and ":myIcons/32x32/exit.png" are available and
-sizeList contains a list of single-dimension sizes to be added to the icon.
+ * that we want to bundle them together into exitIcon.
+ *
-Example:
+ * \code
+ *   QList<int> sizes; sizes << 16 << 24 << 32;
-Assumes the resources ":myIcons/16x16/exit.png", ":myIcons/24x24/exit.png", and ":myIcons/32x32/exit.png" are available.
+ *   QIcon exitIcon;
-<code cpp-qt>
+ *   buildIcon(&exitIcon, ":myIcons/%size%/exit.png", sizes);
-QList<int> sizes; sizes << 16 << 24 << 32;
+ * \endcode
+ *
-QIcon exitIcon;
+ * Does NOT check whether the referenced resources actually exist.
-buildIcon(&exitIcon, ":myIcons/%size%/exit.png", sizes);
+ *
+ * @return void
-</code>
+ */
-buildIcon() does NOT check whether the referenced resources actually exist.
+void MainWindow::buildIcon(QIcon* const theIcon,           ///< Pointer to the icon that will be built/appened to.
+                           QString const &iconRscTemplate, ///< A tag-based template string for the icon resource. Two tags are recognized in iconRscTemplate: \%size\% and \%dim\%. When the iconRscTemplate is expanded, the tag \%dim\% will be replaced by {iconSize} and \%size\% will be replaced by {iconSize}x{iconSize}, where {iconSize} is a string cast of an element in sizeList.
-<code cpp-qt>
+                           QList<int> const &sizeList      ///< A list of single-dimension sizes to be added to the icon.
-void MainWindow::buildIcon(QIcon* const theIcon, QString const &iconRscTemplate, QList const &sizeList)
+                          )
 {
-    foreach (const int iconSize in sizeList)
+    foreach (const int iconSize, sizeList)
     {
         QString theResource = iconRscTemplate;
-        theResource.replace(QString("%size%"), iconSize+"x"+iconSize);  // does this work?
+        QString dim; dim.setNum(iconSize);
-        theResource.replace(QString("%dim%"), iconSize+"");             // does this work?
+        theResource.replace(QString("%dim%"), dim);
+        theResource.replace(QString("%size%"), dim +"x"+dim);
-        theIcon->addFile(theResource, QSize(iconSize, iconSize))
+        theIcon->addFile(theResource, QSize(iconSize, iconSize));
     }
 }</code>