QtxListBox Class Reference

#include <QtxListBox.h>

Inheritance diagram for QtxListBox:

Public Slots
virtual void	setEditEnabled (bool)
virtual void	setDefaultEditAction (bool)
virtual void	setModificationEnabled (bool)
virtual void	clearValidator ()
virtual void	setValidator (const QValidator *)
virtual void	setContentsPos (int, int)

Signals
void	itemEdited (int)
void	itemEdited (QListWidgetItem *)
void	itemMoved (int, int)

Public Member Functions
	QtxListBox (QWidget *=0, const char *=0, Qt::WindowFlags=0)
virtual	~QtxListBox ()
bool	isEditEnabled () const
bool	defaultEditAction () const
bool	isModificationEnabled () const
QListWidgetItem *	editedItem () const
int	editedIndex () const
void	startEdition (const int)
void	startEdition (const QListWidgetItem *)
void	endEdition (const bool)
void	ensureItemVisible (const int)
void	ensureItemVisible (const QListWidgetItem *)
virtual bool	eventFilter (QObject *, QEvent *)
const QValidator *	validator () const
void	moveItemToTop (const int)
void	moveItemToBottom (const int)
void	moveItem (const int, const int)
void	createItem (const int=-1)
void	deleteItem (const int=-1)

Protected Member Functions
virtual void	keyPressEvent (QKeyEvent *)
virtual void	viewportResizeEvent (QResizeEvent *)
virtual void	mouseDoubleClickEvent (QMouseEvent *)

Private Slots
void	onContentsMoving (int, int)

Private Member Functions
QLineEdit *	editor () const
void	createEditor ()
void	updateEditor ()

Private Attributes
QLineEdit *	myEditor
int	myEditIndex
bool	myEditState
bool	myEditDefault
bool	myModifEnabled

Constructor & Destructor Documentation

QtxListBox()

QtxListBox::QtxListBox	(	QWidget *	= 0,
		const char *	= 0,
		Qt::WindowFlags	= 0
	)

Constructor

References onContentsMoving().

~QtxListBox()

QtxListBox::~QtxListBox ( )

virtual

Destructor

Member Function Documentation

clearValidator

void QtxListBox::clearValidator ( )

virtualslot

Removes validator of item editor

References editor().

createEditor()

void QtxListBox::createEditor ( )

private

Creates item editor

References myEditor.

createItem()

void QtxListBox::createItem

(

const int

i = -1

)

Inserts empty item

Parameters

i	- position of item (if it is less than 0, then current position is used)

References isEditEnabled(), and startEdition().

defaultEditAction()

bool QtxListBox::defaultEditAction

(

)

const

Returns

default edit action

See also

setDefaultEditAction()

References myEditDefault.

deleteItem()

void QtxListBox::deleteItem

(

const int

i = -1

)

Removes item

Parameters

i	- position of item (if it is less than 0, then current position is used)

References defaultEditAction(), editedIndex(), endEdition(), isEditEnabled(), and updateEditor().

editedIndex()

int QtxListBox::editedIndex

(

)

const

Returns

current edited index

References myEditIndex.

editedItem()

QListBoxItem * QtxListBox::editedItem

(

)

const

Returns

current edited item

References editedIndex().

editor()

QLineEdit * QtxListBox::editor ( ) const

private

Returns

item editor

References createEditor(), and myEditor.

endEdition()

void QtxListBox::endEdition

(

const bool

action

)

Finishes edition of item

Parameters

action

- if it is true, then new values must be accepted

References editedIndex(), editor(), itemEdited(), and myEditIndex.

ensureItemVisible() [1/2]

void QtxListBox::ensureItemVisible

(

const int

idx

)

Ensures that the item is visible.

Parameters

idx	- index of item

ensureItemVisible() [2/2]

void QtxListBox::ensureItemVisible

(

const QListWidgetItem *

)

eventFilter()

bool QtxListBox::eventFilter ( QObject *  o, QEvent *  e  )

virtual

Custom event filter, performs finish of edition on focus out, escape/return/enter pressing

References defaultEditAction(), editor(), and endEdition().

isEditEnabled()

bool QtxListBox::isEditEnabled

