kexi

Classes | Public Slots | Signals | Public Member Functions | Protected Slots | Protected Member Functions | Protected Attributes | List of all members
KexiRecordNavigator Class Reference

#include <kexirecordnavigator.h>

Inherits TQFrame.

Classes

class  Actions
 

Public Slots

void setInsertingEnabled (bool set)
 
void setInsertingButtonVisible (bool set)
 
void setEditingIndicatorEnabled (bool set)
 
void showEditingIndicator (bool show)
 
virtual void setEnabled (bool set)
 
void setCurrentRecordNumber (uint r)
 
void setRecordCount (uint count)
 
void updateGeometry (int leftMargin)
 
void setLabelText (const TQString &text)
 

Signals

void prevButtonClicked ()
 
void nextButtonClicked ()
 
void lastButtonClicked ()
 
void firstButtonClicked ()
 
void newButtonClicked ()
 
void recordNumberEntered (uint r)
 

Public Member Functions

 KexiRecordNavigator (TQWidget *parent, int leftMargin=0, const char *name=0)
 
void setParentView (TQScrollView *view)
 
void setRecordHandler (KexiRecordNavigatorHandler *handler)
 
bool isInsertingEnabled () const
 
uint currentRecordNumber () const
 
uint recordCount () const
 
void setHBarGeometry (TQScrollBar &hbar, int x, int y, int w, int h)
 
virtual bool eventFilter (TQObject *o, TQEvent *e)
 
bool editingIndicatorVisible () const
 
bool editingIndicatorEnabled () const
 

Protected Slots

void slotPrevButtonClicked ()
 
void slotNextButtonClicked ()
 
void slotLastButtonClicked ()
 
void slotFirstButtonClicked ()
 
void slotNewButtonClicked ()
 

Protected Member Functions

void updateButtons (uint recCnt)
 

Protected Attributes

TQLabel * m_textLabel
 
TQToolButton * m_navBtnFirst
 
TQToolButton * m_navBtnPrev
 
TQToolButton * m_navBtnNext
 
TQToolButton * m_navBtnLast
 
TQToolButton * m_navBtnNew
 
KLineEdit * m_navRecordNumber
 
TQIntValidator * m_navRecordNumberValidator
 
KLineEdit * m_navRecordCount
 
uint m_nav1DigitWidth
 
TQScrollView * m_view
 
bool m_isInsertingEnabled: 1
 
KexiRecordNavigatorPrivate * d
 

Detailed Description

KexiRecordNavigator class provides a record navigator.

Record navigator is usually used for data tables (e.g. KexiTableView) or data-aware forms.

