File indexing completed on 2024-05-12 04:35:05

 /* This file is part of the TikZKit project.
  *
  * Copyright (C) 2015 Dominik Haumann <dhaumann@kde.org>
  *
  * This library is free software; you can redistribute it and/or modify
  * it under the terms of the GNU Library General Public License as published
  * by the Free Software Foundation, either version 2 of the License, or
  * (at your option) any later version.
  *
  * This library 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 Library General Public License for more details.
  *
  * You should have received a copy of the GNU Library General Public License
  * along with this library; see the file COPYING.LIB.  If not, see
  * <http://www.gnu.org/licenses/>.
  */
 
 #ifndef TIKZ_CORE_ENTITY_H
 #define TIKZ_CORE_ENTITY_H
 
 #include "ConfigObject.h"
 #include "tikz.h"
 #include "Uid.h"
 
 #include <memory>
 #include <QObject>
 #include <QJsonObject>
 
 namespace tikz {
 namespace core {
 
 class Document;
 class EntityPrivate;
 
 class TIKZKITCORE_EXPORT Entity : public ConfigObject
 {
     Q_OBJECT
     Q_PROPERTY(Uid uid READ uid)
 
     public:
         /**
          * Default constructor.
          * Creates a default entity with uid set to -1 and no associated Document.
          */
         Entity();
 
         /**
          * Virtual destructor.
          */
         virtual ~Entity();
 
         /**
          * Returns the unique entity identifier in terms of a Uid.
          * The uid().id() is the same as id(). However, the Uid also passes
          * information about the type of the object through Uid::type().
          */
         Uid uid() const;
 
         /**
          * Returns the EntityType.
          */
         virtual tikz::EntityType entityType() const = 0;
 
 
         /**
          * Returns the document, if passed to the constructor.
          */
         Document * document() const;
 
     public:
         /**
          * Helper function that returns true if the object name is empty.
          */
         Q_INVOKABLE bool objectNameSet() const;
 
         /**
          * Helper function that always returns true for the object name;
          */
         Q_INVOKABLE void unsetObjectName();
 
     //
     // serialization
     //
     public:
         /**
          * Load the state from the @p json object.
          */
         void load(const QJsonObject & json);
 
         /**
          * Save the state to the json object.
          */
         QJsonObject save() const;
 
     protected:
         /**
          * Load the payload state from the @p json object.
          * The default implementation is empty.
          */
         virtual void loadData(const QJsonObject & json);
 
         /**
          * Save the payload state to the json object.
          * The default implementation is empty.
          */
         virtual QJsonObject saveData() const;
 
     //
     // internal to tikz::Document
     //
     protected:
         friend class Document;
 
         /**
          * Associate this style with @p uid. The passed @p uid also
          * provides the associated tikz Document.
          */
         explicit Entity(const Uid & uid);
 
     private:
         std::unique_ptr<EntityPrivate> const d;
 };
 
 }
 }
 #endif // TIKZ_CORE_ENTITY_H
 
 // kate: indent-width 4; replace-tabs on;