summaryrefslogtreecommitdiff
path: root/src/w32dlib/autocheck.h
blob: f7aa2fa16efaae3adf5ce362d66be54225346b25 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
//  w32dlib - Win32 Control Helpers
//
//  Copyright (C) 2005  Ian Cowburn (ianc@noddybox.demon.co.uk)
//
//  This program 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; either version 2 of the License, or
//  (at your option) any later version.
//
//  This program 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 this program; if not, write to the Free Software
//  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//
//  -------------------------------------------------------------------------
//
#ifndef W32DLIB_AUTOCHECK_H

#define W32DLIB_AUTOCHECK_H "$Id$"

#include "w32dlib/base.h"
#include "w32dlib/control.h"

namespace W32DLib
{

    /// \brief The AutoCheck class.
    ///
    class AutoCheck : public Control
    {
    public:

	/// \brief Describes the checkstate
	///
	enum EState
	{
	    eError		=0,			///< Error getting state
	    eChecked		=BST_CHECKED,		///< Checked
	    eUnchecked		=BST_UNCHECKED,		///< Unchecked
	    eIndeterminate	=BST_INDETERMINATE	///< Indeterminate
	};

	/// \brief Constructor
	///
	/// \param parent The dialog the control belongs to.
	/// \param resource_id The ID of the control in the resource file.
	/// \param datax The DataX to use.  The default of 0 means don't
	///   use data exchange.
	///
	AutoCheck(Dialog *parent, int resource_id, DataX *datax=0);

	/// \brief Destructor
	///
	virtual ~AutoCheck();


	/// \brief Sets a callback for a button press
	///
	/// \param owner The class the callback resides in.
	/// \param callback The callback.
	///
	void		OnPress(Window *owner,
				W32DLibCallback callback);


	/// \brief Sets the tickstate.
	///
	/// This member allows the indeterminate checks to be set.
	///
	/// \param state The tick state
	/// \sa GetState()
	///
	void		SetFullState(EState state);


	/// \brief Gets the tickstate.
	///
	/// This member allows the indeterminate state to be tested.
	///
	/// \return The tick state
	/// \sa SetState()
	///
	EState		GetFullState();


	/// \brief Sets the tickstate.
	///
	/// \param state The tick state
	/// \sa GetState()
	///
	void		SetState(bool state);


	/// \brief Gets the tickstate.
	///
	/// \return The tick state
	/// \sa SetState()
	///
	bool		GetState();

	/// \brief Performs data exchange.
	///
	/// Support types:
	///
	/// \link DataX::eString eString \endlink -- see
	/// Control::DoDataExchange()
	///
	/// \link DataX::eInt eInt \endlink -- same as
	/// GetFullState() / SetFullState()
	///
	/// \link DataX::eBool eBool \endlink -- same as
	/// GetState() / SetState()
	///
	/// \param set If true the set the Control from the DataX object.  If
	///  false then set the DataX object from the Control.
	///
	virtual void	DoDataExchange(bool set);

    protected:

    private:

    };	// class AutoCheck

};	// namespace w32dlib

#endif	// W32DLIB_AUTOCHECK_H


// END OF FILE