Added comments to describe functions for frmContactEditorOrganisations

[xestiaab/.git] / source / contacteditor / frmContactEditorOrganisations.cpp

diff --git a/source/contacteditor/frmContactEditorOrganisations.cpp b/source/contacteditor/frmContactEditorOrganisations.cpp
index ccfb509..fa0ca45 100644 (file)
--- a/source/contacteditor/frmContactEditorOrganisations.cpp
+++ b/source/contacteditor/frmContactEditorOrganisations.cpp
@@ -1,3 +1,21 @@
+// frmContactEditorOrganisation.cpp - frmContactEditorOrganisation form.
+//
+// (c) 2012-2015 Xestia Software Development.
+//
+// This file is part of Xestia Address Book.
+//
+// Xestia Address Book is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by the
+// Free Software Foundation, version 3 of the license.
+//
+// Xestia Address Book is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License along
+// with Xestia Address Book. If not, see <http://www.gnu.org/licenses/>
+
 #include "frmContactEditorOrganisations.h"
 #include <wx/tokenzr.h>
 #include "../common/textprocessing.h"
@@ -6,13 +24,19 @@ frmContactEditorOrganisations::frmContactEditorOrganisations( wxWindow* parent )
 :
 frmContactEditorOrganisationsADT( parent )
 {
+       
+       // Setup the window.
+       
        EditorMode = FALSE;
        sliPriority->Disable();
+       
 }
 
 void frmContactEditorOrganisations::UpdateSortAs( wxCommandEvent& event )
 {
 
+       // Update the predefined SortAs listings.
+       
        // Clear out the options for the combo box.
        
        cmbSortAs->Clear();
@@ -51,16 +75,22 @@ void frmContactEditorOrganisations::UpdateSortAs( wxCommandEvent& event )
 
 void frmContactEditorOrganisations::EnablePriority( wxCommandEvent& event )
 {
+       
+       // Enable/disable the priority setting.
+       
        if (chkUsePref->IsChecked()){
                sliPriority->Enable();
        } else {
                sliPriority->Disable();
        }
+       
 }
 
 void frmContactEditorOrganisations::ProcessAction( wxCommandEvent& event )
 {
 
+       // Process action.
+       
        long ListCtrlIndex;
        
        if (EditorMode == FALSE){
@@ -181,6 +211,9 @@ void frmContactEditorOrganisations::ProcessAction( wxCommandEvent& event )
 
 void frmContactEditorOrganisations::SetEditorMode(bool EditMode, SectionType SectType)
 {
+       
+       // Set the editor mode.
+       
        // Set if the editor is adding or editing an address.
        // FALSE = Add
        // TRUE = Edit
@@ -221,7 +254,8 @@ void frmContactEditorOrganisations::SetEditorMode(bool EditMode, SectionType Sec
                
                striter = OrganisationListSortAsPtr->find(OrganisationListIndex);
                 
-               if (striter->first == OrganisationListIndex){
+               if (striter->first == OrganisationListIndex && 
+                 striter != OrganisationListSortAsPtr->end()){
                
                        strValue = striter->second;
                
@@ -233,7 +267,8 @@ void frmContactEditorOrganisations::SetEditorMode(bool EditMode, SectionType Sec
                
                intiter = OrganisationListPrefPtr->find(OrganisationListIndex);         
                
-               if (intiter->first == OrganisationListIndex && intiter->second > 0){
+               if (intiter->first == OrganisationListIndex && intiter->second > 0 &&
+                 intiter != OrganisationListPrefPtr->end()){
                
                        sliPriority->SetValue(intiter->second);
                        sliPriority->Enable();
@@ -249,7 +284,11 @@ void frmContactEditorOrganisations::SetEditorMode(bool EditMode, SectionType Sec
 
 void frmContactEditorOrganisations::CloseWindow( wxCommandEvent& event )
 {
+       
+       // Close the window.
+       
        this->Close();
+       
 }
 
 void frmContactEditorOrganisations::SetupPointers(std::map<int, wxString> *OrganisationList,
@@ -264,6 +303,8 @@ void frmContactEditorOrganisations::SetupPointers(std::map<int, wxString> *Organ
        int OrganisationIndex )
 {
 
+       // Setup the pointers.
+       
        OrganisationListPtr = OrganisationList;
        OrganisationListLanguagePtr = OrganisationListLanguage;
        OrganisationListSortAsPtr = OrganisationListSortAs;