summaryrefslogtreecommitdiff
path: root/include/m_skin.h
blob: 4363478fabb9ddf7eb2b0be145d36b4f73bbb153 (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
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
/*

Miranda IM: the free IM client for Microsoft* Windows*

Copyright 2000-2008 Miranda ICQ/IM project,
all portions of this codebase are copyrighted to the people
listed in contributors.txt.

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 M_SKIN_H__
#define M_SKIN_H__ 1

extern int hLangpack;

//loads an icon from the user's custom skin library, or from the exe if there
//isn't one of them
//wParam = id of icon to load - see below
//lParam = 0
//returns an hIcon for the new icon. Do *not* DestroyIcon() the return value
//returns NULL if id is invalid, but will always succeed for a valid id
#define MS_SKIN_LOADICON     "Skin/Icons/Load"
//nice function to wrap this:
__forceinline HICON LoadSkinnedIcon(int id) {return (HICON)CallService(MS_SKIN_LOADICON, id, 0);}
__forceinline HANDLE LoadSkinnedIconHandle(int id) {return (HANDLE)CallService(MS_SKIN_LOADICON, id, 1);}
__forceinline HICON LoadSkinnedIconBig(int id) {return (HICON)CallService(MS_SKIN_LOADICON, id, 2);}

//event icons
#define SKINICON_EVENT_MESSAGE       100
#define SKINICON_EVENT_URL           101
#define SKINICON_EVENT_FILE          102

//other icons
#define SKINICON_OTHER_MIRANDA       200
#define SKINICON_OTHER_EXIT          201
#define SKINICON_OTHER_SHOWHIDE      202
#define SKINICON_OTHER_GROUPOPEN     203     // v.0.1.1.0+
#define SKINICON_OTHER_USERONLINE    204     // v.0.1.0.1+
#define SKINICON_OTHER_GROUPSHUT     205     // v.0.1.1.0+
#define SKINICON_OTHER_CONNECTING    206     // v.0.1.0.1+
#define SKINICON_OTHER_ADDCONTACT    207     // v.0.7.0.2+
#define SKINICON_OTHER_USERDETAILS   208     // v.0.7.0.2+
#define SKINICON_OTHER_HISTORY       209     // v.0.7.0.2+
#define SKINICON_OTHER_DOWNARROW     210     // v.0.7.0.2+
#define SKINICON_OTHER_FINDUSER      211     // v.0.7.0.2+
#define SKINICON_OTHER_OPTIONS       212     // v.0.7.0.2+
#define SKINICON_OTHER_SENDEMAIL     213     // v.0.7.0.2+
#define SKINICON_OTHER_DELETE        214     // v.0.7.0.2+
#define SKINICON_OTHER_RENAME        215     // v.0.7.0.2+
#define SKINICON_OTHER_SMS           216     // v.0.7.0.2+
#define SKINICON_OTHER_SEARCHALL     217     // v.0.7.0.2+
#define SKINICON_OTHER_TICK          218     // v.0.7.0.2+
#define SKINICON_OTHER_NOTICK        219     // v.0.7.0.2+
#define SKINICON_OTHER_HELP          220     // v.0.7.0.2+
#define SKINICON_OTHER_MIRANDAWEB    221     // v.0.7.0.2+
#define SKINICON_OTHER_TYPING        222     // v.0.7.0.2+
#define SKINICON_OTHER_SMALLDOT      223     // v.0.7.0.2+
#define SKINICON_OTHER_FILLEDBLOB    224     // v.0.7.0.2+
#define SKINICON_OTHER_EMPTYBLOB     225     // v.0.7.0.2+
#define SKINICON_OTHER_UNICODE       226     // v.0.7.0.19+
#define SKINICON_OTHER_ANSI          227     // v.0.7.0.19+
#define SKINICON_OTHER_LOADED        228     // v.0.7.0.19+
#define SKINICON_OTHER_NOTLOADED     229     // v.0.7.0.19+
#define SKINICON_OTHER_UNDO          230     // v.0.8.0.4+
#define SKINICON_OTHER_WINDOW        231     // v.0.8.0.4+
#define SKINICON_OTHER_WINDOWS       232     // v.0.8.0.4+
#define SKINICON_OTHER_ACCMGR        233     // v.0.8.0.4+
#define SKINICON_OTHER_MAINMENU      234     // v.0.8.0.12+
#define SKINICON_OTHER_STATUS        235     // v.0.8.0.12+
#define SKINICON_CHAT_JOIN           236     // v.0.8.0.27+
#define SKINICON_CHAT_LEAVE          237     // v.0.8.0.27+
#define SKINICON_OTHER_STATUS_LOCKED 238     // v.0.8.0.28+
#define SKINICON_OTHER_GROUP         239     // v.0.8.0.29+
#define SKINICON_OTHER_ON            240     // v.0.9.0.9+
#define SKINICON_OTHER_OFF           241     // v.0.9.0.9+
#define SKINICON_OTHER_LOADEDGRAY    242     // v.0.10.3.1+
#define SKINICON_OTHER_NOTLOADEDGRAY 243     // v.0.10.3.1+
#define SKINICON_OTHER_VISIBLE_ALL   244     // v.0.93.4+
#define SKINICON_OTHER_INVISIBLE_ALL 245     // v.0.93.4+
#define SKINICON_OTHER_FRAME         246     // v.0.94.1+

//menu icons are owned by the module that uses them so are not and should not
//be skinnable. Except exit and show/hide

//status mode icons. NOTE: These are deprecated in favour of LoadSkinnedProtoIcon()
#define SKINICON_STATUS_OFFLINE     0
#define SKINICON_STATUS_ONLINE      1
#define SKINICON_STATUS_AWAY        2
#define SKINICON_STATUS_NA          3
#define SKINICON_STATUS_OCCUPIED    4
#define SKINICON_STATUS_DND         5
#define SKINICON_STATUS_FREE4CHAT   6
#define SKINICON_STATUS_INVISIBLE   7
#define SKINICON_STATUS_ONTHEPHONE  8
#define SKINICON_STATUS_OUTTOLUNCH  9

//Loads an icon representing the status mode for a particular protocol.
//wParam = (WPARAM)(const char*)szProto
//lParam = status
//returns an hIcon for the new icon. Do *not* DestroyIcon() the return value
//returns NULL on failure
//if szProto is NULL the function will load the user's selected 'all protocols'
//status icon.
#define MS_SKIN_LOADPROTOICON     "Skin/Icons/LoadProto"
#define MS_SKIN_LOADPROTOICONBIG  "Skin/Icons/LoadProtoBig"
//nice function to wrap this:
__forceinline HICON LoadSkinnedProtoIcon(const char *szProto, int status) {return (HICON)CallService(MS_SKIN_LOADPROTOICON, (WPARAM)szProto, status);}
__forceinline HICON LoadSkinnedProtoIconBig(const char *szProto, int status) {return (HICON)CallService(MS_SKIN_LOADPROTOICONBIG, (WPARAM)szProto, status);}

//add a new sound so it has a default and can be changed in the options dialog
//wParam = hLangpack
//lParam = (LPARAM)(SKINSOUNDDESC*)ssd;
//returns 0 on success, nonzero otherwise

#define SSDF_UNICODE 0x0001

#if defined(_UNICODE)
	#define SSDF_TCHAR  SSDF_UNICODE
#else
	#define SSDF_TCHAR  0
#endif

typedef struct {
	int cbSize;
	const char *pszName;           // name to refer to sound when playing and in db
	union {
		const char *pszDescription;    // [TRANSLATED-BY-CORE] description for options dialog
		const TCHAR *ptszDescription;
	};
	union {
		const char *pszDefaultFile;    // default sound file to use
		const TCHAR *ptszDefaultFile;
	};
	union {
		const char *pszSection;        // [TRANSLATED-BY-CORE] section name used to group sounds (NULL is acceptable) (added during 0.3.4+ (2004/10/*))
		const TCHAR *ptszSection;
	};
	DWORD dwFlags;
}
	SKINSOUNDDESCEX;

__forceinline INT_PTR SkinAddNewSoundEx(const char *name, const char *section, const char *description)
{
	SKINSOUNDDESCEX ssd = { 0 };
	ssd.cbSize = sizeof(ssd);
	ssd.pszName = name;
	ssd.pszSection = section;
	ssd.pszDescription = description;
	return CallService("Skin/Sounds/AddNew", hLangpack, (LPARAM)&ssd);
}

__forceinline INT_PTR SkinAddNewSound(const char *name, const char *description, const char *defaultFile)
{
	SKINSOUNDDESCEX ssd = { 0 };
	ssd.cbSize = sizeof(ssd);
	ssd.pszName = name;
	ssd.pszDescription = description;
	ssd.pszDefaultFile = defaultFile;
	return CallService("Skin/Sounds/AddNew", hLangpack, (LPARAM)&ssd);
}

__forceinline INT_PTR SkinAddNewSoundExT(const char *name, const TCHAR *section, const TCHAR *description)
{
	SKINSOUNDDESCEX ssd = { 0 };
	ssd.cbSize = sizeof(ssd);
	ssd.dwFlags = SSDF_TCHAR;
	ssd.pszName = name;
	ssd.ptszSection = section;
	ssd.ptszDescription = description;
	return CallService("Skin/Sounds/AddNew", hLangpack, (LPARAM)&ssd);
}

__forceinline INT_PTR Skin_AddSound(SKINSOUNDDESCEX *ssd)
{
	return CallService("Skin/Sounds/AddNew", hLangpack, (LPARAM)ssd);
}

//play a named sound event
//wParam = 0
//lParam = (LPARAM)(const char*)pszName
//pszName should have been added with Skin/Sounds/AddNew, but if not the
//function will not fail, it will play the Windows default sound instead.
#define MS_SKIN_PLAYSOUND        "Skin/Sounds/Play"

__forceinline INT_PTR SkinPlaySound(const char *name)
{
	return CallService(MS_SKIN_PLAYSOUND, 0, (LPARAM)name);
}

//sent when the icons DLL has been changed in the options dialog, and everyone
//should re-make their image lists
//wParam = lParam = 0
#define ME_SKIN_ICONSCHANGED     "Skin/IconsChanged"


/*
	wParam: 0 when playing sound (1 when sound is being previewed)
	lParam: (TCHAR*) pszSoundFile
	Affect: This hook is fired when the sound module needs to play a sound
	Note  : This event has default processing, if no one HookEvent()'s this event then it will
			use the default hook code, which uses PlaySound()
	Version: 0.3.4a (2004/09/15)
*/
#define ME_SKIN_PLAYINGSOUND  "Skin/Sounds/Playing"

//random ideas for the future:
// Skin/LoadNetworkAnim - get some silly spinner thing when we want to be busy

#endif //M_SKIN_H__