Kexi API Documentation (2.0 alpha)

KexiDBTextEdit Class Reference

#include <kexidbtextedit.h>

Inheritance diagram for KexiDBTextEdit:

KTextEdit KexiDBTextWidgetInterface KexiFormDataItemInterface KexiDataItemInterface List of all members.

Detailed Description

Multiline edit widget for Kexi forms.

Definition at line 30 of file kexidbtextedit.h.

Public Slots

void setDataSource (const QString &ds)
 Sets the name of the data source for this widget.
void setDataSourceMimeType (const QCString &ds)
virtual void setReadOnly (bool readOnly)
virtual void setText (const QString &text, const QString &context)
virtual void undo ()
virtual void moveCursorToEnd ()
 Implemented for KexiDataItemInterface.
virtual void moveCursorToStart ()
 Implemented for KexiDataItemInterface.
virtual void selectAll ()
 Implemented for KexiDataItemInterface.

Public Member Functions

 KexiDBTextEdit (QWidget *parent, const char *name=0)
virtual ~KexiDBTextEdit ()
QString dataSource () const
QCString dataSourceMimeType () const
virtual QVariant value ()
virtual void setInvalidState (const QString &displayText)
virtual bool valueIsNull ()
virtual bool valueIsEmpty ()
virtual bool isReadOnly () const
virtual QWidgetwidget ()
virtual bool cursorAtStart ()
virtual bool cursorAtEnd ()
virtual void clear ()
 clears item's data, so the data will contain NULL data
virtual void setColumnInfo (KexiDB::QueryColumnInfo *cinfo)
virtual void setDisplayDefaultValue (QWidget *widget, bool displayDefaultValue)

Protected Slots

void slotTextChanged ()

Protected Member Functions

virtual void paintEvent (QPaintEvent *)
virtual void setValueInternal (const QVariant &add, bool removeOld)
QPopupMenu * createPopupMenu (const QPoint &pos)

Protected Attributes

KexiDBWidgetContextMenuExtender m_menuExtender
 Used for extending context menu.
bool m_slotTextChanged_enabled: 1
 Used to disable slotTextChanged().

Properties

QString dataSource
QCString dataSourceMimeType


Constructor & Destructor Documentation

KexiDBTextEdit::KexiDBTextEdit QWidget parent,
const char *  name = 0
 

Definition at line 29 of file kexidbtextedit.cpp.

References slotTextChanged().

KexiDBTextEdit::~KexiDBTextEdit  )  [virtual]
 

Definition at line 39 of file kexidbtextedit.cpp.


Member Function Documentation

void KexiDBTextEdit::clear  )  [virtual]
 

clears item's data, so the data will contain NULL data

Implements KexiDataItemInterface.

Definition at line 128 of file kexidbtextedit.cpp.

References setText().

QPopupMenu * KexiDBTextEdit::createPopupMenu const QPoint &  pos  )  [protected]
 

Definition at line 148 of file kexidbtextedit.cpp.

References KexiDBWidgetContextMenuExtender::createTitle(), and m_menuExtender.

bool KexiDBTextEdit::cursorAtEnd  )  [virtual]
 

Returns:
true if the item widget's cursor (whatever that means, eg. line edit cursor) is at the end of editor's contents. This can inform table/form view that after pressing "right arrow" key should stop editing and move to a field on the right hand.

Implements KexiDataItemInterface.

Definition at line 121 of file kexidbtextedit.cpp.

bool KexiDBTextEdit::cursorAtStart  )  [virtual]
 

Returns:
true if the item widget's cursor (whatever that means, eg. line edit cursor) is at the beginning of editor's contents. This can inform table/form view that after pressing "left arrow" key should stop editing and move to a field on the left hand.

Implements KexiDataItemInterface.

Definition at line 114 of file kexidbtextedit.cpp.

QString KexiDBTextEdit::dataSource  )  const [inline]
 

Returns:
the name of the data source for this widget. Data source usually means here a table or query, a field name or an expression.

Reimplemented from KexiFormDataItemInterface.

Definition at line 43 of file kexidbtextedit.h.

References KexiFormDataItemInterface::dataSource().

QCString KexiDBTextEdit::dataSourceMimeType  )  const [inline]
 

Returns:
the mime type of the data source for this widget. Data source mime type means here types like "kexi/table" or "kexi/query" in.the data source is set to object (as within form or subform) or is empty if the data source is set to table field or query column.

Reimplemented from KexiFormDataItemInterface.

Definition at line 44 of file kexidbtextedit.h.

References KexiFormDataItemInterface::dataSourceMimeType().

bool KexiDBTextEdit::isReadOnly  )  const [virtual]
 

Returns:
'readOnly' flag for this widget.

Reimplemented from KexiDataItemInterface.

Definition at line 88 of file kexidbtextedit.cpp.

void KexiDBTextEdit::moveCursorToEnd  )  [virtual, slot]
 

Implemented for KexiDataItemInterface.

Reimplemented from KexiDataItemInterface.

Definition at line 181 of file kexidbtextedit.cpp.

void KexiDBTextEdit::moveCursorToStart  )  [virtual, slot]
 

Implemented for KexiDataItemInterface.

Reimplemented from KexiDataItemInterface.

Definition at line 186 of file kexidbtextedit.cpp.

void KexiDBTextEdit::paintEvent QPaintEvent *   )  [protected, virtual]
 

Definition at line 141 of file kexidbtextedit.cpp.

References KexiDBTextWidgetInterface::paint().

void KexiDBTextEdit::selectAll  )  [virtual, slot]
 

Implemented for KexiDataItemInterface.

Reimplemented from KexiDataItemInterface.

Definition at line 191 of file kexidbtextedit.cpp.

