Changeset 21 for trunk/include/helpers/cnrh.h

Timestamp:

Jan 8, 2001, 6:54:48 PM (25 years ago)

Author:

umoeller

Message:

Final changes for 0.9.7, i hope...

File:

• trunk/include/helpers/cnrh.h (modified) (12 diffs)

trunk/include/helpers/cnrh.h

@@ -39 +39 @@
     #endif
 
+    /*
+     *@@category: Helpers\PM helpers\Container helpers\Details view helpers
+     */
+
     /* ******************************************************************
      *
@@ -107 +111 @@
                                  ULONG ulFieldReturn);
 
+    /*
+     *@@category: Helpers\PM helpers\Container helpers\Record core helpers
+     */
+
     /* ******************************************************************
      *
@@ -174 +182 @@
         WinSendMsg(hwndCnr, CM_INVALIDATERECORD, NULL, MPFROM2SHORT(0, CMA_ERASE | CMA_REPOSITION | CMA_TEXTCHANGED))
 
+    /*
+     *@@category: Helpers\PM helpers\Container helpers\View management
+     */
+
     /* ******************************************************************
      *
@@ -186 +198 @@
      *      be a PCNRINFO.
      *      Example:
+     *
      +          CNRINFO CnrInfo;
      +          cnrhQueryCnrInfo(&CnrInfo);
@@ -199 +212 @@
     /*
      *@@ BEGIN_CNRINFO:
-     *      this func starts a "container info" block for the
-     *      following functions.
+     *      this macro starts a "container info" block. In such
+     *      a block, you may use the following macros:
+     *
+     *      -- cnrhSetTitle
+     *
+     *      -- cnrhSetSplitBarAfter
+     *
+     *      -- cnrhSetSplitBarPos
+     *
+     *      -- cnrhSetTreeBmpOrIconSize
+     *
+     *      -- cnrhSetBmpOrIconSize
+     *
+     *      -- cnrhSetView (most frequently)
+     *
+     *      -- cnrhSetTreeIndent
+     *
+     *      -- cnrhSetSortFunc
+     *
+     *      Typical usage is like this:
+     *
+     +          BEGIN_CNRINFO()
+     +          {
+     +              cnrhSetTreeIndent(20);
+     +              cnrhSetView(CV_TREE | CV_ICON | CA_TREELINE);
+     +          } END_CNRINFO(hwndCnr);
+     *
      *      This must always be followed by END_CNRINFO(),
      *      or you'll get funny compilation errors.
@@ -215 +253 @@
     /*
      *@@ END_CNRINFO:
-     *      this ends a "container info" block started by
-     *      BEGIN_CNRINFO.
+     *      this macro ends a "container info" block.
+     *      See BEGIN_CNRINFO.
      *
      *@@added V0.9.0
@@ -228 +266 @@
     /*
      *@@ cnrhSetTitle:
-     *      this sets the container title to the specified
+     *      this macro sets the container title to the specified
      *      text. You must specify CA_CONTAINERTITLE with
      *      cnrhSetView then.
+     *
+     *      This can only be used after BEGIN_CNRINFO().
      *
      *@@added V0.9.1 (99-12-18) [umoeller]
@@ -278 +318 @@
      *      tree views.
      *      The default is the system icon size (32 or 40).
+     *
+     *      This can only be used after BEGIN_CNRINFO().
      */
 
@@ -304 +346 @@
     /*
      *@@ cnrhSetView:
-     *      this sets the container view attributes (CNRINFO.flWindowAttr).
-     *
-     *      This can only be used after BEGIN_CNRINFO().
+     *      this macro sets the container view attributes (CNRINFO.flWindowAttr).
+     *
+     *      This can only be used after BEGIN_CNRINFO(), like this:
+     *
+     +          BEGIN_CNRINFO()
+     +          {
+     +              cnrhSetView(CV_TEXT | CV_FLOW);
+     +          } END_CNRINFO(hwndCnr);
      *
      *      The following combinations are useful for flWindowAttr.
@@ -382 +429 @@
     /*
      *@@ cnrhSetTreeIndent:
-     *      this sets the horizontal spacing between levels
+     *      this macro sets the horizontal spacing between levels
      *      in Tree views.
+     *
+     *      This can only be used after BEGIN_CNRINFO().
      *
      *@@added V0.9.0
@@ -394 +443 @@
     /*
      *@@ cnrhSetSortFunc:
-     *      this sets the sort function for a container.
+     *      this macro sets the sort function for a container.
+     *
      *      This can only be used after BEGIN_CNRINFO().
      *
@@ -473 +523 @@
                                             PRECORDCORE preccCurrent);
 
+    /*
+     *@@category: Helpers\PM helpers\Container helpers\Record relations/iteration
+     */
+
     /* ******************************************************************
      *