#include <kexiviewbase.h>

Inheritance diagram for KexiViewBase:

Public Slots
virtual void	setFocus ()
virtual void	propertySetSwitched ()
void	setDirty (bool set)
void	setDirty ()

Signals
void	closing (bool &cancel)
void	focus (bool in)

Public Member Functions
	KexiViewBase (KexiMainWindow mainWin, TQWidget parent, const char *name=0)
KexiMainWindow *	mainWin () const
KexiDialogBase *	parentDialog () const
KexiPart::Part *	part () const
virtual TQSize	preferredSizeHint (const TQSize &otherSize)
virtual bool	eventFilter (TQObject o, TQEvent e)
void	addChildView (KexiViewBase *childView)
virtual bool	dirty () const
int	viewMode () const
virtual TDEAction *	sharedAction (const char *action_name)
virtual void	setAvailable (const char *action_name, bool set)
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)

Protected Member Functions
virtual tristate	beforeSwitchTo (int mode, bool &dontStore)
virtual tristate	afterSwitchFrom (int mode)
virtual void	closeEvent (TQCloseEvent *e)
virtual KoProperty::Set *	propertySet ()
void	propertySetReloaded (bool preservePrevSelection=false, const TQCString &propertyToSelect=TQCString())
virtual KexiDB::SchemaData *	storeNewData (const KexiDB::SchemaData &sdata, bool &cancel)
bool	loadDataBlock (TQString &dataString, const TQString &dataID=TQString(), bool canBeEmpty=false)
virtual tristate	storeData (bool dontAsk=false)
bool	storeDataBlock (const TQString &dataString, const TQString &dataID=TQString())
bool	removeDataBlock (const TQString &dataID=TQString())
void	setViewWidget (TQWidget *w, bool focusProxy=false)
virtual void	updateActions (bool activated)
virtual void	setFocusInternal ()
virtual void	parentDialogDetached ()
virtual void	parentDialogAttached ()
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)
TQObject *	receiver () const
void	addActionProxyChild (KexiActionProxy *child)
void	takeActionProxyChild (KexiActionProxy *child)

Protected Attributes
TQString	m_defaultIconName
KexiMainWindow *	m_mainWin
KexiDialogBase *	m_dialog
TQWidget *	m_viewWidget
KexiViewBase *	m_parentView
TQGuardedPtr< TQWidget >	m_lastFocusedChildBeforeFocusOut
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

Friends
class	KexiDialogBase

Additional Inherited Members
Public Attributes inherited from KexiActionProxy
KexiActionProxy *	m_focusedChild

Detailed Description

Base class for single view embeddable of in KexiDialogBase.

This class automatically works as a proxy for shared (application-wide) actions. KexiViewBase has 'dirty' flag to indicate that view's data has changed. This flag's state is reused by KexiDialogBase object that contain the view. KexiViewBase objects can be also nested, using addChildView(): any actions and 'dirty' flag are transmited to parent view in this case.

KexiViewBase objects are usually allocated within KexiDialogBase objects by implementing KexiPart::createView() method. See query or table part code for examples.

KexiViewBase object can be also allocated without attaching it KexiDialogBase, especially withinn dock window. see KexiMainWindowImpl::initNavigator() to see example how KexiBrowser does this.

Definition at line 52 of file kexiviewbase.h.

Constructor & Destructor Documentation

◆ KexiViewBase()

KexiViewBase::KexiViewBase	(	KexiMainWindow *	mainWin,
		TQWidget *	parent,
		const char *	name = 0 )

Definition at line 33 of file kexiviewbase.cpp.

◆ ~KexiViewBase()

KexiViewBase::~KexiViewBase ( )

virtual

Definition at line 56 of file kexiviewbase.cpp.

Member Function Documentation

◆ addChildView()

void KexiViewBase::addChildView ( KexiViewBase * childView )

Definition at line 264 of file kexiviewbase.cpp.

◆ afterSwitchFrom()

tristate KexiViewBase::afterSwitchFrom ( int mode )

protectedvirtual

called by KexiDialogBase::switchToViewMode() right after dialog is switched to new mode By default does nothing. Reimplement this if you need to do something after switching to this view.

Returns: true if you accept or false if a error occupied and view shouldn't change If there is no error but switching should be just cancelled (probably after showing some info messages), you need to return cancelled.

Reimplemented in KexiFormView, KexiMacroView, KexiQueryDesignerGuiEditor, KexiQueryDesignerSQLView, KexiReportView, and KexiTableDesignerView.

