GnuCashew ~ Web Application compatible with GnuCash sql data files.
GCW
Loading...
Searching...
No Matches
Classes | Typedefs | Enumerations | Functions
GCW::Gui::BillPay Namespace Reference

Bill Pay. More...

Classes

struct  COLUMNDEF
 
class  EditWidget
 Edit Widget. More...
 
class  EditWidgetDialog
 Edit Widget Dialog. More...
 
class  Item
 Bill Pay Item. More...
 
class  MainWidget
 Bill Pay Widget. More...
 
class  PaymentWidget
 Payment Widget. More...
 
class  PaymentWidgetDialog
 Edit Widget Dialog. More...
 
class  SummaryWidget
 Summary Widget. More...
 
class  TableModel
 Data Model. More...
 
class  TableView
 Table View. More...
 
class  ToolBar
 Control Bar. More...
 

Typedefs

typedef struct GCW::Gui::BillPay::COLUMNDEF ColumnDef_t
 

Enumerations

enum class  Status { Unpaid , Pending , Paid , Inactive }
 Bill Status. More...
 

Functions

auto configItem () -> GCW::Dbo::Vars::Item::Ptr
 Config Item.
 
auto bpItems () -> std::vector< GCW::Gui::BillPay::Item >
 Bill Pay Items.
 
auto bpItem (const std::string &_guid) -> GCW::Gui::BillPay::Item
 Bill Pay Item.
 
auto toString (int _value) -> std::string
 Convert Integer to String.
 
auto exportAll () -> void
 
auto importAll () -> void
 
auto asString (Status _status) -> std::string
 Get Status as String.
 
auto asStyleClass (Status _status) -> std::string
 Get Status as Style Class.
 

Detailed Description

Bill Pay.

This tool provides an interface for paying bills. The intent of the interface is to present bills that are due within a specific period of time, with thier due dates shown, and organized in to sets of "not paid", "pending" and "paid".

Typedef Documentation

◆ ColumnDef_t

\Brief Model Column Definitions

This holds the column definitions for the Model and Table. It includes the field name, field width (for the table), alignment (also for the table). The tool tip is derived from the 'name' value and is applied to the table accordingly.

Enumeration Type Documentation

◆ Status

enum class GCW::Gui::BillPay::Status
strong

Bill Status.

Bills get loaded in to the model depending on their status. A bills status depends on the selected month, and the check-box status for that same month. The check-box values equate as follows;

  • unpaid == (no) unchecked
  • paid == (yes) checked
  • pending == (maybe) semi-checked
Note
these values are internal, not stored
Enumerator
Unpaid 

Unpaid Status.

Pending 

Pending Status.

Paid 

Paid Status.

Inactive 

Disabled Status.

Definition at line 26 of file Status.h.

Function Documentation

◆ asString()

auto GCW::Gui::BillPay::asString ( Status  _status) -> std::string

Get Status as String.

This returns the 'string' representation of the status code.

Definition at line 6 of file Status.cpp.

References TR8.

Referenced by GCW::Gui::BillPay::TableModel::loadData().

◆ asStyleClass()

auto GCW::Gui::BillPay::asStyleClass ( Status  _status) -> std::string

Get Status as Style Class.

The style-class is used to alter the display rendering based on the status.

Definition at line 22 of file Status.cpp.

Referenced by GCW::Gui::BillPay::TableView::TableView().

◆ bpItem()

auto GCW::Gui::BillPay::bpItem ( const std::string &  _guid) -> GCW::Gui::BillPay::Item

◆ bpItems()

auto GCW::Gui::BillPay::bpItems ( ) -> std::vector< GCW::Gui::BillPay::Item >

Bill Pay Items.

This returns all bill pay items in a vector

Definition at line 18 of file BillPay.cpp.

References GCW_GUI_BILLPAY_ITEM_CFY, and GCW::Dbo::Vars::getByCfy().

Referenced by GCW::Gui::BillPay::TableModel::loadData().

◆ configItem()

auto GCW::Gui::BillPay::configItem ( ) -> GCW::Dbo::Vars::Item::Ptr

Config Item.

This returns the single 'config item' that contains the properties of the bill pay sub-system.

Definition at line 6 of file BillPay.cpp.

References GCW::app(), GCW_GUI_BILLPAY_CONFIG_CFY, and GCW::Dbo::Vars::get().

Referenced by GCW::Gui::BillPay::MainWidget::buildContent(), GCW::Gui::BillPay::MainWidget::setMonth(), and GCW::Gui::BillPay::ToolBar::ToolBar().

◆ exportAll()

auto GCW::Gui::BillPay::exportAll ( ) -> void

Definition at line 67 of file BillPay.cpp.

◆ importAll()

auto GCW::Gui::BillPay::importAll ( ) -> void

Definition at line 74 of file BillPay.cpp.

◆ toString()

auto GCW::Gui::BillPay::toString ( int  _value) -> std::string

Convert Integer to String.

This converts an integer in to a 2-character string. So, numbers less that 10 return "09", "08", "07"... as a string.

Definition at line 54 of file BillPay.cpp.

Referenced by GCW::Gui::BillPay::Item::cb(), GCW::Gui::BillPay::EditWidget::EditWidget(), GCW::Gui::BillPay::TableModel::loadData(), GCW::Gui::BillPay::Item::set_cb(), and GCW::Gui::BillPay::SummaryWidget::setMonth().