#include <kexidialogbase.h>

Inheritance diagram for KexiDialogBase:

Public Slots
virtual void	setFocus ()

void	updateCaption ()

tristate	storeData (bool dontAsk=false)

tristate	storeNewData ()

void	sendDetachedStateToCurrentView ()

void	sendAttachedStateToCurrentView ()

Signals
void	updateContextHelp ()

void	closing ()

void	dirtyChanged (KexiDialogBase *)

Public Member Functions
	KexiDialogBase (KexiMainWindow *parent, const TQString &caption=TQString())

bool	isRegistered ()

KexiViewBase *	selectedView () const

KexiViewBase *	viewForMode (int mode) const

void	addView (KexiViewBase *view)

virtual TQSize	minimumSizeHint () const

virtual TQSize	sizeHint () const

KexiMainWindow *	mainWin () const

void	setId (int id)

int	id () const

KexiPart::Part *	part () const

KexiPart::Item *	partItem () const

KexiPart::GUIClient *	commonGUIClient () const

KexiPart::GUIClient *	guiClient () const

virtual TQString	itemIcon ()

bool	supportsViewMode (int mode) const

int	currentViewMode () const

tristate	switchToViewMode (int newViewMode)

void	setContextHelp (const TQString &caption, const TQString &text, const TQString &iconName)

virtual bool	eventFilter (TQObject obj, TQEvent e)

virtual void	attachToGUIClient ()

virtual void	detachFromGUIClient ()

bool	dirty () const

KexiViewBase *	viewThatRecentlySetDirtyFlag () const

bool	neverSaved () const

KoProperty::Set *	propertySet ()

KexiDB::SchemaData *	schemaData () const

KexiDialogTempData *	tempData () const

void	activate ()

void	deactivate ()

Public Member Functions inherited from KexiActionProxy
	KexiActionProxy (TQObject receiver, KexiSharedActionHost host=0)

bool	activateSharedAction (const char *action_name, bool alsoCheckInChildren=true)

void	setSharedActionHost (KexiSharedActionHost &host)

bool	isAvailable (const char *action_name, bool alsoCheckInChildren=true) const

bool	isSupported (const char *action_name) const

void	setActionProxyParent_internal (KexiActionProxy *parent)

Public Member Functions inherited from Kexi::ObjectStatus
	ObjectStatus (const TQString &message, const TQString &description)

	ObjectStatus (KexiDB::Object *dbObject, const TQString &message, const TQString &description)

const ObjectStatus &	status () const

bool	error () const

void	setStatus (const TQString &message, const TQString &description)

void	setStatus (KexiDB::Object *dbObject, const TQString &message=TQString(), const TQString &description=TQString())

void	setStatus (KexiDB::ResultInfo *result, const TQString &message=TQString(), const TQString &description=TQString())

void	setStatus (KexiDB::Object dbObject, KexiDB::ResultInfo result, const TQString &message=TQString(), const TQString &description=TQString())

void	clearStatus ()

TQString	singleStatusString () const

void	append (const ObjectStatus &otherStatus)

KexiDB::Object *	dbObject () const

	operator KexiDB::MessageHandler * ()

Protected Slots
void	setDirty (bool dirty)

Protected Member Functions
tristate	switchToViewMode (int newViewMode, TQMap< TQString, TQString > *staticObjectArgs, bool &proposeOpeningInTextViewModeBecauseOfProblems)

void	registerDialog ()

virtual void	closeEvent (TQCloseEvent *e)

void	addView (KexiViewBase *view, int mode)

void	removeView (int mode)

TQWidgetStack *	stack () const

void	dirtyChanged (KexiViewBase *view)

bool	isDesignModePreloadedForTextModeHackUsed (int newViewMode) const

Protected Member Functions inherited from KexiActionProxy
void	plugSharedAction (const char action_name, TQObject receiver, const char *slot)

void	unplugSharedAction (const char *action_name)

void	plugSharedAction (const char action_name, const char slot)

int	plugSharedAction (const char action_name, TQWidget w)

void	plugSharedActionToExternalGUI (const char action_name, KXMLGUIClient client)

void	plugSharedActionsToExternalGUI (const TQValueList< TQCString > &action_names, KXMLGUIClient *client)