Definition at line 70 of file kexiviewbase.cpp.

◆ beforeSwitchTo()

tristate KexiViewBase::beforeSwitchTo	(	int	mode,
		bool &	dontStore )

protectedvirtual

called by KexiDialogBase::switchToViewMode() right before dialog is switched to new mode By default does nothing. Reimplement this if you need to do something before switching to this view.

Returns: true if you accept or false if a error occupied and view shouldn't change If there is no error but switching should be just cancelled (probably after showing some info messages), you need to return cancelled. Set dontStore to true (it's false by default) if you want to avoid data storing by storeData() or storeNewData().

Reimplemented in KexiFormView, KexiMacroView, KexiQueryDesignerGuiEditor, KexiQueryDesignerSQLView, KexiReportView, and KexiTableDesignerView.

Definition at line 65 of file kexiviewbase.cpp.

◆ closeEvent()

void KexiViewBase::closeEvent ( TQCloseEvent * e )

protectedvirtual

Definition at line 88 of file kexiviewbase.cpp.

◆ closing

void KexiViewBase::closing ( bool & cancel )

signal

emitted when the view is about to close

◆ dirty()

virtual bool KexiViewBase::dirty ( ) const

inlinevirtual

True if contents (data) of the view 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). "Dirty" flag is reused by KexiDialogBase::dirty(). Default implementation just uses internal m_dirty flag, that is false by default. Reimplement this if you e.g. want reuse other "dirty" flag from internal structures that may be changed.

Definition at line 91 of file kexiviewbase.h.

◆ eventFilter()

bool KexiViewBase::eventFilter	(	TQObject *	o,
		TQEvent *	e )

virtual

Definition at line 213 of file kexiviewbase.cpp.

◆ loadDataBlock()

bool KexiViewBase::loadDataBlock	(	TQString &	dataString,
		const TQString &	dataID = TQString(),
		bool	canBeEmpty = false )

protected

Loads large string data dataString block (e.g. xml form's representation), indexed with optional dataID, from the database backend. If canBeEmpty is true and there is no data block for dataID, true is returned and dataString is set to null string. The default is false.

Returns: true on success

See also: storeDataBlock().

Definition at line 178 of file kexiviewbase.cpp.

◆ mainWin()

KexiMainWindow * KexiViewBase::mainWin ( ) const

inline

Returns: kexi main window that contain this view

Definition at line 62 of file kexiviewbase.h.

◆ parentDialog()

KexiDialogBase * KexiViewBase::parentDialog ( ) const

inline

Returns: parent KexiDialogBase that contains this view, or 0 if no dialog contain this view

Definition at line 65 of file kexiviewbase.h.

◆ parentDialogAttached()

virtual void KexiViewBase::parentDialogAttached ( )

inlineprotectedvirtual

Allows to react on parent dialog's attaching (only for KMDI's ChildFrame mode)

it is called by KexiDialogBase::youAreAttached(). Default implementation does nothing. Implement it if you want to perform some appropriate actions.

Definition at line 246 of file kexiviewbase.h.

◆ parentDialogDetached()

virtual void KexiViewBase::parentDialogDetached ( )

inlineprotectedvirtual

Allows to react on parent dialog's detaching (only for KMDI's ChildFrame mode)

it is called by KexiDialogBase::youAreDetached(). Default implementation does nothing. Implement it if you want to perform some appropriate actions.

Definition at line 240 of file kexiviewbase.h.

◆ part()

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

Added for convenience.

Returns: KexiPart object that was used to create this view (with a dialog) or 0 if this view is not created using KexiPart.

See also: parentDialog()

Definition at line 60 of file kexiviewbase.cpp.

◆ preferredSizeHint()

TQSize KexiViewBase::preferredSizeHint ( const TQSize & otherSize )

virtual

Returns: preferred size hint, that can be used to resize the view. It is computed using maximum of (a) otherSize and (b) current KMDI dock area's size, so the view won't exceed this maximum size. The method is used e.g. in KexiDialogBase::sizeHint(). If you reimplement this method, do not forget to return value of yoursize.boundedTo( KexiViewBase::preferredSizeHint(otherSize) ).

Reimplemented in KexiFormView, and KexiReportView.

Definition at line 75 of file kexiviewbase.cpp.

◆ propertySet()

KoProperty::Set * KexiViewBase::propertySet ( )

protectedvirtual

Returns: a property set for this view. For reimplementation. By default returns NULL.

