vnote/src/vdocument.h

140 lines
3.7 KiB
C++

#ifndef VDOCUMENT_H
#define VDOCUMENT_H
#include <QObject>
#include <QString>
class VFile;
class VDocument : public QObject
{
Q_OBJECT
Q_PROPERTY(QString text MEMBER m_text NOTIFY textChanged)
Q_PROPERTY(QString toc MEMBER m_toc NOTIFY tocChanged)
Q_PROPERTY(QString html MEMBER m_html NOTIFY htmlChanged)
public:
// @p_file could be NULL.
VDocument(const VFile *p_file, QObject *p_parent = 0);
QString getToc();
// Scroll to @anchor in the web.
// @anchor is the id without '#', like "toc_1". If empty, will scroll to top.
void scrollToAnchor(const QString &anchor);
void setHtml(const QString &html);
// Request to highlight a segment text.
// Use p_id to identify the result.
void highlightTextAsync(const QString &p_text, int p_id, int p_timeStamp);
// Request to convert @p_text to HTML.
void textToHtmlAsync(const QString &p_text);
void setFile(const VFile *p_file);
bool isReadyToHighlight() const;
bool isReadyToTextToHtml() const;
// Request to get the HTML content.
void getHtmlContentAsync();
public slots:
// Will be called in the HTML side
// @toc: the HTML of the TOC.
// @baseLevel: the base level of @toc, starting from 1. It is the top level
// in the @toc.
void setToc(const QString &toc, int baseLevel);
// When the Web view has been scrolled, it will signal current header anchor.
// Empty @anchor to indicate an invalid header.
// The header does not begins with '#'.
void setHeader(const QString &anchor);
void setLog(const QString &p_log);
void keyPressEvent(int p_key, bool p_ctrl, bool p_shift);
void updateText();
void highlightTextCB(const QString &p_html, int p_id, int p_timeStamp);
void noticeReadyToHighlightText();
void textToHtmlCB(const QString &p_text, const QString &p_html);
void noticeReadyToTextToHtml();
// Web-side handle logics (MathJax etc.) is finished.
// But the page may not finish loading, such as images.
void finishLogics();
void htmlContentCB(const QString &p_head,
const QString &p_style,
const QString &p_body);
signals:
void textChanged(const QString &text);
void tocChanged(const QString &toc);
void requestScrollToAnchor(const QString &anchor);
// @anchor is the id of that anchor, without '#'.
void headerChanged(const QString &anchor);
void htmlChanged(const QString &html);
void logChanged(const QString &p_log);
void keyPressed(int p_key, bool p_ctrl, bool p_shift);
void requestHighlightText(const QString &p_text, int p_id, int p_timeStamp);
void textHighlighted(const QString &p_html, int p_id, int p_timeStamp);
void readyToHighlightText();
void logicsFinished();
void requestTextToHtml(const QString &p_text);
void textToHtmlFinished(const QString &p_text, const QString &p_html);
void requestHtmlContent();
void htmlContentFinished(const QString &p_headContent,
const QString &p_styleContent,
const QString &p_bodyContent);
private:
QString m_toc;
QString m_header;
// m_text does NOT contain actual content.
QString m_text;
// When using Hoedown, m_html will contain the html content.
QString m_html;
const VFile *m_file;
// Whether the web side is ready to handle highlight text request.
bool m_readyToHighlight;
// Whether the web side is ready to convert text to html.
bool m_readyToTextToHtml;
};
inline bool VDocument::isReadyToHighlight() const
{
return m_readyToHighlight;
}
inline bool VDocument::isReadyToTextToHtml() const
{
return m_readyToTextToHtml;
}
#endif // VDOCUMENT_H