File indexing completed on 2024-05-12 16:44:12

 /*
     SPDX-FileCopyrightText: 2007 Thomas Baumgart <ipwizard@users.sourceforge.net>
     SPDX-FileCopyrightText: 2017 Łukasz Wojniłowicz <lukasz.wojnilowicz@gmail.com>
     SPDX-License-Identifier: GPL-2.0-or-later
 */
 
 #ifndef KNEWACCOUNTWIZARD_H
 #define KNEWACCOUNTWIZARD_H
 
 // ----------------------------------------------------------------------------
 // QT Includes
 
 // ----------------------------------------------------------------------------
 // Project Includes
 
 #include "kmymoneywizard.h"
 
 class MyMoneyMoney;
 class MyMoneyPrice;
 class MyMoneyInstitution;
 class MyMoneyTransaction;
 class MyMoneySchedule;
 class MyMoneyAccount;
 
 /**
   * @author Thomas Baumgart
   */
 namespace NewAccountWizard
 {
 enum steps {
     StepInstitution = 1,
     StepAccount,
     StepBroker,
     StepDetails,
     StepPayments,
     StepFees,
     StepSchedule,
     StepPayout,
     StepParentAccount,
     StepFinish,
 };
 
 /**
 * @author Thomas Baumgart
 *
 * This class implements the new account wizard which is used to gather
 * the required information from the user to create a new account
 */
 class WizardPrivate;
 class Wizard : public KMyMoneyWizard
 {
     friend class AccountTypePage;
     friend class InstitutionPage;
     friend class BrokeragePage;
     friend class CreditCardSchedulePage;
     friend class GeneralLoanInfoPage;
     friend class LoanDetailsPage;
     friend class LoanPaymentPage;
     friend class LoanSchedulePage;
     friend class LoanPayoutPage;
     friend class HierarchyPage;
     friend class AccountSummaryPage;
 
     Q_OBJECT
     Q_DISABLE_COPY(Wizard)
 
 public:
     explicit Wizard(QWidget *parent = nullptr, bool modal = false, Qt::WindowFlags flags = 0);
     ~Wizard() override;
 
     /**
     * Returns the information about the account as entered by
     * the user.
     */
     const MyMoneyAccount& account();
 
     /**
     * Method to load the generated account information back into the widget
     */
     void setAccount(const MyMoneyAccount& acc);
 
     /**
     * Returns the information about the parent account as entered by
     * the user.
     * @note For now it's either fixed as Asset or Liability. We will provide
     * user selected parent accounts later.
     */
     MyMoneyAccount parentAccount();
 
     /**
     * Returns information about the schedule. If the returned value
     * equals MyMoneySchedule() then the user did not select to create
     * a schedule.
     */
     const MyMoneySchedule& schedule();
 
     /**
     * This method returns the value of the opening balance
     * entered by the user
     */
     MyMoneyMoney openingBalance() const;
 
     /**
     * This method returns the interest rate as factor, ie an
     * interest rate of 6.5% will be returned as 0.065
     */
     MyMoneyMoney interestRate() const;
 
     /**
     * This method returns the payout transaction for loans.
     * If the account to be created is not a loan or no
     * payout transaction should be generated, this method
     * returns an empty transaction.
     */
     MyMoneyTransaction payoutTransaction();
 
     /**
     * This method returns a MyMoneyAccount() object filled
     * with the data to create a brokerage account. If the
     * user selected not to create a brokerage account or
     * the account type is not able to create a brokerage
     * account, an empty MyMoneyAccount() object is returned.
     *
     * @note Make sure to call the account() method before you call this method.
     * Otherwise the returned object might contain unexpected results.
     */
     MyMoneyAccount brokerageAccount() const;
 
     /**
     * This method returns the conversion rate
     */
     MyMoneyPrice conversionRate() const;
 
     static void newAccount(MyMoneyAccount& account);
 
 Q_SIGNALS:
     void createAccount(MyMoneyAccount& account);
 
 public Q_SLOTS:
     void slotPayeeNew(const QString& txt, QString& id);
     void slotAccountNew(MyMoneyAccount& account);
 
 protected:
     /**
     * This method returns information about the selection of the user
     * if the loan is for borrowing or lending money.
     *
     * @retval true loan is for money borrowed
     * @retval false loan is for money lent
     */
     bool moneyBorrowed() const;
 
 private:
     Q_DECLARE_PRIVATE(Wizard)
 };
 
 } // namespace
 
 
 #endif