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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
|
(*
===============================================================================
PopUp plugin
Plugin Name: PopUp
Plugin author: hrk, Luca Santarelli, hrk@users.sourceforge.net
This file has been created by egodust, Sam, egodust@users.sourceforge.net
===============================================================================
The purpose of this plugin is to give developers a common "platform/interface" to show PopUps. It is born from the source code of NewStatusNotify, another plugin I've made.
Remember that users *must* have this plugin enabled, or they won't get any popup. Write this in the requirements, do whatever you wish ;-)... but tell them!
===============================================================================
-- To use this file you need Windows.pas, m_globaldefs.pas (get it from the CVS under the 'inc' module)
-- To include this in the source, use {$include m_popup.h}
*)
{$ifndef M_POPUP_H}
{$define M_POPUP_H}
{$ifdef FPC}
{$PACKRECORDS C}
{$MODE Delphi}
{$endif}
const
MAX_CONTACTNAME = 2048;
MAX_SECONDLINE = 2048;
SM_WARNING = $01; //Triangle icon.
SM_NOTIFY = $02; //Exclamation mark icon.
type
// for info on what this stuff is, see m_popup.h
PPOPUPDATA = ^TPOPUPDATA;
TPOPUPDATA = record
lchContact: HCONTACT;
lchIcon: THandle;
lpszContactName: array[0..MAX_CONTACTNAME-1] of Char;
lpszText: array[0..MAX_SECONDLINE-1] of Char;
colorBack: COLORREF;
colorForeText: COLORREF;
PluginWindowProc: Pointer; // must be a window procedure using stdcall
PluginData: Pointer;
end;
type
// for info on what this stuff is, see m_popup.h
PPOPUPDATA = ^TPOPUPDATA;
TPOPUPDATA = record
lchContact: HCONTACT;
lchIcon: THandle;
lpszContactName: array[0..MAX_CONTACTNAME-1] of Char;
lpszText: array[0..MAX_SECONDLINE-1] of Char;
colorBack: COLORREF;
colorForeText: COLORREF;
PluginWindowProc: Pointer; // must be a window procedure using stdcall
PluginData: Pointer;
iSeconds: int; //Custom delay time in seconds. -1 means "forever", 0 means "default time".
cZero: array[0..15] of Char; //16 unused bytes which may come useful in the future.
end;
const
(*
Creates, adds and shows a popup, given a (valid) POPUPDATA structure pointer.
wParam = (WPARAM)(*POPUPDATA)PopUpDataAddress
lParam = 0
Returns: > 0 on success, 0 if creation went bad, -1 if the PopUpData contained unacceptable values.
NOTE: it returns -1 if the PopUpData was not valid, if there were already too many popups, if the module was disabled.
Otherwise, it can return anything else...
*)
MS_POPUP_ADDPOPUP = 'PopUp/AddPopUp';
(*
The same, but with a POPUPDATAEX structure pointer.
wParam = (WPARAM)(*POPUPDATAEX)PopUpDataExAddress
lParam = 0
*)
MS_POPUP_ADDPOPUP = 'PopUp/AddPopUpEx';
(*
Returns the handle to the contact associated to the specified PopUpWindow.
You will probably need to know this handle inside your WNDPROC. Exampole: you want to open the MessageWindow. :-)
Call MS_POPUP_GETCONTACT on the hWnd you were given in the WNDPROC.
wParam = (WPARAM)(HWND)hPopUpWindow
lParam = 0;
Returns: the HANDLE of the contact. Can return NULL, meaning it's the main contact. -1 means failure.
*)
MS_POPUP_GETCONTACT = 'PopUp/GetContact';
(*
wParam = hPopUpWindow
lParam = PluginDataAddress;
Returns: the address of the PLUGINDATA structure. Can return NULL, meaning nothing was given. -1 means failure.
IMPORTANT NOTE: it doesn't seem to work if you do:
CallService(..., (LPARAM)aPointerToAStruct);
and then use that struct.
Do this, instead:
aPointerToStruct = CallService(..., (LPARAM)aPointerToAStruct);
and it will work. Just look at the example I've written above (PopUpDlgProc).
*)
MS_POPUP_GETPLUGINDATA = 'PopUp/GetPluginData';
(*
wParam = 0
lParam = 0
Returns: 0 if the user has chosen not to have the second line, 1 if he choose to have the second line.
*)
MS_POPUP_ISSECONDLINESHOWN = 'PopUp/IsSecondLineShown';
(*
UM_FREEPLUGINDATA
wParam = lParam = 0. Process this message if you have allocated your own memory. (i.e.: POPUPDATA.PluginData != NULL)
*)
UM_FREEPLUGINDATA = ((*WM_USER*)$400 + $200);
(*
UM_DESTROYPOPUP
wParam = lParam = 0. Send this message when you want to destroy the popup, or use the function below.
*)
UM_DESTROYPOPUP = ((*WM_USER*)$400 + $201);
(*
UM_INITPOPUP
wParam = (WPARAM)(HWND)hPopUpWindow (but this is useless, since I'll directly send it to your hPopUpWindow
lParam = 0.
This message is sent to the PopUp when its creation has been finished, so POPUPDATA (and thus your PluginData) is reachable.
Catch it if you needed to catch WM_CREATE or WM_INITDIALOG, which you'll never ever get in your entire popup-life.
Return value: if you process this message, return 0. If you don't process it, return 0. Do whatever you like ;-)
*)
UM_INITPOPUP = ($400(*WM_USER*) + $202);
(*
wParam = hPopUpWindow
lParam = lpzNewText
returns: > 0 for success, -1 for failure, 0 if the failure is due to second line not being shown. (but you could call PUIsSecondLineShown() before changing the text...)
Changes the text displayed in the second line of the popup.
*)
MS_POPUP_CHANGETEXT = 'PopUp/Changetext';
(*
This is mainly for developers.
Shows a warning message in a PopUp. It's useful if you need a "MessageBox" like function, but you don't want a modal window (which will interfere with a DialogProcedure. MessageBox steals focus and control, this one not.
wParam = lpzMessage
lParam = 0; Returns: 0 if the popup was shown, -1 in case of failure.
*)
MS_POPUP_SHOWMESSAGE = 'PopUp/ShowMessage';
(* helper functions, will be inlined on FPC if you have the swithces enabled *)
function PUAddPopup(ppdp: PPOPUPDATA): int;
{$ifdef FPC}
inline;
{$endif}
begin
Result := CallService(MS_POPUP_ADDPOPUP, WPARAM(ppdp), 0);
end;
function PUGetContact(hPopUpWindow: THandle): THandle;
{$ifdef FPC}
inline;
{$endif}
begin
Result := CallService(MS_POPUP_GETCONTACT, WPARAM(hPopUpWindow), 0);
end;
function PUGetPluginData(hPopUpWindow: THandle): Pointer;
{$ifdef FPC}
inline;
{$endif}
var
dummy: pointer;
begin
dummy := nil;
Int(Result) := CallService(MS_POPUP_GETPLUGINDATA, WPARAM(hPopUpWindow), LPARAM(dummy));
end;
function PUIsSecondLineShown: BOOL;
{$ifdef FPC}
inline;
{$endif}
begin
Int(Result) := CallService(MS_POPUP_ISSECONDLINESHOWN, 0, 0);
end;
function PUDeletePopUp(hWndPopUp: THandle): int;
{$ifdef FPC}
inline;
{$endif}
begin
Result := SendMessage(hWndPopUp, UM_DESTROYPOPUP, 0, 0);
end;
function PUChangeText(hWndPopUp: THandle; lpzNewText: PChar): int;
{$ifdef FPC}
inline;
{$endif}
begin
Result := CallService(MS_POPUP_CHANGETEXT, WPARAM(hWndPopUp), LPARAM(lpzNewText));
end;
function PUShowMessage(lpzText: PChar; kind: Byte): int;
{$ifdef FPC}
inline;
{$endif}
begin
Result := CallService(MS_POPUP_SHOWMESSAGE, WPARAM(lpzText), LPARAM(kind));
end;
{$endif}
|
