KexiPart::Info Class Reference

#include <kexipartinfo.h>

Inheritance diagram for KexiPart::Info:

Detailed Description

Information about a Kexi Part (plugin).

Definition at line 40 of file kexipartinfo.h.

Public Member Functions

Info (KService::Ptr service)

~Info ()

QString groupName () const

QCString mimeType () const

QString itemIcon () const

QString createItemIcon () const

QString objectName () const

int projectPartID () const

KService::Ptr ptr () const

bool isBroken () const

bool isVisibleInNavigator () const

bool isDataExportSupported () const

bool isPrintingSupported () const

bool isExecuteSupported () const

Protected Member Functions

Info ()

Used in StaticInfo.

void setProjectPartID (int id)

Sets the project-part-id.

void setBroken (bool broken, const QString &errorMessage)

Sets the broken flag and error message.

QString errorMessage () const

void setIdStoredInPartDatabase (bool set)

bool isIdStoredInPartDatabase () const

Protected Attributes

Private * d

Friends

class Manager

class ::KexiProject

class ::KexiMainWindowImpl

class ::KexiDialogBase

Classes

class Private

Constructor & Destructor Documentation

Info::Info ( KService::Ptr service )

Definition at line 60 of file kexipartinfo.cpp.

Info::~Info ( )

Definition at line 70 of file kexipartinfo.cpp.
References d.

Info::Info ( ) [protected]

Used in StaticInfo.

Definition at line 65 of file kexipartinfo.cpp.

Member Function Documentation

QString Info::createItemIcon ( ) const

Returns:
the icon for a item

Definition at line 81 of file kexipartinfo.cpp.
References d, and KexiPart::Info::Private::itemIcon.

QString Info::errorMessage ( ) const [protected]

Returns:
i18n'd error message set by setBroken().

Definition at line 98 of file kexipartinfo.cpp.
References d, and KexiPart::Info::Private::errorMessage.
Referenced by KexiPart::Manager::part().

QString Info::groupName ( ) const

Returns:
a i18n'ed group name e.g. "Tables"

Definition at line 75 of file kexipartinfo.cpp.
References d, and KexiPart::Info::Private::groupName.

bool Info::isBroken ( ) const

Returns:
true if loading was tried but failed

Definition at line 87 of file kexipartinfo.cpp.
References KexiPart::Info::Private::broken, and d.
Referenced by KexiPart::Manager::part().

bool Info::isDataExportSupported ( ) const

Returns:
true if the part supports data exporting.

Definition at line 110 of file kexipartinfo.cpp.
References d, and KexiPart::Info::Private::ptr.
Referenced by KexiMainWindowImpl::invalidateProjectWideActions(), and KexiMacro::ObjectVariable< ACTIONIMPL >::ObjectVariable().

bool Info::isExecuteSupported ( ) const

Returns:
true if the part supports execution. This is as example the case for the Macro and the Scripting plugins.

Definition at line 122 of file kexipartinfo.cpp.
References d, and KexiPart::Info::Private::ptr.
Referenced by KexiMainWindowImpl::executeItem(), and KexiMacro::ObjectVariable< ACTIONIMPL >::ObjectVariable().

bool Info::isIdStoredInPartDatabase ( ) const [protected]

Returns:
true if ID of the part is stored in project's database false by default. This flag is updated in Manager::checkProject() and set to true on first successful execution of KexiDialogBase::storeNewData()

Definition at line 105 of file kexipartinfo.cpp.
References d, and KexiPart::Info::Private::idStoredInPartDatabase.

bool Info::isPrintingSupported ( ) const

Returns:
true if the part supports data printing.

Definition at line 116 of file kexipartinfo.cpp.
References d, and KexiPart::Info::Private::ptr.
Referenced by KexiMainWindowImpl::printActionForItem().

bool Info::isVisibleInNavigator ( ) const

Returns:
true if the part should be visible in the Project Navigator (as a folder).

Definition at line 89 of file kexipartinfo.cpp.
References d, and KexiPart::Info::Private::isVisibleInNavigator.
Referenced by KexiBrowser::addGroup(), and KexiMacro::ObjectVariable< ACTIONIMPL >::ObjectVariable().

QString Info::itemIcon ( ) const

Returns:
the icon for a item

Definition at line 79 of file kexipartinfo.cpp.
References d, and KexiPart::Info::Private::itemIcon.
Referenced by KexiMainWindowImpl::getNewObjectInfo(), KexiBrowserItem::KexiBrowserItem(), and KexiCSVExportWizard::KexiCSVExportWizard().

