tutorialmanager.h

Go to the documentation of this file.

/*
 * SyntaxTutor - Interactive Tutorial About Syntax Analyzers
 * Copyright (C) 2025 Jose R. (jose-rzm)
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef TUTORIALMANAGER_H
#define TUTORIALMANAGER_H
 
#include <QEvent>
#include <QFrame>
#include <QObject>
#include <QPushButton>
#include <QString>
#include <QTextBrowser>
#include <QVector>
#include <QWidget>

struct TutorialStep {
    QWidget* target;   
    QString  htmlText; 
};

class TutorialManager : public QObject {
    Q_OBJECT
  public:
    TutorialManager(QWidget* rootWindow);

    void addStep(QWidget* target, const QString& htmlText);

    void start();

    void setRootWindow(QWidget* newRoot);

    void clearSteps();

    void hideOverlay();

    void finishLL1();

    void finishSLR1();
 
  protected:
    bool eventFilter(QObject* obj, QEvent* ev) override;
 
  signals:
    void stepStarted(int index);

    void tutorialFinished();

    void ll1Finished();

    void slr1Finished();
 
  public slots:
    void nextStep();
 
  private:
    void showOverlay();

    void repositionOverlay();
 
    QWidget*              m_root;  
    QVector<TutorialStep> m_steps; 
    int                   m_index = -1; 
 
    QWidget* m_overlay = nullptr; 
    QFrame*  m_highlight =
        nullptr; 
    QTextBrowser* m_textBox = nullptr; 
    QPushButton*  m_nextBtn = nullptr; 
};
 
#endif // TUTORIALMANAGER_H