From 34070bacbe68b726dd1c3d34834b72ad2b324c54 Mon Sep 17 00:00:00 2001
From: Steve Brokenshire <sbrokenshire@xestia.co.uk>
Date: Sun, 13 Mar 2016 10:22:31 +0000
Subject: [PATCH] Added comments to describe functions for frmContactEditorKey

---
 source/contacteditor/frmContactEditorKey.cpp | 27 ++++++++++++++++++++
 1 file changed, 27 insertions(+)

diff --git a/source/contacteditor/frmContactEditorKey.cpp b/source/contacteditor/frmContactEditorKey.cpp
index 569b0c3..bc876d6 100644
--- a/source/contacteditor/frmContactEditorKey.cpp
+++ b/source/contacteditor/frmContactEditorKey.cpp
@@ -25,6 +25,9 @@ frmContactEditorKey::frmContactEditorKey( wxWindow* parent )
 :
 frmContactEditorKeyADT( parent )
 {
+	
+	// Setup the window.
+	
 	EditorMode = FALSE;
 	sliPriority->Disable();
 	
@@ -51,15 +54,22 @@ frmContactEditorKeyADT( parent )
 
 void frmContactEditorKey::EnablePriority( wxCommandEvent& event )
 {
+	
+	// Enable/disable the priority setting.
+	
 	if (chkUsePref->IsChecked()){
 		sliPriority->Enable();
 	} else {
 		sliPriority->Disable();
 	}
+	
 }
 
 void frmContactEditorKey::SetEditorMode(bool EditMode)
 {
+	
+	// Set the editor mode.
+	
 	// Set if the editor is adding or editing an address.
 	// FALSE = Add
 	// TRUE = Edit
@@ -210,6 +220,9 @@ void frmContactEditorKey::SetEditorMode(bool EditMode)
 
 void frmContactEditorKey::ProcessAction( wxCommandEvent& event )
 {
+	
+	// Process action.
+	
 	long ListCtrlIndex;
 	int intKeyType = 0;
 	
@@ -394,6 +407,8 @@ void frmContactEditorKey::ProcessAction( wxCommandEvent& event )
 void frmContactEditorKey::ProcessKeyType( wxCommandEvent& event )
 {
 
+	// Process the key type (via wxCommandEvent).
+	
 	int intKeyType = 0;
 	
 	intKeyType = cmbKeyMainType->GetCurrentSelection();
@@ -415,6 +430,8 @@ void frmContactEditorKey::ProcessKeyType( wxCommandEvent& event )
 void frmContactEditorKey::ProcessKeyType()
 {
 
+	// Process the key type.
+	
 	int intKeyType = 0;
 	
 	intKeyType = cmbKeyMainType->GetCurrentSelection();
@@ -436,6 +453,8 @@ void frmContactEditorKey::ProcessKeyType()
 void frmContactEditorKey::ConvertURLType( wxCommandEvent& event )
 {
 
+	// Convert the URL type.
+	
 	wxString strValue;
 
 	strValue = cmbURL->GetString(cmbURL->GetCurrentSelection());
@@ -451,6 +470,8 @@ void frmContactEditorKey::ConvertURLType( wxCommandEvent& event )
 void frmContactEditorKey::ConvertKeyType( wxCommandEvent& event )
 {
 
+	// Convert the key type.
+	
 	wxString strValue;
 
 	strValue = cmbKeyType->GetString(cmbKeyType->GetCurrentSelection());
@@ -465,7 +486,11 @@ void frmContactEditorKey::ConvertKeyType( wxCommandEvent& event )
 
 void frmContactEditorKey::CloseWindow( wxCommandEvent& event )
 {
+	
+	// Close this window.
+	
 	this->Close();
+	
 }
 
 void frmContactEditorKey::SetupPointers(std::map<int, wxString> *KeyList,
@@ -480,6 +505,8 @@ void frmContactEditorKey::SetupPointers(std::map<int, wxString> *KeyList,
 	int KeyIndex )
 {
 
+	// Setup the pointers.
+	
 	KeyListPtr = KeyList;
 	KeyListAltIDPtr = KeyListAltID;
 	KeyListPIDPtr = KeyListPID;
-- 
2.39.2