You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
koffice/kexi/plugins/macros/lib/variable.h

223 lines
5.8 KiB

/***************************************************************************
* This file is part of the KDE project
* copyright (C) 2005 by Sebastian Sauer (mail@dipe.org)
* copyright (C) 2005 by Tobi Krebs (tobi.krebs@gmail.com)
*
* This program 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 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
* Library General Public License for more details.
* You should have received a copy of the GNU Library General Public License
* along with this program; see the file COPYING. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
***************************************************************************/
#ifndef KOMACRO_VARIABLE_H
#define KOMACRO_VARIABLE_H
#include <tqobject.h>
#include <tqdom.h>
#include <tqvariant.h>
#include <ksharedptr.h>
#include "metaparameter.h"
namespace KoMacro {
/**
* A variable value used to provide abstract access to variables. The
* class handles TQVariant and TQObject and provides access to them.
* Variable inherits TDEShared and implements reference couting. So, it's
* not needed to take care of memory-managment.
*/
class KOMACRO_EXPORT Variable : public MetaParameter
{
/**
* Property to get and set a TQVariant as variable.
*/
TQ_PROPERTY(TQVariant variant READ variant WRITE setVariant)
/**
* Property to get and set a TQObject as variable.
*/
TQ_PROPERTY(TQObject* object READ object WRITE setObject)
/**
* Property to get a string-representation of the variable.
*/
TQ_PROPERTY(TQString string READ toString)
public:
/**
* A list of variables.
*/
typedef TQValueList<TDESharedPtr<Variable > > List;
/**
* A map of variables.
*/
typedef TQMap<TQString, TDESharedPtr<Variable > > Map;
/**
* Default constructor.
*/
explicit Variable();
/**
* Constructor from the TQVariant @p variant .
*
* @param variant The value this variable has.
* @param name The unique @a name() this variable has.
* @param text The describing @a text() this variable has.
*/
Variable(const TQVariant& variant, const TQString& name = TQString(), const TQString& text = TQString());
/**
* Constructor from the TQObject @p object .
*
* @param object The value this variable has.
*/
Variable(const TQObject* object);
/**
* Constructor from the TQDomElement @p element .
* @deprecated replaced with methods of @a XMLHandler.
* @param element The TQDomElement that may optional contains the
* variable content or other additional informations.
*/
Variable(const TQDomElement& element);
/**
* Destructor.
*/
virtual ~Variable();
/**
* @return the name this @a Variable has.
*/
TQString name() const;
/**
* Set the name @param name this @a Variable has.
*/
void setName(const TQString& name);
/**
* @return the caption this @a Variable has.
*/
TQString text() const;
/**
* Set the caption @param text this @a Variable has.
*/
void setText(const TQString& text);
/**
* Set the TQObject @param object this variable has. A
* previously remembered value will be overwritten and
* the new type is a @a TypeObject .
*/
void setObject(const TQObject* object);
/**
* @return the TQVariant this variable has. If this
* variable isn't a @a TypeVariant an invalid TQVariant
* got returned.
*/
const TQVariant variant() const;
/**
* Set the TQVariant @param variant this variable has. A
* previously remembered value will be overwritten and
* the new type is a @a TypeVariant . If @param detecttype is
* true the method tries to set the @a variantType according
* to the passed TQVariant. If false the variantType won't
* be changed.
*/
void setVariant(const TQVariant& variant, bool detecttype = true);
/**
* @return the TQObject this variable has. If this
* variable isn't a @a TypeObject NULL got returned.
*/
const TQObject* object() const;
/**
* Implicit conversion to TQVariant operator. This method
* calls @a variant() internaly.
*/
operator TQVariant () const;
/**
* Implicit conversion to TQObject operator. This method
* calls @a object() internaly.
*/
operator const TQObject* () const;
/**
* @return a string-represenation of the variable.
*/
const TQString toString() const;
/**
* @return a integer-represenation of the variable.
*/
int toInt() const;
/**
* @return the optional list of @a Variable instances
* that are children of this @a Variable .
*
* @note that the list is returned call-by-reference. The
* list is accessed as getter/setter (read/write). So,
* don't set this method to const!
*/
List children() const;
/**
* Append a @a Variable to the list of children this
* @a Variable has.
*/
void appendChild(TDESharedPtr<Variable> variable);
/**
* Clear the list of children this @a Variable has.
*/
void clearChildren();
/**
* Set the children this @a Variable has.
*/
void setChildren(const List& children);
#if 0
/**
* @return true if this @a Variable is enabled else
* false is returned.
*/
bool isEnabled() const;
/**
* Set this @a Variable to be enabled if @param enabled is
* true else the variable is disabled.
*/
void setEnabled(const bool enabled);
#endif
private:
/// @internal d-pointer class.
class Private;
/// @internal d-pointer instance.
Private* const d;
};
}
#endif