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/scripting/kexiapp/kexiappmainwindow.h

92 lines
3.1 KiB

/***************************************************************************
* kexiappmainwindow.h
* This file is part of the KDE project
* copyright (C)2004-2005 by Sebastian Sauer (mail@dipe.org)
*
* 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 KROSS_KEXIAPP_KEXIAPPMAINWINDOW_H
#define KROSS_KEXIAPP_KEXIAPPMAINWINDOW_H
#include <tqstring.h>
#include <tqvariant.h>
#include <api/object.h>
#include <api/variant.h>
#include <api/list.h>
#include <api/class.h>
// Forward declarations.
class KexiMainWindow;
namespace Kross { namespace KexiApp {
// Forward declarations.
class KexiAppPartItem;
class KexiAppMainWindowPrivate;
/**
* Class to handle Kexi's mainwindow instance.
*/
class KexiAppMainWindow : public Kross::Api::Class<KexiAppMainWindow>
{
public:
/**
* Constructor.
*
* \param mainwindow The \a KexiMainWindow instance
* this class provides access to.
*/
KexiAppMainWindow(KexiMainWindow* mainwindow);
/**
* Destructor.
*/
virtual ~KexiAppMainWindow();
/// \see Kross::Api::Object::getClassName
virtual const TQString getClassName() const;
/** \return true if Kexi is connected with a project else
false is returned. */
bool isConnected();
/** \return the \a Kross::KexiDB::KexiDBConnection object that
belongs to the opened project or throw an exception if there
was no project opened (no connection established). Cause the
KexiApp-module doesn't know anything about the KexiDB-module
we have to use the base-class \a Kross::Api::Object to pass
the \a Kross::KexiDB::KexiDBConnection object around. */
Kross::Api::Object::Ptr getConnection();
/** \return a list of \a KexiAppPartItem objects for the defined
\p mimetype string. */
Kross::Api::List* getPartItems(const TQString& mimetype);
/** Try to open the defined \a KexiAppPartItem and \return true
on success else false. */
bool openPartItem(KexiAppPartItem* partitem);
private:
/// Private d-pointer class.
KexiAppMainWindowPrivate* d;
};
}}
#endif