File indexing completed on 2024-04-28 07:29:29

 /*
     KmPlot - a math. function plotter for the KDE-Desktop
 
     SPDX-FileCopyrightText: 1998, 1999, 2000, 2002 Klaus-Dieter Möller <kd.moeller@t-online.de>
 
     This file is part of the KDE Project.
     KmPlot is part of the KDE-EDU Project.
 
     SPDX-License-Identifier: GPL-2.0-or-later
 
 */
 
 #ifndef KMPLOTIO_H
 #define KMPLOTIO_H
 
 #include <QGradient>
 #include <QUrl>
 
 class Equation;
 class Function;
 class QDomDocument;
 class QDomElement;
 class QString;
 
 /** @short This class manages the file operations load and save.
  *
  * @author Klaus-Dieter Möller & Matthias Meßmer
  */
 class KmPlotIO
 {
 public:
     /// Nothing to do here; only static functions needed.
     KmPlotIO();
     /// Empty.
     ~KmPlotIO();
 
     /**
      * Store all information about the current saved plot in a xml file
      * with the .fkt extension in the filename file.
      * @param url Name (URL) of the file which will be saved.
      */
     bool save(const QUrl &url);
 
     /**
      * @return a QDomDocument describing the current KmPlot state (settings
      * and functions).
      */
     QDomDocument currentState();
 
     /**
      * Read a kmpdoc xml file to restore the settings of a previously saved
      * plot.
      * @param url Name (URL) of file which will be opened
      */
     bool load(const QUrl &url);
 
     /**
      * Restore KmPlot to the state described in the given QDomDocument.
      * @return success status
      */
     bool restore(const QDomDocument &doc);
 
     /**
      * Adds a QDomElement for \p function to the given \p document
      */
     void addFunction(QDomDocument &doc, QDomElement &root, Function *function);
     /**
      * Adds a QDomElement for the Constants (stored in Parser) to \p document
      */
     void addConstants(QDomDocument &doc, QDomElement &root);
     /**
      * Reads function parameters from the node @a n.
      * @param n Node containing the options.
      * @param allowRename whether to check function names for uniqueness
      */
     void parseFunction(const QDomElement &n, bool allowRename = false);
 
 private:
     /** Esay way to add a tag to the Dom tree
      * @param &doc The document.
      * @param parentTag The parent tag to support encapsulated tags.
      * @param tagName The Name of the tag.
      * @param tagValue The data between the opening and closing tag.
      * @return The QDomElement that was created.
      */
     QDomElement addTag(QDomDocument &doc, QDomElement &parentTag, const QString &tagName, const QString &tagValue);
     /// Reads axes parameters from the node @a n.
     /// @param n Node containing the options.
     void parseAxes(const QDomElement &n);
     /// Reads grid parameters from the node @a n.
     /// @param n Node containing the options.
     void parseGrid(const QDomElement &n);
     /// Reads scale parameters from the node @a n.
     /// @param n Node containing the options.
     void parseScale(const QDomElement &n);
     /**
      * Reads in a constant from the node \p n.
      */
     void parseConstant(const QDomElement &n);
     /// Reads parameter values for a function from the node @a n.
     /// @param parser points to the parser instance.
     /// @param n Node containing the options.
     /// @param ix Function index in the parser instance
     void parseParameters(const QDomElement &n, Function *function);
     /**
      * Initializes \p equation from the dom element.
      */
     void parseDifferentialStates(const QDomElement &e, Equation *equation);
 
     /// For KDE <3.3
     ///  This is the same as parseFunction but is made for old KmPlot-files
     void oldParseFunction(const QDomElement &n);
     /**
      * For KDE <4.0
      * Reads function parameters from the node @a n.
      * @param n Node containing the options.
      * @param allowRename whether to check function names for uniqueness
      */
     void oldParseFunction2(const QDomElement &n);
 
     double lengthScaler; ///< for reading in lengths
     /**
      * version of the file currently being opened (0,1,2,3,4)
      * \li < 3 is for pre-kde4
      * \li 4 is for kde4
      */
     int version;
     QString parametricXEquation; ///< Used when reading in the x part of a parametric equation
 
     /**
      * Converts \p stops to a string representation for saving in a file.
      */
     static QString gradientToString(const QGradientStops &stops);
     /**
      * Inverse of gradientToString function.
      */
     static QGradientStops stringToGradient(const QString &string);
 };
 
 #endif