include/pwlib/pwedbox.h

   1 /*
   2  * pwedbox.h
   3  *
   4  * password edit text box control.
   5  *
   6  * Portable Windows Library
   7  *
   8  * Copyright (c) 1993-1998 Equivalence Pty. Ltd.
   9  *
  10  * The contents of this file are subject to the Mozilla Public License
  11  * Version 1.0 (the "License"); you may not use this file except in
  12  * compliance with the License. You may obtain a copy of the License at
  13  * http://www.mozilla.org/MPL/
  14  *
  15  * Software distributed under the License is distributed on an "AS IS"
  16  * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
  17  * the License for the specific language governing rights and limitations
  18  * under the License.
  19  *
  20  * The Original Code is Portable Windows Library.
  21  *
  22  * The Initial Developer of the Original Code is Equivalence Pty. Ltd.
  23  *
  24  * Portions are Copyright (C) 1993 Free Software Foundation, Inc.
  25  * All Rights Reserved.
  26  *
  27  * Contributor(s): ______________________________________.
  28  *
  29  * $Log$
  30  * Revision 1.12  2001/05/22 12:49:33  robertj
  31  * Did some seriously wierd rewrite of platform headers to eliminate the
  32  *   stupid GNU compiler warning about braces not matching.
  33  *
  34  * Revision 1.11  1999/03/10 03:49:53  robertj
  35  * More documentation adjustments.
  36  *
  37  * Revision 1.10  1999/03/09 08:01:49  robertj
  38  * Changed comments for doc++ support (more to come).
  39  *
  40  * Revision 1.9  1999/02/16 08:08:46  robertj
  41  * MSVC 6.0 compatibility changes.
  42  *
  43  * Revision 1.8  1998/09/23 06:28:29  robertj
  44  * Added open source copyright license.
  45  *
  46  * Revision 1.7  1995/06/04 12:35:21  robertj
  47  * Added common constructor - Unix implementation requirement.
  48  * Removed redundent destructor.
  49  *
  50  * Revision 1.6  1995/03/14 12:42:19  robertj
  51  * Updated documentation to use HTML codes.
  52  *
  53  * Revision 1.5  1995/01/14  06:19:23  robertj
  54  * Documentation
  55  *
  56  * Revision 1.4  1994/10/30  11:46:57  robertj
  57  * Changed mechanism for doing notification callback functions.
  58  *
  59  * Revision 1.3  1994/08/23  11:32:52  robertj
  60  * Oops
  61  *
  62  * Revision 1.2  1994/08/22  00:46:48  robertj
  63  * Added pragma fro GNU C++ compiler.
  64  *
  65  * Revision 1.1  1994/04/11  14:15:05  robertj
  66  * Initial revision
  67  *
  68  */
  69
  70 #define _PPASSWORDEDITBOX
  71
  72 #ifdef __GNUC__
  73 #pragma interface
  74 #endif
  75
  76 /**This class is a text editing box that does not display characters entered.
  77    It is typically used for entering password in secure systems. Other than
  78    the display of a simgle character for all real characters entered it is
  79    identical to the ancestor \Ref{PEditBox}.
  80  */
  81 class PPasswordEditBox : public PEditBox
  82 {
  83   PCLASSINFO(PPasswordEditBox, PEditBox);
  84
  85   public:
  86     /** Create a password edit box control. */
  87     PPasswordEditBox(
  88       PInteractor * parent  /// Interactor into which the control is placed.
  89     );
  90
  91     /** Create control from interactor layout with the specified control ID. */
  92     PPasswordEditBox(
  93       PInteractorLayout * parent, /// Interactor into which the box is placed.
  94       PRESOURCE_ID ctlID,         /// Identifier for the control in the layout.
  95       const PNotifier & notify,   /// Function to call when changes state.
  96       PString * valuePtr          /// Variable to change to the editor value.
  97     );
  98
  99
 100   /**@name New functions for class */
 101    /**Set the character displayed instead of entered characters. This gives
 102        the user feedback on how many characters were entered but not what
 103        characters.
 104      */
 105     void SetPasswordCharacter(
 106       char c   /// New character to display.
 107     );
 108
 109    /**Get the character displayed instead of entered characters. This gives
 110        the user feedback on how many characters were entered but not what
 111        characters.
 112
 113        @return
 114        character to display.
 115      */
 116     char GetPasswordCharacter();
 117
 118
 119   private:
 120     void Construct();
 121       // Common construction code.
 122
 123
 124 // Include platform dependent part of class
 125 #include <pwlib/pwedbox.h>
 126 };
 127
 128
 129 // End Of File ///////////////////////////////////////////////////////////////