keduvocconjugation.h

/*
 * C++ Interface: keduvocconjugation
 * SPDX-FileCopyrightText: 2007 Frederik Gladhorn <frederik.gladhorn@kdemail.net>
 * SPDX-License-Identifier: GPL-2.0-or-later
 */
 
#ifndef KEDUVOCCONJUGATION_H
#define KEDUVOCCONJUGATION_H
 
#include "keduvocdocument_export.h"
#include "keduvoctext.h"
#include "keduvocwordflags.h"
 
#include <QStringList>
 
/**
 * The conjugation of a verb
 */
class KEDUVOCDOCUMENT_EXPORT KEduVocConjugation
{
public:
    /**
     * The constructor
     */
    explicit KEduVocConjugation();
 
    KEduVocConjugation(const KEduVocConjugation &rhs);
 
    ~KEduVocConjugation();
 
    KEduVocConjugation &operator=(const KEduVocConjugation &a);
    bool operator==(const KEduVocConjugation &a) const;
 
    /**
     *  Returns an existing conjugation object. It is an error and leads to undefined behavior
     *  to call this method with flags which are not in the list returned by keys().
     *
     *  BCI: return a pointer instead of a reference.
     *
     *  @param  flags Flags obtained by a previous call to keys()
     *  @return The existing conjugation object with the specified properties
     */
    KEduVocText &conjugation(KEduVocWordFlags flags) const;
    /**
     *  Updates or creates the conjugation object for the given word flags.
     */
    void setConjugation(const KEduVocText &conjugation, KEduVocWordFlags flags);
 
    QList<KEduVocWordFlags> keys();
 
    bool isEmpty();
 
    /**
     * Create xml for this declension
     * @param parent
     * @param tense
     */
    void toKVTML2(QDomElement &parent, const QString &tense);
 
    /**
     * Reads a declension from xml, returns 0 if it is empty
     * @param parent
     * @return
     */
    static KEduVocConjugation *fromKVTML2(QDomElement &parent);
 
private:
    class Private;
    Private *const d;
};
 
#endif // KEDUVOCCONJUGATION_H