summaryrefslogtreecommitdiff
path: root/src/w32dlib/control.h
blob: f645a98a6f6f2dc8156012d3371fc1c19f10e478 (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
//  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_CONTROL_H

#define W32DLIB_CONTROL_H "$Id$"

#include "w32dlib/base.h"

namespace W32DLib
{

    /// \brief The base Control class.
    ///
    class Control : public Window
    {
    public:

	/// \brief Constructor
	///
	/// When a control is constructed it calls Dialog::AddControl to add
	/// itself to the dialog.
	///
	/// \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.
	///
	Control(Dialog *parent, int resource_id, DataX *datax=0);

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

	/// \brief Returns the Resource ID for the control.
	///
	int		ResourceID();

	/// \brief Processes a windows event.
	///
	/// This is called by the Dialog when a message is recieved that
	/// refers to this control's resource ID.
	///
	/// \param msg The Windows event
	/// \param wp The Windows event parameters
	/// \param lp The Windows event parameters
	/// \return TRUE if the message was processed.
	///
	BOOL		ProcessMessage(UINT msg, WPARAM wp, LPARAM lp);

	/// \brief Provides a base DoDataExchange.
	///
	/// This interface is called by the Dialog to say that data exchange
	/// should take place.
	///
	/// This base version simply honours DataX \link DataX::eString eString
	/// \endlink objects and calls
	/// Window::SetText or Window::GetText accordingly.
	///
	/// \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:

	/// \brief Add a callback for the control.
	///
	/// \param msg The Windows event message to respond to.
	/// \param notification The top word of the WPARAM will be checked
	/// against this.  If zero, then ignored.
	/// \param owner The class (generally a Dialog derived one) in which
	///  the callback resides.  The class must be derived from
	///  Window.
	/// \param callback The callback.
	///
	void		AddCallback(UINT msg,
				    UINT notification,
				    Window *owner,
				    W32DLibCallback callback);

	/// \brief Filled in by the constructor with the parent dialog.
	///
    	Dialog 		*m_parent;

	/// \brief Filled in by the constructor with the resource ID.
	///
	int		m_resid;

	/// \brief Filled in by the constructor with the DataX object.
	///
	DataX		*m_data;

    private:

	struct CallbackDetails
	{
	    Window		*owner;
	    UINT		msg;
	    UINT		notif;
	    W32DLibCallback	cb;
	};

    	typedef std::vector<CallbackDetails> CallbackList;

	CallbackList	m_cblist;

    };	// class Control

};	// namespace w32dlib

#endif	// W32DLIB_CONTROL_H


// END OF FILE