CnC_Remastered_Collection

Command and Conquer: Red Alert
Log | Files | Refs | README | LICENSE

TOGGLE.H (4031B)

      1 //
      2 // Copyright 2020 Electronic Arts Inc.
      3 //
      4 // TiberianDawn.DLL and RedAlert.dll and corresponding source code is free 
      5 // software: you can redistribute it and/or modify it under the terms of 
      6 // the GNU General Public License as published by the Free Software Foundation, 
      7 // either version 3 of the License, or (at your option) any later version.
      8 
      9 // TiberianDawn.DLL and RedAlert.dll and corresponding source code is distributed 
     10 // in the hope that it will be useful, but with permitted additional restrictions 
     11 // under Section 7 of the GPL. See the GNU General Public License in LICENSE.TXT 
     12 // distributed with this program. You should have received a copy of the 
     13 // GNU General Public License along with permitted additional restrictions 
     14 // with this program. If not, see https://github.com/electronicarts/CnC_Remastered_Collection
     15 
     16 /* $Header:   F:\projects\c&c\vcs\code\toggle.h_v   2.16   16 Oct 1995 16:47:34   JOE_BOSTIC  $ */
     17 /*********************************************************************************************** 
     18  ***             C O N F I D E N T I A L  ---  W E S T W O O D   S T U D I O S               *** 
     19  *********************************************************************************************** 
     20  *                                                                                             * 
     21  *                 Project Name : Command & Conquer                                            * 
     22  *                                                                                             * 
     23  *                    File Name : TOGGLE.H                                                     * 
     24  *                                                                                             * 
     25  *                   Programmer : Joe L. Bostic                                                * 
     26  *                                                                                             * 
     27  *                   Start Date : 01/15/95                                                     * 
     28  *                                                                                             * 
     29  *                  Last Update : January 15, 1995 [JLB]                                       * 
     30  *                                                                                             * 
     31  *---------------------------------------------------------------------------------------------* 
     32  * Functions:                                                                                  * 
     33  * - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - */
     34 
     35 #ifndef TOGGLE_H
     36 #define TOGGLE_H
     37 
     38 #include "control.h"
     39 
     40 /*
     41 **	This class handles gadgets that behave like the Windows buttons. That is, once the mouse
     42 **	button is clicked over them, they capture the focus until the mouse button is released.
     43 **	They have a different imagery for the pressed and released states. They only recognize
     44 **	a valid selection when the mouse button is release while over the button.
     45 */
     46 class ToggleClass : public ControlClass
     47 {
     48 	public:
     49 		ToggleClass(unsigned id, int x, int y, int w, int h);
     50 		virtual void Turn_On(void);
     51 		virtual void Turn_Off(void);
     52 
     53 		/*
     54 		**	Is this button in a pressed down state? This occurs when the mouse is clicked on the
     55 		**	button and the mouse is still being held down.
     56 		*/
     57 		unsigned IsPressed:1;
     58 
     59 		/*
     60 		**	This is the button on/off state. Sometimes a button that is "on" has a different
     61 		**	imagery than one that is "off". If the on/off state is not necessary, then just
     62 		**	ignore this flag.
     63 		*/
     64 		unsigned IsOn:1;
     65 
     66 		/*
     67 		**	If this button can be turned "on" or "off", then this flag should be set to
     68 		**	true. Sometimes a button needs to display its on/off state. In the render routine,
     69 		**	examine the IsOn flag and display accordingly. If this flag is false, then the
     70 		**	IsOn flag will not be changed, regardless of button clicking.
     71 		*/
     72 		unsigned IsToggleType:1;
     73 
     74 	protected:
     75 
     76 		virtual int Action(unsigned flags, KeyNumType &key);
     77 };
     78 
     79 #endif