Reimplemented in KexiFormView, KexiMacroDesignView, KexiQueryDesignerGuiEditor, KexiReportView, KexiScriptDesignView, and KexiTableDesignerView.

Definition at line 99 of file kexiviewbase.cpp.

◆ propertySetReloaded()

void KexiViewBase::propertySetReloaded	(	bool	preservePrevSelection = false,
		const TQCString &	propertyToSelect = TQCString() )

protected

Call this in your view's implementation whenever current property set is changed that few properties are now visible and/or few other are invisible, so property editor operating on this property set should be completely reloaded. If preservePrevSelection is true and there was a property set assigned before call, previously selected item will be preselected in the editor (if found).

Definition at line 110 of file kexiviewbase.cpp.

◆ propertySetSwitched

void KexiViewBase::propertySetSwitched ( )

virtualslot

Call this in your view's implementation whenever current property set (returned by propertySet()) is switched to other, so property editor contents need to be completely replaced.

Reimplemented in KexiTableDesignerView.

Definition at line 104 of file kexiviewbase.cpp.

◆ removeDataBlock()

bool KexiViewBase::removeDataBlock ( const TQString & dataID = TQString() )

protected

Removes (potentially large) string data (e.g. xml form's representation), pointed by optional dataID, from the database backend.

Returns: true on success. Does not fail if the block doe not exists. Note that if dataID is not specified, all data blocks for this view will be removed.

See also: storeDataBlock().

Definition at line 206 of file kexiviewbase.cpp.

◆ setAvailable()

void KexiViewBase::setAvailable	(	const char *	action_name,
		bool	set )

virtual

Enables or disables shared action declared in Kexi Part (part()). If there's no such action, global shared action is enabled or disabled (if exists).

Reimplemented from KexiActionProxy.

Definition at line 305 of file kexiviewbase.cpp.

◆ setDirty [1/2]

void KexiViewBase::setDirty ( )

inlineslot

Equal to setDirty(true).

Definition at line 122 of file kexiviewbase.h.

◆ setDirty [2/2]

void KexiViewBase::setDirty ( bool set )

slot

Sets dirty flag on or off. It the flag changes, dirty(bool) signal is emitted by parent dialog (KexiDialog), to inform the world about that. If this view has a parent view, setDirty() is called also on parent view. Always use this function to update 'dirty' flag information.

Definition at line 116 of file kexiviewbase.cpp.

◆ setFocus

void KexiViewBase::setFocus ( )

virtualslot

Definition at line 275 of file kexiviewbase.cpp.

◆ setFocusInternal()

virtual void KexiViewBase::setFocusInternal ( )

inlineprotectedvirtual

Definition at line 234 of file kexiviewbase.h.

◆ setViewWidget()

void KexiViewBase::setViewWidget	(	TQWidget *	w,
		bool	focusProxy = false )

protected

Definition at line 249 of file kexiviewbase.cpp.

◆ sharedAction()

TDEAction * KexiViewBase::sharedAction ( const char * action_name )

virtual

Reimpelmented from KexiActionProxy.

Returns: shared action with name action_name for this view. If there's no such action declared in Kexi Part (part()), global shared action is returned (if exists).

Reimplemented from KexiActionProxy.

Definition at line 292 of file kexiviewbase.cpp.

◆ storeData()

tristate KexiViewBase::storeData ( bool dontAsk = false )

protectedvirtual

Tells this view to store data changes on the backend. Called by KexiDialogBase::storeData(). Default implementation:

makes a deep copy of sdata
stores object schema data sdata in 'kexi__objects' internal table using Connection::storeObjectSchemaData(). If dontAsk is true, no question dialog will be shown to the user. The default is false.

Reimpelment this for your needs. Should return true on success or cancelled when the task should be cancelled.

See also: storeNewData()

Reimplemented in KexiFormView, KexiMacroTextView, KexiMacroView, KexiQueryDesignerGuiEditor, KexiQueryDesignerSQLView, KexiReportView, KexiScriptDesignView, and KexiTableDesignerView.

Definition at line 164 of file kexiviewbase.cpp.

◆ storeDataBlock()

bool KexiViewBase::storeDataBlock	(	const TQString &	dataString,
		const TQString &	dataID = TQString() )

protected

Stores (potentially large) string data dataString, block (e.g. xml form's representation), at the database backend. Block will be stored in "kexi__objectdata" table pointed by this object's id and an optional dataID identifier.

If dialog's id is not available (KexiDialogBase::id()), then ID that was just created in storeNewData() is used (see description of m_newlyAssignedID member). If there is already such record in the table, it's simply overwritten.

Returns: true on success

Definition at line 190 of file kexiviewbase.cpp.

◆ storeNewData()

KexiDB::SchemaData * KexiViewBase::storeNewData	(	const KexiDB::SchemaData &	sdata,
		bool &	cancel )

protectedvirtual

Tells this dialog to create and store data of the new object pointed by sdata on the backend. Called by KexiDialogBase::storeNewData(). Default implementation:

makes a deep copy of sdata
stores object schema data sdata in 'kexi__objects' internal table using Connection::storeObjectSchemaData(). Reimpelment this for your needs. Requirements:
deep copy of sdata should be made
schema data should be created at the backend (by calling KexiViewBase::storeNewData(const KexiDB::SchemaData& sdata)), or using Connection::storeObjectSchemaData() or more specialized method. For example, KexiAlterTableDialog uses Connection::createTable(TableSchema) for this (tableschema is SchemaData subclass) to store more information than just a schem adata. You should use such subclasses if needed. Should return newly created schema data object on success. In this case, do not store schema object yourself (make deep copy if needed).

Reimplemented in KexiFormView, KexiMacroView, KexiQueryDesignerGuiEditor, KexiQueryDesignerSQLView, KexiReportView, KexiScriptDesignView, and KexiTableDesignerView.

Definition at line 149 of file kexiviewbase.cpp.

◆ updateActions()

void KexiViewBase::updateActions ( bool activated )

protectedvirtual

Updates actions (e.g. availability). Reimplement it, if needed (you must call superclass impelmentation at the end!). This implementation does nothing for this view but calls updateActions() for every child-view of this view. called by KexiDialogBase on dialog's activation (activated is true) or deactivation.

Reimplemented in KexiDataAwareView, KexiEditor, KexiQueryDesignerSQLView, and KexiTableDesignerView.

Definition at line 318 of file kexiviewbase.cpp.

◆ viewMode()

int KexiViewBase::viewMode ( ) const

inline

Returns: the view mode for this view.

Definition at line 94 of file kexiviewbase.h.

◆ KexiDialogBase

friend class KexiDialogBase

friend

Definition at line 277 of file kexiviewbase.h.

Member Data Documentation

◆ m_defaultIconName

TQString KexiViewBase::m_defaultIconName

protected

Definition at line 248 of file kexiviewbase.h.

◆ m_dialog

KexiDialogBase* KexiViewBase::m_dialog

protected

Definition at line 252 of file kexiviewbase.h.

◆ m_lastFocusedChildBeforeFocusOut

TQGuardedPtr<TQWidget> KexiViewBase::m_lastFocusedChildBeforeFocusOut

protected

Definition at line 258 of file kexiviewbase.h.

◆ m_mainWin

KexiMainWindow* KexiViewBase::m_mainWin

protected

Definition at line 250 of file kexiviewbase.h.

◆ m_parentView

KexiViewBase* KexiViewBase::m_parentView

protected

Definition at line 256 of file kexiviewbase.h.

◆ m_viewWidget

TQWidget* KexiViewBase::m_viewWidget

protected

Definition at line 254 of file kexiviewbase.h.

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

kexi

Public Slots

Signals

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KexiViewBase()

◆ ~KexiViewBase()

Member Function Documentation

◆ addChildView()

◆ afterSwitchFrom()

◆ beforeSwitchTo()

◆ closeEvent()

◆ closing

◆ dirty()

◆ eventFilter()

◆ loadDataBlock()

◆ mainWin()

◆ parentDialog()

◆ parentDialogAttached()

◆ parentDialogDetached()

◆ part()

◆ preferredSizeHint()

◆ propertySet()

◆ propertySetReloaded()

◆ propertySetSwitched

◆ removeDataBlock()

◆ setAvailable()

◆ setDirty [1/2]

◆ setDirty [2/2]

◆ setFocus

◆ setFocusInternal()

◆ setViewWidget()

◆ sharedAction()

◆ storeData()

◆ storeDataBlock()

◆ storeNewData()

◆ updateActions()

◆ viewMode()

Friends And Related Symbol Documentation

◆ KexiDialogBase

Member Data Documentation

◆ m_defaultIconName

◆ m_dialog

◆ m_lastFocusedChildBeforeFocusOut

◆ m_mainWin

◆ m_parentView

◆ m_viewWidget

kexi

kexi