[Igarden-commit] Garden/source/Document CGardenPanel.cpp, 1.3.2.5, 1.3.2.6 CGardenForm.cpp, 1.4.2.1
Status: Beta
Brought to you by:
jlbedell
Menu
▾
▴
[Igarden-commit] Garden/source/Document CGardenPanel.cpp, 1.3.2.5, 1.3.2.6 CGardenForm.cpp, 1.4.2.13, 1.4.2.14 CDatabasePanel.cpp, 1.4.2.27, 1.4.2.28
|
From: Jeffrey B. <jlb...@us...> - 2008-05-17 20:44:23
|
Update of /cvsroot/igarden/Garden/source/Document In directory sc8-pr-cvs2.sourceforge.net:/tmp/cvs-serv20560/source/Document Modified Files: Tag: Release_branch_v1 CGardenPanel.cpp CGardenForm.cpp CDatabasePanel.cpp Log Message: Improve some comments Index: CGardenPanel.cpp =================================================================== RCS file: /cvsroot/igarden/Garden/source/Document/CGardenPanel.cpp,v retrieving revision 1.3.2.5 retrieving revision 1.3.2.6 diff -C2 -d -r1.3.2.5 -r1.3.2.6 *** CGardenPanel.cpp 29 Mar 2008 19:40:37 -0000 1.3.2.5 --- CGardenPanel.cpp 17 May 2008 20:44:20 -0000 1.3.2.6 *************** *** 344,347 **** --- 344,350 ---- /// DoKeyEvent // + /// Default handler for a keypress from the user. + /// Return 0 if the event was handled, -1 otherwise. + // long CGardenPanel::DoKeyEvent( long /*arg*/, void* /*parg*/ ) { *************** *** 351,355 **** // --------------------------------------------------------------------------- ! /// DoTableChanged // long CGardenPanel::DoTableChanged( long /*arg*/, void* /*parg*/ ) --- 354,364 ---- // --------------------------------------------------------------------------- ! /// DoTableChanged (default method, should be overridden) ! // ! /// Handle the KTableChange message from RGTableView, indicating that the table data ! /// was changed. This is the primary way of handling user input from a table ! /// in an application-specific manner. ! // ! /// Return 0 if the data was handled, -1 otherwise. // long CGardenPanel::DoTableChanged( long /*arg*/, void* /*parg*/ ) *************** *** 359,363 **** // --------------------------------------------------------------------------- ! /// DoInputError // long CGardenPanel::DoInputError( long /*arg*/, void* /*parg*/ ) --- 368,376 ---- // --------------------------------------------------------------------------- ! /// DoInputError (default method, should be overridden) ! // ! /// Default method Handle the kTableInputErr message sent by RGTableView. ! // ! /// Return 0 if the error has been displayed, -1 otherwise. // long CGardenPanel::DoInputError( long /*arg*/, void* /*parg*/ ) *************** *** 377,380 **** --- 390,398 ---- /// DoModifyMenu // + /// Handle the KXGModifyMenu message from YAAF, which allows receivers to modify + /// the menus on the menuy bar. Called before the menus are displayed. + // + /// Returns 0 if a menu was changed, -1 if not. + // long CGardenPanel::DoModifyMenu( long /*arg*/, void* /*parg*/ ) { *************** *** 392,395 **** --- 410,417 ---- /// PrintHeader // + /// Default method to print the header information onto a printout. + // + /// Can be overridden if needed. + // void CGardenPanel::PrintHeader( XGDraw& draw, uint32 /*pageNum*/, uint32 /*maxPages*/, Point printSize ) { *************** *** 411,415 **** // --------------------------------------------------------------------------- ! // void CGardenPanel::PrintFooter // void CGardenPanel::PrintFooter( XGDraw& draw, uint32 pageNum, uint32 maxPages, Point printSize ) --- 433,441 ---- // --------------------------------------------------------------------------- ! /// PrintFooter ! // ! /// Default method to print the footer information onto a printout. ! // ! /// Can be overridden if needed. // void CGardenPanel::PrintFooter( XGDraw& draw, uint32 pageNum, uint32 maxPages, Point printSize ) *************** *** 539,542 **** --- 565,571 ---- /// Activate // + /// Handle activities which need to happen when this panel activates (becomes the current panel + /// in the document). Called from CGardenForm, you should not need to call this elsewhere. + // void CGardenPanel::Activate() { *************** *** 546,549 **** --- 575,581 ---- /// Deactivate // + /// Handle activities which need to happen when this panel deactivates (stops being the current panel + /// in the document). Called from CGardenForm, you should not need to call this elsewhere. + // void CGardenPanel::Deactivate() { *************** *** 560,563 **** --- 592,598 ---- /// ScrollWheelMoved // + /// Called from CGardenForm when the scroll wheel on the mouse has been moved over + /// the current view. + // void CGardenPanel::ScrollWheelMoved(wheelAxis_t /*axis*/, sint32 /*offset*/) { Index: CGardenForm.cpp =================================================================== RCS file: /cvsroot/igarden/Garden/source/Document/CGardenForm.cpp,v retrieving revision 1.4.2.13 retrieving revision 1.4.2.14 diff -C2 -d -r1.4.2.13 -r1.4.2.14 *** CGardenForm.cpp 14 May 2008 13:08:31 -0000 1.4.2.13 --- CGardenForm.cpp 17 May 2008 20:44:20 -0000 1.4.2.14 *************** *** 950,953 **** --- 950,959 ---- /// DoTableChanged // + /// Handle the KTableChange message from RGTableView, indicating that the table data + /// was changed. This is the primary way of handling user input from a table + /// in an application-specific manner. + // + /// Return 0 if the data was handled, -1 otherwise. + // long CGardenForm::DoTableChanged( long arg, void* parg ) { *************** *** 969,972 **** --- 975,982 ---- /// DoInputError // + /// Handle the kTableInputErr message sent by RGTableView. + // + /// Return 0 if the error has been displayed, -1 otherwise. + // long CGardenForm::DoInputError( long arg, void* parg ) { *************** *** 979,982 **** --- 989,997 ---- /// DoKeyEvent // + /// Handle the KXGKeyEvent event from YAAF, indicating that a key has been pressed. + /// Return 0 if the event was handled, -1 otherwise. + // + /// This version just passes the event down to the current pane. + // long CGardenForm::DoKeyEvent( long arg, void* parg ) { *************** *** 998,1001 **** --- 1013,1021 ---- /// DoModifyMenu // + /// Handle the KXGModifyMenu message from YAAF, which allows receivers to modify + /// the menus on the menuy bar. Called before the menus are displayed. + // + /// Returns 0 if a menu was changed, -1 if not. + // long CGardenForm::DoModifyMenu( long arg, void* parg ) { *************** *** 1068,1073 **** } ! // --------------------------------------------------------------------------- ! /// DoSetupContextMenu // long CGardenForm::DoSetupContextMenu(long arg, void* parg) --- 1088,1095 ---- } ! /// Called back from YAAF to determine if this view has a contextual menu, and allow ! /// the view to add items to the contextual menu (right-click). ! // ! // Returns 0 if the view does have a contextual menu, -1 otherwise. // long CGardenForm::DoSetupContextMenu(long arg, void* parg) *************** *** 1695,1698 **** --- 1717,1726 ---- } + // --------------------------------------------------------------------------- + /// ScrollWheelMoved + // + /// Called from the window event handler when the scroll wheel on the mouse has been moved over + /// the current view. + // void CGardenForm::ScrollWheelMoved(wheelAxis_t axis, sint32 offset) { Index: CDatabasePanel.cpp =================================================================== RCS file: /cvsroot/igarden/Garden/source/Document/CDatabasePanel.cpp,v retrieving revision 1.4.2.27 retrieving revision 1.4.2.28 diff -C2 -d -r1.4.2.27 -r1.4.2.28 *** CDatabasePanel.cpp 17 May 2008 19:53:21 -0000 1.4.2.27 --- CDatabasePanel.cpp 17 May 2008 20:44:21 -0000 1.4.2.28 *************** *** 2595,2599 **** // --------------------------------------------------------------------------- ! /// DoTableChanged // long CDatabasePanel::DoRowMoved( long arg, void* /*parg*/ ) --- 2595,2599 ---- // --------------------------------------------------------------------------- ! /// DoRowMoved // long CDatabasePanel::DoRowMoved( long arg, void* /*parg*/ ) *************** *** 2608,2611 **** --- 2608,2617 ---- /// DoTableChanged // + /// Handle the KTableChange message from RGTableView, indicating that the table data + /// was changed. This is the primary way of handling user input from a table + /// in an application-specific manner. + // + /// Return 0 if the data was handled, -1 otherwise. + // long CDatabasePanel::DoTableChanged( long /*arg*/, void* parg ) { *************** *** 3511,3514 **** --- 3517,3524 ---- /// DoInputError // + /// Handle the kTableInputErr message sent by RGTableView. + // + /// Return 0 if the error has been displayed, -1 otherwise. + // long CDatabasePanel::DoInputError( long /*arg*/, void* parg ) { *************** *** 3642,3645 **** --- 3652,3658 ---- /// DoPlotInfoChanged // + // Responds to the kModifyPlotInfoMsg message, sent when basic garden plot + // information (dimensions, name, etc..) has changed. + // long CDatabasePanel::DoPlotInfoChanged( long /*arg*/, void* /*parg*/ ) { *************** *** 3725,3728 **** --- 3738,3744 ---- /// ScrollWheelMoved // + /// Called from CGardenForm when the scroll wheel on the mouse has been moved over + /// the current view. + // void CDatabasePanel::ScrollWheelMoved(wheelAxis_t axis, sint32 offset) { *************** *** 3746,3749 **** --- 3762,3768 ---- /// DoKeyEvent // + /// Handle the KXGKeyEvent event from YAAF, indicating that a key has been pressed. + /// Return 0 if the event was handled, -1 otherwise. + // long CDatabasePanel::DoKeyEvent(long arg, void* parg) { *************** *** 3812,3817 **** /// SetupContextMenu // ! /// Called back from YAAF to determine if this view has a contextual menu, and what ! /// the items are on the contextual menu (right-click). // // Returns true since this view does have a contextual menu. --- 3831,3836 ---- /// SetupContextMenu // ! /// Called back from CGardenForm to determine if this view has a contextual menu, and allow ! /// the view to add items to the contextual menu (right-click). // // Returns true since this view does have a contextual menu. *************** *** 4588,4591 **** --- 4607,4613 ---- /// Activate // + /// Handle activities which need to happen when this panel activates (becomes the current panel + /// in the document). Called from CGardenForm, you should not need to call this elsewhere. + // void CDatabasePanel::Activate() { |