[Igarden-commit] Garden/source/Document CPlanPanel.cpp, 1.4.2.10, 1.4.2.11
Status: Beta
Brought to you by:
jlbedell
Menu
▾
▴
[Igarden-commit] Garden/source/Document CPlanPanel.cpp, 1.4.2.10, 1.4.2.11
|
From: Jeffrey B. <jlb...@us...> - 2008-05-17 20:47:19
|
Update of /cvsroot/igarden/Garden/source/Document In directory sc8-pr-cvs2.sourceforge.net:/tmp/cvs-serv22138/source/Document Modified Files: Tag: Release_branch_v1 CPlanPanel.cpp Log Message: Improve some comments Index: CPlanPanel.cpp =================================================================== RCS file: /cvsroot/igarden/Garden/source/Document/CPlanPanel.cpp,v retrieving revision 1.4.2.10 retrieving revision 1.4.2.11 diff -C2 -d -r1.4.2.10 -r1.4.2.11 *** CPlanPanel.cpp 14 May 2008 13:08:31 -0000 1.4.2.10 --- CPlanPanel.cpp 17 May 2008 20:47:16 -0000 1.4.2.11 *************** *** 88,93 **** ENDDISPATCH ! long ! CPlanPanel::DoModifyMenu( long /*arg*/, void* parg ) { XGMenu *menu, *subMenu; --- 88,101 ---- ENDDISPATCH ! ! // --------------------------------------------------------------------------- ! /// 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 CPlanPanel::DoModifyMenu( long /*arg*/, void* parg ) { XGMenu *menu, *subMenu; *************** *** 150,153 **** --- 158,164 ---- } + // --------------------------------------------------------------------------- + /// DoPopValue + // long CPlanPanel::DoPopValue( long /*arg*/, void* /*parg*/ ) *************** *** 156,159 **** --- 167,174 ---- } + + // --------------------------------------------------------------------------- + /// SetCurrentPlot + // void CPlanPanel::SetCurrentPlot(long index) { *************** *** 179,182 **** --- 194,201 ---- } + + // --------------------------------------------------------------------------- + /// RebuildPlotMenu + // void CPlanPanel::RebuildPlotMenu() { *************** *** 184,187 **** --- 203,209 ---- } + // --------------------------------------------------------------------------- + /// DoHeaderIconChanged + // long CPlanPanel::DoHeaderIconChanged( long /*arg*/, void* /*parg*/ ) { *************** *** 190,197 **** // --------------------------------------------------------------------------- ! // CGardenPanel* CPlanPanel::Create( CGardenForm* doc, XGView* superView ) ! // --------------------------------------------------------------------------- // - /* Called once for each panel on the creation of a CGardenDoc. Use the name and resourceID and build the view. */ CGardenPanel* CPlanPanel::Create( CGardenForm* doc, XGView* superView ) { --- 212,220 ---- // --------------------------------------------------------------------------- ! /// Create ! // ! /// Called once for each panel on the creation of a CGardenDoc. ! /// Use the name and resourceID and build the view. */ // CGardenPanel* CPlanPanel::Create( CGardenForm* doc, XGView* superView ) { *************** *** 209,215 **** return(result); } // --------------------------------------------------------------------------- ! // void CPlanPanel::Save() ! // --------------------------------------------------------------------------- // void CPlanPanel::Save() --- 232,239 ---- return(result); } + + // --------------------------------------------------------------------------- ! /// Save // void CPlanPanel::Save() *************** *** 217,223 **** } // --------------------------------------------------------------------------- ! // void CPlanPanel::Open() ! // --------------------------------------------------------------------------- // void CPlanPanel::Open() --- 241,248 ---- } + + // --------------------------------------------------------------------------- ! /// Open // void CPlanPanel::Open() *************** *** 889,895 **** return result; } // --------------------------------------------------------------------------- ! // long CPlanPanel::DoKeyEvent( long arg, void* parg ) ! // --------------------------------------------------------------------------- // long CPlanPanel::DoKeyEvent( long arg, void* /*parg*/ ) --- 914,924 ---- return result; } + + // --------------------------------------------------------------------------- ! /// DoKeyEvent ! // ! /// Handle the KXGKeyEvent event from YAAF, indicating that a key has been pressed. ! /// Return 0 if the event was handled, -1 otherwise. // long CPlanPanel::DoKeyEvent( long arg, void* /*parg*/ ) *************** *** 1001,1005 **** // --------------------------------------------------------------------------- // void CPlanPanel::DoSwitchPlot( long arg, void* parg ) - // --------------------------------------------------------------------------- // void CPlanPanel::DoSwitchPlot( long /*arg*/, void* parg ) --- 1030,1033 ---- *************** *** 1011,1016 **** // --------------------------------------------------------------------------- ! // long CPlanPanel::DoIdleTime( long arg, void* parg ) ! // --------------------------------------------------------------------------- // long CPlanPanel::DoIdleTime( long arg, void* parg ) --- 1039,1043 ---- // --------------------------------------------------------------------------- ! /// DoIdleTime // long CPlanPanel::DoIdleTime( long arg, void* parg ) *************** *** 1033,1039 **** return -1; } // --------------------------------------------------------------------------- ! // void CPlanPanel::RecalculateDisplay() ! // --------------------------------------------------------------------------- // void CPlanPanel::RecalculateDisplay() --- 1060,1067 ---- return -1; } + + // --------------------------------------------------------------------------- ! /// RecalculateDisplay // void CPlanPanel::RecalculateDisplay() *************** *** 1047,1050 **** --- 1075,1080 ---- _planView->InvalView(); } + + // --------------------------------------------------------------------------- /// SetDisplayMonth *************** *** 1056,1059 **** --- 1086,1091 ---- _planView->SetDisplayMonth(month); } + + // --------------------------------------------------------------------------- /// ComputePageBoundries *************** *** 1095,1105 **** } } // --------------------------------------------------------------------------- /// PrintPageContents // ! ! ! void ! CPlanPanel::PrintPageContents( Rect& printRect, XGDraw& draw, sint32 xOffset, sint32 yOffset ) { planPoint_t newPos; --- 1127,1136 ---- } } + + // --------------------------------------------------------------------------- /// PrintPageContents // ! void CPlanPanel::PrintPageContents( Rect& printRect, XGDraw& draw, sint32 xOffset, sint32 yOffset ) { planPoint_t newPos; *************** *** 1128,1134 **** --- 1159,1169 ---- } + // --------------------------------------------------------------------------- /// OpenFloatingWindows // + /// Creates any foloating (palette) windows associated with this panel. + /// Called from CGardenForm, you should not need to call this elsewhere. + // void CPlanPanel::OpenFloatingWindows() { *************** *** 1140,1146 **** --- 1175,1185 ---- } + // --------------------------------------------------------------------------- /// Activate // + /// Handle activities which need to happen when this panel activates (becomes the current panel + /// in the document). + // void CPlanPanel::Activate() { *************** *** 1159,1162 **** --- 1198,1204 ---- /// 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 CPlanPanel::Deactivate() { *************** *** 1167,1170 **** --- 1209,1215 ---- /// DoPlotInfoChanged // + // Responds to the kModifyPlotInfoMsg message, sent when basic garden plot + // information (dimensions, name, etc..) has changed. + // long CPlanPanel::DoPlotInfoChanged( long /*arg*/, void* /*parg*/ ) { *************** *** 1197,1200 **** --- 1242,1250 ---- /// ScrollWheelMoved // + /// Called from CGardenForm when the scroll wheel on the mouse has been moved over + /// the current view. + // + // This view treats option-scroll as a zoom operation + // void CPlanPanel::ScrollWheelMoved(wheelAxis_t axis, sint32 offset) { *************** *** 1230,1233 **** --- 1280,1288 ---- /// 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. + // bool CPlanPanel::SetupContextMenu(RGContextMenu *menu) { *************** *** 1241,1244 **** --- 1296,1303 ---- } + + // --------------------------------------------------------------------------- + /// CloseSubWindows + // void CPlanPanel::CloseSubWindows() { |