LearnSpellingsEditor Class Reference

Editor widget of Learn Spellings template. More...

#include <learnspellingseditor.h>

Collaboration diagram for LearnSpellingsEditor:

Public Member Functions
	LearnSpellingsEditor (TemplateCore *core, QWidget *parent=0)
QList< LearnSpellingsItem >	activeWords () const
QString	generateBundleData ()
	Generates RAW data which represent data of this template. More...
bool	loadBundleData (const QString &bundle_data)
	Loads editor state from XML bundle. More...
bool	canGenerateApplications ()
	Specifies if template can generate applications or not. More...
QString	projectName ()
	Access to project name of current editor. More...
QString	authorName ()
	Access to author name of current editor. More...
Public Member Functions inherited from TemplateEditor
	TemplateEditor (TemplateCore *core, QWidget *parent=0)
virtual QString	generationStatusDescription ()
	Access to description of current state. More...
virtual void	launch ()
	Executed when given template with this editor is launched. More...
TemplateCore *	core () const
	Access to associated template core. More...
bool	isDirty () const
	Check if editor contains unsaved contents. More...
void	setIsDirty (bool is_dirty)
	Sets new dirtiness status. More...

Friends
class	LearnSpellingsSimulator
class	LearnSpellingsCore

Additional Inherited Members
Public Slots inherited from TemplateEditor
void	dirtify ()
	Dirtifies (sets m_isDirty to true) the editor.
Signals inherited from TemplateEditor
void	changed ()
	Emitted everytime any child widget of editor changes its contents. More...
void	canGenerateChanged (bool can_generate, const QString &message=QString())
	Emitted if status, which specifies if mobile application can be generated from the template, changes. More...
Protected Member Functions inherited from TemplateEditor
void	issueNewGenereationStatus (bool can_generate, const QString &message=QString())
	Emits new signal notifying other components about state of creating of APK application. More...
Protected Attributes inherited from TemplateEditor
bool	m_canGenerate
QString	m_generateMessage
bool	m_isDirty
TemplateCore *	m_core

Detailed Description

Editor widget of Learn Spellings template.

Definition at line 46 of file learnspellingseditor.h.

Member Function Documentation

QString LearnSpellingsEditor::authorName ( )

virtual

Access to author name of current editor.

Returns

Returns string of author name. This is usually text in some text box in the editor.

Implements TemplateEditor.

Definition at line 287 of file learnspellingseditor.cpp.

                                         {
  return m_ui->m_txtAuthor->lineEdit()->text();
}

bool LearnSpellingsEditor::canGenerateApplications ( )

virtual

Specifies if template can generate applications or not.

Returns

Returns true if editor contains enough data for generating of applications.

Warning

This is used in cooperation with canGenerateStatusChanged(bool can_generate).

Reimplemented from TemplateEditor.

Definition at line 276 of file learnspellingseditor.cpp.

                                                   {
  return
      !activeWords().isEmpty() &&
      !m_ui->m_txtAuthor->lineEdit()->text().simplified().isEmpty() &&
      !m_ui->m_txtName->lineEdit()->text().simplified().isEmpty();
}

QString LearnSpellingsEditor::generateBundleData ( )

virtual

Generates RAW data which represent data of this template.

Remarks

Generated data are stored in XML bundle file.

Warning

Generated data of this method must be compatible with custom implementation of TemplateEntryPoint::loadCoreFromBundleData(const QString &raw_data) method!!!

Returns

Returns string with generated data.

Implements TemplateEditor.

Definition at line 104 of file learnspellingseditor.cpp.

                                                 {
  /*if (!canGenerateApplications()) {
    return QString();
  }*/

  QDomDocument source_document = qApp->templateManager()->generateBundleHeader(core()->entryPoint()->typeIndentifier(),
                                                                               m_ui->m_txtAuthor->lineEdit()->text(),
                                                                               QString(),
                                                                               m_ui->m_txtName->lineEdit()->text(),
                                                                               QString(),
                                                                               "1");
  FIND_DATA_ELEMENT(data_element, source_document);

  foreach (const LearnSpellingsItem &item, activeWords()) {
    QDomElement item_element = source_document.createElement("item");

    // Fill in details about question.
    QDomElement word_element = source_document.createElement("word");
    QDomElement meaning_element = source_document.createElement("meaning");

    word_element.appendChild(source_document.createTextNode(item.word()));
    meaning_element.appendChild(source_document.createTextNode(item.meaning()));

    item_element.appendChild(word_element);
    item_element.appendChild(meaning_element);

    data_element.appendChild(item_element);
  }

  return source_document.toString(XML_BUNDLE_INDENTATION);
}

Here is the call graph for this function:

bool LearnSpellingsEditor::loadBundleData ( const QString &  bundle_data )

virtual

Loads editor state from XML bundle.

Parameters

bundle_data

Raw XML bundle data.

Returns

Returns true if editor loaded bundle data, otherwise returns false.

Implements TemplateEditor.

Definition at line 136 of file learnspellingseditor.cpp.

                                                                    {
  QDomDocument bundle_document;
  bundle_document.setContent(bundle_data);

  QDomNodeList items = bundle_document.documentElement().elementsByTagName("item");

  for (int i = 0; i < items.size(); i++) {
    QDomNode item = items.at(i);

    if (item.isElement()) {
      QString word = item.namedItem("word").toElement().text();
      QString meaning = item.namedItem("meaning").toElement().text();

      if (word.isEmpty()) {
        // TODO: error
        continue;
      }
      else {
        addSampleWord(word, meaning);
      }
    }
    else {
      continue;
    }
  }

  // Load author & name.
  m_ui->m_txtAuthor->lineEdit()->setText(bundle_document.documentElement().namedItem("author").namedItem("name").toElement().text());
  m_ui->m_txtName->lineEdit()->setText(bundle_document.documentElement().namedItem("title").toElement().text());

  return true;
}

QString LearnSpellingsEditor::projectName ( )

virtual

Access to project name of current editor.

Returns

Returns string of project name of current editor. This is usually text in some text box in the editor.

Implements TemplateEditor.

Definition at line 283 of file learnspellingseditor.cpp.

                                          {
  return m_ui->m_txtName->lineEdit()->text();
}

---

The documentation for this class was generated from the following files:

• learnspellingseditor.h
• learnspellingseditor.cpp