summaryrefslogtreecommitdiffstats
path: root/kexi/plugins/macros/lib/action.cpp
blob: fc729b57961d2a10478b0ef6d4f6b128e4006c58 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
/***************************************************************************
 * 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)
 * copyright (C) 2006 by Sascha Kupper (kusato@kfnv.de)
 *
 * 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.
 ***************************************************************************/

#include "action.h"

#include <kdebug.h>

using namespace KoMacro;

namespace KoMacro {

	/**
	* @internal d-pointer class to be more flexible on future extension of the
	* functionality without to much risk to break the binary compatibility.
	*/
	class Action::Private
	{
		public:

			/**
			* The name this @a Action has.
			*/
			TQString name;

			/**
			* The i18n-caption text this @a Action has.
			*/
			TQString text;

			/**
			* The comment the user is able to define for each action.
			*/
			TQString comment;

			/**
			 * A map of @a Variable instances this @a Action
			 * provides accessible by there TQString name.
			 */
			Variable::Map varmap;

			/**
			* List of variablenames. This list provides a
			* sorted order for the @a Variable instances
			* defined in the map above.
			*/
			TQStringList varnames;

	};

}

Action::Action(const TQString& name, const TQString& text)
	: TQObject()
	, KShared()
	, d( new Private() ) // create the private d-pointer instance.
{
	kdDebug() << "Action::Action() name=" << name << endl;
	d->name = name;
	setText(text);

	// Publish this action.
	KoMacro::Manager::self()->publishAction( KSharedPtr<Action>(this) );
}

Action::~Action()
{
	//kdDebug() << TQString("Action::~Action() name=\"%1\"").arg(name()) << endl;

	// destroy the private d-pointer instance.
	delete d;
}

const TQString Action::toString() const
{
	return TQString("Action:%1").arg(name());
}

const TQString Action::name() const
{
	return d->name;
}

void Action::setName(const TQString& name)
{
	d->name = name;
}

const TQString Action::text() const
{
	return d->text;
}

void Action::setText(const TQString& text)
{
	d->text = text;
}

const TQString Action::comment() const
{
	return d->comment;
}

void Action::setComment(const TQString& comment)
{
	d->comment = comment;
}

bool Action::hasVariable(const TQString& name) const
{
	return d->varmap.contains(name);
}

KSharedPtr<Variable> Action::variable(const TQString& name) const
{
	return d->varmap.contains(name) ? d->varmap[name] : KSharedPtr<Variable>(0);
}

Variable::Map Action::variables() const
{
	return d->varmap;
}

TQStringList Action::variableNames() const
{
	return d->varnames;
}

void Action::setVariable(KSharedPtr<Variable> variable)
{
	const TQString name = variable->name();
	if(! d->varmap.contains(name)) {
		d->varnames.append(name);
	}
	d->varmap.replace(name, variable);
}

void Action::setVariable(const TQString& name, const TQString& text, const TQVariant& variant)
{
	Variable* variable = new Variable(variant);
	variable->setName(name);
	variable->setText(text);
	setVariable( KSharedPtr<Variable>(variable) );
}

void Action::removeVariable(const TQString& name)
{
	if(d->varmap.contains(name)) {
		d->varmap.remove(name);
		d->varnames.remove(name);
	}
}

#include "action.moc"