Checkbox for Sorting: CodeBrowser_gui.ipf

Checkbox Event calls updateListBoxHook()
normal flow on update: updatePanel -> updateListBoxHook -> parseAllProcedureWindows
updatePanel not needed. panel exists is checkbox event was raised

actual Sorting in CodeBrowser.ipf
parseAllProcedureWindows()
calls returnCheckBoxAlpha() to get state via a ControlInfo call.
returnCheckBoxAlpha() requires Panel/Checkbox to exist otherwise fall back to sorting enabled.

Saving Checkbox State in package preferences CodeBrowser_preferences.ipf
FillPackagePrefsStruct -->
SyncPackagePrefsStruct or DefaultPackagePrefsStruct
called via hook preparePanelClose (experiment exit, panel kill)

Author: Matthias Kastner

procedures/CodeBrowser.ipf

@@ -405,7 +405,11 @@ Function/S parseAllProcedureWindows()
 
 	macList  = getDecoratedMacroList(procedureWithoutModule)
 
-	list = SortList(funcList + macList,";",4)
+	if (returnCheckBoxSort())
+		list = SortList(funcList + macList,";",4) //option 4: Case-insensitive sort
+	else
+		list = funcList + macList
+	endif
 
 	Wave/T decls = getDeclWave()
 	Wave/D lines = getLineWave()

procedures/CodeBrowser_gui.ipf

@@ -9,13 +9,15 @@
 static Constant popupLength   = 240
 static Constant moduleCtrlTop = 10
 static Constant procCtrlTop   = 40
+static Constant SortCtrlTop   = 70
 static Constant border        = 5
-static Constant topSpaceList  = 80
+static Constant topSpaceList  = 90
 
 static StrConstant panel      = "CodeBrowser"
 static StrConstant moduleCtrl	= "popupNamespace"
 static StrConstant procCtrl  	= "popupProcedure"
 static StrConstant listCtrl   = "list1"
+static StrConstant sortCtrl = "checkboxSort"
 static StrConstant userDataRawList = "rawList"
 static StrConstant userDataNiceList = "niceList"
 
@@ -59,6 +61,9 @@ Function createPanel()
 	ListBox   $listCtrl,   win=$panel,mode=5,selCol=1, widths={4,40}, keySelectCol=1
 	ListBox   $listCtrl,   win=$panel,listWave=getDeclWave()
 
+	CheckBox $sortCtrl, win=$panel, pos={30,SortCtrlTop},size={40,20},value=prefs.panelCheckboxSort
+	CheckBox $sortCtrl, win=$panel, title="sort"
+	CheckBox $sortCtrl, win=$panel, proc=$(module + "#checkboxSort")
 	SetWindow $panel, hook(mainHook)=$(module + "#panelHook")
 	DoUpdate/W=$panel
 
@@ -118,6 +123,7 @@ Function resizePanel()
 	left = (width - V_Width) / 2.0
 	PopupMenu $moduleCtrl, win=$panel,pos={left,moduleCtrlTop}
 	PopupMenu $procCtrl,   win=$panel,pos={left+8,procCtrlTop}
+	CheckBox  $sortCtrl, win=$panel,pos={left+66,SortCtrlTop}
 End
 
 // Must be called after every change which might affect the panel contents
@@ -305,6 +311,32 @@ Function popupProcedures(pa) : PopupMenuControl
 	return 0
 End
 
+Function checkboxSort(cba) : CheckBoxControl
+	STRUCT WMCheckboxAction &cba
+
+	switch( cba.eventCode )
+		case 2: // mouse up
+			updateListBoxHook()
+			break
+		case -1: // control being killed
+			break
+	endswitch
+
+	return 0
+End
+
+// returns 0 if checkbox is deselected or 1 if it is selected.
+Function returnCheckBoxSort()	
+	ControlInfo/W=$panel $sortCtrl
+	if (V_flag == 2)		// Checkbox found?
+		return V_Value
+	else
+		//Fallback: Sorting as default behaviour
+		return 1
+	endif
+End
+
+
 Function listBoxProc(lba) : ListBoxControl
 	STRUCT WMListboxAction &lba
 

procedures/CodeBrowser_preferences.ipf

@@ -6,15 +6,16 @@
 // This file was created by () byte physics Thomas Braun, [email protected]
 // (c) 2013
 
-static Constant kPrefsVersion = 100
+static Constant kPrefsVersion = 101
 static StrConstant kPackageName = "CodeBrowser"
 static StrConstant kPrefsFileName = "CodeBrowser.bin"
 static Constant kPrefsRecordID = 0
 
 Structure CodeBrowserPrefs
 	uint32	version		// Preferences structure version number. 100 means 1.00.
 	double panelCoords[4]	// left, top, right, bottom
-	uint32 reserved[100]	// Reserved for future use
+	uint32 panelCheckboxSort 	// status of checkbox in createPanel()
+	uint32 reserved[99]	// Reserved for future use
 EndStructure
 
 //	DefaultPackagePrefsStruct(prefs)
@@ -31,8 +32,10 @@ static Function DefaultPackagePrefsStruct(prefs)
 	prefs.panelCoords[2] = 0.95 * dims.right
 	prefs.panelCoords[3] = 0.90 * dims.bottom
 
+	prefs.panelCheckboxSort = 1
+
 	Variable i
-	for(i=0; i<100; i+=1)
+	for(i=0; i<99; i+=1)
 		prefs.reserved[i] = 0
 	endfor
 End
@@ -53,6 +56,8 @@ static Function SyncPackagePrefsStruct(prefs)
 	prefs.panelCoords[1] = V_top * scale
 	prefs.panelCoords[2] = V_right * scale
 	prefs.panelCoords[3] = V_bottom * scale
+	
+	prefs.panelCheckboxSort = returnCheckBoxSort()
 End
 
 // InitPackagePrefsStruct(prefs)