QCString Info::mimeType ( ) const

Returns:
the internal mime type of this part

Definition at line 77 of file kexipartinfo.cpp.
References d, and KexiPart::Info::Private::mimeType.
Referenced by KexiBrowser::addGroup(), KexiProject::createPartItem(), KexiProject::items(), KexiPart::Manager::lookup(), and KexiMainWindowImpl::newObject().

QString Info::objectName ( ) const

Returns:
the object name associated with this part (e.g. "table")

Definition at line 83 of file kexipartinfo.cpp.
References d, and KexiPart::Info::Private::objectName.
Referenced by KexiActionSelectionDialog::currentAction(), KexiPart::nameForCreateAction(), KexiMacro::ObjectVariable< ACTIONIMPL >::ObjectVariable(), and KexiPart::Manager::part().

int Info::projectPartID ( ) const

Returns:
the project-part-id

Definition at line 91 of file kexipartinfo.cpp.
References d, and KexiPart::Info::Private::projectPartID.
Referenced by KexiMainWindowImpl::getNewObjectInfo(), KexiProject::items(), KexiPart::Part::openInstance(), and KexiPart::Manager::part().

KService::Ptr Info::ptr ( ) const

Returns:
the KService::Ptr associated with this part

Definition at line 85 of file kexipartinfo.cpp.
References d, and KexiPart::Info::Private::ptr.
Referenced by KexiPart::Manager::part().

void Info::setBroken ( bool broken,

const QString & errorMessage

) [protected]

Sets the broken flag and error message.
Most likely to be called by KexiPart::Manager
Definition at line 95 of file kexipartinfo.cpp.
References KexiPart::Info::Private::broken, d, and KexiPart::Info::Private::errorMessage.
Referenced by KexiPart::Manager::part().

void Info::setIdStoredInPartDatabase ( bool set ) [protected]

Definition at line 100 of file kexipartinfo.cpp.
References d, and KexiPart::Info::Private::idStoredInPartDatabase.
Referenced by KexiPart::Manager::checkProject().

void Info::setProjectPartID ( int id ) [protected]

Sets the project-part-id.

Definition at line 93 of file kexipartinfo.cpp.
References d, and KexiPart::Info::Private::projectPartID.
Referenced by KexiPart::Manager::checkProject(), KexiPart::Manager::lookup(), and KexiPart::Manager::part().

Friends And Related Function Documentation

friend class ::KexiDialogBase [friend]

Definition at line 121 of file kexipartinfo.h.

friend class ::KexiMainWindowImpl [friend]

Definition at line 120 of file kexipartinfo.h.

friend class ::KexiProject [friend]

Definition at line 119 of file kexipartinfo.h.

friend class Manager [friend]

Definition at line 118 of file kexipartinfo.h.

Member Data Documentation

Private* KexiPart::Info::d [protected]

Definition at line 149 of file kexipartinfo.h.
Referenced by createItemIcon(), errorMessage(), groupName(), isBroken(), isDataExportSupported(), isExecuteSupported(), isIdStoredInPartDatabase(), isPrintingSupported(), isVisibleInNavigator(), itemIcon(), mimeType(), objectName(), projectPartID(), ptr(), setBroken(), setIdStoredInPartDatabase(), setProjectPartID(), KexiPart::StaticInfo::StaticInfo(), and ~Info().

The documentation for this class was generated from the following files:


Public Member Functions
	Info (KService::Ptr service)
	~Info ()
QString	groupName () const
QCString	mimeType () const
QString	itemIcon () const
QString	createItemIcon () const
QString	objectName () const
int	projectPartID () const
KService::Ptr	ptr () const
bool	isBroken () const
bool	isVisibleInNavigator () const
bool	isDataExportSupported () const
bool	isPrintingSupported () const
bool	isExecuteSupported () const
Protected Member Functions
	Info ()
	Used in StaticInfo.
void	setProjectPartID (int id)
	Sets the project-part-id.
void	setBroken (bool broken, const QString &errorMessage)
	Sets the broken flag and error message.
QString	errorMessage () const
void	setIdStoredInPartDatabase (bool set)
bool	isIdStoredInPartDatabase () const
Protected Attributes
Private *	d
Friends
class	Manager
class	::KexiProject
class	::KexiMainWindowImpl
class	::KexiDialogBase
Classes
class	Private

Kexi API Documentation (2.0 alpha)

KexiPart::Info Class Reference

Detailed Description

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Classes

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation