You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
81 lines
3.6 KiB
81 lines
3.6 KiB
/***************************************************************************
|
|
* ktouchleveldata.h *
|
|
* ----------------- *
|
|
* Copyright (C) 2000 by Håvard Frøiland, 2003 by Andreas Nicolai *
|
|
* ghorwin@users.sourceforge.net *
|
|
* *
|
|
* 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 2 of the License, or *
|
|
* (at your option) any later version. *
|
|
***************************************************************************/
|
|
|
|
#ifndef KTOUCHLEVELDATA_H
|
|
#define KTOUCHLEVELDATA_H
|
|
|
|
#ifdef HAVE_CONFIG_H
|
|
#include <config.h>
|
|
#endif
|
|
|
|
#include <tqstring.h>
|
|
#include <tqtextstream.h>
|
|
#include <tqvaluevector.h>
|
|
#include <tqdom.h>
|
|
|
|
class TQDomDocument;
|
|
class TQDomElement;
|
|
|
|
/// This class contains the data of one level in a lecture and provides
|
|
/// access to the lines of that level.
|
|
///
|
|
/// A lecture (KTouchLecture) typically contains multiple levels. Each
|
|
/// level contains a level description, a string with the
|
|
/// newly introduced characters and several lines of training text.
|
|
/// There is ALWAYS at least one line of training text in the level!<p>
|
|
/// During a training session you might want to retrieve a certain line of
|
|
/// the level. You can use the member function line(lineNumber) to get a
|
|
/// line of the level.
|
|
/// The member function count() returns the number of lines in this level.
|
|
class KTouchLevelData {
|
|
public:
|
|
/// Default constructor, creates a default level.
|
|
KTouchLevelData() { createDefault(); }
|
|
/// Constructor for creating a new level.
|
|
KTouchLevelData(const TQString& comment, const TQString& newChars)
|
|
: m_comment(comment), m_newChars(newChars) { createDefault(); }
|
|
/// Returns the level description (comment).
|
|
const TQString& comment() const { return m_comment; }
|
|
/// Returns the new characters string.
|
|
const TQString& newChars() const { return m_newChars; }
|
|
/// Returns the line with number 'lineNumber' (0 means first line).
|
|
///
|
|
/// If the line number is out of range, the first line will be returned.
|
|
const TQString& line(unsigned int lineNumber) const;
|
|
/// Returns the number of lines.
|
|
unsigned int count() const { return m_lines.size(); }
|
|
|
|
private:
|
|
/// Creates a default level.
|
|
void createDefault();
|
|
/// Reads a level from the input stream.
|
|
/// @return Returns 'true', when a level could be read successfully, or 'false' otherwise.
|
|
bool readLevel(TQTextStream& in);
|
|
/// Reads a level from a XML Dom Node.
|
|
/// @return Returns 'true', when a level could be read successfully, or 'false' otherwise.
|
|
bool readLevel(TQDomNode in);
|
|
/// Writes the level data into the output stream.
|
|
void writeLevel(TQTextStream& out) const;
|
|
/// Writes the level data into the output stream.
|
|
void writeLevel(TQDomDocument& doc, TQDomElement& root) const;
|
|
|
|
TQString m_comment; ///< A comment for the level.
|
|
TQString m_newChars; ///< Contains the newly introduced characters in this level.
|
|
TQValueVector<TQString> m_lines; ///< The lines of the level.
|
|
|
|
// so I don't have to allow access to read/write function to everybody :-)
|
|
friend class KTouchLecture;
|
|
friend class KTouchLectureEditor;
|
|
};
|
|
|
|
#endif // KTOUCHLEVELDATA_H
|