koffice/kexi/plugins/macros/kexiactions/objectvariable.h

/***************************************************************************
 * This file is part of the KDE project
 * copyright (C) 2006 by Sebastian Sauer (mail@dipe.org)
 * copyright (C) 2006 by Bernd Steindorff (bernd@itii.de)
 * 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.
 ***************************************************************************/

#ifndef KEXIMACRO_OBJECTVARIABLE_H
#define KEXIMACRO_OBJECTVARIABLE_H

#include "../lib/action.h"
#include "../lib/variable.h"

#include "kexivariable.h"

#include <core/kexi.h>
#include <core/kexiproject.h>
#include <core/kexipartmanager.h>
#include <core/kexipartinfo.h>

#include <tdelocale.h>
#include <kdebug.h>

namespace KexiMacro {

	/**
	* The ObjectVariable class implements @a KoMacro::Variable to
	* provide a variable list of Kexi-objects. Those Kexi-objects
	* are KexiPart's like e.g. table, query, form or script.
	*/
	template<class ACTIONIMPL>
	class ObjectVariable : public KexiVariable<ACTIONIMPL>
	{
		public:

			enum Conditions {
				VisibleInNav = 1,
				Executable = 2,
				DataExport = 4
			};

			ObjectVariable(ACTIONIMPL* actionimpl, int conditions = VisibleInNav, const TQString& objectname = TQString())
				: KexiVariable<ACTIONIMPL>(actionimpl, "object", i18n("Object"))
			{
				KexiPart::PartInfoList* parts = Kexi::partManager().partInfoList();
				for(KexiPart::PartInfoListIterator it(*parts); it.current(); ++it) {
					KexiPart::Info* info = it.current();

					if(conditions & VisibleInNav && ! info->isVisibleInNavigator())
						continue;
					if(conditions & Executable && ! info->isExecuteSupported())
						continue;
					if(conditions & DataExport && ! info->isDataExportSupported())
						continue;

					const TQString name = info->objectName(); //info->groupName();
					this->appendChild( TDESharedPtr<KoMacro::Variable>(new KoMacro::Variable(name)) );
				}

				if(! objectname.isNull())
					this->setVariant( objectname );
				else if(this->children().count() > 0)
					this->setVariant( this->children()[0]->variant() );
				else
					this->setVariant( TQString() );

				kdDebug()<<"##################### KexiActions::ObjectVariable() variant="<<this->variant()<<endl;
			}

	};

}

#endif