Model.h

Go to the documentation of this file.

#line 2 "src/Gui/AccountRegister/Model.h"
 
#ifndef __ENG_ACCOUNTREGISTER_MODEL_H___
#define __ENG_ACCOUNTREGISTER_MODEL_H___
 
#include <Wt/WDateTime.h>
#include <Wt/WStandardItemModel.h>
 
#include "../Glb/gcwglobal.h"
#include "ViewMode.h"
 
namespace GCW {
  namespace Eng {
    namespace Transaction {
      class Manager;
    } // endnamespace Transaction {
  } // endnamespace Eng {
 
  namespace Gui {
    namespace AccountRegister {
 
/*!
** \brief Account Register Model
**
** This model is used to present account details to the 'editor register' (the spreadsheet-looking
**  book-like-looking thing that the user posts transactions through.
*/
class Model
: public Wt::WStandardItemModel
{
  class ColumnSet
  : public std::vector< std::unique_ptr< Wt::WStandardItem > >
  {
    enum SetType
    {
      /// empty row, used for nothing, undefined (shouldn't happen?)
      EmptyRow  = 0x00,
 
      /// blank row, used for doubleLine
      BlankRow  = 0x01,
 
      /// basic Ledger row, everything on one line
      BasicRow  = 0x02,
 
      /// split Ledger row, multiple lines follow
      SplitRow  = 0x03,
 
      /// one of the split lines following SplitRow
      SplitLine = 0x04,
 
      /// row is condensed (using reduced columns, for small displays)
      Condensed = 0x08
 
    }; // endenum SetType
 
    public:
 
      ColumnSet()
      {
      }
 
      /*
      ** create an empty set for this type
      */
      ColumnSet( SetType _type )
      : m_type( _type )
      {}
 
      /*
      ** create a set on an existing row using the index
      */
      ColumnSet( Wt::WModelIndex _index )
      {
      }
 
      SetType m_type = EmptyRow ;
 
  }; // endclass ColumnSet
 
  using ColItem = Wt::WStandardItem * ;
 
  public:
 
    /*!
    ** \brief ctor
    **
    ** This constructs the model, empty.
    */
    Model() ;
 
    auto setAccountGuid( const std::string & _accountGuid )-> void ;
    auto refreshFromDisk()-> void ;
    auto applyDoubleLine()-> void ;
    auto saveToDisk()-> void ;
 
    auto viewMode() const-> ViewMode { return m_viewMode; }
    auto setViewMode( ViewMode _viewMode )-> void ;
 
    auto doubleLine() const-> bool { return m_doubleLine; }
    auto setDoubleLine( bool _doubleLine )-> void ;
 
    /*!
    ** \brief Split Count
    **
    ** This is ~slightly~ different than the rowCount() since
    **  rowCount will return the number of rows in the model, and
    **  splitCount will return the number of splits used to build
    **  the model.
    **
    */
    auto splitCount()-> int ;
 
    /*!
    ** \brief Is Deletable
    **
    ** This returns .true. if the item can be deleted.
    */
    auto isDeletable( const Wt::WModelIndex & _index )-> bool ;
 
    /*!
    ** \brief Is Jumpable
    **
    ** This returns .true. if the item can be jumped to
    **  the other account in the split
    */
    auto isJumpable( const Wt::WModelIndex & _index )-> bool ;
 
    auto isReadOnly()-> bool ;
    auto isReadOnly( int _row )-> bool ;
    auto isReadOnly( const Wt::WModelIndex & _index )-> bool ;
 
    auto setReadOnly( bool _state ) { m_readOnly = _state; }
 
    /*!
    ** \brief Get GUID from index
    **
    ** This will retrieve the GUID value from the row.
    */
    auto getSplitGuid( const Wt::WModelIndex & _index )-> std::string ;
 
    /*!
    ** \brief Get GUID from row
    **
    ** This will retrieve the GUID value from the row.
    */
    auto getSplitGuid( int _row )-> std::string ;
 
    /*!
    ** \brief Get Split Row
    **
    ** This will locate a split by its GUID and return the
    **  row number that it is a part of
    **
    */
    auto getSplitRow( const std::string & _guid )-> int ;
 
    /*!
    ** \brief Get Date from the index
    **
    ** This pulls the 'date' column out and returns it as a WDateTime
    **  value.
    **
    ** \note This will 'force' the 'time' component to be equal to
    **        the default time of '10:59:00', since the 'date' column
    **        does not support a time component... this seems to be
    **        consistent with GnuCash.
    */
    auto getDate( const Wt::WModelIndex & _index )-> Wt::WDateTime ;
 
    /*!
    ** \brief Get Action
    */
    auto getAction( const Wt::WModelIndex & _index )-> std::string ;
 
    /*!
    ** \brief Get Description
    */
    auto getDescription( const Wt::WModelIndex & _index )-> std::string ;
 
    /*!
    ** \brief Get Transfer Account Text
    */
    auto getTransferText( const Wt::WModelIndex & _index )-> std::string ;
 
    /*!
    ** \brief Get Transfer Account GUID
    */
    auto getTransferGuid( const Wt::WModelIndex & _index )-> std::string;
 
    /*!
    ** \brief Get Reconciliation
    */
    auto getReconcile( const Wt::WModelIndex & _index )-> std::string ;
 
    /*!
    ** \brief Get numeric value
    **
    ** This returns the numeric value of the line.  This is suitable
    **  for querying either the debit or credit column values (and is really
    **  intended for internal use).  The 'value' is pulled from the Display
    **  value of the index and converted to a GCW_NUMERIC value.
    */
    auto getNumeric( const Wt::WModelIndex & _index )-> GCW_NUMERIC ;
 
    /*!
    ** \brief Get Debit value
    */
    auto getDebit( const Wt::WModelIndex & _index )-> GCW_NUMERIC ;
 
    /*!
    ** \brief Get Credit value
    */
    auto getCredit( const Wt::WModelIndex & _index )-> GCW_NUMERIC ;
 
    /*!
    ** \brief Get Value (positive or negative)
    **
    ** The value that gets stored in the back-end database is either positive
    **  for debit, and negative for credit.  This function will read-out the
    **  debit and credit columns in the register display and figure out if
    **  the returned value should be returned positive or negative corrected.
    **
    ** This function always positive for debit, and negative for credit values.
    */
    auto getValue( const Wt::WModelIndex & _index )-> GCW_NUMERIC ;
 
    /*!
    ** \brief Get Balance (positive or negative)
    */
    auto getBalance ( const Wt::WModelIndex & _index )-> GCW_NUMERIC ;
 
    auto present    () const-> GCW_NUMERIC { return m_present    ; }
    auto future     () const-> GCW_NUMERIC { return m_future     ; }
    auto cleared    () const-> GCW_NUMERIC { return m_cleared    ; }
    auto reconciled () const-> GCW_NUMERIC { return m_reconciled ; }
    auto projected  () const-> GCW_NUMERIC { return m_projected  ; }
 
    auto makeColumnSet( const std::string & _splitGuid )-> ColumnSet ;
 
    /*!
    ** \brief Column Suggestions
    **
    ** This produces a unique-set of items that represent all the text-values
    **  for that particular column.  This is used to produce a suggestion-box
    **  for the register.
    */
    auto suggestionsFromColumn( int _column ) const-> std::set< std::string > ;
 
    auto setData( const Wt::WModelIndex & _index, const Wt::cpp17::any & _value, Wt::ItemDataRole _role )-> bool ;
 
    auto goneDirty()-> Wt::Signal< Wt::WModelIndex > & { return m_goneDirty; }
 
  private:
 
    auto setStyleClass( int _row, const std::string & _class )-> void ;
    auto removeStyleClass( int _row, const std::string & _class )-> void ;
 
    auto getString( const Wt::WModelIndex & _index, int column )-> std::string ;
 
    auto saveToDisk( const Wt::WModelIndex & _index )-> void ;
 
#ifdef NEVER
    template <typename T>
    bool matchValue( const Wt::cpp17::any & _any1, const Wt::cpp17::any & _any2 )
    {
      auto v1 = Wt::cpp17::any_cast< T >( _any1 ) ;
      auto v2 = Wt::cpp17::any_cast< T >( _any2 ) ;
      return v1 == v2;
    }
#endif
 
    /*
    ** Send a signal when a index is being updated
    **  because it was dirty.
    */
    Wt::Signal< Wt::WModelIndex > m_goneDirty ;
 
    /*
    ** keep track of rows as they go dirty.
    */
//    std::set< int > m_dirtyRows;
 
    /*!
    ** \brief Editable Indicator
    **
    ** The model can be either R/W (read-write) or R/O (read-only).
    */
    bool m_readOnly = false ;
 
    ViewMode m_viewMode   = ViewMode::BASIC_LEDGER ;
    bool     m_doubleLine = false ;
 
    /*!
    ** \brief Account GUID
    **
    ** The model is associated with a single account.
    */
    std::string m_accountGuid ;
 
    /*
    ** Keep track of the last date entered for pre-populating
    **  the next row.
    */
    Wt::WDateTime m_lastDate ;
 
/*!
** \brief Accumulators
**
** \todo these are additional values that need to be available
**
** \code
**   balance
**   balance limit
**   balance (Period)
**   balance usd
**   cleared
**   cleared usd
**   fiture minimum
**   future minimum usa
**   last num
**   last reconcile date
**   opening balance
**   present
**   present usd
**   reconciled reconciled usd
**   total total period
**   total usd
** \endcode
**
*/
 
    int         m_splitCount ; // different than rowCount depending on 'viewMode'
    GCW_NUMERIC m_balance    ;
    GCW_NUMERIC m_present    ;
    GCW_NUMERIC m_future     ;
    GCW_NUMERIC m_cleared    ;
    GCW_NUMERIC m_reconciled ;
    GCW_NUMERIC m_projected  ;
 
    friend class Eng::Transaction::Manager ;
 
}; // endclass Model
 
    } // namespace AccountRegister {
  } //  namespace Gui {
} // endnamespace GCW {
 
#endif // #ifndef __ENG_ACCOUNTREGISTER_MODEL_H___