checkbox.h
上传用户:hzhsqp
上传日期:2007-01-06
资源大小:1600k
文件大小:6k
源码类别:

IP电话/视频会议

开发平台:

Visual C++

  1. /*
  2.  * checkbox.h
  3.  *
  4.  * Check 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: checkbox.h,v $
  30.  * Revision 1.18  1999/03/10 03:49:51  robertj
  31.  * More documentation adjustments.
  32.  *
  33.  * Revision 1.17  1999/03/09 08:01:47  robertj
  34.  * Changed comments for doc++ support (more to come).
  35.  *
  36.  * Revision 1.16  1999/02/16 08:08:45  robertj
  37.  * MSVC 6.0 compatibility changes.
  38.  *
  39.  * Revision 1.15  1998/09/23 06:23:01  robertj
  40.  * Added open source copyright license.
  41.  *
  42.  * Revision 1.14  1995/03/14 12:41:05  robertj
  43.  * Updated documentation to use HTML codes.
  44.  *
  45.  * Revision 1.13  1995/01/27  11:04:15  robertj
  46.  * Changed state of checkbox from CheckValue to BOOL.
  47.  *
  48.  * Revision 1.12  1994/11/28  12:31:46  robertj
  49.  * Documentation.
  50.  *
  51.  * Revision 1.11  1994/10/30  11:46:30  robertj
  52.  * Changed mechanism for doing notification callback functions.
  53.  *
  54.  * Revision 1.10  1994/08/23  11:32:52  robertj
  55.  * Oops
  56.  *
  57.  * Revision 1.9  1994/08/22  00:46:48  robertj
  58.  * Added pragma fro GNU C++ compiler.
  59.  *
  60.  * Revision 1.8  1994/06/25  11:55:15  robertj
  61.  * Unix version synchronisation.
  62.  *
  63.  * Revision 1.7  1994/03/07  07:38:19  robertj
  64.  * Major enhancementsacross the board.
  65.  *
  66.  * Revision 1.6  1994/01/15  02:50:29  robertj
  67.  * Moved control contructors to common and added a platform dependent Construct() function.
  68.  *
  69.  * Revision 1.5  1994/01/03  04:42:23  robertj
  70.  * Mass changes to common container classes and interactors etc etc etc.
  71.  *
  72.  * Revision 1.4  1993/09/27  16:35:25  robertj
  73.  * Removed special constructor for dialog resource loading.
  74.  *
  75.  * Revision 1.3  1993/08/21  01:50:33  robertj
  76.  * Made Clone() function optional, default will assert if called.
  77.  *
  78.  * Revision 1.2  1993/07/14  12:49:16  robertj
  79.  * Fixed RCS keywords.
  80.  *
  81.  */
  82. #define _PCHECKBOX
  83. #ifdef __GNUC__
  84. #pragma interface
  85. #endif
  86. /**A 2 state check box control that has {it Checked}, {it Unchecked}
  87.    states.
  88.    The exact appearence of a check box is platform dependent, however, they
  89.    all have some visual distinction between the two states plus a string
  90.    label associated with it.
  91.  */
  92. class PCheckBox : public PCheck3WayBox
  93. {
  94.   PCLASSINFO(PCheckBox, PCheck3WayBox);
  95.   public:
  96.    /**Create a check box control with the specified name next to it,
  97.        callback function and the initial check state.
  98.      */
  99.     PCheckBox(
  100.       PInteractor * parent,     /// Interactor into which the control is placed.
  101.       BOOL value = FALSE        /// Initial state for the check box.
  102.     );
  103.     PCheckBox(
  104.       PInteractor * parent,     /// Interactor into which the control is placed.
  105.       const PString & name,     /// Name to be placed next to the check box.
  106.       BOOL value = FALSE        /// Initial state for the check box.
  107.     );
  108.     PCheckBox(
  109.       PInteractor * parent,     /// Interactor into which the control is placed.
  110.       const PString & name,     /// Name to be placed next to the check box.
  111.       const PNotifier & notify  /// Function to call when changes state.
  112.     );
  113.    /**Create control from interactor layout with the specified control ID.
  114.        This is mainly used in support of resource based dialogs.
  115.      */
  116.     PCheckBox(
  117.       PInteractorLayout * parent, /// Interactor into which the box is placed.
  118.       PRESOURCE_ID ctlID,         /// Identifier for the control in the layout.
  119.       const PNotifier & notify,   /// Function to call when changes state.
  120.       BOOL * valuePtr             /// Variable to change to the check box state.
  121.     );
  122.     /** Destroy the check box. */
  123.     virtual ~PCheckBox();
  124.   /**@name Overrides from class PControl */
  125.    /**This function transfers the value of the control to or from the variable
  126.        pointed to by the value pointer member variable.
  127.      */
  128.     virtual void TransferValue(
  129.       int option 
  130.      /**Transfer value option. When this is -1 when the function transfers
  131.          the value from the value pointer into the control. This is called in
  132.          Ref{PDialog::OnInit()} function. When option is zero then the
  133.          function transfers the value from the control to the value pointer
  134.          variable. This is called just before the callback function every time
  135.          the check box state changes.
  136.        */
  137.     );
  138.     /**@name Overrides from class PCheck3WayBox */
  139.    /**Get the current state of the check box.
  140.        @return
  141.        check box state.
  142.      */
  143.     BOOL GetValue() const;
  144.    /**Set the check state of the check box. This will be updated on the
  145.        screen immediately (within OS contsraints).
  146.        Note that unlike the Ref{PCheck3WayBox} class this function is
  147.        limited to the Checked (TRUE) and Unchecked (FALSE) values.
  148.      */
  149.     virtual void SetValue(
  150.       BOOL newVal  /// New state to set the check box to.
  151.     );
  152.    /**Get the current value pointer associated with the control. The variable
  153.        pointed to by this is autamatically updated with the current value of
  154.        the check box.
  155.        @return
  156.        value pointer associated with the control.
  157.      */
  158.     BOOL * GetValuePointer() const;
  159.    /**Set the current value pointer associated with the control. The variable
  160.        pointed to by this is autamatically updated with the current value of
  161.        the check box.
  162.      */
  163.     void SetValuePointer(
  164.       BOOL * ptr  /// New value pointer to associate with the control.
  165.     );
  166. #ifdef DOC_PLUS_PLUS
  167. };
  168. #endif
  169. // Class declaration continued in platform specific header file ///////////////