kmymoney2.h

Go to the documentation of this file.

/***************************************************************************
                          kmymoney2.h
                             -------------------
    copyright            : (C) 2000-2001 by Michael Edwardes
    email                : mte@users.sourceforge.net
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   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 KMYMONEY2_H
#define KMYMONEY2_H

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

// ----------------------------------------------------------------------------
// QT Includes

#include <qapplication.h>
class QTimer;
class QLabel;

// ----------------------------------------------------------------------------
// KDE Includes

#include <kapplication.h>
#include <kmainwindow.h>
#include <kaccel.h>
#include <kaction.h>
#include <kprocess.h>
#include <kurl.h>
#include <kfile.h>
#include <dcopobject.h>
class KComboBox;
class KPushButton;

// ----------------------------------------------------------------------------
// Project Includes

#include <kmymoney/mymoneyaccount.h>
#include <kmymoney/mymoneyscheduled.h>
#include <kmymoney/mymoneyinstitution.h>
#include <kmymoney/mymoneypayee.h>
#include <kmymoney/mymoneybudget.h>
#include <kmymoney/kmymoneyplugin.h>
#include <kmymoney/register.h>
#include <kmymoney/kmymoneyutils.h>

class QSignalMapper;
class KProgress;
class KMyMoneyView;
class MyMoneyQifReader;
class MyMoneyStatementReader;
class MyMoneyStatement;
class IMyMoneyStorage;
class KFindTransactionDlg;
class TransactionEditor;
class KEndingBalanceDlg;
class KPluginInfo;

namespace KMyMoneyPlugin { class ImporterPlugin; }

class KMyMoney2App : public KMainWindow, public DCOPObject
{
  Q_OBJECT
  K_DCOP

protected slots:
  void slotFileSaveAsFilterChanged(const QString& filter);

  void slotAutoSave(void);

  void slotEnableMessages(void);

  void slotFileFileInfo(void);

  void slotPerformanceTest(void);

  void slotToggleTraces(void);

  void slotToggleTimers(void);

  void slotFileViewPersonal(void);

  void slotQifImport(void);

  void slotQifImportFinished(void);

  void slotGncImport(void);

  void slotAccountChart(void);

  void slotStatementImport(void);

  void slotLoadAccountTemplates(void);
  void slotSaveAccountTemplates(void);

  void slotQifExport(void);

  void slotSettings(void);

  void slotFileBackup(void);

  void slotShowTipOfTheDay(void);

  void slotQifProfileEditor(void);

  void slotShowPreviousView(void);

  void slotShowNextView(void);

  void slotSecurityEditor(void);

  void slotFindTransaction(void);

  void slotCloseSearchDialog(void);

  void slotInstitutionEdit(const MyMoneyObject& obj = MyMoneyInstitution());

  void slotInstitutionDelete(void);

  void slotCategoryNew(const QString& name, QString& id);

  void slotPrintView(void);

  void slotInvestmentNew(void);

  void slotInvestmentNew(MyMoneyAccount& account, const MyMoneyAccount& parent);

  void slotInvestmentEdit(void);

  void slotInvestmentDelete(void);

  void slotOnlinePriceUpdate(void);

  void slotManualPriceUpdate(void);

  void slotUpdateConfiguration(void);

  void slotPayeeNew(const QString& newnameBase, QString& id);
  void slotPayeeNew(void);

  void slotPayeeDelete(void);

  void slotBudgetNew(void);

  void slotBudgetDelete(void);

  void slotBudgetCopy(void);

  void slotBudgetChangeYear(void);

  void slotBudgetForecast(void);

  void slotCurrencyNew(void);

  void slotCurrencyRename(QListViewItem* item, int, const QString& txt);

  void slotCurrencyDelete(void);

  void slotCurrencySetBase(void);

  void slotNewFeature(void);

  void slotTransactionsNew(void);

  void slotTransactionsEdit(void);

  void slotTransactionsEditSplits(void);

  void slotTransactionsDelete(void);

  void slotTransactionsEnter(void);

  void slotTransactionsCancel(void);

  void slotTransactionsCancelOrEnter(bool& okToSelect);

  void slotTransactionDuplicate(void);

  void slotToggleReconciliationFlag(void);

  void slotMarkTransactionCleared(void);

  void slotMarkTransactionReconciled(void);

  void slotMarkTransactionNotReconciled(void);

  void slotTransactionGotoAccount(void);

  void slotTransactionGotoPayee(void);

  void slotTransactionCreateSchedule(void);

  void slotTransactionAssignNumber(void);

  void slotTransactionCombine(void);

  void slotTransactionsAccept(void);

  void slotDateChanged(void);

  void slotDataChanged(void);

  void slotMoveToAccount(const QString& id);

  void slotUpdateMoveToAccountMenu(void);

  void slotScheduleNew(const MyMoneyTransaction& t, MyMoneySchedule::occurenceE occurence = MyMoneySchedule::OCCUR_MONTHLY);

  void slotScheduleDuplicate(void);

  void slotKDELanguageSettings(void);

  void slotAccountMapOnline(void);
  void slotAccountUnmapOnline(void);
  void slotAccountUpdateOnline(void);
  void slotAccountUpdateOnlineAll(void);

  void slotManageGpgKeys(void);
  void slotKeySelected(int idx);

public:
  void createInitialAccount(void);

  const KURL lastOpenedURL(void);

  KMyMoney2App(QWidget* parent=0, const char* name=0);

  ~KMyMoney2App();

  bool initWizard(void);

  static void progressCallback(int current, int total, const QString&);

  void writeLastUsedDir(const QString& directory);
  QString readLastUsedDir(void) const;
  void writeLastUsedFile(const QString& fileName);
  QString readLastUsedFile(void) const;

  bool isImportableFile( const KURL& url );

  void updateCaption(bool skipActions = false);

  const QValueList<QCString> instanceList(void) const;

  void dumpActions(void) const;

  void showContextMenu(const QString& containerName);

  void createCategory(MyMoneyAccount& account, const MyMoneyAccount& parent);

  const MyMoneyAccount& account(const QString& key, const QString& value) const;

  void setAccountOnlineParameters(const MyMoneyAccount& acc, const MyMoneyKeyValueContainer& kvps);

  KURL selectFile(const QString& title, const QString& path, const QString& mask, KFile::Mode mode);

  const MyMoneyAccount& findAccount(const MyMoneyAccount& acc, const MyMoneyAccount& parent) const;

  void createAccount(MyMoneyAccount& newAccount, MyMoneyAccount& parentAccount, MyMoneyAccount& brokerageAccount, MyMoneyMoney openingBal);

k_dcop:
  // Note: Don't use e.g. filename(void) but use filename() because
  // otherwise the kidl compiler produces uncompilable results.
  const QString filename() const;

  void webConnect(const QString&, const QCString& asn_id);

  bool okToWriteFile(const KURL& url);

  // QValueList<MyMoneyAccount> accountList() const;

protected:
  void saveOptions(void);

  void createInterfaces(void);

  void loadPlugins(void);

  void readOptions(void);

  void initActions(void);

  void initDynamicMenus(void);

  void initStatusBar(void);

  virtual bool queryClose(void);

  virtual bool queryExit(void);

  void slotCheckSchedules(void);

  virtual void resizeEvent(QResizeEvent*);

  void createSchedule(MyMoneySchedule newSchedule, MyMoneyAccount& newAccount);

  bool canCloseAccount(const MyMoneyAccount& acc) const;

  bool payeeInList(const QValueList<MyMoneyPayee>& list, const QString& id) const;

  void markTransaction(MyMoneySplit::reconcileFlagE flag);

  KMyMoneyUtils::EnterScheduleResultCodeE enterSchedule(MyMoneySchedule& s, bool autoEnter = false, bool extendedKeys = false);

  void createInstitution(MyMoneyInstitution& institution);

  void transactionUnmatch(void);

  void transactionMatch(void);

public slots:
  void slotFileInfoDialog(void);

  void slotFileNew(void);

  void slotFileNewWindow(void);

  void slotFileOpen(void);

  void slotFileOpenRecent(const KURL& url);

  void slotOpenDatabase(void);

  bool slotFileSave(void);

  bool slotFileSaveAs(void);

  bool slotSaveAsDatabase(void);

  void slotFileCloseWindow(void);

  void slotFileClose(void);

  void slotFileQuit(void);

  void slotFileConsitencyCheck(void);

  void slotPriceDialog(void);

  void slotCurrencyDialog(void);

  void slotHideReconciledTransactions(void);

  void slotHideUnusedCategories(void);

  void slotShowAllAccounts(void);


  const QString slotStatusMsg(const QString &text);

  void slotStatusProgressBar(int current, int total = 0);

  void slotProcessExited(void);

  void slotEquityPriceUpdate(void);

  bool slotStatementImport(const MyMoneyStatement& s);

  bool slotStatementImport(const QString& url);

  void slotAccountReconcileStart(void);

  void slotAccountReconcileFinish(void);

  void slotAccountReconcilePostpone(void);

  void slotAccountDelete(void);

  void slotAccountEdit(void);

  void slotAccountOpen(const MyMoneyObject& = MyMoneyAccount());

  void slotAccountClose(void);

  void slotAccountReopen(void);

  void slotReparentAccount(const MyMoneyAccount& src, const MyMoneyAccount& dest);

  void slotReparentAccount(const MyMoneyAccount& src, const MyMoneyInstitution& dest);

  void slotAccountTransactionReport(void);

  void slotShowAccountContextMenu(const MyMoneyObject&);

  void slotShowScheduleContextMenu(void);

  void slotShowInstitutionContextMenu(const MyMoneyObject&);

  void slotShowInvestmentContextMenu(void);

  void slotShowPayeeContextMenu(void);

  void slotShowBudgetContextMenu(void);

  void slotShowTransactionContextMenu(void);

  void slotShowCurrencyContextMenu(void);

  void slotScheduleNew(void);

  void slotScheduleEdit(void);

  void slotScheduleDelete(void);

  void slotScheduleEnter(void);

  void slotScheduleSkip(void);

  void slotToolsStartKCalc(void);

  void slotResetSelections(void);

  void slotSelectAccount(const MyMoneyObject& account = MyMoneyAccount());

  void slotSelectInstitution(const MyMoneyObject& institution = MyMoneyInstitution());

  void slotSelectInvestment(const MyMoneyObject& account = MyMoneyAccount());

  void slotSelectSchedule(const MyMoneySchedule& schedule = MyMoneySchedule());

  void slotSelectPayees(const QValueList<MyMoneyPayee>& list);

  void slotSelectBudget(const QValueList<MyMoneyBudget>& list);

  void slotSelectTransactions(const KMyMoneyRegister::SelectedTransactions& list);

  void slotSelectCurrency(const MyMoneySecurity& currency = MyMoneySecurity());

  void slotTransactionMatch(void);

  void slotAccountNew(void);
  void slotAccountNew(MyMoneyAccount&);

  void slotCategoryNew(void);

  void slotCategoryNew(MyMoneyAccount& account, const MyMoneyAccount& parent = MyMoneyAccount());

  void slotUpdateActions(void);

  void slotInstitutionNew(void);

  void slotInstitutionNew(MyMoneyInstitution& institution);

  void slotPluginPlug(KPluginInfo*);

  void slotPluginUnplug(KPluginInfo*);

private:
  // bool verifyImportedData(const MyMoneyAccount& account);

  void ready(void);

  bool isReady(void);

  void deleteTransactionEditor(void);

  void doDeleteTransactions(void);

  bool exchangeAccountInTransaction(MyMoneyTransaction& _t, const QString& fromId, const QString& toId);

signals:
  void fileLoaded(const KURL& url);

  void payeesSelected(const QValueList<MyMoneyPayee>& payees);

  void transactionsSelected(const KMyMoneyRegister::SelectedTransactions& transactions);

  void selectAllTransactions(void);

  void budgetSelected(const QValueList<MyMoneyBudget>& budget);
  void budgetRename(void);

  void accountSelected(const MyMoneyAccount& account);
  void investmentSelected(const MyMoneyAccount& account);

  void institutionSelected(const MyMoneyInstitution& institution);

  void scheduleSelected(const MyMoneySchedule& schedule);

  void currencySelected(const MyMoneySecurity& currency);

  void payeeRename(void);
  void payeeCreated(const QString& id);

  void currencyRename(void);
  void currencyCreated(const QString& id);

  void startMatchTransaction(const MyMoneyTransaction& t);
  void cancelMatchTransaction(void);

  void accountReconciled(const MyMoneyAccount& account, const QDate& date, const MyMoneyMoney& startingBalance, const MyMoneyMoney& endingBalance, const QValueList<QPair<MyMoneyTransaction, MyMoneySplit> >& transactionList);

public:
  KAction* action(const QString& actionName) const;

  KToggleAction* toggleAction(const QString& actionName) const;


private:
  class Private;
  /*
   * Actually, one should write "Private * const d" but that confuses the KIDL
   * compiler in this context. It complains about the const keyword. So we leave
   * it out here
   */
  Private* d;

  KConfig *config;

  QMap<QString,KMyMoneyPlugin::ImporterPlugin*> m_importerPlugins;

  QMap<QString, KMyMoneyPlugin::OnlinePlugin*> m_onlinePlugins;

  enum backupStateE {
    BACKUP_IDLE = 0,
    BACKUP_MOUNTING,
    BACKUP_COPYING,
    BACKUP_UNMOUNTING
  };
  backupStateE   m_backupState;

  int     m_backupResult;

  bool    m_backupMount;

  KProcess proc;

  KMyMoneyView *myMoneyView;

  KURL  m_fileName;

  bool m_startDialog;
  QString m_mountpoint;

  KProgress* progressBar;

  QString m_statusMsg;

  int m_progressUpdate;
  int m_nextUpdate;

  MyMoneyQifReader* m_qifReader;
  MyMoneyStatementReader* m_smtReader;
  KFindTransactionDlg* m_searchDlg;

  bool m_bCheckSchedules;

  KToolBarPopupAction*  m_previousViewButton;
  KToolBarPopupAction*  m_nextViewButton;

  QObject*              m_pluginInterface;

  MyMoneyAccount        m_selectedAccount;
  MyMoneyAccount        m_reconciliationAccount;
  MyMoneyAccount        m_selectedInvestment;
  MyMoneyInstitution    m_selectedInstitution;
  MyMoneySchedule       m_selectedSchedule;
  MyMoneySecurity       m_selectedCurrency;
  QValueList<MyMoneyPayee>  m_selectedPayees;
  QValueList<MyMoneyBudget> m_selectedBudgets;
  KMyMoneyRegister::SelectedTransactions m_selectedTransactions;

  // This is Auto Saving related
  bool                  m_autoSaveEnabled;
  QTimer*               m_autoSaveTimer;
  int                   m_autoSavePeriod;
  bool                  m_inAutoSaving;

  // Pointer to the combo box used for key selection during
  // File/Save as
  KComboBox*            m_saveEncrypted;

  // pointer to the current transaction editor
  TransactionEditor*    m_transactionEditor;

  // Reconciliation dialog
  KEndingBalanceDlg*    m_endingBalanceDlg;

  // id's that need to be remembered
  QString               m_accountGoto, m_payeeGoto;

  QStringList           m_additionalGpgKeys;
  QLabel*               m_additionalKeyLabel;
  KPushButton*          m_additionalKeyButton;
};

extern  KMyMoney2App *kmymoney2;

class KMStatus
{
public:
  KMStatus (const QString &text);
  ~KMStatus();
private:
  QString m_prevText;
};

#define KMSTATUS(msg) KMStatus _thisStatus(msg)

#endif // KMYMONEY2_H