Changeset 65 for trunk/src/helpers/dialog.c

Timestamp:

Apr 29, 2001, 2:10:31 PM (24 years ago)

Author:

umoeller

Message:

Misc fixes.

File:

• trunk/src/helpers/dialog.c (modified) (6 diffs)

trunk/src/helpers/dialog.c

@@ -400 +400 @@
 
 VOID ProcessColumn(PCOLUMNDEF pColumnDef,
-                   PROWDEF pOwningRow,
-                   PROCESSMODE ProcessMode,
+                   PROWDEF pOwningRow,          // in: current row from ProcessRow
+                   PROCESSMODE ProcessMode,     // in: processing mode (see ProcessAll)
                    PLONG plX,                   // in/out: PROCESS_CALC_POSITIONS only
                    PDLGPRIVATE pDlgData)
@@ -673 +673 @@
 /*
  *@@ ProcessRow:
- *
+ *      level-3 procedure (called from ProcessTable),
+ *      which in turn calls ProcessColumn for each column
+ *      in the row.
+ *
+ *      See ProcessAll for the meaning of ProcessMode.
  */
 
 VOID ProcessRow(PROWDEF pRowDef,
-                PTABLEDEF pOwningTable,
-                PROCESSMODE ProcessMode,
-                PLONG plY,
+                PTABLEDEF pOwningTable,     // in: current table from ProcessTable
+                PROCESSMODE ProcessMode,    // in: processing mode (see ProcessAll)
+                PLONG plY,                  // in/out: current y position (decremented)
                 PDLGPRIVATE pDlgData)
 {
@@ -727 +731 @@
 /*
  *@@ ProcessTable:
- *
- *      This routine is a bit sick because it can be
- *      called recursively if a nested table is found
- *      in a COLUMNDEF.
+ *      level-2 procedure (called from ProcessAll),
+ *      which in turn calls ProcessRow for each row
+ *      in the table (which in turn calls ProcessColumn
+ *      for each column in the row).
+ *
+ *      See ProcessAll for the meaning of ProcessMode.
+ *
+ *      This routine is a bit sick because it can even be
+ *      called recursively from ProcessColumn (!) if a
+ *      nested table is found in a COLUMNDEF.
  *
  *      With PROCESS_CALC_POSITIONS, pptl must specify
@@ -742 +752 @@
 VOID ProcessTable(PTABLEDEF pTableDef,
                   const CONTROLPOS *pcpTable,       // in: table position with PROCESS_CALC_POSITIONS
-                  PROCESSMODE ProcessMode,
+                  PROCESSMODE ProcessMode,          // in: processing mode (see ProcessAll)
                   PDLGPRIVATE pDlgData)
 {
@@ -783 +793 @@
 /*
  *@@ ProcessAll:
+ *      level-1 procedure, which in turn calls ProcessTable
+ *      for each root-level table found (which in turn
+ *      calls ProcessRow for each row in the table, which
+ *      in turn calls ProcessColumn for each column in
+ *      the row).
+ *
+ *      The first trick to formatting is that ProcessAll will
+ *      get three times, thus going down the entire tree three
+ *      times, with ProcessMode being set to one of the
+ *      following for each call (in this order):
  *
  *      -- PROCESS_CALC_SIZES: calculates the sizes
  *         of all tables, rows, columns, and controls.
  *
+ *         After this first call, we know all the sizes
+ *         only and then then calculate the positions.
+ *
  *      -- PROCESS_CALC_POSITIONS: calculates the positions
  *         based on the sizes calculated before.
@@ -793 +816 @@
  *         positions and sizes calculated before.
  *
+ *      The second trick is the precondition that tables may
+ *      nest by allowing a table definition instead of a
+ *      control definition in a column. This way we can
+ *      recurse from columns back into tables and thus
+ *      know the size and position of a nested table column
+ *      just as if it were a regular control.
  */