Kexi API Documentation (2.0 alpha)
Overview Class Hierarchy Classes Classes (annotated) Members Source Files

Kexi Namespace Reference

Detailed Description

Namespace for general Kexi functions.


Classes

class  ObjectStatus
class  ActionCategories
 A set of functions used to declare action categories. More...

Enumerations

enum  ViewMode {
  AllViewModes = 0, NoViewMode = 0, DataViewMode = 1, DesignViewMode = 2,
  TextViewMode = 4
}
enum  ActionCategory { NoActionCategory = 0, GlobalActionCategory = 1, PartItemActionCategory = 2, WindowActionCategory = 4 }

Functions

KEXICORE_EXPORT void initCmdLineArgs (int argc, char *argv[], KAboutData *aboutData=0)
KEXICORE_EXPORT QString nameForViewMode (int m)
 i18n'ed name of view mode m
KEXICORE_EXPORT KexiDBConnectionSet & connset ()
 A set of known connections.
KEXICORE_EXPORT KexiProjectSet & recentProjects ()
 A set avaiulable of project infos.
KEXICORE_EXPORT KexiDB::DriverManager & driverManager ()
 shared driver manager
KEXICORE_EXPORT KexiPart::Manager & partManager ()
 shared part manager
KEXICORE_EXPORT void deleteGlobalObjects ()
 can be called to delete global objects like driverManager and partManager (and thus, all loaded factories/plugins) before KLibrary::~KLibrary() do this for us
KEXICORE_EXPORT bool & tempShowForms ()
 false by default, flag loaded on main window startup
KEXICORE_EXPORT bool & tempShowReports ()
 false by default, flag loaded on main window startup
KEXICORE_EXPORT bool & tempShowMacros ()
 false by default, flag loaded on main window startup
KEXICORE_EXPORT bool & tempShowScripts ()
 false by default, flag loaded on main window startup
KEXICORE_EXPORT QFont smallFont (QWidget *init=0)
KEXICORE_EXPORT QString msgYouCanImproveData ()
KEXICORE_EXPORT KAboutData * createAboutData ()
KEXICORE_EXPORT ActionCategories * actionCategories ()
KEXICORE_EXPORT unsigned int version ()
 Returns the encoded number of Kexi's version, see the KEXI_VERSION macro.
KEXICORE_EXPORT unsigned int versionMajor ()
 Returns the major number of Kexi's version, e.g.
KEXICORE_EXPORT unsigned int versionMinor ()
 Returns the minor number of Kexi's version, e.g.
KEXICORE_EXPORT unsigned int versionRelease ()
 Returns the release of Kexi's version, e.g.
KEXICORE_EXPORT const char * versionString ()
 Returns the Kexi version as string, e.g.
KexiStartupHandler & startupHandler ()

Variables

static KStaticDeleter< ActionCategories > Kexi_actionCategoriesDeleter
ActionCategories * Kexi_actionCategories = 0
static KStaticDeleter< KexiStartupHandler > Kexi_startupHandlerDeleter
KexiStartupHandler * _startupHandler = 0

Enumeration Type Documentation

enum Kexi::ActionCategory
 

Enumeration values:
NoActionCategory  no category at all
GlobalActionCategory  global application action like editcopy; can be applied to focused widget (of many types)
PartItemActionCategory  action related to part item, e.g.

data_execute; requires context, used only in the navigator

WindowActionCategory  action related to active window, which can display table, query, form, report..

Definition at line 28 of file kexiactioncategories.h.

enum Kexi::ViewMode
 

Modes of view for the dialogs. Used mostly for parts and KexiDialogBase.

Enumeration values:
AllViewModes  Usable primarily in KexiPart::initInstanceActions().
NoViewMode  In KexiViewBase::afterSwitchFrom() and KexiViewBase::beforeSwitchTo() means that parent dialog of the view has not yet view defined.
DataViewMode 
DesignViewMode 
TextViewMode  Also known as SQL View Mode.

Definition at line 42 of file kexi.h.

Function Documentation

KEXICORE_EXPORT ActionCategories * Kexi::actionCategories (   ) 
 

Returns:
ActionCategories singleton object

Definition at line 63 of file kexiactioncategories.cpp.

