From efbc45fe46c0e16ee2587e4f5cf8467e7e6ba14d Mon Sep 17 00:00:00 2001 From: trialuser02 Date: Sat, 13 Mar 2010 18:43:44 +0000 Subject: updated api documentation git-svn-id: http://svn.code.sf.net/p/qmmp-dev/code/trunk/qmmp@1624 90c681e8-e032-0410-971d-27865f9a5e38 --- src/qmmpui/templateeditor.h | 26 +++++++++++++++++++++++--- 1 file changed, 23 insertions(+), 3 deletions(-) (limited to 'src/qmmpui/templateeditor.h') diff --git a/src/qmmpui/templateeditor.h b/src/qmmpui/templateeditor.h index c53949ae4..8db1e7f65 100644 --- a/src/qmmpui/templateeditor.h +++ b/src/qmmpui/templateeditor.h @@ -23,25 +23,45 @@ #include - namespace Ui { class TemplateEditor; } class QAction; -/*! +/*! @brief The TemplateEditor class provides simple template editor dialog. * @author Ilya Kotov */ class TemplateEditor : public QDialog { Q_OBJECT public: + /*! + * Constructor. + * @param parent Parent widget. + */ explicit TemplateEditor(QWidget *parent = 0); - + /*! + * Returns current template from editor. + */ QString currentTemplate() const; + /*! + * Sets template which is placed in the text edit to \b text. + */ void setTemplate(const QString &text = QString()); + /*! + * Sets default template to \b text. + * This template will be placed in the text edit if the user pressed Reset + */ void setDefaultTemplate(const QString &text); + /*! + * Static convenience function to get a template from the user. + * @param parent Parent widget. + * @param title Window title. + * @param text Template which is placed in the text edit. + * @param default_template This template will be placed in the text edit if the user pressed Reset. + * @param ok This varible will be set to \b true (\b false) if the user pressed OK (Cancel). + */ static QString getTemplate (QWidget *parent, const QString &title, const QString &text = QString(), const QString &default_template = QString(), bool *ok = 0); -- cgit v1.2.3-13-gbd6f