kMyMoneyAccountSelector Class Reference

#include <kmymoneyaccountselector.h>

Inheritance diagram for kMyMoneyAccountSelector:

Collaboration diagram for kMyMoneyAccountSelector:

[legend]List of all members.


Public Slots
void	slotSelectAllAccounts (void)
void	slotDeselectAllAccounts (void)
Public Member Functions
	kMyMoneyAccountSelector (QWidget parent=0, const char name=0, QWidget::WFlags flags=0, const bool createButtons=true)
virtual	~kMyMoneyAccountSelector ()
const QCStringList	accountList (const QValueList< MyMoneyAccount::accountTypeE > &list=QValueList< MyMoneyAccount::accountTypeE >()) const
void	setSelectionMode (QListView::SelectionMode mode)
virtual bool	match (const QRegExp &exp, QListViewItem *item) const
virtual bool	contains (const QString &txt) const
void	removeButtons (void)
Protected Slots
void	slotSelectIncomeCategories (void)
void	slotSelectExpenseCategories (void)
Protected Member Functions
int	loadSubAccounts (QListViewItem *parent, const QCStringList &list)
void	selectCategories (const bool income, const bool expense)
Protected Attributes
KPushButton *	m_allAccountsButton
KPushButton *	m_noAccountButton
KPushButton *	m_incomeCategoriesButton
KPushButton *	m_expenseCategoriesButton
QValueList< int >	m_typeList
QCStringList	m_accountList
Friends
class	AccountSet

Detailed Description

This class implements an account/category selector. It is based on a tree view. Using this widget, one can select one or multiple accounts depending on the mode of operation and the set of accounts selected to be displayed. (see setSelectionMode() and loadList() about the specifics of configuration).

Single selection mode
In this mode the widget allows to select a single entry out of the set of displayed accounts.

Multi selection mode
In this mode, the widget allows to select one or more entries out of the set of displayed accounts. Selection is performed by marking the account in the view.

Constructor & Destructor Documentation

kMyMoneyAccountSelector::kMyMoneyAccountSelector ( QWidget * parent = 0,

const char * name = 0,

QWidget::WFlags flags = 0,

const bool createButtons = true

)

virtual kMyMoneyAccountSelector::~kMyMoneyAccountSelector ( ) [virtual]

Member Function Documentation

const QCStringList kMyMoneyAccountSelector::accountList ( const QValueList< MyMoneyAccount::accountTypeE > & list = QValueList< MyMoneyAccount::accountTypeE >() ) const

This method returns a list of account ids of those accounts currently loaded into the widget. It is possible to select a list of specific account types only. In this case, pass a list of account types as parameter list.

Parameters:

list QValueList of account types to be returned. If this list is empty (the default), then the ids of all accounts will be returned.

Returns:
QCStringList of account ids

virtual bool kMyMoneyAccountSelector::contains ( const QString & txt ) const [virtual]

This method returns, if any of the items in the selector contains the text txt.

Parameters:

txt const reference to string to be looked for

Return values:

true exact match found

false no match found

Reimplemented from KMyMoneySelector.

int kMyMoneyAccountSelector::loadSubAccounts ( QListViewItem * parent,

const QCStringList & list

) [protected]

This method loads the list of subaccounts as found in the list and attaches them to the parent widget passed as parent.

Parameters:

parent pointer to parent widget

list QCStringList containing the ids of all subaccounts to load

Returns:
This method returns the number of accounts loaded into the list

virtual bool kMyMoneyAccountSelector::match ( const QRegExp & exp,

QListViewItem * item

) const [virtual]

This method checks if a given item matches the given regular expression exp.

Parameters:

exp const reference to a regular expression object

item pointer to QListViewItem

Return values:

true item matches

false item does not match

Reimplemented from KMyMoneySelector.

void kMyMoneyAccountSelector::removeButtons ( void )

This method removes all the buttons of the widget

void kMyMoneyAccountSelector::selectCategories ( const bool income,

const bool expense

) [protected]

This is a helper method for selectAllIncomeCategories() and selectAllExpenseCategories().

void kMyMoneyAccountSelector::setSelectionMode ( QListView::SelectionMode mode )

This method sets the mode of operation of this widget. Supported values are QListView::Single and QListView::Multi.

Parameters:

mode QListView::Single selects single selection mode and QListView::Multi selects multi selection mode

Note:
When the widget is created, it defaults to QListView::Single. Any items loaded into the widget will be cleared if the mode changes. Changing the selection mode also changes the type of the items created through newItem(). You should therefor set the selection mode before you create items.

Reimplemented from KMyMoneySelector.

void kMyMoneyAccountSelector::slotDeselectAllAccounts ( void ) [inline, slot]

This slot deselects all items that are currently in the account list of the widget.

void kMyMoneyAccountSelector::slotSelectAllAccounts ( void ) [inline, slot]

This slot selects all items that are currently in the account list of the widget.