You can plug KexiRecordNavigator object to your data-aware object in two ways: 1) By connectiong to slots prevButtonClicked(), etc. 2) A bit cleaner way: by inheriting from KexiRecordNavigatorHandler interface in your data-aware class and implementing all it's prototype methods like moveToRecordRequested(), and then caling setRecordHandler() on navigator's object. Note that using this way, you can allow to exist more than one navigator widget connected with your data-aware object (don't matter if this is sane).

Definition at line 65 of file kexirecordnavigator.h.

Constructor & Destructor Documentation

◆ KexiRecordNavigator()

KexiRecordNavigator::KexiRecordNavigator ( TQWidget *  parent,
int  leftMargin = 0,
const char *  name = 0 
)

Definition at line 68 of file kexirecordnavigator.cpp.

◆ ~KexiRecordNavigator()

KexiRecordNavigator::~KexiRecordNavigator ( )
virtual

Definition at line 172 of file kexirecordnavigator.cpp.

Member Function Documentation

◆ currentRecordNumber()

uint KexiRecordNavigator::currentRecordNumber ( ) const
Returns
current record number displayed for this navigator. can return 0, if the 'text box's content is cleared.

Definition at line 311 of file kexirecordnavigator.cpp.

◆ editingIndicatorEnabled()

bool KexiRecordNavigator::editingIndicatorEnabled ( ) const
Returns
true if "editing" indicator is enabled for this navigator. Only meaningful if setEditingIndicatorEnabled(true) is called.

Definition at line 421 of file kexirecordnavigator.cpp.

◆ editingIndicatorVisible()

bool KexiRecordNavigator::editingIndicatorVisible ( ) const
Returns
true if "editing" indicator is visible for this navigator.
See also
showEditingIndicator()

Definition at line 416 of file kexirecordnavigator.cpp.

◆ eventFilter()

bool KexiRecordNavigator::eventFilter ( TQObject *  o,
TQEvent *  e 
)
virtual

Definition at line 193 of file kexirecordnavigator.cpp.

◆ isInsertingEnabled()

bool KexiRecordNavigator::isInsertingEnabled ( ) const
inline
Returns
true if data inserting is enabled (the default).

Definition at line 81 of file kexirecordnavigator.h.

◆ recordCount()

uint KexiRecordNavigator::recordCount ( ) const
Returns
record count displayed for this navigator.

Definition at line 320 of file kexirecordnavigator.cpp.

◆ setCurrentRecordNumber

void KexiRecordNavigator::setCurrentRecordNumber ( uint  r)
slot

Sets current record number for this navigator, i.e. a value that will be displayed in the 'record number' text box. This can also affect button's enabling and disabling. If r is 0, 'record number' text box's content is cleared.

Definition at line 251 of file kexirecordnavigator.cpp.

◆ setEditingIndicatorEnabled

void KexiRecordNavigator::setEditingIndicatorEnabled ( bool  set)
slot

Sets visibility of the place where "editing" indicator will be displayed. "editing" indicator will display KexiRecordMarker::penImage() image when setEditingIndicatorVisible() is called. This method is currently used e.g. within standard kexi forms (see KexiFormScrollView class).

Definition at line 426 of file kexirecordnavigator.cpp.

◆ setEnabled

void KexiRecordNavigator::setEnabled ( bool  set)
virtualslot

Definition at line 186 of file kexirecordnavigator.cpp.

◆ setHBarGeometry()

void KexiRecordNavigator::setHBarGeometry ( TQScrollBar &  hbar,
int  x,
int  y,
int  w,
int  h 
)

Sets horizontal bar's hbar (at the bottom) geometry so this record navigator is properly positioned together with horizontal scroll bar. This method is used in TQScrollView::setHBarGeometry() implementations: see KexiTableView::setHBarGeometry() and KexiFormScrollView::setHBarGeometry() for usage examples.

Definition at line 357 of file kexirecordnavigator.cpp.

◆ setInsertingButtonVisible

void KexiRecordNavigator::setInsertingButtonVisible ( bool  set)
slot

Sets visibility of "inserting" button.

Definition at line 367 of file kexirecordnavigator.cpp.

◆ setInsertingEnabled

void KexiRecordNavigator::setInsertingEnabled ( bool  set)
slot

Sets insertingEnabled flag. If true, "+" button will be enabled.

Definition at line 177 of file kexirecordnavigator.cpp.

◆ setLabelText

void KexiRecordNavigator::setLabelText ( const TQString &  text)
slot

Sets label text at the left of the for record navigator's button. By default this label contains translated "Row:" text.

Definition at line 362 of file kexirecordnavigator.cpp.

◆ setParentView()

void KexiRecordNavigator::setParentView ( TQScrollView *  view)

Definition at line 329 of file kexirecordnavigator.cpp.

◆ setRecordCount

void KexiRecordNavigator::setRecordCount ( uint  count)
slot

Sets record count for this navigator. This can also affect button's enabling and disabling. By default count is 0.

Definition at line 284 of file kexirecordnavigator.cpp.

◆ setRecordHandler()

void KexiRecordNavigator::setRecordHandler ( KexiRecordNavigatorHandler *  handler)

Sets record navigator handler. This allows to react on actions performed within navigator and vice versa.

Definition at line 411 of file kexirecordnavigator.cpp.

◆ showEditingIndicator

void KexiRecordNavigator::showEditingIndicator ( bool  show)
slot

Shows or hides "editing" indicator.

Definition at line 447 of file kexirecordnavigator.cpp.

◆ slotFirstButtonClicked

void KexiRecordNavigator::slotFirstButtonClicked ( )
protectedslot

Definition at line 396 of file kexirecordnavigator.cpp.

◆ slotLastButtonClicked

void KexiRecordNavigator::slotLastButtonClicked ( )
protectedslot

Definition at line 389 of file kexirecordnavigator.cpp.

◆ slotNewButtonClicked

void KexiRecordNavigator::slotNewButtonClicked ( )
protectedslot

Definition at line 403 of file kexirecordnavigator.cpp.

◆ slotNextButtonClicked

void KexiRecordNavigator::slotNextButtonClicked ( )
protectedslot

Definition at line 382 of file kexirecordnavigator.cpp.

◆ slotPrevButtonClicked

void KexiRecordNavigator::slotPrevButtonClicked ( )
protectedslot

Definition at line 375 of file kexirecordnavigator.cpp.

◆ updateButtons()

void KexiRecordNavigator::updateButtons ( uint  recCnt)
protected

Definition at line 272 of file kexirecordnavigator.cpp.

◆ updateGeometry

void KexiRecordNavigator::updateGeometry ( int  leftMargin)
slot

Definition at line 334 of file kexirecordnavigator.cpp.

Member Data Documentation

◆ d

KexiRecordNavigatorPrivate* KexiRecordNavigator::d
protected

Definition at line 188 of file kexirecordnavigator.h.

◆ m_isInsertingEnabled

bool KexiRecordNavigator::m_isInsertingEnabled
protected

Definition at line 186 of file kexirecordnavigator.h.

◆ m_nav1DigitWidth

uint KexiRecordNavigator::m_nav1DigitWidth
protected

Definition at line 183 of file kexirecordnavigator.h.

◆ m_navBtnFirst

TQToolButton* KexiRecordNavigator::m_navBtnFirst
protected

Definition at line 175 of file kexirecordnavigator.h.

◆ m_navBtnLast

TQToolButton* KexiRecordNavigator::m_navBtnLast
protected

Definition at line 178 of file kexirecordnavigator.h.

◆ m_navBtnNew

TQToolButton* KexiRecordNavigator::m_navBtnNew
protected

Definition at line 179 of file kexirecordnavigator.h.

◆ m_navBtnNext

TQToolButton* KexiRecordNavigator::m_navBtnNext
protected

Definition at line 177 of file kexirecordnavigator.h.

◆ m_navBtnPrev

TQToolButton* KexiRecordNavigator::m_navBtnPrev
protected

Definition at line 176 of file kexirecordnavigator.h.

◆ m_navRecordCount

KLineEdit* KexiRecordNavigator::m_navRecordCount
protected

readonly counter

Definition at line 182 of file kexirecordnavigator.h.

◆ m_navRecordNumber

KLineEdit* KexiRecordNavigator::m_navRecordNumber
protected

Definition at line 180 of file kexirecordnavigator.h.

◆ m_navRecordNumberValidator

TQIntValidator* KexiRecordNavigator::m_navRecordNumberValidator
protected

Definition at line 181 of file kexirecordnavigator.h.

◆ m_textLabel

TQLabel* KexiRecordNavigator::m_textLabel
protected

Definition at line 174 of file kexirecordnavigator.h.

◆ m_view

TQScrollView* KexiRecordNavigator::m_view
protected

Definition at line 185 of file kexirecordnavigator.h.

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