References Kexi::ActionCategories::ActionCategories(), Kexi_actionCategories, and Kexi_actionCategoriesDeleter.

Referenced by KActionsListViewBase::init(), and KexiMainWindowImpl::initActions().

KEXICORE_EXPORT KexiDBConnectionSet& Kexi::connset (   ) 
 

A set of known connections.

Referenced by KexiMainWindowImpl::createBlankProjectData(), KexiStartupHandler::init(), KexiMainWindowImpl::openProject(), KexiMainWindowImpl::openProjectInExternalKexiInstance(), KexiMainWindowImpl::slotProjectOpen(), and KexiMainWindowImpl::slotToolsCompactDatabase().

KEXICORE_EXPORT KAboutData* Kexi::createAboutData (   ) 
 

Referenced by Kexi::initCmdLineArgs().

KEXICORE_EXPORT void Kexi::deleteGlobalObjects (   ) 
 

can be called to delete global objects like driverManager and partManager (and thus, all loaded factories/plugins) before KLibrary::~KLibrary() do this for us

KEXICORE_EXPORT KexiDB::DriverManager& Kexi::driverManager (   ) 
 

shared driver manager

Referenced by KexiProject::createConnection(), KexiStartupHandler::detectActionForFile(), KexiDBConnectionWidget::KexiDBConnectionWidget(), KexiProjectSet::KexiProjectSet(), and KexiMainWindowImpl::slotToolsCompactDatabase().

KEXICORE_EXPORT void Kexi::initCmdLineArgs (  int  argc,
char *  argv[],
KAboutData *  aboutData = 0
) 
 

Referenced by KexiMainWindowImpl::create().

KEXICORE_EXPORT QString Kexi::msgYouCanImproveData (   ) 
 

Referenced by KexiDataAwareObjectInterface::acceptEditor(), and KexiTableViewData::saveRow().

KEXICORE_EXPORT QString Kexi::nameForViewMode (  int  m  ) 
 

i18n'ed name of view mode m

Referenced by KexiPart::Part::createGUIClients(), KexiMainWindowImpl::openObject(), KexiMainWindowImpl::switchToViewMode(), and KexiDialogBase::switchToViewMode().

KEXICORE_EXPORT KexiPart::Manager& Kexi::partManager (   ) 
 

shared part manager

Referenced by KexiCSVImportDialog::accept(), KexiFormEventAction::activate(), KexiMacro::ExecuteAction::activate(), KexiMacro::DataTableAction::activate(), KexiProject::createPartItem(), KexiActionSelectionDialog::currentAction(), KexiFormEventAction::ActionData::decodeString(), KexiUserAction::execute(), KexiMainWindowImpl::executeItem(), KexiProject::findPartFor(), KexiProject::getSortedItemsForMimeType(), KexiProject::initProject(), KexiMainWindowImpl::initUserMode(), KexiProject::itemsForMimeType(), KexiActionSelectionDialog::KexiActionSelectionDialog(), KexiCSVExportWizard::KexiCSVExportWizard(), KexiMainWindowImpl::KexiMainWindowImpl(), KexiProject::KexiProject(), KexiMainWindowImpl::newObject(), KexiMacro::ObjectNameVariable< ACTIONIMPL >::ObjectNameVariable(), KexiMacro::ObjectVariable< ACTIONIMPL >::ObjectVariable(), KexiMainWindowImpl::openingAllowed(), KexiMainWindowImpl::openObject(), KexiMainWindowImpl::openObjectFromNavigator(), KexiMainWindowImpl::printActionForItem(), KexiMainWindowImpl::removeObject(), KexiDataSourceComboBox::setProject(), KexiBrowser::setProject(), KexiMainWindowImpl::slotAutoOpenObjectsLater(), KexiBrowser::slotContextMenu(), KexiBrowser::slotNewObjectPopupAboutToShow(), KexiBrowser::slotSelectionChanged(), KexiPart::StaticPart::StaticPart(), and KexiMainWindowImpl::updateReadOnlyState().

KEXICORE_EXPORT KexiProjectSet& Kexi::recentProjects (   ) 
 

A set avaiulable of project infos.

Referenced by KexiMainWindowImpl::createBlankProject(), KexiStartupHandler::init(), KexiMainWindowImpl::openProject(), KexiMainWindowImpl::slotProjectOpen(), and KexiMainWindowImpl::slotToolsCompactDatabase().

