Improve documentation for UI classes

This commit is contained in:
Wladimir J. van der Laan
2011-11-13 13:19:52 +01:00
parent 66112ed6e6
commit af836ad588
28 changed files with 188 additions and 131 deletions

View File

@@ -4,29 +4,31 @@
#include <QSortFilterProxyModel>
#include <QDateTime>
// Filter transaction list according to pre-specified rules
/** Filter the transaction list according to pre-specified rules. */
class TransactionFilterProxy : public QSortFilterProxyModel
{
Q_OBJECT
public:
explicit TransactionFilterProxy(QObject *parent = 0);
// Earliest date that can be represented (far in the past)
/** Earliest date that can be represented (far in the past) */
static const QDateTime MIN_DATE;
// Last date that can be represented (far in the future)
/** Last date that can be represented (far in the future) */
static const QDateTime MAX_DATE;
// Type filter bit field (all types)
/** Type filter bit field (all types) */
static const quint32 ALL_TYPES = 0xFFFFFFFF;
static quint32 TYPE(int type) { return 1<<type; }
void setDateRange(const QDateTime &from, const QDateTime &to);
void setAddressPrefix(const QString &addrPrefix);
// Type filter takes a bitfield created with TYPE() or ALL_TYPES
/**
@note Type filter takes a bitfield created with TYPE() or ALL_TYPES
*/
void setTypeFilter(quint32 modes);
void setMinAmount(qint64 minimum);
// Set maximum number of rows returned, -1 if unlimited
/** Set maximum number of rows returned, -1 if unlimited. */
void setLimit(int limit);
int rowCount(const QModelIndex &parent = QModelIndex()) const;