#include <kexidataawareobjectiface.h>
|
| enum | DeletionPolicy { NoDelete = 0
, AskDelete = 1
, ImmediateDelete = 2
, SignalDelete = 3
} |
| |
|
| void | setData (KexiTableViewData *data, bool owner=true) |
| |
| KexiTableViewData * | data () const |
| |
| int | currentColumn () const |
| |
| int | currentRow () const |
| |
| virtual int | lastVisibleRow () const =0 |
| |
| KexiTableItem * | selectedItem () const |
| |
| int | rows () const |
| |
| virtual int | columns () const |
| |
| int | dataColumns () const |
| |
| virtual bool | isReadOnly () const |
| |
| void | setReadOnly (bool set) |
| |
| bool | isSortingEnabled () const |
| |
| virtual void | setSorting (int col, bool ascending=true) |
| |
| virtual void | setSortingEnabled (bool set) |
| |
| int | dataSortedColumn () const |
| |
| int | dataSortingOrder () const |
| |
| virtual bool | sort () |
| |
| void | sortAscending () |
| |
| void | sortDescending () |
| |
| virtual bool | isInsertingEnabled () const |
| |
| void | setInsertingEnabled (bool set) |
| |
| bool | isDeleteEnabled () const |
| |
| bool | isEmptyRowInsertingEnabled () const |
| |
| void | setEmptyRowInsertingEnabled (bool set) |
| |
| virtual void | setFilteringEnabled (bool set) |
| |
| bool | isFilteringEnabled () const |
| |
| virtual void | setSpreadSheetMode () |
| |
| bool | spreadSheetMode () const |
| |
| bool | rowEditing () const |
| |
| DeletionPolicy | deletionPolicy () const |
| |
| virtual void | setDeletionPolicy (DeletionPolicy policy) |
| |
| virtual void | deleteCurrentRow () |
| |
| virtual KexiTableItem * | insertEmptyRow (int row=-1) |
| |
| virtual bool | beforeDeleteItem (KexiTableItem *item) |
| |
| bool | deleteItem (KexiTableItem *item) |
| |
| void | insertItem (KexiTableItem *newItem, int row=-1) |
| |
| tristate | deleteAllRows (bool ask=false, bool repaint=true) |
| |
| virtual int | rowsPerPage () const =0 |
| |
| virtual void | selectRow (int row) |
| |
| virtual void | selectNextRow () |
| |
| virtual void | selectPrevRow () |
| |
| virtual void | selectNextPage () |
| |
| virtual void | selectPrevPage () |
| |
| virtual void | selectFirstRow () |
| |
| virtual void | selectLastRow () |
| |
| virtual void | addNewRecordRequested () |
| |
| virtual void | clearSelection () |
| |
| virtual void | setCursorPosition (int row, int col=-1, bool forceSet=false) |
| |
| virtual void | ensureCellVisible (int row, int col)=0 |
| |
| virtual void | setAcceptsRowEditAfterCellAccepting (bool set) |
| |
| bool | acceptsRowEditAfterCellAccepting () const |
| |
| bool | dropsAtRowEnabled () const |
| |
| virtual void | setDropsAtRowEnabled (bool set) |
| |
| KexiDataItemInterface * | editor () const |
| |
| virtual bool | cancelRowEdit () |
| |
| virtual bool | acceptRowEdit () |
| |
| virtual void | removeEditor () |
| |
| virtual bool | cancelEditor () |
| |
| virtual bool | acceptEditor () |
| |
| virtual void | createEditor (int row, int col, const TQString &addText=TQString(), bool removeOld=false)=0 |
| |
| virtual void | startEditCurrentCell (const TQString &setText=TQString()) |
| |
| virtual void | deleteAndStartEditCurrentCell () |
| |
| KexiTableItem * | itemAt (int row) const |
| |
| virtual KexiTableViewColumn * | column (int col) |
| |
| virtual int | fieldNumberForColumn (int col) |
| |
| bool | hasDefaultValueAt (const KexiTableViewColumn &tvcol) |
| |
| const TQVariant * | bufferedValueAt (int col, bool useDefaultValueIfPossible=true) |
| |
| int | columnType (int col) |
| |
| TQVariant | columnDefaultValue (int col) const |
| |
| virtual bool | columnEditable (int col) |
| |
| virtual void | updateCurrentCell ()=0 |
| |
| KexiRecordMarker * | verticalHeader () const |
| |
| virtual void | itemChanged (KexiTableItem *, int row, int col)=0 |
| |
|
virtual void | itemChanged (KexiTableItem *, int row, int col, TQVariant oldValue)=0 |
| |
|
virtual void | itemDeleteRequest (KexiTableItem *, int row, int col)=0 |
| |
|
virtual void | currentItemDeleteRequest ()=0 |
| |
| virtual void | newItemAppendedForAfterDeletingInSpreadSheetMode ()=0 |
| |
| virtual void | dataRefreshed ()=0 |
| |
|
virtual void | dataSet (KexiTableViewData *data)=0 |
| |
| TDEPopupMenu * | contextMenu () const |
| |
| bool | contextMenuEnabled () const |
| |
| void | setContextMenuEnabled (bool set) |
| |
| bool | scrollbarToolTipsEnabled () const |
| |
| void | setScrollbarToolTipsEnabled (bool set) |
| |
| void | startEditOrToggleValue () |
| |
| bool | newRowEditing () const |
| |
| virtual void | boolToggled () |
| |
|
virtual void | connectCellSelectedSignal (const TQObject *receiver, const char *intIntMember)=0 |
| |
|
virtual void | connectRowEditStartedSignal (const TQObject *receiver, const char *intMember)=0 |
| |
|
virtual void | connectRowEditTerminatedSignal (const TQObject *receiver, const char *voidMember)=0 |
| |
|
virtual void | connectReloadActionsSignal (const TQObject *receiver, const char *voidMember)=0 |
| |
|
virtual void | connectDataSetSignal (const TQObject *receiver, const char *kexiTableViewDataMember)=0 |
| |
|
virtual void | connectToReloadDataSlot (const TQObject *sender, const char *voidSignal)=0 |
| |
| virtual void | slotDataDestroying () |
| |
| virtual void | copySelection ()=0 |
| |
| virtual void | cutSelection ()=0 |
| |
| virtual void | paste ()=0 |
| |
| virtual tristate | find (const TQVariant &valueToFind, const KexiSearchAndReplaceViewInterface::Options &options, bool next) |
| |
| virtual tristate | findNextAndReplace (const TQVariant &valueToFind, const TQVariant &replacement, const KexiSearchAndReplaceViewInterface::Options &options, bool replaceAll) |
| |
| virtual TQScrollBar * | verticalScrollBar () const =0 |
| |
| virtual bool | handleKeyPress (TQKeyEvent *e, int &curRow, int &curCol, bool fullRowSelection, bool *moveToFirstField=0, bool *moveToLastField=0) |
| |
|
| virtual void | initDataContents () |
| |
| virtual void | clearColumns (bool repaint=true) |
| |
| virtual void | clearColumnsInternal (bool repaint)=0 |
| |
| virtual void | addHeaderColumn (const TQString &caption, const TQString &description, const TQIconSet &icon, int size)=0 |
| |
| virtual int | currentLocalSortingOrder () const =0 |
| |
| virtual int | currentLocalSortColumn () const =0 |
| |
| virtual void | setLocalSortingOrder (int col, int order)=0 |
| |
| virtual void | sortColumnInternal (int col, int order=0) |
| |
| virtual void | updateGUIAfterSorting ()=0 |
| |
| virtual void | reloadActions ()=0 |
| |
| virtual void | reloadData () |
| |
| virtual void | itemSelected (KexiTableItem *)=0 |
| |
| virtual void | cellSelected (int col, int row)=0 |
| |
| virtual void | sortedColumnChanged (int col)=0 |
| |
| virtual void | rowEditTerminated (int row)=0 |
| |
| virtual void | clearVariables () |
| |
| virtual KexiDataItemInterface * | editor (int col, bool ignoreMissingEditor=false)=0 |
| |
| virtual void | editorShowFocus (int row, int col)=0 |
| |
| virtual void | updateCell (int row, int col)=0 |
| |
| virtual void | updateRow (int row)=0 |
| |
| virtual void | updateWidgetContents ()=0 |
| |
| virtual void | updateWidgetContentsSize ()=0 |
| |
| virtual void | updateWidgetScrollBars ()=0 |
| |
| virtual void | updateAfterCancelRowEdit () |
| |
| virtual void | updateAfterAcceptRowEdit () |
| |
| virtual void | slotRowRepaintRequested (KexiTableItem &item) |
| |
| virtual void | slotAboutToDeleteRow (KexiTableItem &item, KexiDB::ResultInfo *result, bool repaint) |
| |
| virtual void | slotRowDeleted () |
| |
| virtual void | slotRowInserted (KexiTableItem *item, bool repaint) |
| |
| virtual void | slotRowInserted (KexiTableItem *item, uint row, bool repaint) |
| |
| virtual void | slotRowsDeleted (const TQValueList< int > &) |
| |
| bool | hasData () const |
| |
| virtual void | selectCellInternal () |
| |
| virtual void | updateAllVisibleRowsBelow (int row) |
| |
| virtual void | focusOutEvent (TQFocusEvent *e) |
| |
| virtual void | vScrollBarValueChanged (int v) |
| |
| virtual void | vScrollBarSliderReleased () |
| |
| virtual void | scrollBarTipTimeout () |
| |
| int | showErrorMessageForResult (KexiDB::ResultInfo *resultInfo) |
| |
| void | updateIndicesForVisibleValues () |
| |
The KexiDataAwareObjectInterface is an interface for record-based data object.
This interface is implemented by KexiTableView and KexiFormView and used by KexiDataAwareView. If yu're implementing this interface, add KEXI_DATAAWAREOBJECTINTERFACE convenience macro just after TQ_OBJECT.
You should add following code to your destructor so data is deleted:
KexiTableViewData * m_data data structure displayed for this object bool m_owner true if m_data member is owned by this object This is not performed in KexiDataAwareObjectInterface because you may need to access m_data in your desctructor.
Definition at line 68 of file kexidataawareobjectiface.h.
◆ DeletionPolicy
| enum KexiDataAwareObjectInterface::DeletionPolicy |
◆ KexiDataAwareObjectInterface()
| KexiDataAwareObjectInterface::KexiDataAwareObjectInterface |
( |
| ) |
|
◆ ~KexiDataAwareObjectInterface()
| KexiDataAwareObjectInterface::~KexiDataAwareObjectInterface |
( |
| ) |
|
|
virtual |
◆ acceptEditor()
| bool KexiDataAwareObjectInterface::acceptEditor |
( |
| ) |
|
|
virtual |
Accepst changes made to the currently active editor.
- Returns
- true on success or false on failure (e.g. when editor does not exist or there is data validation error)
- Todo:
- allow displaying user-defined warning
- Todo:
- Todo:
- also use for other error messages
- Todo:
- validation rules for this value?
Definition at line 906 of file kexidataawareobjectiface.cpp.
◆ acceptRowEdit()
| bool KexiDataAwareObjectInterface::acceptRowEdit |
( |
| ) |
|
|
virtual |
Accepts row editing. All changes made to the editing row during this current session will be accepted (saved). - Returns
- true if accepting was successful, false otherwise (e.g. when current row contain data that does not meet given constraints).
Definition at line 694 of file kexidataawareobjectiface.cpp.
◆ acceptsRowEditAfterCellAccepting()
| bool KexiDataAwareObjectInterface::acceptsRowEditAfterCellAccepting |
( |
| ) |
const |
|
inline |
- Returns
- true, if this object automatically accepts row editing (using acceptRowEdit()) on accepting any cell's edit (i.e. after acceptEditor()). By default this flag is set to false. Not that if the query for this table has given constraints defined, like NOT NULL / NOT EMPTY for more than one field - editing a record would be impossible for the flag set to true, because of constraints violation. However, setting this flag to true can be useful especially for not-db-aware data set (it's used e.g. in Kexi Alter Table's field editor).
Definition at line 320 of file kexidataawareobjectiface.h.
◆ addHeaderColumn()
| virtual void KexiDataAwareObjectInterface::addHeaderColumn |
( |
const TQString & |
caption, |
|
|
const TQString & |
description, |
|
|
const TQIconSet & |
icon, |
|
|
int |
size |
|
) |
| |
|
protectedpure virtual |
◆ addNewRecordRequested()
| void KexiDataAwareObjectInterface::addNewRecordRequested |
( |
| ) |
|
|
virtual |
◆ beforeDeleteItem()
| bool KexiDataAwareObjectInterface::beforeDeleteItem |
( |
KexiTableItem * |
item | ) |
|
|
virtual |
◆ boolToggled()
| void KexiDataAwareObjectInterface::boolToggled |
( |
| ) |
|
|
virtual |
Reaction on toggling a boolean value of a cell: we're starting to edit the cell and inverting it's state.
Definition at line 1625 of file kexidataawareobjectiface.cpp.
◆ bufferedValueAt()
| const TQVariant * KexiDataAwareObjectInterface::bufferedValueAt |
( |
int |
col, |
|
|
bool |
useDefaultValueIfPossible = true |
|
) |
| |
◆ cancelEditor()
| bool KexiDataAwareObjectInterface::cancelEditor |
( |
| ) |
|
|
virtual |
Cancels changes made to the currently active editor. Reverts the editor's value to old one. - Returns
- true on success or false on failure (e.g. when editor does not exist)
Definition at line 881 of file kexidataawareobjectiface.cpp.
◆ cancelRowEdit()
| bool KexiDataAwareObjectInterface::cancelRowEdit |
( |
| ) |
|
|
virtual |
Cancels row editing All changes made to the editing row during this current session will be undone. - Returns
- true on success or false on failure (e.g. when editor does not exist)
- Todo:
- (js): cancel changes for this row!
Definition at line 816 of file kexidataawareobjectiface.cpp.
◆ cellSelected()
| virtual void KexiDataAwareObjectInterface::cellSelected |
( |
int |
col, |
|
|
int |
row |
|
) |
| |
|
protectedpure virtual |
for implementation as a signal
◆ clearColumns()
| void KexiDataAwareObjectInterface::clearColumns |
( |
bool |
repaint = true | ) |
|
|
protectedvirtual |
Clears columns information and thus all internal table data and its visible representation. Repaints widget if repaint is true.
Definition at line 1367 of file kexidataawareobjectiface.cpp.
◆ clearColumnsInternal()
| virtual void KexiDataAwareObjectInterface::clearColumnsInternal |
( |
bool |
repaint | ) |
|
|
protectedpure virtual |
◆ clearSelection()
| void KexiDataAwareObjectInterface::clearSelection |
( |
| ) |
|
|
virtual |
◆ clearVariables()
| void KexiDataAwareObjectInterface::clearVariables |
( |
| ) |
|
|
protectedvirtual |
◆ column()
◆ columnDefaultValue()
| TQVariant KexiDataAwareObjectInterface::columnDefaultValue |
( |
int |
col | ) |
const |
◆ columnEditable()
| bool KexiDataAwareObjectInterface::columnEditable |
( |
int |
col | ) |
|
|
virtual |
- Returns
- true is column col is editable. Default implementation takes information about 'readOnly' flag from data member. Within forms, this is reimplemented for checking 'readOnly' flag from a widget ('readOnly' flag from data member is still checked though).
Reimplemented in KexiFormScrollView.
Definition at line 1439 of file kexidataawareobjectiface.cpp.
◆ columns()
| virtual int KexiDataAwareObjectInterface::columns |
( |
| ) |
const |
|
inlinevirtual |
◆ columnType()
| int KexiDataAwareObjectInterface::columnType |
( |
int |
col | ) |
|
◆ contextMenu()
| TDEPopupMenu * KexiDataAwareObjectInterface::contextMenu |
( |
| ) |
const |
|
inline |
◆ contextMenuEnabled()
| bool KexiDataAwareObjectInterface::contextMenuEnabled |
( |
| ) |
const |
|
inline |
◆ copySelection()
| virtual void KexiDataAwareObjectInterface::copySelection |
( |
| ) |
|
|
pure virtual |
Copy current selection to a clipboard (e.g. cell)
Implemented in KexiTableView.
◆ createEditor()
| virtual void KexiDataAwareObjectInterface::createEditor |
( |
int |
row, |
|
|
int |
col, |
|
|
const TQString & |
addText = TQString(), |
|
|
bool |
removeOld = false |
|
) |
| |
|
pure virtual |
◆ currentColumn()
| int KexiDataAwareObjectInterface::currentColumn |
( |
| ) |
const |
|
inline |
◆ currentLocalSortColumn()
| virtual int KexiDataAwareObjectInterface::currentLocalSortColumn |
( |
| ) |
const |
|
protectedpure virtual |
◆ currentLocalSortingOrder()
| virtual int KexiDataAwareObjectInterface::currentLocalSortingOrder |
( |
| ) |
const |
|
protectedpure virtual |
◆ currentRow()
| int KexiDataAwareObjectInterface::currentRow |
( |
| ) |
const |
|
inline |
◆ cutSelection()
| virtual void KexiDataAwareObjectInterface::cutSelection |
( |
| ) |
|
|
pure virtual |
Cut current selection to a clipboard (e.g. cell)
Implemented in KexiTableView.
◆ data()
◆ dataColumns()
| int KexiDataAwareObjectInterface::dataColumns |
( |
| ) |
const |
◆ dataRefreshed()
| virtual void KexiDataAwareObjectInterface::dataRefreshed |
( |
| ) |
|
|
pure virtual |
◆ dataSortedColumn()
| int KexiDataAwareObjectInterface::dataSortedColumn |
( |
| ) |
const |
- Returns
- sorted column number or -1 if no column is sorted within data. This does not mean that any sorting has been performed within GUI of this object, because the data could be changed in the meantime outside of this GUI object.
Definition at line 273 of file kexidataawareobjectiface.cpp.
◆ dataSortingOrder()
| int KexiDataAwareObjectInterface::dataSortingOrder |
( |
| ) |
const |
- Returns
- 1 if ascending order for data sorting data is set, -1 for descending, 0 for no sorting. This does not mean that any sorting has been performed within GUI of this objetct, because the data could be changed in the meantime outside of this GUI object.
Definition at line 280 of file kexidataawareobjectiface.cpp.
◆ deleteAllRows()
| tristate KexiDataAwareObjectInterface::deleteAllRows |
( |
bool |
ask = false, |
|
|
bool |
repaint = true |
|
) |
| |
Clears entire table data, its visible representation and deletes data at database backend (if this is db-aware object). Does not clear columns information. Does not destroy KexiTableViewData object (if present) but only clears its contents. Displays confirmation dialog if ask is true (the default is false). Repaints widget if repaint is true (the default). For empty tables, true is returned immediately. If isDeleteEnabled() is false, false is returned. For spreadsheet mode all current rows are just replaced by empty rows. - Returns
- true on success, false on failure, and cancelled if user cancelled deletion (only possible if ask is true).
Definition at line 1320 of file kexidataawareobjectiface.cpp.
◆ deleteAndStartEditCurrentCell()
| void KexiDataAwareObjectInterface::deleteAndStartEditCurrentCell |
( |
| ) |
|
|
virtual |
Deletes currently selected cell's contents, if allowed. In most cases delete is not accepted immediately but "row editing" mode is just started.
Definition at line 1169 of file kexidataawareobjectiface.cpp.
◆ deleteCurrentRow()
| void KexiDataAwareObjectInterface::deleteCurrentRow |
( |
| ) |
|
|
virtual |
Deletes currently selected record; does nothing if no record is currently selected. If record is in edit mode, editing is cancelled before deleting.
Definition at line 1193 of file kexidataawareobjectiface.cpp.
◆ deleteItem()
| bool KexiDataAwareObjectInterface::deleteItem |
( |
KexiTableItem * |
item | ) |
|
◆ deletionPolicy()
| DeletionPolicy KexiDataAwareObjectInterface::deletionPolicy |
( |
| ) |
const |
|
inline |
◆ dropsAtRowEnabled()
| bool KexiDataAwareObjectInterface::dropsAtRowEnabled |
( |
| ) |
const |
|
inline |
◆ editor() [1/2]
◆ editor() [2/2]
| virtual KexiDataItemInterface * KexiDataAwareObjectInterface::editor |
( |
int |
col, |
|
|
bool |
ignoreMissingEditor = false |
|
) |
| |
|
protectedpure virtual |
◆ editorShowFocus()
| virtual void KexiDataAwareObjectInterface::editorShowFocus |
( |
int |
row, |
|
|
int |
col |
|
) |
| |
|
protectedpure virtual |
◆ ensureCellVisible()
| virtual void KexiDataAwareObjectInterface::ensureCellVisible |
( |
int |
row, |
|
|
int |
col |
|
) |
| |
|
pure virtual |
Ensures that cell at row and col is visible. If col is -1, current column number is used. row and col (if not -1) must be between 0 and rows() (or cols() accordingly).
◆ fieldNumberForColumn()
| virtual int KexiDataAwareObjectInterface::fieldNumberForColumn |
( |
int |
col | ) |
|
|
inlinevirtual |
◆ find()
Finds valueToFind within the data items options are used to control the process. Selection is moved to found value. If next is true, "find next" is performed, else "find previous" is performed.
Searching behaviour also depends on status of the previous search: for every search, position of the cells containing the found value is stored internally by the data-aware interface (not in options). Moreover, position (start, end) of the found value is also stored. Thus, the subsequent search will reuse this information to be able to start searching exactly after the previously found value (or before for "find previous" option). The flags can be zeroed, what will lead to seaching from the first character of the current item (cell).
- Returns
- true if value has been found, false if value has not been found, and cancelled if there is nothing to find or there is no data to search in.
- Todo:
- for regexp lastCharacter should be computed
Definition at line 1965 of file kexidataawareobjectiface.cpp.
◆ findNextAndReplace()
Finds valueToFind within the data items and replaces with replacement options are used to control the process. - Returns
- true if value has been found and replaced, false if value has not been found and replaced, and cancelled if there is nothing to find or there is no data to search in or the data is read only. If replaceAll is true, all found values are replaced.
- Todo:
- implement KexiDataAwareObjectInterface::findAndReplace()
Definition at line 2094 of file kexidataawareobjectiface.cpp.
◆ focusOutEvent()
| void KexiDataAwareObjectInterface::focusOutEvent |
( |
TQFocusEvent * |
e | ) |
|
|
protectedvirtual |
◆ handleKeyPress()
| bool KexiDataAwareObjectInterface::handleKeyPress |
( |
TQKeyEvent * |
e, |
|
|
int & |
curRow, |
|
|
int & |
curCol, |
|
|
bool |
fullRowSelection, |
|
|
bool * |
moveToFirstField = 0, |
|
|
bool * |
moveToLastField = 0 |
|
) |
| |
|
virtual |
Used in KexiTableView::keyPressEvent() (and in continuous forms). - Returns
- true when the key press event was consumed. You should also check e->isAccepted(), if it's true, nothing should be done; if it is false, you should call setCursorPosition() for the altered curCol and
curRow variables.
If moveToFirstField is not 0, *moveToFirstField will be set to true when the cursor should be moved to the first field (in tab order) and to false otherwise. If moveToLastField is not 0, *moveToLastField will be set to true when the cursor should be moved to the last field (in tab order) and to false otherwise. Note for forms: if moveToFirstField and moveToLastField are not 0, curCol is altered after calling this method, so setCursorPosition() will set to the index of an appropriate column (field). This is needed because field widgets can be inserted and ordered in custom tab order, so the very first field in the data source can be other than the very first field in the form.
Used by KexiTableView::keyPressEvent() and KexiTableView::keyPressEvent().
Definition at line 1663 of file kexidataawareobjectiface.cpp.
◆ hasData()
| bool KexiDataAwareObjectInterface::hasData |
( |
| ) |
const |
|
inlineprotected |
◆ hasDefaultValueAt()
◆ initDataContents()
| void KexiDataAwareObjectInterface::initDataContents |
( |
| ) |
|
|
protectedvirtual |
◆ insertEmptyRow()
| KexiTableItem * KexiDataAwareObjectInterface::insertEmptyRow |
( |
int |
row = -1 | ) |
|
|
virtual |
Inserts one empty row above row row. If row is -1 (the default), new row is inserted above the current row (or above 1st row if there is no current). A new item becomes current if row is -1 or if row is equal currentRow(). This method does nothing if: -inserting flag is disabled (see isInsertingEnabled()) -read-only flag is set (see isReadOnly()) \ return inserted row's data
Definition at line 1230 of file kexidataawareobjectiface.cpp.
◆ insertItem()
| void KexiDataAwareObjectInterface::insertItem |
( |
KexiTableItem * |
newItem, |
|
|
int |
row = -1 |
|
) |
| |
◆ isDeleteEnabled()
| bool KexiDataAwareObjectInterface::isDeleteEnabled |
( |
| ) |
const |
◆ isEmptyRowInsertingEnabled()
| bool KexiDataAwareObjectInterface::isEmptyRowInsertingEnabled |
( |
| ) |
const |
|
inline |
- Returns
- true if inserting empty rows are enabled (false by default). Mostly usable for not db-aware objects (e.g. used in Kexi Alter Table). Note, that if inserting is disabled, or the data set is read-only, this flag will be ignored.
Definition at line 198 of file kexidataawareobjectiface.h.
◆ isFilteringEnabled()
| bool KexiDataAwareObjectInterface::isFilteringEnabled |
( |
| ) |
const |
|
inline |
◆ isInsertingEnabled()
| bool KexiDataAwareObjectInterface::isInsertingEnabled |
( |
| ) |
const |
|
virtual |
◆ isReadOnly()
| bool KexiDataAwareObjectInterface::isReadOnly |
( |
| ) |
const |
|
virtual |
- Returns
- true if data represented by this object is not editable (it can be editable with other ways although, outside of this object).
Definition at line 404 of file kexidataawareobjectiface.cpp.
◆ isSortingEnabled()
| bool KexiDataAwareObjectInterface::isSortingEnabled |
( |
| ) |
const |
|
inline |
◆ itemAt()
| KexiTableItem * KexiDataAwareObjectInterface::itemAt |
( |
int |
row | ) |
const |
|
inline |
◆ itemChanged()
| virtual void KexiDataAwareObjectInterface::itemChanged |
( |
KexiTableItem * |
, |
|
|
int |
row, |
|
|
int |
col |
|
) |
| |
|
pure virtual |
◆ itemSelected()
| virtual void KexiDataAwareObjectInterface::itemSelected |
( |
KexiTableItem * |
| ) |
|
|
protectedpure virtual |
for implementation as a signal
◆ lastVisibleRow()
| virtual int KexiDataAwareObjectInterface::lastVisibleRow |
( |
| ) |
const |
|
pure virtual |
◆ newItemAppendedForAfterDeletingInSpreadSheetMode()
| virtual void KexiDataAwareObjectInterface::newItemAppendedForAfterDeletingInSpreadSheetMode |
( |
| ) |
|
|
pure virtual |
Emitted for spreadsheet mode when an item was deleted and a new item has been appended.
◆ newRowEditing()
| bool KexiDataAwareObjectInterface::newRowEditing |
( |
| ) |
const |
|
inline |
◆ paste()
| virtual void KexiDataAwareObjectInterface::paste |
( |
| ) |
|
|
pure virtual |
Paste current clipboard contents (e.g. to a cell)
Implemented in KexiTableView.
◆ reloadActions()
| virtual void KexiDataAwareObjectInterface::reloadActions |
( |
| ) |
|
|
protectedpure virtual |
Emitted in initActions() to force reload actions You should remove existing actions and add them again. Define and emit reloadActions() signal here.
◆ reloadData()
| void KexiDataAwareObjectInterface::reloadData |
( |
| ) |
|
|
protectedvirtual |
◆ removeEditor()
| void KexiDataAwareObjectInterface::removeEditor |
( |
| ) |
|
|
virtual |
◆ rowEditing()
| bool KexiDataAwareObjectInterface::rowEditing |
( |
| ) |
const |
|
inline |
◆ rowEditTerminated()
| virtual void KexiDataAwareObjectInterface::rowEditTerminated |
( |
int |
row | ) |
|
|
protectedpure virtual |
for implementation as a signal
◆ rows()
| int KexiDataAwareObjectInterface::rows |
( |
| ) |
const |
◆ rowsPerPage()
| virtual int KexiDataAwareObjectInterface::rowsPerPage |
( |
| ) |
const |
|
pure virtual |
- Returns
- maximum number of rows that can be displayed per one "page" for current view's size.
Implemented in KexiTableView.
◆ scrollBarTipTimeout()
| void KexiDataAwareObjectInterface::scrollBarTipTimeout |
( |
| ) |
|
|
protectedvirtual |
Handles timeout() signal of the m_scrollBarTipTimer. If the tooltip is visible, m_scrollBarTipTimerCnt is set to 0 and m_scrollBarTipTimerCnt is restarted; else the m_scrollBarTipTimerCnt is just set to 0.
Definition at line 1808 of file kexidataawareobjectiface.cpp.
◆ scrollbarToolTipsEnabled()
| bool KexiDataAwareObjectInterface::scrollbarToolTipsEnabled |
( |
| ) |
const |
◆ selectCellInternal()
| virtual void KexiDataAwareObjectInterface::selectCellInternal |
( |
| ) |
|
|
inlineprotectedvirtual |
◆ selectedItem()
| KexiTableItem * KexiDataAwareObjectInterface::selectedItem |
( |
| ) |
const |
|
inline |
◆ selectFirstRow()
| void KexiDataAwareObjectInterface::selectFirstRow |
( |
| ) |
|
|
virtual |
◆ selectLastRow()
| void KexiDataAwareObjectInterface::selectLastRow |
( |
| ) |
|
|
virtual |
◆ selectNextPage()
| void KexiDataAwareObjectInterface::selectNextPage |
( |
| ) |
|
|
virtual |
◆ selectNextRow()
| void KexiDataAwareObjectInterface::selectNextRow |
( |
| ) |
|
|
virtual |
◆ selectPrevPage()
| void KexiDataAwareObjectInterface::selectPrevPage |
( |
| ) |
|
|
virtual |
◆ selectPrevRow()
| void KexiDataAwareObjectInterface::selectPrevRow |
( |
| ) |
|
|
virtual |
◆ selectRow()
| void KexiDataAwareObjectInterface::selectRow |
( |
int |
row | ) |
|
|
virtual |
◆ setAcceptsRowEditAfterCellAccepting()
| void KexiDataAwareObjectInterface::setAcceptsRowEditAfterCellAccepting |
( |
bool |
set | ) |
|
|
virtual |
◆ setContextMenuEnabled()
| void KexiDataAwareObjectInterface::setContextMenuEnabled |
( |
bool |
set | ) |
|
|
inline |
◆ setCursorPosition()
| void KexiDataAwareObjectInterface::setCursorPosition |
( |
int |
row, |
|
|
int |
col = -1, |
|
|
bool |
forceSet = false |
|
) |
| |
|
virtual |
Moves cursor to row and col. If col is -1, current column number is used. If forceSet is true, cursor position is updated even if row and col doesn't differ from actual position.
Definition at line 499 of file kexidataawareobjectiface.cpp.
◆ setData()
| void KexiDataAwareObjectInterface::setData |
( |
KexiTableViewData * |
data, |
|
|
bool |
owner = true |
|
) |
| |
Sets data for this object. if owner is true, the object will own data and therefore will be destroyed when needed, else: data is (possibly) shared and not owned by the widget. If widget already has different data object assigned (and owns this data), old data is destroyed before new assignment.
- Todo:
- add col width configuration and storage
- Todo:
- : store sorting settings?
Definition at line 114 of file kexidataawareobjectiface.cpp.
◆ setDeletionPolicy()
| void KexiDataAwareObjectInterface::setDeletionPolicy |
( |
DeletionPolicy |
policy | ) |
|
|
virtual |
◆ setDropsAtRowEnabled()
| void KexiDataAwareObjectInterface::setDropsAtRowEnabled |
( |
bool |
set | ) |
|
|
virtual |
Specifies, if this table accepts dropping data on the rows. If enabled:
- dragging over row is indicated by drawing a line at bottom side of this row
- dragOverRow() signal will be emitted on dragging, -droppedAtRow() will be emitted on dropping By default this flag is set to false.
Definition at line 1471 of file kexidataawareobjectiface.cpp.
◆ setEmptyRowInsertingEnabled()
| void KexiDataAwareObjectInterface::setEmptyRowInsertingEnabled |
( |
bool |
set | ) |
|
◆ setFilteringEnabled()
| void KexiDataAwareObjectInterface::setFilteringEnabled |
( |
bool |
set | ) |
|
|
virtual |
◆ setInsertingEnabled()
| void KexiDataAwareObjectInterface::setInsertingEnabled |
( |
bool |
set | ) |
|
Sets insertingEnabled flag. If true, empty row is available at the end of this widget for new entering new data. Unless the flag is set, the widget inherits insertingEnabled flag from it's data structure assigned with setData(). The default value if false.
Note: it is not allowed to force insertingEnabled on when internal data has insertingEnabled set off - in that case the method does nothing. You can check internal data flag calling data()->insertingEnabled().
Setting this flag to true will have no effect if read-only flag is true. - See also
- setReadOnly()
Definition at line 415 of file kexidataawareobjectiface.cpp.
◆ setLocalSortingOrder()
| virtual void KexiDataAwareObjectInterface::setLocalSortingOrder |
( |
int |
col, |
|
|
int |
order |
|
) |
| |
|
protectedpure virtual |
◆ setReadOnly()
| void KexiDataAwareObjectInterface::setReadOnly |
( |
bool |
set | ) |
|
Sets readOnly flag for this object. Unless the flag is set, the widget inherits readOnly flag from it's data structure assigned with setData(). The default value if false.
This method is useful when you need to switch on the flag indepentently from the data structure. Note: it is not allowed to force readOnly off when internal data is readOnly - in that case the method does nothing. You can check internal data flag calling data()->isReadOnly().
If set is true, insertingEnabled flag will be cleared automatically. - See also
- isInsertingEnabled()
Definition at line 393 of file kexidataawareobjectiface.cpp.
◆ setScrollbarToolTipsEnabled()
| void KexiDataAwareObjectInterface::setScrollbarToolTipsEnabled |
( |
bool |
set | ) |
|
◆ setSorting()
| void KexiDataAwareObjectInterface::setSorting |
( |
int |
col, |
|
|
bool |
ascending = true |
|
) |
| |
|
virtual |
◆ setSortingEnabled()
| void KexiDataAwareObjectInterface::setSortingEnabled |
( |
bool |
set | ) |
|
|
virtual |
Enables or disables sorting for this object This method is different that setSorting() because it prevents both user and programmer from sorting by clicking a column's header or calling setSorting(). By default sorting is enabled.
Definition at line 256 of file kexidataawareobjectiface.cpp.
◆ setSpreadSheetMode()
| void KexiDataAwareObjectInterface::setSpreadSheetMode |
( |
| ) |
|
|
virtual |
◆ showErrorMessageForResult()
| int KexiDataAwareObjectInterface::showErrorMessageForResult |
( |
KexiDB::ResultInfo * |
resultInfo | ) |
|
|
protected |
Shows error message box suitable for resultInfo. This can be "sorry" or "detailedSorry" message box or "queryYesNo" if resultInfo->allowToDiscardChanges is true. - Returns
- code of button clicked: KMessageBox::Ok in case of "sorry" or "detailedSorry" messages and KMessageBox::Yes or KMessageBox::No in case of "queryYesNo" message.
Definition at line 1831 of file kexidataawareobjectiface.cpp.
◆ slotAboutToDeleteRow()
| void KexiDataAwareObjectInterface::slotAboutToDeleteRow |
( |
KexiTableItem & |
item, |
|
|
KexiDB::ResultInfo * |
result, |
|
|
bool |
repaint |
|
) |
| |
|
protectedvirtual |
◆ slotDataDestroying()
| void KexiDataAwareObjectInterface::slotDataDestroying |
( |
| ) |
|
|
virtual |
◆ slotRowDeleted()
| void KexiDataAwareObjectInterface::slotRowDeleted |
( |
| ) |
|
|
protectedvirtual |
◆ slotRowInserted() [1/2]
| void KexiDataAwareObjectInterface::slotRowInserted |
( |
KexiTableItem * |
item, |
|
|
bool |
repaint |
|
) |
| |
|
protectedvirtual |
◆ slotRowInserted() [2/2]
| void KexiDataAwareObjectInterface::slotRowInserted |
( |
KexiTableItem * |
item, |
|
|
uint |
row, |
|
|
bool |
repaint |
|
) |
| |
|
protectedvirtual |
◆ slotRowRepaintRequested()
| virtual void KexiDataAwareObjectInterface::slotRowRepaintRequested |
( |
KexiTableItem & |
item | ) |
|
|
inlineprotectedvirtual |
◆ slotRowsDeleted()
| virtual void KexiDataAwareObjectInterface::slotRowsDeleted |
( |
const TQValueList< int > & |
| ) |
|
|
inlineprotectedvirtual |
◆ sort()
| bool KexiDataAwareObjectInterface::sort |
( |
| ) |
|
|
virtual |
◆ sortAscending()
| void KexiDataAwareObjectInterface::sortAscending |
( |
| ) |
|
Sorts currently selected column in ascending order. This slot is used typically for "data_sort_az" action.
Definition at line 328 of file kexidataawareobjectiface.cpp.
◆ sortColumnInternal()
| void KexiDataAwareObjectInterface::sortColumnInternal |
( |
int |
col, |
|
|
int |
order = 0 |
|
) |
| |
|
protectedvirtual |
◆ sortDescending()
| void KexiDataAwareObjectInterface::sortDescending |
( |
| ) |
|
Sorts currently selected column in descending order. This slot is used typically for "data_sort_za" action.
Definition at line 335 of file kexidataawareobjectiface.cpp.
◆ sortedColumnChanged()
| virtual void KexiDataAwareObjectInterface::sortedColumnChanged |
( |
int |
col | ) |
|
|
protectedpure virtual |
for implementation as a signal
◆ spreadSheetMode()
| bool KexiDataAwareObjectInterface::spreadSheetMode |
( |
| ) |
const |
|
inline |
◆ startEditCurrentCell()
| void KexiDataAwareObjectInterface::startEditCurrentCell |
( |
const TQString & |
setText = TQString() | ) |
|
|
virtual |
Used when Return key is pressed on cell, the cell has been double clicked or "+" navigator's button is clicked. Also used when we want to continue editing a cell after "invalid value" message was displayed (in this case, setText is usually not empty, what means that text will be set in the cell replacing previous value).
Definition at line 1148 of file kexidataawareobjectiface.cpp.
◆ startEditOrToggleValue()
| void KexiDataAwareObjectInterface::startEditOrToggleValue |
( |
| ) |
|
◆ updateAfterAcceptRowEdit()
| void KexiDataAwareObjectInterface::updateAfterAcceptRowEdit |
( |
| ) |
|
|
protectedvirtual |
◆ updateAfterCancelRowEdit()
| void KexiDataAwareObjectInterface::updateAfterCancelRowEdit |
( |
| ) |
|
|
protectedvirtual |
◆ updateAllVisibleRowsBelow()
| virtual void KexiDataAwareObjectInterface::updateAllVisibleRowsBelow |
( |
int |
row | ) |
|
|
inlineprotectedvirtual |
◆ updateCell()
| virtual void KexiDataAwareObjectInterface::updateCell |
( |
int |
row, |
|
|
int |
col |
|
) |
| |
|
protectedpure virtual |
◆ updateCurrentCell()
| virtual void KexiDataAwareObjectInterface::updateCurrentCell |
( |
| ) |
|
|
pure virtual |
◆ updateGUIAfterSorting()
| virtual void KexiDataAwareObjectInterface::updateGUIAfterSorting |
( |
| ) |
|
|
protectedpure virtual |
◆ updateIndicesForVisibleValues()
| void KexiDataAwareObjectInterface::updateIndicesForVisibleValues |
( |
| ) |
|
|
protected |
Prepares array of indices of visible values to search within. This is per-interface global cache. Needed for faster lookup because there could be lookup values. Called whenever columns definition changes, i.e. in setData() and clearColumns(). - See also
- find()
Definition at line 1850 of file kexidataawareobjectiface.cpp.
◆ updateRow()
| virtual void KexiDataAwareObjectInterface::updateRow |
( |
int |
row | ) |
|
|
protectedpure virtual |
◆ updateWidgetContents()
| virtual void KexiDataAwareObjectInterface::updateWidgetContents |
( |
| ) |
|
|
protectedpure virtual |
◆ updateWidgetContentsSize()
| virtual void KexiDataAwareObjectInterface::updateWidgetContentsSize |
( |
| ) |
|
|
protectedpure virtual |
◆ updateWidgetScrollBars()
| virtual void KexiDataAwareObjectInterface::updateWidgetScrollBars |
( |
| ) |
|
|
protectedpure virtual |
◆ verticalHeader()
◆ verticalScrollBar()
| virtual TQScrollBar * KexiDataAwareObjectInterface::verticalScrollBar |
( |
| ) |
const |
|
pure virtual |
◆ vScrollBarSliderReleased()
| void KexiDataAwareObjectInterface::vScrollBarSliderReleased |
( |
| ) |
|
|
protectedvirtual |
◆ vScrollBarValueChanged()
| void KexiDataAwareObjectInterface::vScrollBarValueChanged |
( |
int |
v | ) |
|
|
protectedvirtual |
◆ m_acceptsRowEditAfterCellAccepting
| bool KexiDataAwareObjectInterface::m_acceptsRowEditAfterCellAccepting |
|
protected |
Public version of 'acceptsRowEditAfterCellAcceptin' flag (available for a user). It's OR'es together with above flag.
Definition at line 747 of file kexidataawareobjectiface.h.
◆ m_alsoUpdateNextRow
| bool KexiDataAwareObjectInterface::m_alsoUpdateNextRow |
|
protected |
◆ m_contentsMousePressEvent_dblClick
| bool KexiDataAwareObjectInterface::m_contentsMousePressEvent_dblClick |
|
protected |
◆ m_contextMenuEnabled
| bool KexiDataAwareObjectInterface::m_contextMenuEnabled |
|
protected |
◆ m_curCol
| int KexiDataAwareObjectInterface::m_curCol |
|
protected |
◆ m_currentItem
| KexiTableItem* KexiDataAwareObjectInterface::m_currentItem |
|
protected |
◆ m_curRow
| int KexiDataAwareObjectInterface::m_curRow |
|
protected |
◆ m_cursorPositionSetExplicityBeforeShow
| bool KexiDataAwareObjectInterface::m_cursorPositionSetExplicityBeforeShow |
|
protected |
◆ m_data
◆ m_deletionPolicy
| DeletionPolicy KexiDataAwareObjectInterface::m_deletionPolicy |
|
protected |
◆ m_dragIndicatorLine
| int KexiDataAwareObjectInterface::m_dragIndicatorLine |
|
protected |
Row number that over which user drags a mouse pointer. Used to indicate dropping possibility for that row. Equal -1 if no indication is needed.
Definition at line 818 of file kexidataawareobjectiface.h.
◆ m_dropsAtRowEnabled
| bool KexiDataAwareObjectInterface::m_dropsAtRowEnabled |
|
protected |
◆ m_editor
◆ m_emptyRowInsertingEnabled
| bool KexiDataAwareObjectInterface::m_emptyRowInsertingEnabled |
|
protected |
◆ m_errorMessagePopup
| TQGuardedPtr<KexiArrowTip> KexiDataAwareObjectInterface::m_errorMessagePopup |
|
protected |
◆ m_horizontalHeader
◆ m_indicesForVisibleValues
| TQValueVector<uint> KexiDataAwareObjectInterface::m_indicesForVisibleValues |
|
protected |
◆ m_initDataContentsOnShow
| bool KexiDataAwareObjectInterface::m_initDataContentsOnShow |
|
protected |
◆ m_insertingEnabled
| int KexiDataAwareObjectInterface::m_insertingEnabled |
|
protected |
◆ m_insertItem
| KexiTableItem* KexiDataAwareObjectInterface::m_insertItem |
|
protected |
◆ m_inside_acceptEditor
| bool KexiDataAwareObjectInterface::m_inside_acceptEditor |
|
protected |
◆ m_internal_acceptsRowEditAfterCellAccepting
| bool KexiDataAwareObjectInterface::m_internal_acceptsRowEditAfterCellAccepting |
|
protected |
◆ m_isFilteringEnabled
| bool KexiDataAwareObjectInterface::m_isFilteringEnabled |
|
protected |
◆ m_isSortingEnabled
| bool KexiDataAwareObjectInterface::m_isSortingEnabled |
|
protected |
◆ m_itemIterator
| KexiTableViewData::Iterator* KexiDataAwareObjectInterface::m_itemIterator |
|
protected |
◆ m_navPanel
◆ m_navPanelEnabled
| bool KexiDataAwareObjectInterface::m_navPanelEnabled |
|
protected |
◆ m_newRowEditing
| bool KexiDataAwareObjectInterface::m_newRowEditing |
|
protected |
◆ m_owner
| bool KexiDataAwareObjectInterface::m_owner |
|
protected |
◆ m_popupMenu
| TDEPopupMenu* KexiDataAwareObjectInterface::m_popupMenu |
|
protected |
◆ m_positionOfRecentlyFoundValue
| PositionOfValue KexiDataAwareObjectInterface::m_positionOfRecentlyFoundValue |
|
protected |
Used to mark recently found value. Updated on succesful execution of find(). If the current cursor's position changes, or data in the current cell changes, positionOfRecentlyFoundValue.exists is set to false.
Definition at line 862 of file kexidataawareobjectiface.h.
◆ m_readOnly
| int KexiDataAwareObjectInterface::m_readOnly |
|
protected |
◆ m_recentlySearchedValue
| TQVariant KexiDataAwareObjectInterface::m_recentlySearchedValue |
|
protected |
◆ m_recentSearchDirection
◆ m_rowEditing
| bool KexiDataAwareObjectInterface::m_rowEditing |
|
protected |
when (current or new) row is edited - changed field values are temporary stored here
true if currently selected row is edited
Definition at line 733 of file kexidataawareobjectiface.h.
◆ m_rowWillBeDeleted
| int KexiDataAwareObjectInterface::m_rowWillBeDeleted |
|
protected |
◆ m_scrollBarTip
| TQLabel* KexiDataAwareObjectInterface::m_scrollBarTip |
|
protected |
◆ m_scrollBarTipTimer
| TQTimer KexiDataAwareObjectInterface::m_scrollBarTipTimer |
|
protected |
◆ m_scrollBarTipTimerCnt
| uint KexiDataAwareObjectInterface::m_scrollBarTipTimerCnt |
|
protected |
◆ m_scrollbarToolTipsEnabled
| bool KexiDataAwareObjectInterface::m_scrollbarToolTipsEnabled |
|
protected |
◆ m_spreadSheetMode
| bool KexiDataAwareObjectInterface::m_spreadSheetMode |
|
protected |
◆ m_updateEntireRowWhenMovingToOtherRow
| bool KexiDataAwareObjectInterface::m_updateEntireRowWhenMovingToOtherRow |
|
protected |
true, if this entire (visible) row should be updated when boving to other row. False by default. For table view with 'row highlighting' flag enabled, it is true.
Definition at line 792 of file kexidataawareobjectiface.h.
◆ m_verticalHeader
◆ m_verticalHeaderAlreadyAdded
| bool KexiDataAwareObjectInterface::m_verticalHeaderAlreadyAdded |
|
protected |
◆ m_vScrollBarValueChanged_enabled
| bool KexiDataAwareObjectInterface::m_vScrollBarValueChanged_enabled |
|
protected |
The documentation for this class was generated from the following files:
|