KEXICORE_EXPORT QFont Kexi::smallFont (  QWidget *  init = 0  ) 
 

A global setting for minimal readable font. Note: this is defined because KDE has no such setting yet. init is a widget that should be passed if no qApp->mainWidget() is available yet.

Referenced by KexiRelationViewConnection::drawConnection(), KexiSmallToolButton::init(), KexiMainWindowImpl::initPropertyEditor(), and KexiMainWindowImpl::KexiMainWindowImpl().

KEXIMAIN_EXPORT KexiStartupHandler & Kexi::startupHandler (   ) 
 

Returns:
singleton Startup Handler singleton.

Definition at line 66 of file KexiStartup.cpp.

References _startupHandler, and Kexi_startupHandlerDeleter.

Referenced by KexiMainWindowImpl::create(), KexiMainWindowImpl::KexiMainWindowImpl(), KexiMainWindowImpl::openProject(), and KexiMainWindowImpl::startup().

KEXICORE_EXPORT bool& Kexi::tempShowForms (   ) 
 

false by default, flag loaded on main window startup

Referenced by KexiPart::Manager::lookup(), and KexiMainWindowImpl::slotOptionsEnableForms().

KEXICORE_EXPORT bool& Kexi::tempShowMacros (   ) 
 

false by default, flag loaded on main window startup

Referenced by KexiMainWindowImpl::initActions(), and KexiPart::Manager::lookup().

KEXICORE_EXPORT bool& Kexi::tempShowReports (   ) 
 

false by default, flag loaded on main window startup

Referenced by KexiMainWindowImpl::initActions(), and KexiPart::Manager::lookup().

KEXICORE_EXPORT bool& Kexi::tempShowScripts (   ) 
 

false by default, flag loaded on main window startup

Referenced by KexiMainWindowImpl::initActions(), and KexiPart::Manager::lookup().

KEXICORE_EXPORT unsigned int Kexi::version (   ) 
 

Returns the encoded number of Kexi's version, see the KEXI_VERSION macro.

Returns:
KFormDesigner API version number for this library. This information is stored

Definition at line 26 of file kexi_global.cpp.

KEXICORE_EXPORT unsigned int Kexi::versionMajor (   ) 
 

Returns the major number of Kexi's version, e.g.

1 for Kexi 1.2.3.

Returns:
the major version number

Definition at line 31 of file kexi_global.cpp.

KEXICORE_EXPORT unsigned int Kexi::versionMinor (   ) 
 

Returns the minor number of Kexi's version, e.g.

2 for Kexi 1.2.3.

Returns:
the minor version number

Definition at line 36 of file kexi_global.cpp.

KEXICORE_EXPORT unsigned int Kexi::versionRelease (   ) 
 

Returns the release of Kexi's version, e.g.

3 for Kexi 1.2.3.

Returns:
the release number

Definition at line 41 of file kexi_global.cpp.

References KEXI_VERSION_RELEASE.

KEXICORE_EXPORT const char* Kexi::versionString (   ) 
 

Returns the Kexi version as string, e.g.

"1.2.3" Sometimes it may be even something like "1.2.3 beta 2"

Returns:
the Kexi version. You can keep the string forever

Definition at line 46 of file kexi_global.cpp.

References KEXI_VERSION_STRING.

Referenced by KexiDB::MySqlConnection::drv_connect().

Variable Documentation

KexiStartupHandler* Kexi::_startupHandler = 0
 

Definition at line 64 of file KexiStartup.cpp.

Referenced by startupHandler().

ActionCategories* Kexi::Kexi_actionCategories = 0
 

Definition at line 49 of file kexiactioncategories.cpp.

Referenced by actionCategories().

KStaticDeleter<ActionCategories> Kexi::Kexi_actionCategoriesDeleter [static]
 

Definition at line 48 of file kexiactioncategories.cpp.

Referenced by actionCategories().

KStaticDeleter<KexiStartupHandler> Kexi::Kexi_startupHandlerDeleter [static]
 

Definition at line 63 of file KexiStartup.cpp.

Referenced by startupHandler().

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:50:36 2008 by doxygen 1.4.2 written by Dimitri van Heesch, © 1997-2003