From 3a1679c0cc5f75a98a2a9d80680e9944571d6858 Mon Sep 17 00:00:00 2001
From: Steve Brokenshire <sbrokenshire@xestia.co.uk>
Date: Mon, 14 Mar 2016 21:59:55 +0000
Subject: [PATCH] Added comment to describe functions in
 search/XABSearchPanel.cpp

---
 source/search/XABSearchPanel.cpp | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/source/search/XABSearchPanel.cpp b/source/search/XABSearchPanel.cpp
index 3966fe6..7a22155 100644
--- a/source/search/XABSearchPanel.cpp
+++ b/source/search/XABSearchPanel.cpp
@@ -36,6 +36,8 @@ XABSearchPanel::XABSearchPanel( wxWindow* parent )
 XABSearchPanelADT( parent )
 {
 
+	// Setup the search panel.
+	
 	// Setup the images for the add and delete buttons.
 	
 	wxMemoryInputStream astream(buttons_add_png, sizeof(buttons_add_png));
@@ -79,6 +81,8 @@ XABSearchPanelADT( parent )
 void XABSearchPanel::UpdateOptions( wxCommandEvent& event )
 {
 	
+	// Update the options in the search panel.
+	
 	if (choOption->GetSelection() == 12 ||
 	choOption->GetSelection() == 13 ||
 	choOption->GetSelection() == 14 ){
@@ -102,6 +106,8 @@ void XABSearchPanel::UpdateOptions( wxCommandEvent& event )
 void XABSearchPanel::AddSearchWidget( wxCommandEvent& event )
 {
 
+	// Add the search panel.
+	
 	frmSearch *SCHWin = static_cast<frmSearch*>(SCHWinPtr);
 
 	wxCommandEvent eventsend(SE_ADDSEARCHSETTING);
@@ -112,6 +118,8 @@ void XABSearchPanel::AddSearchWidget( wxCommandEvent& event )
 void XABSearchPanel::RemoveSearchWidget( wxCommandEvent& event )
 {
 
+	// Remove the search panel.
+	
 	frmSearch *SCHWin = static_cast<frmSearch*>(SCHWinPtr);
 	
 	wxCommandEvent eventsend(SE_REMOVESEARCHSETTING);
@@ -123,6 +131,8 @@ void XABSearchPanel::RemoveSearchWidget( wxCommandEvent& event )
 void XABSearchPanel::EnableButtons(bool AddButton, bool DeleteButton)
 {
 
+	// Enable the buttons for the search panel.
+	
 	if (AddButton == TRUE){
 		btnAdd->Enable();
 	} else {
@@ -139,24 +149,32 @@ void XABSearchPanel::EnableButtons(bool AddButton, bool DeleteButton)
 
 void XABSearchPanel::SetupPointers(void* SCHWinPtrInc){
 
+	// Setup the pointers for the search panel.
+	
 	SCHWinPtr = SCHWinPtrInc;
 
 }
 
 void XABSearchPanel::SetupInteger(int IntInc){
 
+	// Set the ID of the search panel.
+	
 	SCHInt = IntInc;
 
 }
 
 int XABSearchPanel::GetInteger(){
 
+	// Get the ID of the search panel.
+	
 	return SCHInt;
 
 }
 
 void XABSearchPanel::DisableControls(wxCommandEvent &event){
 
+	// Disable the search controls.
+	
 	choOption->Disable();
 	chkActive->Disable();
 	txtSearch->Disable();
@@ -167,6 +185,8 @@ void XABSearchPanel::DisableControls(wxCommandEvent &event){
 
 void XABSearchPanel::EnableControls(wxCommandEvent &event){
 
+	// Enable the search controls.
+	
 	choOption->Enable();
 	chkActive->Enable();
 	txtSearch->Enable();
@@ -177,18 +197,24 @@ void XABSearchPanel::EnableControls(wxCommandEvent &event){
 
 int XABSearchPanel::GetSelectionOption(){
 
+	// Get the selection option.
+	
 	return choOption->GetSelection();
 
 }
 
 bool XABSearchPanel::GetCheckboxSetting(){
 
+	// Get the checkbox setting.
+	
 	return chkActive->IsChecked();
 
 }
 
 wxString XABSearchPanel::GetStringSetting(){
 
+	// Get the search string setting.
+	
 	return txtSearch->GetValue();
 
 }
\ No newline at end of file
-- 
2.39.2