void KexiDBTextEdit::setColumnInfo KexiDB::QueryColumnInfo cinfo  )  [virtual]
 

Used internally to set database column information. Reimplement if you need to do additional actions, e.g. set data validator based on field type. Don't forget about calling superclass implementation.

Reimplemented from KexiFormDataItemInterface.

Definition at line 133 of file kexidbtextedit.cpp.

References KexiFormDataItemInterface::m_columnInfo, KexiDBTextWidgetInterface::setColumnInfo(), and KexiFormDataItemInterface::setColumnInfo().

void KexiDBTextEdit::setDataSource const QString ds  )  [inline, slot]
 

Sets the name of the data source for this widget.

Data source usually means here a table or query or field name name.

Reimplemented from KexiFormDataItemInterface.

Definition at line 77 of file kexidbtextedit.h.

References KexiFormDataItemInterface::setDataSource().

void KexiDBTextEdit::setDataSourceMimeType const QCString &  ds  )  [inline, slot]
 

Sets the mime type of the data source for this widget. Data source usually means here a "kexi/table" or "kexi/query".

See also:
dataSourceMimeType()

Reimplemented from KexiFormDataItemInterface.

Definition at line 78 of file kexidbtextedit.h.

References KexiFormDataItemInterface::setDataSourceMimeType().

void KexiDBTextEdit::setDisplayDefaultValue QWidget widget,
bool  displayDefaultValue
[virtual]
 

If displayDefaultValue is true, the value set by KexiDataItemInterface::setValue() is displayed in a special way. Used by KexiFormDataProvider::fillDataItems(). widget is equal to 'this'. Reimplemented after KexiFormDataItemInterface.

Reimplemented from KexiFormDataItemInterface.

Definition at line 160 of file kexidbtextedit.cpp.

References KexiDisplayUtils::DisplayParameters::font, KexiFormDataItemInterface::m_displayParametersForDefaultValue, KexiFormDataItemInterface::m_displayParametersForEnteredValue, KexiFormDataItemInterface::setDisplayDefaultValue(), and KexiDisplayUtils::DisplayParameters::textColor.

void KexiDBTextEdit::setInvalidState const QString displayText  )  [virtual]
 

Todo:
move this to KexiDataItemInterface::setInvalidStateInternal() ?

Implements KexiFormDataItemInterface.

Definition at line 43 of file kexidbtextedit.cpp.

References setReadOnly().

void KexiDBTextEdit::setReadOnly bool  readOnly  )  [virtual, slot]
 

Changes 'read only' flag, for this widget. Typically this flag can be passed to a widget itself, e.g. KLineEdit::setReadOnly(bool).

Implements KexiFormDataItemInterface.

Definition at line 93 of file kexidbtextedit.cpp.

References lighterGrayBackgroundColor().

Referenced by setInvalidState().

void KexiDBTextEdit::setText const QString text,
const QString context
[virtual, slot]
 

Definition at line 104 of file kexidbtextedit.cpp.

Referenced by clear().

void KexiDBTextEdit::setValueInternal const QVariant &  add,
bool  removeOld
[protected, virtual]
 

Todo:
temporary solution for booleans!

Implements KexiDataItemInterface.

Definition at line 52 of file kexidbtextedit.cpp.

References KexiDB::Field::Boolean, KexiDB::QueryColumnInfo::field, KexiFormDataItemInterface::m_columnInfo, and KexiDataItemInterface::m_origValue.

void KexiDBTextEdit::slotTextChanged  )  [protected, slot]
 

Definition at line 71 of file kexidbtextedit.cpp.

References m_slotTextChanged_enabled, and KexiDataItemInterface::signalValueChanged().

Referenced by KexiDBTextEdit().

void KexiDBTextEdit::undo  )  [virtual, slot]
 

Todo:
enable "real" undo internally so user can use ctrl+z while editing

Definition at line 155 of file kexidbtextedit.cpp.

References KexiFormDataItemInterface::cancelEditor().

QVariant KexiDBTextEdit::value  )  [virtual]
 

Returns:
value currently represented by this item.

Implements KexiDataItemInterface.

Definition at line 66 of file kexidbtextedit.cpp.

bool KexiDBTextEdit::valueIsEmpty  )  [virtual]
 

Returns:
true if editor's value is empty (not necessary null). Only few data types can accept "EMPTY" property (use KexiDB::Field::hasEmptyProperty() to check this). Used for checking if a given constraint within table or form is met.

Implements KexiDataItemInterface.

Definition at line 83 of file kexidbtextedit.cpp.

bool KexiDBTextEdit::valueIsNull  )  [virtual]
 

Returns:
true if editor's value is null (not empty) Used for checking if a given constraint within table of form is met.

Implements KexiDataItemInterface.

Definition at line 78 of file kexidbtextedit.cpp.

QWidget * KexiDBTextEdit::widget  )  [virtual]
 

Returns:
the view widget of this item, e.g. line edit widget.

Reimplemented from KexiFormDataItemInterface.

Definition at line 109 of file kexidbtextedit.cpp.


Member Data Documentation

KexiDBWidgetContextMenuExtender KexiDBTextEdit::m_menuExtender [protected]
 

Used for extending context menu.

Definition at line 104 of file kexidbtextedit.h.

Referenced by createPopupMenu().

bool KexiDBTextEdit::m_slotTextChanged_enabled [protected]
 

Used to disable slotTextChanged().

Definition at line 107 of file kexidbtextedit.h.

Referenced by slotTextChanged().


Property Documentation

QString KexiDBTextEdit::dataSource [read, write]
 

Definition at line 36 of file kexidbtextedit.h.

QCString KexiDBTextEdit::dataSourceMimeType [read, write]
 

Definition at line 37 of file kexidbtextedit.h.


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