From 26748b49233cc2982a2149ba0006fe4fba02889f Mon Sep 17 00:00:00 2001 From: Martchus Date: Wed, 22 Apr 2015 18:57:44 +0200 Subject: [PATCH] First commit --- aboutdialog/aboutdialog.cpp | 89 + aboutdialog/aboutdialog.h | 38 + aboutdialog/aboutdialog.ui | 252 ++ enterpassworddialog/enterpassworddialog.cpp | 332 +++ enterpassworddialog/enterpassworddialog.h | 108 + enterpassworddialog/enterpassworddialog.ui | 283 ++ general.pri | 71 + models/checklistmodel.cpp | 226 ++ models/checklistmodel.h | 119 + pkgbuild/default/PKGBUILD | 22 + pkgbuild/mingw-w64/PKGBUILD | 44 + qtutilities.doxygen | 2310 +++++++++++++++++ qtutilities.pro | 95 + .../hicolor/16x16/actions/edit-clear.png | Bin 0 -> 736 bytes .../icons/hicolor/16x16/actions/edit-menu.png | Bin 0 -> 632 bytes .../hicolor/32x32/actions/edit-clear.png | Bin 0 -> 1063 bytes resources/qtconfigarguments.cpp | 92 + resources/qtconfigarguments.h | 57 + resources/qtutilsicons.qrc | 6 + resources/resources.cpp | 129 + resources/resources.h | 47 + settingsdialog/optioncategory.cpp | 92 + settingsdialog/optioncategory.h | 91 + settingsdialog/optioncategoryfiltermodel.cpp | 31 + settingsdialog/optioncategoryfiltermodel.h | 22 + settingsdialog/optioncategorymodel.cpp | 108 + settingsdialog/optioncategorymodel.h | 72 + settingsdialog/optionpage.cpp | 109 + settingsdialog/optionpage.h | 117 + settingsdialog/settingsdialog.cpp | 214 ++ settingsdialog/settingsdialog.h | 81 + settingsdialog/settingsdialog.ui | 177 ++ widgets/buttonoverlay.cpp | 188 ++ widgets/buttonoverlay.h | 76 + widgets/clearcombobox.cpp | 56 + widgets/clearcombobox.h | 28 + widgets/clearlineedit.cpp | 45 + widgets/clearlineedit.h | 33 + widgets/clearplaintextedit.cpp | 52 + widgets/clearplaintextedit.h | 26 + widgets/clearspinbox.cpp | 76 + widgets/clearspinbox.h | 84 + widgets/iconbutton.cpp | 80 + widgets/iconbutton.h | 52 + 44 files changed, 6230 insertions(+) create mode 100644 aboutdialog/aboutdialog.cpp create mode 100644 aboutdialog/aboutdialog.h create mode 100644 aboutdialog/aboutdialog.ui create mode 100644 enterpassworddialog/enterpassworddialog.cpp create mode 100644 enterpassworddialog/enterpassworddialog.h create mode 100644 enterpassworddialog/enterpassworddialog.ui create mode 100644 general.pri create mode 100644 models/checklistmodel.cpp create mode 100644 models/checklistmodel.h create mode 100644 pkgbuild/default/PKGBUILD create mode 100644 pkgbuild/mingw-w64/PKGBUILD create mode 100644 qtutilities.doxygen create mode 100644 qtutilities.pro create mode 100644 resources/icons/hicolor/16x16/actions/edit-clear.png create mode 100644 resources/icons/hicolor/16x16/actions/edit-menu.png create mode 100644 resources/icons/hicolor/32x32/actions/edit-clear.png create mode 100644 resources/qtconfigarguments.cpp create mode 100644 resources/qtconfigarguments.h create mode 100644 resources/qtutilsicons.qrc create mode 100644 resources/resources.cpp create mode 100644 resources/resources.h create mode 100644 settingsdialog/optioncategory.cpp create mode 100644 settingsdialog/optioncategory.h create mode 100644 settingsdialog/optioncategoryfiltermodel.cpp create mode 100644 settingsdialog/optioncategoryfiltermodel.h create mode 100644 settingsdialog/optioncategorymodel.cpp create mode 100644 settingsdialog/optioncategorymodel.h create mode 100644 settingsdialog/optionpage.cpp create mode 100644 settingsdialog/optionpage.h create mode 100644 settingsdialog/settingsdialog.cpp create mode 100644 settingsdialog/settingsdialog.h create mode 100644 settingsdialog/settingsdialog.ui create mode 100644 widgets/buttonoverlay.cpp create mode 100644 widgets/buttonoverlay.h create mode 100644 widgets/clearcombobox.cpp create mode 100644 widgets/clearcombobox.h create mode 100644 widgets/clearlineedit.cpp create mode 100644 widgets/clearlineedit.h create mode 100644 widgets/clearplaintextedit.cpp create mode 100644 widgets/clearplaintextedit.h create mode 100644 widgets/clearspinbox.cpp create mode 100644 widgets/clearspinbox.h create mode 100644 widgets/iconbutton.cpp create mode 100644 widgets/iconbutton.h diff --git a/aboutdialog/aboutdialog.cpp b/aboutdialog/aboutdialog.cpp new file mode 100644 index 0000000..48a9e68 --- /dev/null +++ b/aboutdialog/aboutdialog.cpp @@ -0,0 +1,89 @@ +#include "aboutdialog.h" +#include "ui_aboutdialog.h" + +#include +#include +#include +#include +#include + +/*! + \namespace Dialogs + \brief Provides common dialogs such as AboutDialog, EnterPasswordDialog and SettingsDialog. +*/ + +namespace Dialogs { + +/*! + * \class Dialogs::AboutDialog + * \brief The AboutDialog class provides a simple about dialog. + */ + +/*! + * \brief Constructs an about dialog with the provided information. + * \param parent Specifies the parent widget. + * \param applicationName Specifies the name of the application. If empty, QApplication::applicationName() will be used. + * \param creator Specifies the creator of the application. If empty, QApplication::organizationName() will be used. + * \param version Specifies the version of the application. If empty, QApplication::applicationVersion() will be used. + * \param description Specifies a short description about the application. + * \param website Specifies the URL to the website of the application. If empty, QApplication::organizationDomain() will be used. + * \param image Specifies the application icon. If the image is null, the standard information icon will be used. + */ +AboutDialog::AboutDialog(QWidget *parent, const QString &applicationName, const QString &creator, const QString &version, const QString &website, const QString &description, const QImage &image) : + QDialog(parent), + m_ui(new Ui::AboutDialog) +{ + m_ui->setupUi(this); +#ifdef Q_OS_WIN32 + setStyleSheet(QStringLiteral("* { font: 9pt \"Segoe UI\"; } #mainWidget { color: black; background-color: white; border: none; } #productNameLabel { font-size: 12pt; color: #003399; }")); +#else + setStyleSheet(QStringLiteral("#productNameLabel { font-weight: bold; }")); +#endif + setWindowFlags(Qt::Tool); + if(!applicationName.isEmpty()) { + m_ui->productNameLabel->setText(applicationName); + } else if(!QApplication::applicationDisplayName().isEmpty()) { + m_ui->productNameLabel->setText(QApplication::applicationDisplayName()); + } else { + m_ui->productNameLabel->setText(QApplication::applicationName()); + } + if(!creator.isEmpty()) { + m_ui->creatorLabel->setText(creator); + } else { + m_ui->creatorLabel->setText(QApplication::organizationName()); + } + if(!version.isEmpty()) { + m_ui->versionLabel->setText(version); + } else { + m_ui->versionLabel->setText(QApplication::applicationVersion()); + } + m_ui->descLabel->setText(description); + if(!website.isEmpty()) { + m_ui->websiteLabel->setText(tr("Website").arg(website)); + } else { + m_ui->websiteLabel->setText(tr("Website").arg(QApplication::organizationDomain())); + } + m_iconScene = new QGraphicsScene(this); + if(!image.isNull()) { + m_iconScene->addItem(new QGraphicsPixmapItem(QPixmap::fromImage(image))); + } else { + m_iconScene->addItem(new QGraphicsPixmapItem(QApplication::style()->standardIcon(QStyle::SP_MessageBoxInformation, nullptr, this).pixmap(128))); + } + m_ui->graphicsView->setScene(m_iconScene); + setGeometry(QStyle::alignedRect(Qt::LeftToRight, Qt::AlignCenter, size(), parentWidget() ? parentWidget()->geometry() : QApplication::desktop()->availableGeometry())); +} + +/*! + * \brief Constructs an about dialog with the specified \a parent, \a description and \a image. + */ +AboutDialog::AboutDialog(QWidget *parent, const QString &description, const QImage &image) : + AboutDialog(parent, QString(), QString(), QString(), QString(), description, image) +{} + +/*! + * \brief Destroys the about dialog. + */ +AboutDialog::~AboutDialog() +{} + +} diff --git a/aboutdialog/aboutdialog.h b/aboutdialog/aboutdialog.h new file mode 100644 index 0000000..0fbbff9 --- /dev/null +++ b/aboutdialog/aboutdialog.h @@ -0,0 +1,38 @@ +#ifndef ABOUTDIALOG_H +#define ABOUTDIALOG_H + +#include + +#include + +#include + +QT_BEGIN_NAMESPACE +class QGraphicsScene; +QT_END_NAMESPACE + +namespace Dialogs +{ + +namespace Ui { +class AboutDialog; +} + +class LIB_EXPORT AboutDialog : public QDialog +{ + Q_OBJECT + +public: + explicit AboutDialog(QWidget *parent, const QString &applicationName, const QString &creator, const QString &version, const QString &website = QString(), const QString &description = QString(), const QImage &image = QImage()); + explicit AboutDialog(QWidget *parent, const QString &description = QString(), const QImage &image = QImage()); + ~AboutDialog(); + +private: + std::unique_ptr m_ui; + QGraphicsScene *m_iconScene; +}; + +} + + +#endif // ABOUTDIALOG_H diff --git a/aboutdialog/aboutdialog.ui b/aboutdialog/aboutdialog.ui new file mode 100644 index 0000000..94c1176 --- /dev/null +++ b/aboutdialog/aboutdialog.ui @@ -0,0 +1,252 @@ + + + Dialogs::AboutDialog + + + + 0 + 0 + 400 + 300 + + + + + 43 + 0 + + + + + 400 + 300 + + + + + 400 + 300 + + + + About + + + + + + + + + false + + + + 0 + + + 0 + + + 0 + + + 0 + + + 0 + + + + + + + + QFrame::NoFrame + + + QFrame::Raised + + + + + + + 32 + 128 + + + + + 16777215 + 128 + + + + background: transparent; + + + QFrame::NoFrame + + + 0 + + + Qt::ScrollBarAlwaysOff + + + Qt::ScrollBarAlwaysOff + + + + + 0 + 0 + 0 + + + + + false + + + + + + + + 0 + 0 + + + + font-size: 12pt; + + + QFrame::NoFrame + + + QFrame::Plain + + + 1 + + + application name + + + Qt::AlignCenter + + + + + + + version + + + Qt::AlignCenter + + + + + + + Qt::Vertical + + + + 20 + 40 + + + + + + + + font-style: italic; + + + description + + + Qt::AlignCenter + + + true + + + + + + + + 0 + 0 + + + + true + + + text-decoration: underline; +color: palette(link)s; + + + website link + + + Qt::AlignCenter + + + true + + + Qt::LinksAccessibleByKeyboard|Qt::LinksAccessibleByMouse + + + + + + + Qt::Vertical + + + + 20 + 40 + + + + + + + + + 0 + 0 + + + + font-size: 8pt; + + + creators + + + Qt::AlignCenter + + + + + + + + + + + + + + diff --git a/enterpassworddialog/enterpassworddialog.cpp b/enterpassworddialog/enterpassworddialog.cpp new file mode 100644 index 0000000..e9d5b68 --- /dev/null +++ b/enterpassworddialog/enterpassworddialog.cpp @@ -0,0 +1,332 @@ +#include "enterpassworddialog.h" +#include "gui/ui_enterpassworddialog.h" + +#include +#include +#include +#include +#include + +#ifdef PLATFORM_SPECIFIC_CAPSLOCK_DETECTION +# if defined(Q_OS_WIN32) +# include +# elif defined(Q_OS_UNIX) +# include +# undef KeyPress +# undef KeyRelease +# undef FocusIn +# undef FocusOut +# endif +#endif + +namespace Dialogs { + +/*! + * \class Dialogs::EnterPasswordDialog + * \brief The EnterPasswordDialog class provides a simple dialog to ask the user for a password. + */ + +/*! + * \brief Constructs a password dialog. + * \param parent Specifies the parent widget. + */ +EnterPasswordDialog::EnterPasswordDialog(QWidget *parent) : + QDialog(parent), + m_ui(new Ui::EnterPasswordDialog) +{ + // setup ui + m_ui->setupUi(this); +#ifdef Q_OS_WIN32 + setStyleSheet(QStringLiteral("* { font: 9pt \"Segoe UI\"; } #mainWidget { color: black; background-color: white; border: none; } #bottomWidget { background-color: #F0F0F0; border-top: 1px solid #DFDFDF; } QMessageBox QLabel, QInputDialog QLabel, #instructionLabel {font-size: 12pt; color: #003399; }")); +#else + setStyleSheet(QStringLiteral("#instructionLabel { font-weight: bold; }")); +#endif + setDescription(); + setPromptForUserName(false); + setVerificationRequired(false); + setWindowFlags(Qt::Dialog | Qt::CustomizeWindowHint | Qt::WindowTitleHint | Qt::WindowCloseButtonHint); + installEventFilter(this); + m_ui->userNameLineEdit->installEventFilter(this); + m_ui->password1LineEdit->installEventFilter(this); + m_ui->password2LineEdit->installEventFilter(this); + // capslock key detection +#ifdef PLATFORM_SPECIFIC_CAPSLOCK_DETECTION + m_capslockPressed = isCapslockPressed(); +#else + m_capslockPressed = false; +#endif + m_ui->capslockWarningWidget->setVisible(m_capslockPressed); + // draw icon to capslock warning graphics view + QIcon icon = QApplication::style()->standardIcon(QStyle::SP_MessageBoxWarning, nullptr, this); + QGraphicsScene* scene = new QGraphicsScene(); + QGraphicsPixmapItem* item = new QGraphicsPixmapItem(icon.pixmap(16, 16)); + scene->addItem(item); + m_ui->capslockWarningGraphicsView->setScene(scene); + // connect signals and slots + connect(m_ui->showPasswordCheckBox, &QCheckBox::clicked, this, &EnterPasswordDialog::updateShowPassword); + connect(m_ui->noPwCheckBox, &QCheckBox::clicked, this, &EnterPasswordDialog::updateShowPassword); + connect(m_ui->confirmPushButton, &QPushButton::clicked, this, &EnterPasswordDialog::confirm); + connect(m_ui->abortPushButton, &QPushButton::clicked, this, &EnterPasswordDialog::abort); + // grab the keyboard + grabKeyboard(); +} + +/*! + * \brief Destroys the password dialog. + */ +EnterPasswordDialog::~EnterPasswordDialog() +{} + +/*! + * \brief Returns the description. The description is shown under the instruction text. + * \sa setDescription() + */ +QString EnterPasswordDialog::description() const +{ + return m_ui->descLabel->text(); +} + +/*! + * \brief Sets the description. + * \sa description() + */ +void EnterPasswordDialog::setDescription(const QString &description) +{ + m_ui->descLabel->setText(description); + m_ui->descLabel->setHidden(description.isEmpty()); + adjustSize(); +} + +/*! + * \brief Returns whether the dialogs prompts for a user name as well. + * + * The dialog does not prompt for a user name by default. + * + * \sa setPromptForUserName() + */ +bool EnterPasswordDialog::promtForUserName() const +{ + return !m_ui->userNameLineEdit->isHidden(); +} + +/*! + * \brief Sets whethere the dialog prompts for a user name as well. + * \sa promptForUserName() + */ +void EnterPasswordDialog::setPromptForUserName(bool prompt) +{ + m_ui->userNameLineEdit->setHidden(!prompt); + adjustSize(); +} + +/*! + * \brief Returns an indication whether a verification (password has to be entered twice) is required. + * + * \sa EnterPasswordDialog::setVerificationRequired() + */ +bool EnterPasswordDialog::isVerificationRequired() const +{ + return !m_ui->password2LineEdit->isHidden(); +} + +/*! + * \brief Returns an indication whether the user is force to enter a password. + * + * If no password is required, the user is allowed to skip the dialog without entering + * a password. + * + * \sa EnterPasswordDialog::setPasswordRequired() + */ +bool EnterPasswordDialog::isPasswordRequired() const +{ + return m_ui->noPwCheckBox->isHidden(); +} + +/*! + * \brief Sets whether the user is force to enter a password. + * + * If no password is required, the user is allowed to skip the dialog without entering + * a password. + * + * \sa EnterPasswordDialog::isPasswordRequired() + */ +void EnterPasswordDialog::setPasswordRequired(bool value) +{ + m_ui->noPwCheckBox->setHidden(value); + m_ui->noPwCheckBox->setChecked(false); + adjustSize(); +} + +/*! + * \brief Updates the relevant controls to show entered characters or to mask them them. + * + * This private slot is called when m_ui->showPasswordCheckBox is clicked. + */ +void EnterPasswordDialog::updateShowPassword() +{ + m_ui->password1LineEdit->setEchoMode(m_ui->showPasswordCheckBox->isChecked() + ? QLineEdit::Normal + : QLineEdit::Password); + m_ui->password1LineEdit->setEnabled(!m_ui->noPwCheckBox->isChecked()); + m_ui->password2LineEdit->setEnabled(!(m_ui->showPasswordCheckBox->isChecked() || m_ui->noPwCheckBox->isChecked())); +} + +/*! + * \brief Sets whether a verification (password has to be entered twice) is required. + * + * \sa EnterPasswordDialog::isVerificationRequired() + */ +void EnterPasswordDialog::setVerificationRequired(bool value) +{ + if(m_instruction.isEmpty()) { + m_ui->instructionLabel->setText(value ? tr("Enter the new password") : tr("Enter the password")); + } + m_ui->password2LineEdit->setHidden(!value); + adjustSize(); +} + +/*! + * \brief Sets the instruction text. + * + * \sa EnterPasswordDialog::instruction() + */ +void EnterPasswordDialog::setInstruction(const QString &value) +{ + m_instruction = value; + if(m_instruction.isEmpty()) { + m_ui->instructionLabel->setText(isVerificationRequired() ? tr("Enter the new password") : tr("Enter the password")); + } else { + m_ui->instructionLabel->setText(value); + } + adjustSize(); +} + +bool EnterPasswordDialog::event(QEvent *event) +{ + switch(event->type()) { + case QEvent::KeyPress: { + QKeyEvent *keyEvent = static_cast(event); + if(keyEvent->key() == Qt::Key_CapsLock) { + m_capslockPressed = !m_capslockPressed; + } + m_ui->capslockWarningWidget->setVisible(m_capslockPressed); + break; + } + default: + ; + } + return QDialog::event(event); +} + +/*! + * \brief Internal method to notice when the capslock key is pressed by the user. + * + * Invocation of this method is done by installing the event filter in the constructor. + */ +bool EnterPasswordDialog::eventFilter(QObject *sender, QEvent *event) +{ + switch(event->type()) { + case QEvent::KeyPress: { + QKeyEvent *keyEvent = static_cast(event); + if(keyEvent->key() == Qt::Key_CapsLock) { + m_capslockPressed = !m_capslockPressed; + } else { + QString text = keyEvent->text(); + if(text.length()) { + QChar firstChar = text.at(0); + bool shiftPressed = (keyEvent->modifiers() & Qt::ShiftModifier) != 0; + if((shiftPressed && firstChar.isLower()) || (!shiftPressed && firstChar.isUpper())) { + m_capslockPressed = true; + } else if(firstChar.isLetter()) { + m_capslockPressed = false; + } + } + } + m_ui->capslockWarningWidget->setVisible(m_capslockPressed); + } + break; + case QEvent::FocusIn: + if(sender == m_ui->userNameLineEdit || sender == m_ui->password1LineEdit || sender == m_ui->password2LineEdit) { + releaseKeyboard(); + qobject_cast(sender)->grabKeyboard(); + } + break; + case QEvent::FocusOut: + if(sender == m_ui->userNameLineEdit || sender == m_ui->password1LineEdit || sender == m_ui->password2LineEdit) { + qobject_cast(sender)->releaseKeyboard(); + grabKeyboard(); + } + break; + default: + ; + } + return false; +} + +/*! + * \brief Sets the dialog status to QDialog::Accepted if a valid password has been enterd. + * Displays an error message otherwise. + * + * This private slot is called when m_ui->confirmPushButton is clicked. + */ +void EnterPasswordDialog::confirm() +{ + if(!isPasswordRequired() && m_ui->noPwCheckBox->isChecked()) { + m_password.clear(); + done(QDialog::Accepted); + } else { + QString userName = m_ui->userNameLineEdit->text(); + QString password = m_ui->password1LineEdit->text(); + QString repeatedPassword = m_ui->password2LineEdit->text(); + if(promtForUserName() && userName.isEmpty()) { + QMessageBox::warning(this, windowTitle(), tr("You didn't enter a user name.")); + } else if(password.isEmpty()) { + QMessageBox::warning(this, windowTitle(), tr("You didn't enter a password.")); + } else { + if(isVerificationRequired() && (password != repeatedPassword) && !m_ui->showPasswordCheckBox->isChecked()) { + if(repeatedPassword.isEmpty()) { + QMessageBox::warning(this, windowTitle(), tr("You have to enter the new password twice to ensure you enterd it correct.")); + } else { + QMessageBox::warning(this, windowTitle(), tr("You mistyped the password.")); + } + } else { + m_userName = userName; + m_password = password; + done(QDialog::Accepted); + } + } + } +} + +/*! + * \brief Returns an indication whether the capslock key is pressed using platform specific functions. + * + * \remarks - Returns always false for unsupported platforms. + * - This method is only avialable if the library is built with + * PLATFORM_SPECIFIC_CAPSLOCK_DETECTION defined. + * - This static function will be used internally to detect whether the capslock key is pressed + * when initializing the dialog if available. + * - The function requires the application to be linked against X11 on Linux/Unix/Max OS X. + */ +#ifdef PLATFORM_SPECIFIC_CAPSLOCK_DETECTION +bool EnterPasswordDialog::isCapslockPressed() +{ + // platform dependent method of determining if CAPS LOCK is pressed +# if defined(Q_OS_WIN32) + return GetKeyState(VK_CAPITAL) == 1; +# elif defined(Q_OS_UNIX) + Display *d = XOpenDisplay((char*)0); + bool caps_state = false; + if (d) { + unsigned n; + XkbGetIndicatorState(d, XkbUseCoreKbd, &n); + caps_state = (n & 0x01) == 1; + } + return caps_state; +# else + return false; +# endif +} +#endif + +} diff --git a/enterpassworddialog/enterpassworddialog.h b/enterpassworddialog/enterpassworddialog.h new file mode 100644 index 0000000..c1f6e31 --- /dev/null +++ b/enterpassworddialog/enterpassworddialog.h @@ -0,0 +1,108 @@ +#ifndef ENTERPASSWORDDIALOG_H +#define ENTERPASSWORDDIALOG_H + +#include + +#include + +#include + +namespace Dialogs { + +namespace Ui { +class EnterPasswordDialog; +} + +class LIB_EXPORT EnterPasswordDialog : public QDialog +{ + Q_OBJECT + Q_PROPERTY(QString userName READ userName) + Q_PROPERTY(QString password READ password) + Q_PROPERTY(QString description READ description WRITE setDescription) + Q_PROPERTY(bool promtForUserName READ promtForUserName WRITE setPromptForUserName) + Q_PROPERTY(bool isVerificationRequired READ isVerificationRequired WRITE setVerificationRequired) + Q_PROPERTY(bool isPasswordRequired READ isPasswordRequired WRITE setPasswordRequired) + Q_PROPERTY(QString instruction READ instruction WRITE setInstruction) + Q_PROPERTY(bool isCapslockPressed READ isCapslockPressed) + +public: + explicit EnterPasswordDialog(QWidget *parent = nullptr); + ~EnterPasswordDialog(); + const QString &userName() const; + const QString &password() const; + QString description() const; + void setDescription(const QString &description = QString()); + bool promtForUserName() const; + void setPromptForUserName(bool prompt); + bool isVerificationRequired() const; + void setVerificationRequired(bool value); + bool isPasswordRequired() const; + void setPasswordRequired(bool value); + const QString &instruction() const; + void setInstruction(const QString &value); +#ifdef PLATFORM_SPECIFIC_CAPSLOCK_DETECTION + static bool isCapslockPressed(); +#endif + +protected: + bool event(QEvent *event); + bool eventFilter(QObject *sender, QEvent *event); + +private slots: + void updateShowPassword(); + void confirm(); + void abort(); + +private: + std::unique_ptr m_ui; + QString m_userName; + QString m_password; + QString m_instruction; + bool m_capslockPressed; +}; + +/*! + * \brief Returns the entered user name. + */ +inline const QString &EnterPasswordDialog::userName() const +{ + return m_userName; +} + +/*! + * \brief Returns the entered password. + */ +inline const QString &EnterPasswordDialog::password() const +{ + return m_password; +} + +/*! + * \brief Returns the instruction text. + * + * The instruction text is displayed at the top of the dialog. + * If the instruction text is empty the default text "Enter the new password" + * or "Enter the password" (depending on whether the verification is requried or + * not) displayed. + * + * \sa EnterPasswordDialog::setInstruction() + */ +inline const QString &EnterPasswordDialog::instruction() const +{ + return m_instruction; +} + +/*! + * \brief Clears all results and sets the dialog status to QDialog::Rejected. + * + * This private slot is called when m_ui->abortPushButton is clicked. + */ +inline void EnterPasswordDialog::abort() +{ + m_password.clear(); + done(QDialog::Rejected); +} + +} + +#endif // ENTERPASSWORDDIALOG_H diff --git a/enterpassworddialog/enterpassworddialog.ui b/enterpassworddialog/enterpassworddialog.ui new file mode 100644 index 0000000..e36e026 --- /dev/null +++ b/enterpassworddialog/enterpassworddialog.ui @@ -0,0 +1,283 @@ + + + Dialogs::EnterPasswordDialog + + + + 0 + 0 + + + + Enter the password + + + true + + + + 0 + + + 0 + + + 0 + + + 0 + + + 0 + + + + + + + + + 0 + 0 + + + + + 500 + 16777215 + + + + Enter the password + + + true + + + + + + + + + + user name + + + + + + + + 0 + 0 + + + + + + + 32 + + + QLineEdit::Password + + + password + + + + + + + true + + + 32 + + + QLineEdit::Password + + + repeat password + + + + + + + + 0 + + + 0 + + + 0 + + + 0 + + + + + + 0 + 0 + + + + show password + + + + + + + don't use a password + + + + + + + + + + + + + + 0 + 0 + + + + + + + + 3 + + + 0 + + + 0 + + + 0 + + + 0 + + + + + + 16 + 16 + + + + background-color: transparent; + + + QFrame::NoFrame + + + + + 0 + 0 + 0 + + + + + + 0.000000000000000 + 0.000000000000000 + 16.000000000000000 + 16.000000000000000 + + + + + + + + font-weight: bold; + + + Capslock is active + + + + + + + + + + Qt::Horizontal + + + + 168 + 20 + + + + + + + + background: none; + + + Abort + + + + + + + + + + + + background: none; + + + Confirm + + + + + + + + + + + + + + + + Widgets::ClearLineEdit + QLineEdit +
qtutilities/widgets/clearlineedit.h
+ + + + password1LineEdit + password2LineEdit + confirmPushButton + abortPushButton + + + + diff --git a/general.pri b/general.pri new file mode 100644 index 0000000..9156999 --- /dev/null +++ b/general.pri @@ -0,0 +1,71 @@ +# template +TEMPLATE = lib +#dirs +UI_DIR = ./gui +MOC_DIR = ./moc +OBJECTS_DIR = ./obj +RCC_DIR = ./res +# compiler flags +QMAKE_CXXFLAGS += -std=c++11 +QMAKE_LFLAGS += -std=c++11 +unix { + QMAKE_LFLAGS += "-Wl,--rpath=./" +} +# prefix +targetprefix = . +# target +CONFIG(debug, debug|release) { + TARGET = $$targetprefix/$${projectname}d +} else { + TARGET = $$targetprefix/$$projectname +} +# variables to check target architecture +win32-g++:QMAKE_TARGET.arch = $$QMAKE_HOST.arch +win32-g++-32:QMAKE_TARGET.arch = x86 +win32-g++-64:QMAKE_TARGET.arch = x86_64 +linux-g++:QMAKE_TARGET.arch = $$QMAKE_HOST.arch +linux-g++-32:QMAKE_TARGET.arch = x86 +linux-g++-64:QMAKE_TARGET.arch = x86_64 +# configuration +mobile { + DEFINES += CONFIG_MOBILE +} else:desktop { + DEFINES += CONFIG_DESKTOP +} else:android { + CONFIG += mobile + DEFINES += CONFIG_MOBILE +} else { + CONFIG += desktop + DEFINES += CONFIG_DESKTOP +} +no-gui { + QT -= gui + DEFINES += GUI_NONE + guiqtquick || guiqtwidgets { + error("Can not use no-gui with guiqtquick or guiqtwidgets.") + } else { + message("Configured for no GUI support.") + } +} else { + QT += gui + mobile { + CONFIG += guiqtquick + } + desktop { + CONFIG += guiqtwidgets + } +} +guiqtquick { + message("Configured for Qt Quick GUI support.") + greaterThan(QT_MAJOR_VERSION, 4): QT += quick + CONFIG(debug, debug|release) { + CONFIG += qml_debug + } + DEFINES += GUI_QTQUICK +} +guiqtwidgets { + message("Configured for Qt widgets GUI support.") + greaterThan(QT_MAJOR_VERSION, 4): QT += widgets + DEFINES += GUI_QTWIDGETS + DEFINES += MODEL_UNDO_SUPPORT +} diff --git a/models/checklistmodel.cpp b/models/checklistmodel.cpp new file mode 100644 index 0000000..eabc617 --- /dev/null +++ b/models/checklistmodel.cpp @@ -0,0 +1,226 @@ +#include "checklistmodel.h" + +#include + +/*! + \namespace Models + \brief Provides common models. +*/ + +namespace Models { + +/*! + * \class Models::ChecklistItem + * \brief The ChecklistItem class provides an item for use with the ChecklistModel class. + */ + +/*! + * \class Models::ChecklistModel + * \brief The ChecklistModel class provides a generic model for storing checkable items. + */ + +/*! + * \brief Constructs a new checklist model. + */ +ChecklistModel::ChecklistModel(QObject *parent) : + QAbstractListModel(parent) +{} + +int ChecklistModel::rowCount(const QModelIndex &parent) const +{ + if(!parent.isValid()) { + return m_items.size(); + } + return 0; +} + +Qt::ItemFlags ChecklistModel::flags(const QModelIndex &index) const +{ + if(!index.isValid() || index.row() >= m_items.count() || index.model() != this) { + return Qt::ItemIsDropEnabled; // allows drops outside the items + } + return QAbstractListModel::flags(index) | Qt::ItemIsUserCheckable | Qt::ItemIsDragEnabled; +} + +QVariant ChecklistModel::data(const QModelIndex &index, int role) const +{ + if(index.isValid() && index.row() < m_items.size()) { + switch(role) { + case Qt::DisplayRole: + return m_items.at(index.row()).label(); + case Qt::CheckStateRole: + return m_items.at(index.row()).checkState(); + case idRole(): + return m_items.at(index.row()).id(); + default: + ; + } + } + return QVariant(); +} + +QMap ChecklistModel::itemData(const QModelIndex &index) const +{ + QMap roles; + roles.insert(Qt::DisplayRole, data(index, Qt::DisplayRole)); + roles.insert(Qt::CheckStateRole, data(index, Qt::CheckStateRole)); + roles.insert(idRole(), data(index, idRole())); + return roles; +} + +bool ChecklistModel::setData(const QModelIndex &index, const QVariant &value, int role) +{ + bool success = false; + QVector roles; + roles << role; + if(index.isValid() && index.row() < m_items.size()) { + switch(role) { + case Qt::DisplayRole: + m_items[index.row()].m_label = value.toString(); + success = true; + break; + case Qt::CheckStateRole: + if(value.canConvert(QMetaType::Int)) { + m_items[index.row()].m_checkState = static_cast(value.toInt()); + success = true; + } + break; + case idRole(): { + m_items[index.row()].m_id = value; + success = true; + QString label = labelForId(value); + if(!label.isEmpty()) { + m_items[index.row()].m_label = label; + roles << Qt::DisplayRole; + } + break; + } default: + ; + } + } + if(success) { + dataChanged(index, index, roles); + } + return success; +} + +bool ChecklistModel::setItemData(const QModelIndex &index, const QMap &roles) +{ + for(QMap::ConstIterator it = roles.constBegin(); it != roles.constEnd(); ++it) { + setData(index, it.value(), it.key()); + } + return true; +} + +/*! + * \brief Returns the label for the specified \a id. + * + * This method might be reimplemented when subclassing to provide labels + * for the item IDs. + * + * If an item's ID is set (using setData() and idRole()) this method is called + * to update the item's label as well. If this method returns an empty string + * (default behaviour) the item's label will not be updated. + */ +QString ChecklistModel::labelForId(const QVariant &) const +{ + return QString(); +} + +Qt::DropActions ChecklistModel::supportedDropActions() const +{ + return Qt::MoveAction; +} + +bool ChecklistModel::insertRows(int row, int count, const QModelIndex &parent) +{ + if (count < 1 || row < 0 || row > rowCount() || parent.isValid()) { + return false; + } + beginInsertRows(QModelIndex(), row, row + count - 1); + for(int index = row, end = row + count; index < end; ++index) { + m_items.insert(index, ChecklistItem()); + } + endInsertRows(); + return true; +} + +bool ChecklistModel::removeRows(int row, int count, const QModelIndex &parent) +{ + if (count < 1 || row < 0 || (row + count) > rowCount() || parent.isValid()) { + return false; + } + beginRemoveRows(QModelIndex(), row, row + count - 1); + for(int index = row, end = row + count; index < end; ++index) { + m_items.removeAt(index); + } + endRemoveRows(); + return true; +} + +/*! + * \brief Sets the items. Resets the model. + */ +void ChecklistModel::setItems(const QList &items) +{ + beginResetModel(); + m_items = items; + endResetModel(); +} + +/*! + * \brief Restores the IDs and checkstates read from the specified \a settings object. + * + * The items will be read from the array with the specified \a name. + * + * Resets the model (current items are cleared). + * + * Does not restore any labels. Labels are meant to be restored from the ID. + */ +void ChecklistModel::restore(QSettings &settings, const QString &name) +{ + beginResetModel(); + auto currentItems = m_items; + QList restoredIds; + m_items.clear(); + int rows = settings.beginReadArray(name); + m_items.reserve(rows); + for(int i = 0; i < rows; ++i) { + settings.setArrayIndex(i); + QVariant id = settings.value(QStringLiteral("id")); + QVariant selected = settings.value(QStringLiteral("selected")); + if(!id.isNull() && !selected.isNull() && selected.canConvert(QMetaType::Bool) && !restoredIds.contains(id)) { + m_items << ChecklistItem(id, labelForId(id), selected.toBool() ? Qt::Checked : Qt::Unchecked); + restoredIds << id; + } + } + settings.endArray(); + for(const ChecklistItem &item : currentItems) { + if(!restoredIds.contains(item.id())) { + m_items << item; + } + } + endResetModel(); +} + +/*! + * \brief Saves the IDs and checkstates to the specified \a settings object. + * + * The items will be stored using an array with the specified \a name. + * + * Does not save any labels. + */ +void ChecklistModel::save(QSettings &settings, const QString &name) const +{ + settings.beginWriteArray(name, m_items.size()); + int index = 0; + for(const ChecklistItem &item : m_items) { + settings.setArrayIndex(index); + settings.setValue(QStringLiteral("id"), item.id()); + settings.setValue(QStringLiteral("selected"), item.isChecked()); + ++index; + } + settings.endArray(); +} + +} diff --git a/models/checklistmodel.h b/models/checklistmodel.h new file mode 100644 index 0000000..14c281a --- /dev/null +++ b/models/checklistmodel.h @@ -0,0 +1,119 @@ +#ifndef CHECKLISTMODEL_H +#define CHECKLISTMODEL_H + +#include + +#include +#include + +QT_BEGIN_NAMESPACE +class QSettings; +QT_END_NAMESPACE + +namespace Models { + +class ChecklistModel; + +class LIB_EXPORT ChecklistItem +{ + friend class ChecklistModel; + +public: + ChecklistItem(const QVariant &id = QVariant(), const QString &label = QString(), Qt::CheckState checked = Qt::Unchecked); + + const QVariant &id() const; + const QString &label() const; + Qt::CheckState checkState() const; + bool isChecked() const; + +private: + QVariant m_id; + QString m_label; + Qt::CheckState m_checkState; +}; + +inline ChecklistItem::ChecklistItem(const QVariant &id, const QString &label, Qt::CheckState checkState) : + m_id(id), + m_label(label), + m_checkState(checkState) +{} + +/*! + * \brief Returns the ID of the item. + */ +inline const QVariant &ChecklistItem::id() const +{ + return m_id; +} + +/*! + * \brief Returns the label. + */ +inline const QString &ChecklistItem::label() const +{ + return m_label; +} + +/*! + * \brief Returns the check state. + */ +inline Qt::CheckState ChecklistItem::checkState() const +{ + return m_checkState; +} + +/*! + * \brief Returns whether the item is checked. + */ + +inline bool ChecklistItem::isChecked() const +{ + return m_checkState == Qt::Checked; +} + +class LIB_EXPORT ChecklistModel : public QAbstractListModel +{ + Q_OBJECT +public: + explicit ChecklistModel(QObject *parent = nullptr); + + int rowCount(const QModelIndex &parent = QModelIndex()) const; + Qt::ItemFlags flags(const QModelIndex &index) const; + QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const; + QMap itemData(const QModelIndex &index) const; + bool setData(const QModelIndex &index, const QVariant &value, int role = Qt::DisplayRole); + bool setItemData(const QModelIndex &index, const QMap &roles); + virtual QString labelForId(const QVariant &id) const; + Qt::DropActions supportedDropActions() const; + bool insertRows(int row, int count, const QModelIndex &parent); + bool removeRows(int row, int count, const QModelIndex &parent); + const QList &items() const; + void setItems(const QList &items); + void restore(QSettings &settings, const QString &name); + void save(QSettings &settings, const QString &name) const; + static inline constexpr int idRole(); + +private: + QList m_items; + +}; + +/*! + * \brief Returns the items. + */ +inline const QList &ChecklistModel::items() const +{ + return m_items; +} + +/*! + * \brief Returns the role used to get or set the item ID. + */ +inline constexpr int ChecklistModel::idRole() +{ + return Qt::UserRole + 1; +} + +} + +#endif // CHECKLISTMODEL_H diff --git a/pkgbuild/default/PKGBUILD b/pkgbuild/default/PKGBUILD new file mode 100644 index 0000000..905ef46 --- /dev/null +++ b/pkgbuild/default/PKGBUILD @@ -0,0 +1,22 @@ +pkgname=qtutilities +pkgver=1.0.4 +pkgrel=1 +arch=('i686' 'x86_64') +pkgdesc="Collection of Qt related utility classes and functions used by Tageditor, Video downloader and Password manager." +license=('GPL') +depends=('c++utilities') +makedepends= +url="http://martchus.netai.net/" +source=("$pkgname.tar.gz") +md5sums=('cee38afc5eb60b2da4eba64107628ed7') +# head end +build() { + cd $srcdir/$pkgname + INSTALL_ROOT=$pkgdir/usr/ qmake-qt5 "$pkgname.pro" -r -spec linux-g++ + make +} + +package() { + cd $srcdir/$pkgname + make install +} diff --git a/pkgbuild/mingw-w64/PKGBUILD b/pkgbuild/mingw-w64/PKGBUILD new file mode 100644 index 0000000..61c16fc --- /dev/null +++ b/pkgbuild/mingw-w64/PKGBUILD @@ -0,0 +1,44 @@ +_name=qtutilities +pkgname=mingw-w64-$_name +pkgver=1.0.4 +pkgrel=1 +arch=('any') +pkgdesc="Collection of Qt related utility classes and functions used by Tageditor, Video downloader and Password manager (mingw-w64)." +license=('GPL') +depends=('mingw-w64-crt' 'mingw-w64-qt5-base' 'mingw-w64-c++utilities') +makedepends=('mingw-w64-gcc') +url="http://martchus.netai.net/" +source=("${_name}.tar.gz") +md5sums=('4e94aff9225d8873f752995c1bcc5f15') +options=('staticlibs' '!strip') +_architectures="i686-w64-mingw32 x86_64-w64-mingw32" +# head end +build() { + cd $srcdir/$_name + # build utilities for each architecture + for _arch in ${_architectures}; do + mkdir -p build-${_arch} && pushd build-${_arch} + INSTALL_ROOT=$pkgdir/usr/ ${_arch}-qmake-qt5 -r ../${_name}.pro + make + popd + done +} + +package() { + cd $srcdir/$_name + for _arch in ${_architectures}; do + # bin stuff + pushd build-${_arch} + ${_arch}-strip --strip-unneeded ./release/${_name}.dll + ${_arch}-strip --strip-unneeded ./release/lib${_name}.dll.a + install -m755 -D ./release/${_name}.dll $pkgdir/usr/${_arch}/bin/${_name}.dll + install -m755 -D ./release/lib${_name}.dll.a $pkgdir/usr/${_arch}/lib/lib${_name}.dll.a + popd + # include files + for dir in aboutdialog enterpassworddialog settingsdialog widgets resources models + do + mkdir -p $pkgdir/usr/${_arch}/include/${_name}/$dir + install -m644 -D ./$dir/*.h $pkgdir/usr/${_arch}/include/${_name}/$dir + done + done +} diff --git a/qtutilities.doxygen b/qtutilities.doxygen new file mode 100644 index 0000000..430f36a --- /dev/null +++ b/qtutilities.doxygen @@ -0,0 +1,2310 @@ +# Doxyfile 1.8.7 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "Qt utilities" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = 1 + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = "Collection of Qt related utility classes and functions used by my C++ applications." + +# With the PROJECT_LOGO tag one can specify an logo or icon that is included in +# the documentation. The maximum height of the logo should not exceed 55 pixels +# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo +# to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = ./doc + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = YES + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a +# new page for each member. If set to NO, the documentation of a member will be +# part of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: +# Fortran. In the later case the parser tries to guess whether the code is fixed +# or free formatted code, this is the default for Fortran type files), VHDL. For +# instance to make doxygen treat .inc files as Fortran files (default is PHP), +# and .f files as C (default is Fortran), use: inc=Fortran f=C. +# +# Note For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by by putting a % sign in front of the word +# or globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = YES + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. When set to YES local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO these classes will be included in the various overviews. This option has +# no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO these declarations will be +# included in the documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# The default value is: system dependent. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the +# todo list. This list is created by putting \todo commands in the +# documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the +# test list. This list is created by putting \test commands in the +# documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES the list +# will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. Do not use file names with spaces, bibtex cannot handle them. See +# also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO doxygen will only warn about wrong or incomplete parameter +# documentation, but not about the absence of documentation. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. +# Note: If this tag is empty the current directory is searched. + +INPUT = aboutdialog enterpassworddialog settingsdialog widgets resources + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank the +# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, +# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, +# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, +# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, +# *.qsf, *.as and *.js. + +FILE_PATTERNS = *.cpp *.h + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = NO + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER ) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = YES + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES, then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user- +# defined cascading style sheet that is included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefor more robust against future updates. +# Doxygen will copy the style sheet file to the output directory. For an example +# see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the stylesheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to NO can help when comparing the output of multiple runs. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler ( hhc.exe). If non-empty +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated ( +# YES) or that it should be included in the master .chm file ( NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated ( +# YES) or a normal table of contents ( NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using prerendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /