1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
|
/***************************************************************************
viewinterface.h
-------------------
begin : Wed Jan 5 2005
copyright : (C) 2005 Thomas Baumgart
email : [email protected]
***************************************************************************/
/***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************/
#ifndef VIEWINTERFACE_H
#define VIEWINTERFACE_H
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
// ----------------------------------------------------------------------------
// QT Includes
#include <tqobject.h>
#include <tqstring.h>
#include <tqpixmap.h>
class TQFrame;
// ----------------------------------------------------------------------------
// KDE Includes
class KPopupMenu;
// ----------------------------------------------------------------------------
// Project Includes
#include <kmymoney/mymoneyaccount.h>
#include <kmymoney/mymoneyinstitution.h>
#include <kmymoney/export.h>
class KMyMoneyViewBase;
namespace KMyMoneyRegister {
class SelectedTransactions;
};
namespace KMyMoneyPlugin {
/**
* This abstract class represents the ViewInterface to
* add new view pages to the JanusWidget of KMyMoney. It
* also gives access to the account context menu.
*/
class KMYMONEY_EXPORT ViewInterface : public TQObject {
Q_OBJECT
public:
ViewInterface(TQObject* parent, const char* name = 0);
~ViewInterface() {}
/**
* This method creates a new page in the application.
* See KJanusWidget::addPage() for details.
*/
virtual KMyMoneyViewBase* addPage(const TQString& item, const TQString& icon) = 0;
/**
* This method adds a widget to the layout of the view
* created with addPage()
*
* @param view pointer to view widget
* @param w widget to be added to @p page
*/
virtual void addWidget(KMyMoneyViewBase* view, TQWidget* w) = 0;
signals:
/**
* This signal is emitted when a new account has been selected by
* the GUI. If no account is selected or the selection is removed,
* @a account is identical to MyMoneyAccount(). This signal is used
* by plugins to get information about changes.
*/
void accountSelected(const MyMoneyAccount& acc);
/**
* This signal is emitted when a transaction/list of transactions has been selected by
* the GUI. If no transaction is selected or the selection is removed,
* @p transactions is identical to an empty TQValueList. This signal is used
* by plugins to get information about changes.
*/
void transactionsSelected(const KMyMoneyRegister::SelectedTransactions& transactions);
/**
* This signal is emitted when a new institution has been selected by
* the GUI. If no institution is selected or the selection is removed,
* @a institution is identical to MyMoneyInstitution(). This signal is used
* by plugins to get information about changes.
*/
void institutionSelected(const MyMoneyInstitution& institution);
/**
* This signal is emitted when an account has been successfully reconciled
* and all transactions are updated in the engine. It can be used by plugins
* to create reconciliation reports.
*
* @param account the account data
* @param date the reconciliation date as provided through the dialog
* @param startingBalance the starting balance as provided through the dialog
* @param endingBalance the ending balance as provided through the dialog
* @param transactionList reference to TQValueList of TQPair containing all
* transaction/split pairs processed by the reconciliation.
*/
void accountReconciled(const MyMoneyAccount& account, const TQDate& date, const MyMoneyMoney& startingBalance, const MyMoneyMoney& endingBalance, const TQValueList<TQPair<MyMoneyTransaction, MyMoneySplit> >& transactionList);
void viewStateChanged(bool);
void kmmFilePlugin(unsigned int);
};
}; // namespace
#endif
|
