updated documentation

This commit is contained in:
Herwig Birke
2018-06-29 11:02:27 +02:00
parent 15e11cde1f
commit 74a798a42c
4 changed files with 1141 additions and 0 deletions
+38
View File
@@ -27,6 +27,11 @@
#endif
/*!
\brief
\enum ALIGN
*/
enum ALIGN
{
ALIGN_left = 1,
@@ -92,11 +97,44 @@ QByteArray textDocument2Blob(cTextDocument* lpTextDocument);
QString localePath();
QString paperName(QPagedPaintDevice::PageSize paperSize);
/*!
\brief
\fn paperKey
\param szPaperSize
\return QPagedPaintDevice::PageSize
*/
QPagedPaintDevice::PageSize paperKey(const QString& szPaperSize);
/*!
\brief
\fn paperList
\return QMap<QPagedPaintDevice::PageSize, QString>
*/
QMap<QPagedPaintDevice::PageSize, QString> paperList();
/*!
\brief
\fn unitName
\param unit
\return QString
*/
QString unitName(QPrinter::Unit unit);
/*!
\brief
\fn unitKey
\param szUnit
\return QPrinter::Unit
*/
QPrinter::Unit unitKey(const QString& szUnit);
/*!
\brief
\fn unitList
\return QMap<QPrinter::Unit, QString>
*/
QMap<QPrinter::Unit, QString> unitList();
#endif // COMMON_H
+11
View File
@@ -53,8 +53,19 @@ private slots:
*/
void onLanguageIndexChanged(int index);
/*!
\brief
\fn onButtonClicked
\param button
*/
void onButtonClicked(QAbstractButton* button);
signals:
/*!
\brief
\fn onLanguageChanged
*/
void onLanguageChanged();
private:
+414
View File
@@ -118,74 +118,488 @@ private slots:
void onTargetDateChanged(const QDateTime& dateTime);
void onPrintTitleChanged(bool checked);
/*!
\brief
\fn onTitleFontChanged
\param text
*/
void onTitleFontChanged(const QString &text);
/*!
\brief
\fn onTitleFontSizeChanged
\param text
*/
void onTitleFontSizeChanged(const QString &text);
/*!
\brief
\fn onTitleBoldChanged
\param checked
*/
void onTitleBoldChanged(bool checked);
/*!
\brief
\fn onTitleItalicChanged
\param checked
*/
void onTitleItalicChanged(bool checked);
/*!
\brief
\fn onTitleUnderlineChanged
\param checked
*/
void onTitleUnderlineChanged(bool checked);
/*!
\brief
\fn onTitleLeftChanged
\param checked
*/
void onTitleLeftChanged(bool checked);
/*!
\brief
\fn onTitleCenterChanged
\param checked
*/
void onTitleCenterChanged(bool checked);
/*!
\brief
\fn onTitleRightChanged
\param checked
*/
void onTitleRightChanged(bool checked);
/*!
\brief
\fn onPrintSubtitleChanged
\param checked
*/
void onPrintSubtitleChanged(bool checked);
/*!
\brief
\fn onSubtitleFontChanged
\param text
*/
void onSubtitleFontChanged(const QString &text);
/*!
\brief
\fn onSubtitleFontSizeChanged
\param text
*/
void onSubtitleFontSizeChanged(const QString &text);
/*!
\brief
\fn onSubtitleBoldChanged
\param checked
*/
void onSubtitleBoldChanged(bool checked);
/*!
\brief
\fn onSubtitleItalicChanged
\param checked
*/
void onSubtitleItalicChanged(bool checked);
/*!
\brief
\fn onSubtitleUnderlineChanged
\param checked
*/
void onSubtitleUnderlineChanged(bool checked);
/*!
\brief
\fn onSubtitleLeftChanged
\param checked
*/
void onSubtitleLeftChanged(bool checked);
/*!
\brief
\fn onSubtitleCenterChanged
\param checked
*/
void onSubtitleCenterChanged(bool checked);
/*!
\brief
\fn onSubtitleRightChanged
\param checked
*/
void onSubtitleRightChanged(bool checked);
/*!
\brief
\fn onPrintShortDescriptionChanged
\param checked
*/
void onPrintShortDescriptionChanged(bool checked);
/*!
\brief
\fn onPrintDescriptionChanged
\param checked
*/
void onPrintDescriptionChanged(bool checked);
/*!
\brief
\fn onPrintAuthorChanged
\param checked
*/
void onPrintAuthorChanged(bool checked);
/*!
\brief
\fn onAuthorFontChanged
\param text
*/
void onAuthorFontChanged(const QString &text);
/*!
\brief
\fn onAuthorFontSizeChanged
\param text
*/
void onAuthorFontSizeChanged(const QString &text);
/*!
\brief
\fn onAuthorBoldChanged
\param checked
*/
void onAuthorBoldChanged(bool checked);
/*!
\brief
\fn onAuthorItalicChanged
\param checked
*/
void onAuthorItalicChanged(bool checked);
/*!
\brief
\fn onAuthorUnderlineChanged
\param checked
*/
void onAuthorUnderlineChanged(bool checked);
/*!
\brief
\fn onAuthorLeftChanged
\param checked
*/
void onAuthorLeftChanged(bool checked);
/*!
\brief
\fn onAuthorCenterChanged
\param checked
*/
void onAuthorCenterChanged(bool checked);
/*!
\brief
\fn onAuthorRightChanged
\param checked
*/
void onAuthorRightChanged(bool checked);
/*!
\brief
\fn onPrintPartNameChanged
\param checked
*/
void onPrintPartNameChanged(bool checked);
/*!
\brief
\fn onPartNameFontChanged
\param text
*/
void onPartNameFontChanged(const QString &text);
/*!
\brief
\fn onPartNameFontSizeChanged
\param text
*/
void onPartNameFontSizeChanged(const QString &text);
/*!
\brief
\fn onPartNameBoldChanged
\param checked
*/
void onPartNameBoldChanged(bool checked);
/*!
\brief
\fn onPartNameItalicChanged
\param checked
*/
void onPartNameItalicChanged(bool checked);
/*!
\brief
\fn onPartNameUnderlineChanged
\param checked
*/
void onPartNameUnderlineChanged(bool checked);
/*!
\brief
\fn onPartNameLeftChanged
\param checked
*/
void onPartNameLeftChanged(bool checked);
/*!
\brief
\fn onPartNameCenterChanged
\param checked
*/
void onPartNameCenterChanged(bool checked);
/*!
\brief
\fn onPartNameRightChanged
\param checked
*/
void onPartNameRightChanged(bool checked);
/*!
\brief
\fn onPrintPartDescriptionChanged
\param checked
*/
void onPrintPartDescriptionChanged(bool checked);
/*!
\brief
\fn onPrintPartTextChanged
\param checked
*/
void onPrintPartTextChanged(bool checked);
/*!
\brief
\fn onPrintChapterNameChanged
\param checked
*/
void onPrintChapterNameChanged(bool checked);
/*!
\brief
\fn onChapterNameFontChanged
\param text
*/
void onChapterNameFontChanged(const QString &text);
/*!
\brief
\fn onChapterNameFontSizeChanged
\param text
*/
void onChapterNameFontSizeChanged(const QString &text);
/*!
\brief
\fn onChapterNameBoldChanged
\param checked
*/
void onChapterNameBoldChanged(bool checked);
/*!
\brief
\fn onChapterNameItalicChanged
\param checked
*/
void onChapterNameItalicChanged(bool checked);
/*!
\brief
\fn onChapterNameUnderlineChanged
\param checked
*/
void onChapterNameUnderlineChanged(bool checked);
/*!
\brief
\fn onChapterNameLeftChanged
\param checked
*/
void onChapterNameLeftChanged(bool checked);
/*!
\brief
\fn onChapterNameCenterChanged
\param checked
*/
void onChapterNameCenterChanged(bool checked);
/*!
\brief
\fn onChapterNameRightChanged
\param checked
*/
void onChapterNameRightChanged(bool checked);
/*!
\brief
\fn onPrintChapterDescriptionChanged
\param checked
*/
void onPrintChapterDescriptionChanged(bool checked);
/*!
\brief
\fn onPrintChapterTextChanged
\param checked
*/
void onPrintChapterTextChanged(bool checked);
/*!
\brief
\fn onPrintSceneNameChanged
\param checked
*/
void onPrintSceneNameChanged(bool checked);
/*!
\brief
\fn onSceneNameFontChanged
\param text
*/
void onSceneNameFontChanged(const QString &text);
/*!
\brief
\fn onSceneNameFontSizeChanged
\param text
*/
void onSceneNameFontSizeChanged(const QString &text);
/*!
\brief
\fn onSceneNameBoldChanged
\param checked
*/
void onSceneNameBoldChanged(bool checked);
/*!
\brief
\fn onSceneNameItalicChanged
\param checked
*/
void onSceneNameItalicChanged(bool checked);
/*!
\brief
\fn onSceneNameUnderlineChanged
\param checked
*/
void onSceneNameUnderlineChanged(bool checked);
/*!
\brief
\fn onSceneNameLeftChanged
\param checked
*/
void onSceneNameLeftChanged(bool checked);
/*!
\brief
\fn onSceneNameCenterChanged
\param checked
*/
void onSceneNameCenterChanged(bool checked);
/*!
\brief
\fn onSceneNameRightChanged
\param checked
*/
void onSceneNameRightChanged(bool checked);
/*!
\brief
\fn onPrintSceneDescriptionChanged
\param checked
*/
void onPrintSceneDescriptionChanged(bool checked);
/*!
\brief
\fn onPrintSceneTextChanged
\param checked
*/
void onPrintSceneTextChanged(bool checked);
/*!
\brief
\fn onPaperSizeChanged
\param text
*/
void onPaperSizeChanged(const QString &text);
/*!
\brief
\fn onOrientationPortraitChanged
\param checked
*/
void onOrientationPortraitChanged(bool checked);
/*!
\brief
\fn onOrientationLandscapeChanged
\param checked
*/
void onOrientationLandscapeChanged(bool checked);
/*!
\brief
\fn onUnitChanged
\param text
*/
void onUnitChanged(const QString &text);
/*!
\brief
\fn onMarginLeftChanged
\param d
*/
void onMarginLeftChanged(double d);
/*!
\brief
\fn onMarginRightChanged
\param d
*/
void onMarginRightChanged(double d);
/*!
\brief
\fn onMarginTopChanged
\param d
*/
void onMarginTopChanged(double d);
/*!
\brief
\fn onMarginBottomChanged
\param d
*/
void onMarginBottomChanged(double d);
private:
+678
View File
@@ -327,174 +327,852 @@ public:
bool rechercheInUse(cRecherche* lpRecherche);
bool printTitle();
/*!
\brief
\fn setPrintTitle
\param value
*/
void setPrintTitle(const bool& value);
/*!
\brief
\fn titleFont
\return QString
*/
QString titleFont();
/*!
\brief
\fn setTitleFont
\param value
*/
void setTitleFont(const QString& value);
/*!
\brief
\fn titleFontSize
\return qint16
*/
qint16 titleFontSize();
/*!
\brief
\fn setTitleFontSize
\param value
*/
void setTitleFontSize(const qint16& value);
/*!
\brief
\fn titleBold
\return bool
*/
bool titleBold();
/*!
\brief
\fn setTitleBold
\param value
*/
void setTitleBold(const bool& value);
/*!
\brief
\fn titleItalic
\return bool
*/
bool titleItalic();
/*!
\brief
\fn setTitleItalic
\param value
*/
void setTitleItalic(const bool& value);
/*!
\brief
\fn titleUnderline
\return bool
*/
bool titleUnderline();
/*!
\brief
\fn setTitleUnderline
\param value
*/
void setTitleUnderline(const bool& value);
/*!
\brief
\fn titleAlign
\return ALIGN
*/
ALIGN titleAlign();
/*!
\brief
\fn setTitleAlign
\param value
*/
void setTitleAlign(const ALIGN& value);
/*!
\brief
\fn printSubTitle
\return bool
*/
bool printSubTitle();
/*!
\brief
\fn setPrintSubTitle
\param value
*/
void setPrintSubTitle(const bool& value);
/*!
\brief
\fn subtitleFont
\return QString
*/
QString subtitleFont();
/*!
\brief
\fn setSubtitleFont
\param value
*/
void setSubtitleFont(const QString& value);
/*!
\brief
\fn subtitleFontSize
\return qint16
*/
qint16 subtitleFontSize();
/*!
\brief
\fn setSubtitleFontSize
\param value
*/
void setSubtitleFontSize(const qint16& value);
/*!
\brief
\fn subtitleBold
\return bool
*/
bool subtitleBold();
/*!
\brief
\fn setSubtitleBold
\param value
*/
void setSubtitleBold(const bool& value);
/*!
\brief
\fn subtitleItalic
\return bool
*/
bool subtitleItalic();
/*!
\brief
\fn setSubtitleItalic
\param value
*/
void setSubtitleItalic(const bool& value);
/*!
\brief
\fn subtitleUnderline
\return bool
*/
bool subtitleUnderline();
/*!
\brief
\fn setSubtitleUnderline
\param value
*/
void setSubtitleUnderline(const bool& value);
/*!
\brief
\fn subtitleAlign
\return ALIGN
*/
ALIGN subtitleAlign();
/*!
\brief
\fn setSubtitleAlign
\param value
*/
void setSubtitleAlign(const ALIGN& value);
/*!
\brief
\fn printShortDescription
\return bool
*/
bool printShortDescription();
/*!
\brief
\fn setPrintShortDescription
\param value
*/
void setPrintShortDescription(const bool& value);
/*!
\brief
\fn printDescription
\return bool
*/
bool printDescription();
/*!
\brief
\fn setPrintDescription
\param value
*/
void setPrintDescription(const bool& value);
/*!
\brief
\fn printAuthor
\return bool
*/
bool printAuthor();
/*!
\brief
\fn setPrintAuthor
\param value
*/
void setPrintAuthor(const bool& value);
/*!
\brief
\fn authorFont
\return QString
*/
QString authorFont();
/*!
\brief
\fn setAuthorFont
\param value
*/
void setAuthorFont(const QString& value);
/*!
\brief
\fn authorFontSize
\return qint16
*/
qint16 authorFontSize();
/*!
\brief
\fn setAuthorFontSize
\param value
*/
void setAuthorFontSize(const qint16& value);
/*!
\brief
\fn authorBold
\return bool
*/
bool authorBold();
/*!
\brief
\fn setAuthorBold
\param value
*/
void setAuthorBold(const bool& value);
/*!
\brief
\fn authorItalic
\return bool
*/
bool authorItalic();
/*!
\brief
\fn setAuthorItalic
\param value
*/
void setAuthorItalic(const bool& value);
/*!
\brief
\fn authorUnderline
\return bool
*/
bool authorUnderline();
/*!
\brief
\fn setAuthorUnderline
\param value
*/
void setAuthorUnderline(const bool& value);
/*!
\brief
\fn authorAlign
\return ALIGN
*/
ALIGN authorAlign();
/*!
\brief
\fn setAuthorAlign
\param value
*/
void setAuthorAlign(const ALIGN& value);
/*!
\brief
\fn printPartName
\return bool
*/
bool printPartName();
/*!
\brief
\fn setPrintPartName
\param value
*/
void setPrintPartName(const bool& value);
/*!
\brief
\fn partFont
\return QString
*/
QString partFont();
/*!
\brief
\fn setPartFont
\param value
*/
void setPartFont(const QString& value);
/*!
\brief
\fn partFontSize
\return qint16
*/
qint16 partFontSize();
/*!
\brief
\fn setPartFontSize
\param value
*/
void setPartFontSize(const qint16& value);
/*!
\brief
\fn partBold
\return bool
*/
bool partBold();
/*!
\brief
\fn setPartBold
\param value
*/
void setPartBold(const bool& value);
/*!
\brief
\fn partItalic
\return bool
*/
bool partItalic();
/*!
\brief
\fn setPartItalic
\param value
*/
void setPartItalic(const bool& value);
/*!
\brief
\fn partUnderline
\return bool
*/
bool partUnderline();
/*!
\brief
\fn setPartUnderline
\param value
*/
void setPartUnderline(const bool& value);
/*!
\brief
\fn partAlign
\return ALIGN
*/
ALIGN partAlign();
/*!
\brief
\fn setPartAlign
\param value
*/
void setPartAlign(const ALIGN& value);
/*!
\brief
\fn printPartDescription
\return bool
*/
bool printPartDescription();
/*!
\brief
\fn setPrintPartDescription
\param value
*/
void setPrintPartDescription(const bool& value);
/*!
\brief
\fn printPartText
\return bool
*/
bool printPartText();
/*!
\brief
\fn setPrintPartText
\param value
*/
void setPrintPartText(const bool& value);
/*!
\brief
\fn printChapterName
\return bool
*/
bool printChapterName();
/*!
\brief
\fn setPrintChapterName
\param value
*/
void setPrintChapterName(const bool& value);
/*!
\brief
\fn chapterFont
\return QString
*/
QString chapterFont();
/*!
\brief
\fn setChapterFont
\param value
*/
void setChapterFont(const QString& value);
/*!
\brief
\fn chapterFontSize
\return qint16
*/
qint16 chapterFontSize();
/*!
\brief
\fn setChapterFontSize
\param value
*/
void setChapterFontSize(const qint16& value);
/*!
\brief
\fn chapterBold
\return bool
*/
bool chapterBold();
/*!
\brief
\fn setChapterBold
\param value
*/
void setChapterBold(const bool& value);
/*!
\brief
\fn chapterItalic
\return bool
*/
bool chapterItalic();
/*!
\brief
\fn setChapterItalic
\param value
*/
void setChapterItalic(const bool& value);
/*!
\brief
\fn chapterUnderline
\return bool
*/
bool chapterUnderline();
/*!
\brief
\fn setChapterUnderline
\param value
*/
void setChapterUnderline(const bool& value);
/*!
\brief
\fn chapterAlign
\return ALIGN
*/
ALIGN chapterAlign();
/*!
\brief
\fn setChapterAlign
\param value
*/
void setChapterAlign(const ALIGN& value);
/*!
\brief
\fn printChapterDescription
\return bool
*/
bool printChapterDescription();
/*!
\brief
\fn setPrintChapterDescription
\param value
*/
void setPrintChapterDescription(const bool& value);
/*!
\brief
\fn printChapterText
\return bool
*/
bool printChapterText();
/*!
\brief
\fn setPrintChapterText
\param value
*/
void setPrintChapterText(const bool& value);
/*!
\brief
\fn printSceneName
\return bool
*/
bool printSceneName();
/*!
\brief
\fn setPrintSceneName
\param value
*/
void setPrintSceneName(const bool& value);
/*!
\brief
\fn sceneFont
\return QString
*/
QString sceneFont();
/*!
\brief
\fn setSceneFont
\param value
*/
void setSceneFont(const QString& value);
/*!
\brief
\fn sceneFontSize
\return qint16
*/
qint16 sceneFontSize();
/*!
\brief
\fn setSceneFontSize
\param value
*/
void setSceneFontSize(const qint16& value);
/*!
\brief
\fn sceneBold
\return bool
*/
bool sceneBold();
/*!
\brief
\fn setSceneBold
\param value
*/
void setSceneBold(const bool& value);
/*!
\brief
\fn sceneItalic
\return bool
*/
bool sceneItalic();
/*!
\brief
\fn setSceneItalic
\param value
*/
void setSceneItalic(const bool& value);
/*!
\brief
\fn sceneUnderline
\return bool
*/
bool sceneUnderline();
/*!
\brief
\fn setSceneUnderline
\param value
*/
void setSceneUnderline(const bool& value);
/*!
\brief
\fn sceneAlign
\return ALIGN
*/
ALIGN sceneAlign();
/*!
\brief
\fn setSceneAlign
\param value
*/
void setSceneAlign(const ALIGN& value);
/*!
\brief
\fn printSceneDescription
\return bool
*/
bool printSceneDescription();
/*!
\brief
\fn setPrintSceneDescription
\param value
*/
void setPrintSceneDescription(const bool& value);
/*!
\brief
\fn printSceneText
\return bool
*/
bool printSceneText();
/*!
\brief
\fn setPrintSceneText
\param value
*/
void setPrintSceneText(const bool& value);
/*!
\brief
\fn paperSize
\return QPagedPaintDevice::PageSize
*/
QPagedPaintDevice::PageSize paperSize();
/*!
\brief
\fn setPaperSize
\param value
*/
void setPaperSize(const QPagedPaintDevice::PageSize& value);
/*!
\brief
\fn paperOrientation
\return QPrinter::Orientation
*/
QPrinter::Orientation paperOrientation();
/*!
\brief
\fn setPaperOrientation
\param value
*/
void setPaperOrientation(const QPrinter::Orientation& value);
/*!
\brief
\fn leftMargin
\return qreal
*/
qreal leftMargin();
/*!
\brief
\fn setLeftMargin
\param value
*/
void setLeftMargin(const qreal& value);
/*!
\brief
\fn rightMargin
\return qreal
*/
qreal rightMargin();
/*!
\brief
\fn setRightMargin
\param value
*/
void setRightMargin(const qreal& value);
/*!
\brief
\fn topMargin
\return qreal
*/
qreal topMargin();
/*!
\brief
\fn setTopMargin
\param value
*/
void setTopMargin(const qreal& value);
/*!
\brief
\fn bottomMargin
\return qreal
*/
qreal bottomMargin();
/*!
\brief
\fn setBottomMargin
\param value
*/
void setBottomMargin(const qreal& value);
/*!
\brief
\fn unit
\return QPrinter::Unit
*/
QPrinter::Unit unit();
/*!
\brief
\fn setUnit
\param value
*/
void setUnit(const QPrinter::Unit& value);
private: