summaryrefslogtreecommitdiff
path: root/Contrib/Banner/Readme.txt
blob: 97813bc60d69ae861c4e0aba9fc21350b42170c7 (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
BANNER PLUG-IN
--------------

The Banner plug-in shows a banner with customizable text. It uses the IDD_VERIFY dialog of the UI.

There are three functions - show, getWindow and destroy.

Usage
-----

Banner::show /NOUNLOAD "Text to show"

[optional] Banner::getWindow /NOUNLOAD

Banner::destroy

See Example.nsi for an example.

Modern UI
---------

The Modern UI has two labels on the IDD_VERIFY dialog. To change all the texts, use:

Banner::show /NOUNLOAD /set 76 "Text 1 (replaces Please wait while Setup is loading...)" "Normal text"

Custom UI
---------

If you have more labels on your IDD_VERIFY dialog, you can use multiple /set parameters to change the texts.

Example:

Banner::show /NOUNLOAD /set 76 "bah #1" /set 54 "bah #2" "Normal text"

The second parameter for /set is the ID of the control.

Some More Tricks
----------------

If you use /set to set the main string (IDC_STR, 1030) you can specify a different string for the window's caption and for the main string.

If you use an empty string as the main string (Banner::show /NOUNLOAD "") the banner window will not show on the taskbar.

Credits
-------

A joint effort of brainsucker and kichik in honor of the messages dropped during the battle