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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
|
// w32dlib - Win32 Dialog 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_DIALOG_H
#define W32DLIB_DIALOG_H "$Id$"
#include "w32dlib/base.h"
namespace W32DLib
{
/// \brief The base Dialog class.
///
class Dialog : public Window
{
public:
/// \brief Constructor
///
Dialog();
/// \brief Destructor
///
virtual ~Dialog();
/// \brief Returns the Resource ID for the dialog.
///
/// All derived classes must implement this. This should return
/// the ID of the dialog in the resource file.
///
virtual int ResourceID()=0;
/// \brief Called when the dialog is displaying.
///
/// Override this call to initialise dialog controls.
///
virtual void OnInit();
/// \brief Called when the dialog is closing.
///
/// Override this call to pick up this event.
///
virtual void OnClose();
/// \brief Enables or disables all Controls in the dialog.
///
/// Overrides Window::Enable.
///
void Enable(bool enable);
/// \brief Displays a modal dialog.
///
/// Call this to display the dialog.
///
/// \param instance The HINSTANCE. Call Common::GetInstance()
/// to get an instance (from a DLL, for example) if all else fails.
/// \param parent The parent window of the dialog (NULL for none).
/// \return The result from Close().
/// \sa Close()
/// \sa Common::GetInstance()
///
INT_PTR ShowModal(HINSTANCE instance, HWND parent);
/// \brief Closes the dialog.
///
/// Closes the dialog. Silently ignored if the dialog is not open.
///
/// \param result The result to return.
/// \sa ShowModal()
///
void Close(INT_PTR result);
/// \brief Adds a control to the dialog.
///
/// Note that the pointer to the control is stored, so the control
/// must exist as long as the dialog is in use.
///
/// \param control The control the add.
///
void AddControl(Control *control);
/// \brief Sets a callback for handling menu commands.
///
/// This call simply passes on all WM_COMMAND messages that were not
/// for any registered control's resource ID.
///
/// Due to this, the callback should take care to ensure it only
/// actions recognised menu commands.
///
/// \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 SetMenuProc(Window *owner, W32DLibCallback callback);
/// \brief Request data exchange with all controls.
///
/// Values will be set from DataX objects registered with the controls.
///
/// This shouldn't be called any earlier than when OnInit() is invoked.
///
void SetData();
/// \brief Request data exchange with all controls.
///
/// Values will be stored in the DataX objects registered with the
/// controls.
///
/// This shouldn't be called any earlier than when OnInit() is invoked.
///
void GetData();
protected:
/// \brief Handles windows messages.
///
/// \param wnd The window handle
/// \param msg The message
/// \param wp Additional parameters. Depends on the value of msg.
/// \param lp Additional parameters. Depends on the value of msg.
/// \return TRUE if the message has been handled.
/// \sa Window::InstanceProc
///
virtual BOOL InstanceProc(HWND wnd,
UINT msg,
WPARAM wp,
LPARAM lp);
private:
typedef std::vector<Control*> ControlSet;
Window *m_menuowner;
W32DLibCallback m_menuproc;
bool m_open;
ControlSet m_cset;
}; // class Dialog
}; // namespace w32dlib
#endif // W32DLIB_DIALOG_H
// END OF FILE
|
