/***************************************************************************
                     string.h  -  the base string type
                             -------------------
    begin                : Sept 29, 2004
    copyright            : (C) 2004 by The University of Toronto
    email                : netterfield@astro.utoronto.ca
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   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 STRING_H
#define STRING_H

#include "primitive.h"

class QXmlStreamWriter;

namespace Kst {

class ScriptInterface;

class KSTCORE_EXPORT String : public Primitive
{
  Q_OBJECT
  Q_PROPERTY(bool orphan READ orphan WRITE setOrphan)

  public:
    virtual const QString& typeString() const;
    static const QString staticTypeString;
    static const QString staticTypeTag;

    virtual QString descriptionTip() const;
    virtual QString sizeString() const;
    virtual QString propertyString() const;

    virtual ScriptInterface* createScriptInterface();

  protected:
    String(ObjectStore *store);

    friend class ObjectStore;
    virtual QString _automaticDescriptiveName() const;
    virtual void _initializeShortName();

  public:
    /** Update the string. */
    virtual void internalUpdate();

    virtual ~String();
    /** Save information */
    void save(QXmlStreamWriter &s);

    String& operator=(const QString& v);
    String& operator=(const char *v);

    virtual ObjectList<Primitive> outputPrimitives() const { return ObjectList<Primitive>(); }
    virtual PrimitiveMap metas() const { return PrimitiveMap(); }

  public slots:
    /* return the value of the string */
    const QString& value() const { return _value; }

    /** Set the value of the string - ignored for some types */
    void setValue(const QString& inV);

    bool orphan() const { return _orphan; }
    void setOrphan(bool orphan) { _orphan = orphan; }

    bool editable() const { return _editable; }
    void setEditable(bool editable) { _editable = editable; }

  protected:
    QString _value;

  private:
    bool _orphan : 1;
    bool _editable;
};

typedef SharedPtr<String> StringPtr;
typedef ObjectList<String> StringList;
typedef ObjectMap<String> StringMap;

}

Q_DECLARE_METATYPE(Kst::String*)

#endif
// vim: ts=2 sw=2 et