(

)

const

Returns

true if editing is enabled

References myEditState.

isModificationEnabled()

bool QtxListBox::isModificationEnabled

(

)

const

Returns

modification enabled state

See also

setModificationEnabled()

References myModifEnabled.

itemEdited [1/2]

void QtxListBox::itemEdited ( int  )

signal

itemEdited [2/2]

void QtxListBox::itemEdited ( QListWidgetItem *  )

signal

itemMoved

void QtxListBox::itemMoved ( int  , int    )

signal

keyPressEvent()

void QtxListBox::keyPressEvent ( QKeyEvent *  e )

protectedvirtual

Custom key press event handler Allows to move items by CTRL + { Up, Down, Home, End }

References createItem(), deleteItem(), isModificationEnabled(), moveItem(), moveItemToBottom(), and moveItemToTop().

mouseDoubleClickEvent()

void QtxListBox::mouseDoubleClickEvent ( QMouseEvent *  e )

protectedvirtual

Custom mouse double click event handler

References isEditEnabled(), and startEdition().

moveItem()

void QtxListBox::moveItem	(	const int	idx,
		const int	step
	)

Moves item

Parameters

idx	- index of item
step	- changing of position

References itemMoved(), myEditIndex, and updateEditor().

moveItemToBottom()

void QtxListBox::moveItemToBottom

(

const int

idx

)

Moves item to bottom

Parameters

idx	- index of item

References moveItem().

moveItemToTop()

void QtxListBox::moveItemToTop

(

const int

idx

)

Moves item to top

Parameters

idx	- index of item

References moveItem().

onContentsMoving

void QtxListBox::onContentsMoving ( int  , int    )

privateslot

Updates editor on contents moving

References updateEditor().

setContentsPos

void QtxListBox::setContentsPos ( int  x, int  y  )

virtualslot

Scrolls the content so that the point is in the top-left corner.

Parameters

x,y	- point co-ordinates

References updateEditor().

setDefaultEditAction

void QtxListBox::setDefaultEditAction ( bool  def )

virtualslot

Changes default edit action. Pressing of ENTER button always accepts new value of edited item. But other ways, such as focus out or edition of other item accepts new value of edited item only if "default edit action" is true

Parameters

def	- new value

References myEditDefault.

setEditEnabled

void QtxListBox::setEditEnabled ( bool  on )

virtualslot

Enables/disables editing

Parameters

on	- new state

References defaultEditAction(), endEdition(), isEditEnabled(), and myEditState.

setModificationEnabled

void QtxListBox::setModificationEnabled ( bool  on )

virtualslot

Changes "modification enabled" state If it is true, then pressing of CTRL + { Up, Down, Home, End } allows move items in list

Parameters

on	- new state

References myModifEnabled.

setValidator

void QtxListBox::setValidator ( const QValidator *  v )

virtualslot

Changes validator of item editor

Parameters

v	- new validator

References editor().

startEdition() [1/2]

void QtxListBox::startEdition

(

const int

idx

)

Starts edition of item

Parameters

idx	- index of item

References defaultEditAction(), editedIndex(), editor(), endEdition(), ensureItemVisible(), isEditEnabled(), myEditIndex, and updateEditor().

startEdition() [2/2]

void QtxListBox::startEdition

(

const QListWidgetItem *

)

updateEditor()

void QtxListBox::updateEditor ( )

private

Updates item editor

References editedIndex(), editedItem(), and editor().

validator()

const QValidator * QtxListBox::validator

(

)

const

Returns

validator of item editor

References editor().

viewportResizeEvent()

void QtxListBox::viewportResizeEvent ( QResizeEvent *  e )

protectedvirtual

Custom resize event handler

References updateEditor().

Member Data Documentation

myEditDefault

bool QtxListBox::myEditDefault

private

myEditIndex

int QtxListBox::myEditIndex

private

myEditor

QLineEdit* QtxListBox::myEditor

private

myEditState

bool QtxListBox::myEditState

private

myModifEnabled

bool QtxListBox::myModifEnabled

private

---

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

• src/Qtx/QtxListBox.h
• src/Qtx/QtxListBox.cxx