src/Utils/IInputValidator.h

   1 // TortoiseGit - a Windows shell extension for easy version control
   2
   3 // Copyright (C) 2010, 2013 - TortoiseSVN
   4
   5 // This program is free software; you can redistribute it and/or
   6 // modify it under the terms of the GNU General Public License
   7 // as published by the Free Software Foundation; either version 2
   8 // of the License, or (at your option) any later version.
   9
  10 // This program is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 // GNU General Public License for more details.
  14
  15 // You should have received a copy of the GNU General Public License
  16 // along with this program; if not, write to the Free Software Foundation,
  17 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 //
  19 #pragma once
  20
  21 class IInputValidator
  22 {
  23 public:
  24         /**
  25          * Method is called to validate the user input, usually an edit control.
  26          * Return an empty string if the input is valid. If the input is not valid,
  27          * return an error string which is then shown in an error balloon.
  28          * \param nID the id of the edit control, or 0 if it's not for a specific control
  29          * \param input the user input
  30          */
  31         virtual CString Validate(const int nID, const CString& input) = 0;
  32 };