Browse Source

cmGrPage.h : Added comment to cmGrLabelFunc_t.

master
kevin 10 years ago
parent
commit
07b0ca3bbb
1 changed files with 4 additions and 0 deletions
  1. 4
    0
      cmGrPage.h

+ 4
- 0
cmGrPage.h View File

@@ -60,7 +60,11 @@ extern "C" {
60 60
   // Draw the page.
61 61
   void      cmGrPageDraw( cmGrPgH_t h, cmGrDcH_t dcH );
62 62
 
63
+  // Label callback functions are used to translate numeric axis values to
64
+  // text strings.  Multiple label callback functions can be registered with
65
+  // a page and then assigned to a given view axis via cmGrViewSetLabelFunc().
63 66
   typedef void (*cmGrLabelFunc_t)( void* arg, cmChar_t* label, unsigned labelCharCnt, cmGrV_t value );
67
+
64 68
   // Returns id of the new page label function.
65 69
   unsigned         cmGrPageLabelFuncRegister( cmGrPgH_t h, cmGrLabelFunc_t func, void* arg, const cmChar_t* label );      
66 70
   unsigned         cmGrPageLabelFuncCount(    cmGrPgH_t h );

Loading…
Cancel
Save