From: Martin Pfeiffer Date: Thu, 1 Dec 2005 21:06:21 +0000 (+0000) Subject: very tiny changes ( copyright, apidox ), bigger changes to come soon ( update the... X-Git-Tag: v3.80.2~215 X-Git-Url: https://git.rmz.fi/?a=commitdiff_plain;h=92f96d286df462d80b4a0287e4c16cbe6435b573;p=libqmvoc.git very tiny changes ( copyright, apidox ), bigger changes to come soon ( update the painting in leitnersystemview ) svn path=/trunk/KDE/kdeedu/libkdeedu/; revision=484766 --- diff --git a/kdeeducore/leitnerbox.h b/kdeeducore/leitnerbox.h index 5896bb4..b134d46 100644 --- a/kdeeducore/leitnerbox.h +++ b/kdeeducore/leitnerbox.h @@ -1,17 +1,26 @@ -// -// C++ Interface: leitnerbox -// -// Description: -// -// -// Author: Martin Pfeiffer , (C) 2005 -// -// Copyright: See COPYING file that comes with this distribution -// -// #ifndef LEITNERBOX_H #define LEITNERBOX_H +/*************************************************************************** + * Copyright (C) 2005 by Martin Pfeiffer * + * * + * 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. * + * * + * This program is distributed in the hope that it will be useful, * + * but WITHOUT ANY WARRANTY; without even the implied warranty of * + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * + * GNU General Public License for more details. * + * * + * You should have received a copy of the GNU General Public License * + * along with this program; if not, write to the * + * Free Software Foundation, Inc., * + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * + ***************************************************************************/ + + #include /** @@ -21,7 +30,7 @@ * as the vocab cards increase or decrease in box position. There is a determined order of LeitnerBoxes * in a LeitnerSystem, therefore each LeitnerBox helds pointers to the LeitnerBox for wrong and correct * cards of this LeitnerBox - * @author Martin Pfeiffer + * @author Martin Pfeiffer */ class LeitnerBox { @@ -31,6 +40,9 @@ public: */ LeitnerBox(); + /** + * The destructor + */ ~LeitnerBox(); /** @@ -44,26 +56,54 @@ public: * @param wrongWordBox a pointer to the LeitnerBox to be set */ void setWrongWordBox( LeitnerBox* wrongWordBox ); + /** * Sets the boxes name * @param name the new name */ void setBoxName( const QString& name ); + /** + * Sets the LeitnerBox's name to name. The name is the unique identifier of a LeitnerBox. + * @param name a QString with the LeitnerBox's new name + */ + void setBoxName( const QString& name ); + + /** + * Returns the current name of the LeitnerBox + * @return a const QString with the name of the LeitnerBox + */ + const QString& boxName() const; + + /** + * Sets the LeitnerBox's vocabCount to count + * @p¾aramcount the new vocabCount to be set + */ void setVocabCount( int count ); + + /** + * Returns the current vocabCount + * @return the number of cards/ vocabs that are currently assigned to the LeitnerBox. + */ int vocabCount(); + /** + * Returns a pointer to the LeitnerBox correct cards of this LeitnerBox here are assigned to + * @return a pointer to a LeitnerBox + */ LeitnerBox* correctWordBox(); - LeitnerBox* wrongWordBox(); - const QString& boxName() const; + /** + * Returns a pointer to the LeitnerBox wrong cards of this LeitnerBox here are assigned to + * @return a pointer to a LeitnerBox + */ + LeitnerBox* wrongWordBox(); + bool operator == ( const LeitnerBox& a ) const; private: QString m_name; - int m_vocabCount; - LeitnerBox* m_wrongWordBox; LeitnerBox* m_correctWordBox; }; diff --git a/kdeeducore/prefleitner.cpp b/kdeeducore/prefleitner.cpp index bb7226a..f18d7d7 100644 --- a/kdeeducore/prefleitner.cpp +++ b/kdeeducore/prefleitner.cpp @@ -1,14 +1,21 @@ -// -// C++ Implementation: prefleitner -// -// Description: the part of the preferences to change the settings for the LeitnerSystem -// -// -// Author: Martin Pfeiffer , (C) 2005 -// -// Copyright: See COPYING file that comes with this distribution -// -// +/*************************************************************************** + * Copyright (C) 2005 by Martin Pfeiffer * + * * + * 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. * + * * + * This program is distributed in the hope that it will be useful, * + * but WITHOUT ANY WARRANTY; without even the implied warranty of * + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * + * GNU General Public License for more details. * + * * + * You should have received a copy of the GNU General Public License * + * along with this program; if not, write to the * + * Free Software Foundation, Inc., * + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * + ***************************************************************************/ #include "prefleitner.h" #include "leitnersystemview.h" diff --git a/kdeeducore/prefleitner.h b/kdeeducore/prefleitner.h index 952430f..7143d63 100644 --- a/kdeeducore/prefleitner.h +++ b/kdeeducore/prefleitner.h @@ -38,7 +38,7 @@ class PrefLeitner : public QDialog, public Ui::PrefLeitnerBase public: /** * The public contructor - * @param parent is the parent widget + * @param parent the widget's parent */ PrefLeitner( QWidget* parent = 0 );