void	unplugSharedAction (const char action_name, TQWidget w)

TDEAction *	plugSharedAction (const char action_name, const TQString &alternativeText, TQWidget w)

virtual TDEAction *	sharedAction (const char *action_name)

TQObject *	receiver () const

virtual void	setAvailable (const char *action_name, bool set)

void	addActionProxyChild (KexiActionProxy *child)

void	takeActionProxyChild (KexiActionProxy *child)

Protected Attributes
int	m_supportedViewModes

int	m_openedViewModes

int	m_currentViewMode

Protected Attributes inherited from KexiActionProxy
KexiSharedActionHost *	m_host

TQGuardedPtr< TQObject >	m_receiver

TQAsciiDict< TQPair< TQSignal *, bool > >	m_signals

TQPtrList< KexiActionProxy >	m_sharedActionChildren

TQPtrList< TDEAction >	m_alternativeActions

KexiActionProxy *	m_actionProxyParent

TQObject	m_signal_parent

TDEAction_setEnabled_Helper *	m_TDEAction_setEnabled_helper

Protected Attributes inherited from Kexi::ObjectStatus
TQGuardedPtr< TQObject >	dbObj

KexiDB::MessageHandler *	msgHandler

Friends
class	KexiMainWindow

class	KexiPart::Part

class	KexiInternalPart

class	KexiViewBase

Additional Inherited Members
Public Attributes inherited from KexiActionProxy
KexiActionProxy *	m_focusedChild

Public Attributes inherited from Kexi::ObjectStatus
TQString	message

TQString	description

Detailed Description

Base class for child window of Kexi's main application window.

This class can contain a number of configurable views, switchable using toggle action. It also automatically works as a proxy for shared (application-wide) actions.

Definition at line 75 of file kexidialogbase.h.

Constructor & Destructor Documentation

◆ KexiDialogBase()

KexiDialogBase::KexiDialogBase	(	KexiMainWindow *	parent,
		const TQString &	caption = `TQString()`
	)

Definition at line 44 of file kexidialogbase.cpp.

◆ ~KexiDialogBase()

KexiDialogBase::~KexiDialogBase ( )

virtual

Definition at line 74 of file kexidialogbase.cpp.

Member Function Documentation

◆ activate()

void KexiDialogBase::activate ( )

