Vuo: editor/VuoEditorAboutBox.cc Source File

Go to the documentation of this file.
  
 #include "VuoStringUtilities.hh"
 #include "VuoEditorAboutBox.hh"
 #include "ui_VuoEditorAboutBox.h"
  
 const QString VuoEditorAboutBox::htmlHead = "<head><style>a { color: #0099a9; }</style></head>";
  
 VuoEditorAboutBox::VuoEditorAboutBox(QWidget *parent) :
     VuoDialogWithoutTitlebar(parent),
     ui(new Ui::VuoEditorAboutBox)
 {
     ui->setupUi(this);
  
     // Introductory text
     QString buildDate = __DATE__;
     QString versionNumber = VUO_VERSION_STRING;
     QString revisionNumber = VUO_REVISION;
  
     QString missionMarkdown = tr(
         "**Create memorable interactive experiences — without coding.**\n"
         "\n"
         "Drag, drop, and connect Vuo's simple building blocks to support your creative work:  \n"
         "VJ gigs, exhibits, installations, stage productions, dome graphics, visual signage,  \n"
         "video effects, maker projects, trade show booths, and more.  \n"
         "\n"
         "Learn more at %1.")
         .arg("[vuo.org](https://vuo.org)");
  
     QString missionHTML = QString::fromStdString(VuoStringUtilities::generateHtmlFromMarkdown(missionMarkdown.toStdString()));
  
     QString descriptiveText = \
             QString("<html>%4<body>"
                     "<p><span style=\"font-size:28pt;\">Vuo</span>"
                         "<span style=\"font-size:20pt;\"> %1</span><br>"
                         "<span style=\"font-size:12pt; color:rgba(0,0,0,.5)\">" + tr("Built on %2 (%3)") + "<br>"
                         "Copyright © 2012–2020 Kosada Incorporated</span></p>%5"
                     "</body></html>").
             arg(
                 versionNumber,
                 buildDate,
                 revisionNumber,
                 htmlHead,
                 missionHTML);
  
     // Text style
     contributorFont = ui->textEdit->font();
  
     licenseFont.setFamily("Monaco");
     licenseFont.setStyleHint(QFont::Monospace);
     licenseFont.setFixedPitch(true);
     licenseFont.setPointSize(11);
  
     const int tabStop = 8;  // 8 characters/tab
     QFontMetrics licenseFontMetrics(licenseFont);
     ui->textEdit->setTabStopWidth(tabStop * licenseFontMetrics.width(' '));
  
     // Set the introductory text.
     ui->textLabel->setText(descriptiveText);
  
     // Populate the "Details" pane.
     contributors = new QTreeWidgetItem(ui->treeWidget);
     contributors->setText(0, tr("Contributors"));
     dependencyLicenses = new QTreeWidgetItem(ui->treeWidget);
     dependencyLicenses->setText(0, tr("Dependency Licenses"));
  
     // Populate the text file content pane.
     populateContributorsList();
     populateLicenseTexts();
  
     ui->textEdit->setReadOnly(true);
  
     // Update the text content in response to selection changes within the "Details" pane.
     connect(ui->treeWidget, &QTreeWidget::currentItemChanged, this, &VuoEditorAboutBox::updateDisplayedTextContent);
  
     // Select the contributors list by default.
     ui->treeWidget->setCurrentItem(contributors);
  
     setFixedSize(size());
     setAttribute(Qt::WA_DeleteOnClose, false);
 }
  
 void VuoEditorAboutBox::populateContributorsList()
 {
     QFile contributorsList(QApplication::applicationDirPath().append("/../Resources/CONTRIBUTORS.md"));
  
     if (!contributorsList.open(QIODevice::ReadOnly))
         contributorText = "Please see our list of contributors at <a href=\"https://vuo.org/contributors\">https://vuo.org/contributors</a>. ";
  
     else
     {
         // Display the contents of the contributors list.
         QTextStream textStream(&contributorsList);
         contributorText = VuoStringUtilities::generateHtmlFromMarkdown(textStream.readAll().toUtf8().constData()).c_str();
     }
 }
  
 void VuoEditorAboutBox::populateLicenseTexts()
 {
     QDir licenseTextDir(QApplication::applicationDirPath().append("/../Frameworks/Vuo.framework/Documentation/Licenses"));
     if (!licenseTextDir.exists())
         return;
  
     QStringList licenseFileList(licenseTextDir.entryList(QDir::Files|QDir::Readable));
     foreach (QString licenseFileName, licenseFileList)
     {
         QFile licenseFile(licenseTextDir.filePath(licenseFileName));
         if (licenseFile.open(QIODevice::ReadOnly))
         {
             QFileInfo licenseFileInfo(licenseFile);
             QString dependencyIdentifier = licenseFileInfo.completeBaseName();
             QTreeWidgetItem *dependencyLicenseItem = new QTreeWidgetItem();
             dependencyLicenseItem->setText(0, dependencyIdentifier);
             dependencyLicenses->addChild(dependencyLicenseItem);
  
             QTextStream textStream(&licenseFile);
             licenseTextForDependency[dependencyIdentifier] = textStream.readAll();
         }
     }
 }
  
 void VuoEditorAboutBox::updateDisplayedTextContent()
 {
     QTreeWidgetItem *currentItem = ui->treeWidget->currentItem();
     if (currentItem == contributors)
     {
         ui->textEdit->setFont(contributorFont);
         ui->textEdit->setText(htmlHead + contributorText);
     }
     else if (currentItem == dependencyLicenses)
         ui->textEdit->setText("");
     else
     {
         ui->textEdit->setFont(licenseFont);
  
         // Use ui->textEdit->document()->setHtml(...) and ui->textEdit->document()->setPlainText(...)
         // rather than ui->textEdit->setText(...) to avoid bug where viewing a license text after
         // clicking on any link within the contributor text caused the full license text to
         // be displayed as a link.
         QString licenseText = licenseTextForDependency[currentItem->text(0)];
         if (Qt::mightBeRichText(licenseText))
             ui->textEdit->document()->setHtml(htmlHead + licenseText);
         else
             ui->textEdit->document()->setPlainText(licenseText);
     }
 }
  
 VuoEditorAboutBox::~VuoEditorAboutBox()
 {
     delete ui;
 }