Kexi API Documentation (2.0 alpha)

Kross::KexiApp::KexiAppMainWindow Class Reference

#include <kexiappmainwindow.h>

Inheritance diagram for Kross::KexiApp::KexiAppMainWindow:

Class List of all members.

Detailed Description

Class to handle Kexi's mainwindow instance.

Definition at line 43 of file kexiappmainwindow.h.

Public Member Functions

 KexiAppMainWindow (KexiMainWindow *mainwindow)
 Constructor.
virtual ~KexiAppMainWindow ()
 Destructor.
virtual const QString getClassName () const
bool isConnected ()
Kross::Api::Object::Ptr getConnection ()
Kross::Api::List * getPartItems (const QString &mimetype)
bool openPartItem (KexiAppPartItem *partitem)
 Try to open the defined KexiAppPartItem and.


Constructor & Destructor Documentation

KexiAppMainWindow::KexiAppMainWindow KexiMainWindow mainwindow  ) 
 

Constructor.

Parameters:
mainwindow The KexiMainWindow instance this class provides access to.

Definition at line 52 of file kexiappmainwindow.cpp.

References getConnection(), getPartItems(), isConnected(), and openPartItem().

KexiAppMainWindow::~KexiAppMainWindow  )  [virtual]
 

Destructor.

Definition at line 65 of file kexiappmainwindow.cpp.


Member Function Documentation

const QString KexiAppMainWindow::getClassName  )  const [virtual]
 

See also:
Kross::Api::Object::getClassName

Definition at line 70 of file kexiappmainwindow.cpp.

Kross::Api::Object::Ptr KexiAppMainWindow::getConnection  ) 
 

Returns:
the 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 Kross::Api::Object to pass the Kross::KexiDB::KexiDBConnection object around.

Definition at line 80 of file kexiappmainwindow.cpp.

Referenced by KexiAppMainWindow().

Kross::Api::List * KexiAppMainWindow::getPartItems const QString mimetype  ) 
 

Returns:
a list of KexiAppPartItem objects for the defined mimetype string.

Definition at line 91 of file kexiappmainwindow.cpp.

Referenced by KexiAppMainWindow().

bool KexiAppMainWindow::isConnected  ) 
 

Returns:
true if Kexi is connected with a project else false is returned.

Definition at line 75 of file kexiappmainwindow.cpp.

Referenced by KexiAppMainWindow().

bool KexiAppMainWindow::openPartItem KexiAppPartItem partitem  ) 
 

Try to open the defined KexiAppPartItem and.

Returns:
true on success else false.

Definition at line 99 of file kexiappmainwindow.cpp.

References Kexi::DataViewMode, and Kross::KexiApp::KexiAppPartItem::item().

Referenced by KexiAppMainWindow().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for Kexi 2.0 alpha.
Documentation copyright © 2002-2007 the Kexi Team.
Generated on Tue Apr 1 20:51:05 2008 by doxygen 1.4.2 written by Dimitri van Heesch, © 1997-2003