Widget.h

Go to the documentation of this file.

#line 2 "src/Gui/AccountRegister/Widget.h"
 
#ifndef __GUI_ACCOUNTREGISTER_WIDGET_H___
#define __GUI_ACCOUNTREGISTER_WIDGET_H___
 
#include <Wt/Json/Object.h>
#include <Wt/WBatchEditProxyModel.h>
#include <Wt/WContainerWidget.h>
#include <Wt/WSortFilterProxyModel.h>
#include <Wt/WStandardItem.h>
#include <Wt/WStandardItemModel.h>
#include <Wt/WItemDelegate.h>
#include <Wt/WPopupMenu.h>
 
#include "../../GnuCashew.h"
#include "../TableView.h"
#include "Model.h"
#include "StatusBar.h"
#include "ToolBar.h"
#include "Editor.h"
 
namespace GCW {
  namespace Gui {
 
    /*!
    ** \brief Account Register
    **
    ** The Account Register
    **
    **
    */
    namespace AccountRegister {
 
/*!
** \brief AccountRegister
**
** The AccountRegister is a widget that displays transactions from a single account
**  within the system.  It displays the account transactions in a spreadsheet-table-like
**  format with multiple columns representing other field values such as;
**  date, check-number, description... and so on.
**
** \image html AccountRegister.png "Account Register" width=480
**
** The goal here is to make this widget behave just as closely as possible to the
**  GnuCash interface, because gnucash is very slick and makes navigating the register
**  a no-mouse-necessary affair.  One of the problems with web-based interfaces, however,
**  is trapping keys completely, such as the ~tab~ key.  So... we'll see how this
**  goes!
**
** The register view also grants the user editing abilities.  When the user clicks on
**  fields that are ~not~ reconciled, and appropriate 'editor' will open.  The editor
**  depends on the column selected, and is generated by the column Delegates.
*/
class Widget
: public Wt::WContainerWidget
{
  private:
 
  public:
 
    /*!
    ** \brief Model
    **
    ** An alias for the Model in case this interface changes.
    */
    using BaseModel       = Model                     ;
    using SortFilterModel = Wt::WSortFilterProxyModel ;
    using BatchEditModel  = Wt::WBatchEditProxyModel  ;
 
    /*!
    ** \brief Constructor
    **
    */
    Widget();
 
    /*!
    ** \brief Set Account
    **
    ** This sets the GUD of the account being represented by this
    **  view
    */
    auto setAccountGuid( const std::string & _accountGuid )-> void ;
 
    auto setDoubleLine( bool _state )-> void ;
 
    /*!
    ** \brief Table View
    */
    auto tableView ()-> GCW::Gui::TableView * { return m_tableView; }
 
    auto baseModel       ()-> std::shared_ptr< BaseModel       >  { return m_baseModel;       }
    auto sortFilterModel ()-> std::shared_ptr< SortFilterModel >  { return m_sortFilterModel; }
    auto batchEditModel  ()-> std::shared_ptr< BatchEditModel  >  { return m_batchEditModel;  }
 
    /*!
    ** \brief Status Bar
    **
    ** This returns a pointer to the status bar
    */
    auto statusBar()-> StatusBar * { return m_statusBar; }
 
    auto test()-> void ;
 
    /*!
    ** \brief Set Read Only
    **
    ** This makes the register view read-only
    */
    auto setReadOnly( bool _state = true )-> void ;
 
    /*!
    ** \brief Signal JumpToAccount
    **
    ** This signals when the user has clicked on the
    **  jump to account menu option.
    */
    auto jumpToAccount()-> Wt::Signal< std::string > & { return m_jumpToAccount; }
 
    /*!
    ** \brief Select Split
    **
    */
    auto selectSplit( const std::string & _guid )-> void ;
 
    /*!
    ** \brief Create View Properties JSON Object
    **
    ** This will pack all of the Widget display variables in to a JSON
    **  object for restoration later.
    **
    ** \sa fromJson()
    */
    auto toJson() const-> Wt::Json::Object ;
 
    /*!
    ** \brief Set View Properties from JSON Object
    **
    ** This accepts a JSON object containing all of the view properties
    **  and applys them to the view, essentially restoring it
    **  to its previous layout.
    */
    auto fromJson( const Wt::Json::Object & _jobj )-> bool ;
 
  private:
 
    /*!
    ** \brief Internal Initializer
    **
    ** This takes care of all the basic initialization stuff.
    */
    auto init()-> void ;
 
    /*!
    ** \brief Editor Helper
    **
    */
//    auto editor()-> Editor & { return m_editor; }
 
    /*!
    ** \brief Load the Data
    **
    ** This loads all of the transactions in to the register.
    */
    auto loadData()-> void ;
 
    /*!
    ** \brief Select Row
    **
    ** This selects the row based on it's row number.
    */
    auto do_selectRow( Wt::WModelIndex _index )-> void ;
 
    /*!
    ** \brief Edit Row
    **
    ** This edits the row based on it's row number.
    */
    auto editRow( Wt::WModelIndex _index )-> void ;
 
 
    /*!
    ** \brief Delete Row
    **
    ** This Deletes a row based on it's row number.
    */
    auto deleteRow( int _row )-> void ;
 
    /*!
    ** \brief Last Index
    **
    ** This returns the last index in the model.
    */
    auto lastIndex()-> Wt::WModelIndex ;
 
    /*!
    ** \brief Show Popup
    **
    ** This responds to a mouse-right-click within the table view.
    **  When triggered, this will pop-up an environment-sensitive
    **  menu that the user can choose actions from.  The context
    **  sensitivity is driven by the type of item that is on the
    **  row that the cursor was on with the click event was
    **  triggered.
    */
    auto on_showPopup_triggered( const Wt::WModelIndex & _index, const Wt::WMouseEvent & _event )-> void ;
 
    auto on_sortBy_triggered()-> void ;
    auto on_filterBy_triggered()-> void ;
    auto on_renamePage_triggered()-> void ;
    auto on_duplicate_triggered()-> void ;
 
    /*!
    ** \brief Delete a Row
    **
    ** This will delete a row from the register
    */
    auto on_delete_triggered()-> void ;
 
    /*!
    ** \brief Remove Splits
    **
    ** This will remove the splits from the transaction
    */
    auto on_removeSplits_triggered()-> void ;
 
    /*!
    ** \brief Enter Transaction
    **
    ** This will enter the transaction, just like if the user
    **  hit the ENTER key
    */
    auto on_enter_triggered()-> void ;
 
    /*!
    ** \brief Cancel Transaction
    **
    ** This will cancel the edits on the transaction.  This
    **  would be the same if the user hit the <esc> key
    */
    auto on_cancel_triggered()-> void ;
 
    /*!
    ** \brief Manage Document
    **
    ** This opens a dialog that allows the user to attach
    **  a document to the transaction
    */
    auto on_manageDocument_triggered()-> void ;
 
    /*!
    ** \brief Open Document
    **
    ** This allows the user to open the document attached
    **  to the transaction
    */
    auto on_openDocument_triggered()-> void ;
 
    /*!
    ** \brief Blank Transaction
    **
    ** This will blank all the values in a transaction
    */
    auto on_blankTransaction_triggered()-> void ;
 
    /*!
    ** \brief Go to Date
    **
    ** This will jump to a specific date within the register view
    */
    auto on_goDate_triggered()-> void ;
 
    /*!
    ** \brief Split Transaction
    **
    ** This will split the current transaction
    */
    auto on_splitTransaction_triggered()-> void ;
 
    /*!
    ** \brief Edit Exchange Rate
    **
    ** This will edit the exchange rate on the transaction
    */
    auto on_editExchangeRate_triggered()-> void ;
 
    /*!
    ** \brief Schedule a Transaction
    **
    ** This will set up a scheduled transaction
    */
    auto on_schedule_triggered()-> void ;
 
    /*!
    ** \brief Jump to Transaction
    **
    ** This will jump to the other side of the transaction
    */
    auto on_jump_triggered()-> void ;
 
    /*!
    ** \brief Edit to Transaction
    **
    ** This will Edit to the other side of the transaction
    */
    auto on_edit_triggered()-> void ;
 
    /*!
    ** \brief Assign Payment
    **
    ** This allows the transaction to be assigned
    **  as a payment to an invoice
    */
    auto on_assignPayment_triggered()-> void ;
 
    /*!
    ** \brief Clicked Handler
    **
    ** This captures clicks within the table view
    */
    auto on_tableView_clicked( Wt::WModelIndex _index, Wt::WMouseEvent _event )-> void ;
 
//    Editor                                         m_editor                  ;
    Wt::WPopupMenu                                 m_popupMenu               ;
    std::string                                    m_accountGuid             ;
    std::shared_ptr< BaseModel                 >   m_baseModel               ;
    std::shared_ptr< Wt::WSortFilterProxyModel >   m_sortFilterModel         ;
    std::shared_ptr< Wt::WBatchEditProxyModel  >   m_batchEditModel          ;
    GCW::Gui::TableView                          * m_tableView     = nullptr ;
    StatusBar                                    * m_statusBar     = nullptr ;
    ToolBar                                      * m_toolBar       = nullptr ;
    Wt::WModelIndex                                m_selectIndex             ;
    Wt::WModelIndex                                m_clickedIndex            ;
    Wt::WModelIndex                                m_rightClickIndex         ;
    Wt::Signal< std::string >                      m_jumpToAccount           ;
 
};  // endclass AccountRegister
 
    }  // endnamespace AccountRegister {
  } // endnamespace Gui {
} // endnamespace GCW {
 
#endif // end __GUI_ACCOUNTREGISTER_H___