X-Git-Url: https://git.novaco.in/?a=blobdiff_plain;f=src%2Fqt%2Ftransactionrecord.h;h=db29b94576ed1cc6276e734205dd569d9104e400;hb=21d9f36781604e4ca9fc35dc65265593423b73e9;hp=c196be2a9ebe398ca4f5d3bfd9463ec653cb9690;hpb=ceb6d4e11d8dab8a6778e20c433f6ed989c16221;p=novacoin.git

diff --git a/src/qt/transactionrecord.h b/src/qt/transactionrecord.h
index c196be2..db29b94 100644
--- a/src/qt/transactionrecord.h
+++ b/src/qt/transactionrecord.h
@@ -3,11 +3,14 @@
 
 #include "uint256.h"
 
+#include <QtGlobal>
 #include <QList>
 
 class CWallet;
 class CWalletTx;
 
+/** UI model for transaction status. The transaction status is the part of a transaction that will change over time.
+ */
 class TransactionStatus
 {
 public:
@@ -20,7 +23,7 @@ public:
     {
         Immature,
         Mature,
-        MaturesWarning, /* Will likely not mature because no nodes have confirmed */
+        MaturesWarning, /**< Transaction will likely not mature because no nodes have confirmed */
         NotAccepted
     };
 
@@ -35,19 +38,26 @@ public:
     bool confirmed;
     std::string sortKey;
 
-    /* For "Generated" transactions */
+    /** @name Generated (mined) transactions
+       @{*/
     Maturity maturity;
     int matures_in;
+    /**@}*/
 
-    /* Reported status */
+    /** @name Reported status
+       @{*/
     Status status;
-    int64 depth;
-    int64 open_for; /* Timestamp if status==OpenUntilDate, otherwise number of blocks */
+    qint64 depth;
+    qint64 open_for; /**< Timestamp if status==OpenUntilDate, otherwise number of blocks */
+    /**@}*/
 
-    /* Current number of blocks (to know whether cached status is still valid. */
+    /** Current number of blocks (to know whether cached status is still valid) */
     int cur_num_blocks;
 };
 
+/** UI model for a transaction. A core transaction can be represented by multiple UI transactions if it has
+    multiple outputs.
+ */
 class TransactionRecord
 {
 public:
@@ -62,7 +72,7 @@ public:
         SendToSelf
     };
 
-    /* Number of confirmation needed for transaction */
+    /** Number of confirmation needed for transaction */
     static const int NumConfirmations = 6;
 
     TransactionRecord():
@@ -70,44 +80,49 @@ public:
     {
     }
 
-    TransactionRecord(uint256 hash, int64 time):
+    TransactionRecord(uint256 hash, qint64 time):
             hash(hash), time(time), type(Other), address(""), debit(0),
             credit(0), idx(0)
     {
     }
 
-    TransactionRecord(uint256 hash, int64 time,
+    TransactionRecord(uint256 hash, qint64 time,
                 Type type, const std::string &address,
-                int64 debit, int64 credit):
+                qint64 debit, qint64 credit):
             hash(hash), time(time), type(type), address(address), debit(debit), credit(credit),
             idx(0)
     {
     }
 
-    /* Decompose CWallet transaction to model transaction records.
+    /** Decompose CWallet transaction to model transaction records.
      */
     static bool showTransaction(const CWalletTx &wtx);
     static QList<TransactionRecord> decomposeTransaction(const CWallet *wallet, const CWalletTx &wtx);
 
-    /* Fixed */
+    /** @name Immutable transaction attributes
+      @{*/
     uint256 hash;
-    int64 time;
+    qint64 time;
     Type type;
     std::string address;
-    int64 debit;
-    int64 credit;
+    qint64 debit;
+    qint64 credit;
+    /**@}*/
 
-    /* Subtransaction index, for sort key */
+    /** Subtransaction index, for sort key */
     int idx;
 
-    /* Status: can change with block chain update */
+    /** Status: can change with block chain update */
     TransactionStatus status;
 
-    /* Update status from wallet tx.
+    /** Return the unique identifier for this transaction (part) */
+    std::string getTxID();
+
+    /** Update status from core wallet tx.
      */
     void updateStatus(const CWalletTx &wtx);
 
-    /* Is a status update needed?
+    /** Return whether a status update is needed.
      */
     bool statusUpdateNeeded();
 };