Used by KexiViewBase subclasses. Sets temporary data shared between views. ‍/ void setTempData( KexiDialogTempData data ) { m_tempData = data; }

    /*! Called primarily by KexiMainWindowImpl to activate dialog.
     Selected view (if present) is also informed about activation.

Definition at line 624 of file kexidialogbase.cpp.

◆ addView() [1/2]

void KexiDialogBase::addView ( KexiViewBase * view )

Adds view for the dialog. It will be the only view (of unspecified mode) for the dialog.

Definition at line 92 of file kexidialogbase.cpp.

◆ addView() [2/2]

void KexiDialogBase::addView	(	KexiViewBase *	view,
		int	mode
	)

protected

Definition at line 97 of file kexidialogbase.cpp.

◆ attachToGUIClient()

void KexiDialogBase::attachToGUIClient ( )

virtual

Used by Main Window

Todo:: js: PROBABLY REMOVE THESE TWO?

Definition at line 160 of file kexidialogbase.cpp.

◆ closeEvent()

void KexiDialogBase::closeEvent ( TQCloseEvent * e )

protectedvirtual

Definition at line 186 of file kexidialogbase.cpp.

◆ closing

void KexiDialogBase::closing ( )

signal

emitted when the window is about to close

◆ commonGUIClient()

KexiPart::GUIClient * KexiDialogBase::commonGUIClient ( ) const

Kexi dialog's gui COMMON client.

It's obtained by querying part object for this dialog.

Definition at line 274 of file kexidialogbase.cpp.

◆ currentViewMode()

int KexiDialogBase::currentViewMode ( ) const

inline

Returns: current view mode for this dialog.

Definition at line 155 of file kexidialogbase.h.

◆ deactivate()

void KexiDialogBase::deactivate ( )

Called primarily by KexiMainWindowImpl to deactivate dialog. Selected view (if present) is also informed about deactivation.

Definition at line 639 of file kexidialogbase.cpp.

◆ detachFromGUIClient()

void KexiDialogBase::detachFromGUIClient ( )

virtual

Definition at line 166 of file kexidialogbase.cpp.

◆ dirty()

bool KexiDialogBase::dirty ( ) const

True if contents (data) of the dialog is dirty and need to be saved This may or not be used, depending if changes in the dialog are saved immediately (e.g. like in datatableview) or saved by hand (by user) (e.g. like in alter-table dialog).

Returns: true if at least on "dirty" flag is set for one of the dialog's view.

Definition at line 223 of file kexidialogbase.cpp.

◆ dirtyChanged [1/2]

void KexiDialogBase::dirtyChanged ( KexiDialogBase * )

signal

Emited to inform the world that 'dirty' flag changes. Activated by KexiViewBase::setDirty().

◆ dirtyChanged() [2/2]

void KexiDialogBase::dirtyChanged ( KexiViewBase * view )

protected

Used by view to inform the dialog about changing state of the "dirty" flag.

Definition at line 450 of file kexidialogbase.cpp.

◆ eventFilter()

bool KexiDialogBase::eventFilter	(	TQObject *	obj,
		TQEvent *	e
	)

virtual

Internal reimplementation.

Definition at line 432 of file kexidialogbase.cpp.

◆ guiClient()

KexiPart::GUIClient * KexiDialogBase::guiClient ( ) const

Kexi dialog's gui client for currently selected view.

It's obtained by querying part object for this dialog.

Definition at line 267 of file kexidialogbase.cpp.

◆ id()

int KexiDialogBase::id ( ) const

If there is a part item associated with this dialog (see partItem()), partItem()->identifier() is returned, otherwise internal dialog's identifier (previously set by setID()) is returned.

Definition at line 172 of file kexidialogbase.cpp.

◆ isDesignModePreloadedForTextModeHackUsed()

bool KexiDialogBase::isDesignModePreloadedForTextModeHackUsed ( int newViewMode ) const

protected

Definition at line 281 of file kexidialogbase.cpp.

◆ isRegistered()

bool KexiDialogBase::isRegistered ( )

Definition at line 156 of file kexidialogbase.cpp.

◆ itemIcon()

TQString KexiDialogBase::itemIcon ( )

virtual

Tries to close the dialog.

Returns: true if closing is accepted (sometimes, user may not want to close the dialog by pressing cancel). If dontSaveChanges if true, changes are not saved even if this dialog is dirty.; name of icon provided by part that created this dialog. The name is used by KexiMainWindow to set/reset icon for this dialog.

Definition at line 255 of file kexidialogbase.cpp.

◆ mainWin()

KexiMainWindow * KexiDialogBase::mainWin ( ) const

inline

Definition at line 109 of file kexidialogbase.h.

◆ minimumSizeHint()

TQSize KexiDialogBase::minimumSizeHint ( ) const

virtual

Returns: main (top level) widget inside this dialog. This widget is used for e.g. determining minimum size hint and size hint.

reimplemented: minimum size hint is inherited from currently visible view.

Definition at line 120 of file kexidialogbase.cpp.

◆ neverSaved()

bool KexiDialogBase::neverSaved ( ) const

Returns: true, if this dialog's data were never saved. If it's true we're usually try to ask a user if the dialog's data should be saved somewhere. After dialog construction, "neverSaved" flag is set to appropriate value. KexiPart::Item::neverSaved() is reused.

Definition at line 495 of file kexidialogbase.cpp.

◆ part()

KexiPart::Part * KexiDialogBase::part ( ) const

inline

Returns: Kexi part used to create this window

Definition at line 125 of file kexidialogbase.h.

◆ partItem()

KexiPart::Item * KexiDialogBase::partItem ( ) const

inline

Returns: Kexi part item used to create this window

Definition at line 128 of file kexidialogbase.h.

◆ propertySet()

KoProperty::Set * KexiDialogBase::propertySet ( )

Returns: property set provided by a current view, or NULL if there is no view set (or the view has no set assigned).

Definition at line 424 of file kexidialogbase.cpp.

◆ registerDialog()

void KexiDialogBase::registerDialog ( )

protected

Definition at line 141 of file kexidialogbase.cpp.

◆ removeView()

void KexiDialogBase::removeView ( int mode )

protected

Definition at line 110 of file kexidialogbase.cpp.

◆ schemaData()

KexiDB::SchemaData * KexiDialogBase::schemaData ( ) const

inline

Definition at line 199 of file kexidialogbase.h.

◆ selectedView()

KexiViewBase * KexiDialogBase::selectedView ( ) const

Returns: currently selected view or 0 if there is no current view

Definition at line 79 of file kexidialogbase.cpp.

◆ sendAttachedStateToCurrentView

void KexiDialogBase::sendAttachedStateToCurrentView ( )

slot

W're informing the current view about performed atttaching by calling KexiViewBase::parentDialogAttached(), so the view can react on this event (by default KexiViewBase::parentDialogAttached() does nothing, you can reimplement it).

Definition at line 653 of file kexidialogbase.cpp.

◆ sendDetachedStateToCurrentView

void KexiDialogBase::sendDetachedStateToCurrentView ( )

slot

Reimplemented - we're informing the current view about performed detaching by calling KexiViewBase::parentDialogDetached(), so the view can react on this event (by default KexiViewBase::parentDialogDetached() does nothing, you can reimplement it).

Definition at line 646 of file kexidialogbase.cpp.

◆ setContextHelp()

void KexiDialogBase::setContextHelp	(	const TQString &	caption,
		const TQString &	text,
		const TQString &	iconName
	)

Definition at line 177 of file kexidialogbase.cpp.

◆ setDirty

void KexiDialogBase::setDirty ( bool dirty )

protectedslot

Sets 'dirty' flag on every dialog's view.

Definition at line 240 of file kexidialogbase.cpp.

◆ setFocus

void KexiDialogBase::setFocus ( )

virtualslot

Definition at line 409 of file kexidialogbase.cpp.

◆ setId()

void KexiDialogBase::setId ( int id )

inline

This method sets internal identifier for the dialog, but if there is a part item associated with this dialog (see partItem()), partItem()->identifier() will be is used as identifier, so this method is noop. Thus, it's usable only for dialog types when no part item is assigned.

Definition at line 117 of file kexidialogbase.h.

◆ sizeHint()

TQSize KexiDialogBase::sizeHint ( ) const

virtual

reimplemented: size hint is inherited from currently visible view.

Definition at line 128 of file kexidialogbase.cpp.

◆ stack()

TQWidgetStack * KexiDialogBase::stack ( ) const

inlineprotected

Definition at line 285 of file kexidialogbase.h.

◆ storeData

tristate KexiDialogBase::storeData ( bool dontAsk = false )

slot

Internal. Called by KexiMainWindowImpl::saveObject(). Tells this dialog to save changes of the existing object to the backend. If dontAsk is true, no question dialog will be shown to the user. The default is false.

See also: storeNewData()

Returns: true on success, false on failure and cancelled when storing has been cancelled.

Definition at line 588 of file kexidialogbase.cpp.

◆ storeNewData

tristate KexiDialogBase::storeNewData ( )

slot

Internal. Called by KexiMainWindowImpl::saveObject(). Tells this dialog to create and store data of the new object to the backend. Object's schema data has been never stored, so it is created automatically, using information obtained form part item. On success, part item's ID is updated to new value, and m_schemaData is set.

See also: schemaData().

Returns: true on success, false on failure and cancelled when storing has been cancelled.

Definition at line 500 of file kexidialogbase.cpp.

◆ supportsViewMode()

bool KexiDialogBase::supportsViewMode ( int mode ) const

inline

Returns: true if this dialog supports switching to mode. mode is one of Kexi::ViewMode enum elements. The flags are used e.g. for testing by KexiMainWindow, if actions of switching to given view mode is available. This member is intialised in KexiPart that creates this KexiDialogBase object.

Definition at line 152 of file kexidialogbase.h.

◆ switchToViewMode() [1/2]

tristate KexiDialogBase::switchToViewMode ( int newViewMode )

Switches this dialog to newViewMode. viewMode is one of Kexi::ViewMode enum elements.

Returns: true for successful switching True is returned also if user has cancelled switching (rarely, but for any reason) - cancelled is returned.

Definition at line 403 of file kexidialogbase.cpp.

◆ switchToViewMode() [2/2]

tristate KexiDialogBase::switchToViewMode	(	int	newViewMode,
		TQMap< TQString, TQString > *	staticObjectArgs,
		bool &	proposeOpeningInTextViewModeBecauseOfProblems
	)

protected

Used by Part::openInstance(), like switchToViewMode( int newViewMode ), but passed staticObjectArgs. Only used for parts of class KexiPart::StaticPart.

Definition at line 288 of file kexidialogbase.cpp.

◆ tempData()

KexiDialogTempData * KexiDialogBase::tempData ( ) const

inline

Reimpelmented: "*" is added if for 'dirty' dialog's data.

Used by KexiViewBase subclasses.

Returns: temporary data shared between views

Definition at line 204 of file kexidialogbase.h.

◆ updateCaption

void KexiDialogBase::updateCaption ( )

slot

Definition at line 476 of file kexidialogbase.cpp.

◆ viewForMode()

KexiViewBase * KexiDialogBase::viewForMode ( int mode ) const

Returns: a view for a given mode or 0 if there's no such mode available (or opened). This does not open mode if it's not opened.

Definition at line 87 of file kexidialogbase.cpp.

◆ viewThatRecentlySetDirtyFlag()

KexiViewBase * KexiDialogBase::viewThatRecentlySetDirtyFlag ( ) const

inline

Returns: a pointer to view that has recently set dirty flag. This value is cleared when dirty flag is set to false (i.e. upon saving changes).

Definition at line 185 of file kexidialogbase.h.

Friends And Related Symbol Documentation

◆ KexiInternalPart

friend class KexiInternalPart

friend

Definition at line 348 of file kexidialogbase.h.

◆ KexiMainWindow

friend class KexiMainWindow

friend

Definition at line 345 of file kexidialogbase.h.

◆ KexiPart::Part

friend class KexiPart::Part

friend

Definition at line 347 of file kexidialogbase.h.

◆ KexiViewBase

friend class KexiViewBase

friend

Definition at line 349 of file kexidialogbase.h.

Member Data Documentation

◆ m_currentViewMode

int KexiDialogBase::m_currentViewMode

protected

Definition at line 283 of file kexidialogbase.h.

◆ m_openedViewModes

int KexiDialogBase::m_openedViewModes

protected

Definition at line 282 of file kexidialogbase.h.

◆ m_supportedViewModes

int KexiDialogBase::m_supportedViewModes

protected

Definition at line 281 of file kexidialogbase.h.

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

kexi

Public Slots

Signals

Public Member Functions

Protected Slots

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KexiDialogBase()

◆ ~KexiDialogBase()

Member Function Documentation

◆ activate()

◆ addView() [1/2]

◆ addView() [2/2]

◆ attachToGUIClient()

◆ closeEvent()

◆ closing

◆ commonGUIClient()

◆ currentViewMode()

◆ deactivate()

◆ detachFromGUIClient()

◆ dirty()

◆ dirtyChanged [1/2]

◆ dirtyChanged() [2/2]

◆ eventFilter()

◆ guiClient()

◆ id()

◆ isDesignModePreloadedForTextModeHackUsed()

◆ isRegistered()

◆ itemIcon()

◆ mainWin()

◆ minimumSizeHint()

◆ neverSaved()

◆ part()

◆ partItem()

◆ propertySet()

◆ registerDialog()

◆ removeView()

◆ schemaData()

◆ selectedView()

◆ sendAttachedStateToCurrentView

◆ sendDetachedStateToCurrentView

◆ setContextHelp()

◆ setDirty

◆ setFocus

◆ setId()

◆ sizeHint()

◆ stack()

◆ storeData

◆ storeNewData

◆ supportsViewMode()

◆ switchToViewMode() [1/2]

◆ switchToViewMode() [2/2]

◆ tempData()

◆ updateCaption

◆ viewForMode()

◆ viewThatRecentlySetDirtyFlag()

Friends And Related Symbol Documentation

◆ KexiInternalPart

◆ KexiMainWindow

◆ KexiPart::Part

◆ KexiViewBase

Member Data Documentation

◆ m_currentViewMode

◆ m_openedViewModes

◆ m_supportedViewModes

kexi

kexi