From 07b0ca3bbba5767670138dc1c9e14e8ab848c4ac Mon Sep 17 00:00:00 2001 From: kevin Date: Wed, 13 Nov 2013 11:53:20 -0500 Subject: [PATCH] cmGrPage.h : Added comment to cmGrLabelFunc_t. --- cmGrPage.h | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/cmGrPage.h b/cmGrPage.h index 1f71873..6d7fd40 100644 --- a/cmGrPage.h +++ b/cmGrPage.h @@ -60,7 +60,11 @@ extern "C" { // Draw the page. void cmGrPageDraw( cmGrPgH_t h, cmGrDcH_t dcH ); + // Label callback functions are used to translate numeric axis values to + // text strings. Multiple label callback functions can be registered with + // a page and then assigned to a given view axis via cmGrViewSetLabelFunc(). typedef void (*cmGrLabelFunc_t)( void* arg, cmChar_t* label, unsigned labelCharCnt, cmGrV_t value ); + // Returns id of the new page label function. unsigned cmGrPageLabelFuncRegister( cmGrPgH_t h, cmGrLabelFunc_t func, void* arg, const cmChar_t* label ); unsigned cmGrPageLabelFuncCount( cmGrPgH_t h );