summaryrefslogtreecommitdiff
path: root/font_service/docs/m_fontservice.h
blob: 3159d4f7d78121d5c00752a91d289511d4e9374a (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
// Copyright Scott Ellis (mail@scottellis.com.au) 2005
// This software is licenced under the GPL (General Public Licence)
// available at http://www.gnu.org/copyleft/gpl.html

#ifndef _FONT_SERVICE_API_INC
#define _FONT_SERVICE_API_INC

// style flags
#define DBFONTF_BOLD       1
#define DBFONTF_ITALIC     2
#define DBFONTF_UNDERLINE  4
#define DBFONTF_STRIKEOUT  8

// flags for compatibility
#define FIDF_APPENDNAME			1		// append 'Name' to the setting used to store font face (as CLC settings require)
#define FIDF_NOAS				2		// disable the <prefix>As setting to prevent 'same as' behaviour
#define FIDF_SAVEACTUALHEIGHT	4		// write the actual height of a test string to the db
#define FIDF_SAVEPOINTSIZE		8		// write the font point size to the db

// additional flags
#define FIDF_DEFAULTVALID		32		// the default font settings are valid - else, just use generic default
#define FIDF_NEEDRESTART		64		// setting changes will not take effect until miranda is restarted
#define FIDF_ALLOWREREGISTER	128		// allow plugins to register this font again (i.e. override already registered settings such as flags)
#define FIDF_ALLOWEFFECTS		256		// allow setting of font effects (i.e. underline and strikeout)

// settings to be used for the value of 'deffontsettings' in the FontID structure below - i.e. defaults
typedef struct FontSettings_tag
{
    COLORREF colour;
    char  size;
    BYTE  style;					// see the DBFONTF_* flags above
    BYTE  charset;
    char  szFace[LF_FACESIZE];
}
	FontSettings;

typedef struct FontSettingsW_tag
{
    COLORREF colour;
    char size;
    BYTE style;					// see the DBFONTF_* flags above
    BYTE charset;
    wchar_t szFace[LF_FACESIZE];
}
	FontSettingsW;

#if defined( _UNICODE )
  #define FontSettingsT FontSettingsW
#else
  #define FontSettingsT FontSettings
#endif

// a font identifier structure - used for registering a font, and getting one out again
typedef struct FontID_tag {
	int   cbSize;
	char  group[64];				// group the font belongs to - this is the 'Font Group' list in the options page
	char  name[64];				// this is the name of the font setting - e.g. 'contacts' in the 'contact list' group
	char  dbSettingsGroup[32];	// the 'module' in the database where the font data is stored
	char  prefix[32];			// this is prepended to the settings used to store this font's data in the db
	DWORD flags;				// bitwise OR of the FIDF_* flags above
	FontSettings deffontsettings; // defaults, valid if flags & FIDF_DEFAULTVALID
	int   order;					// controls the order in the font group in which the fonts are listed in the UI (if order fields are equal,
								// they will be ordered alphabetically by name)
	char backgroundGroup[64];
	char backgroundName[64];
}
	FontID;

typedef struct FontIDW_tag {
	int cbSize;
	wchar_t group[64];				// group the font belongs to - this is the 'Font Group' list in the options page
	wchar_t name[64];				// this is the name of the font setting - e.g. 'contacts' in the 'contact list' group
	char dbSettingsGroup[32];	// the 'module' in the database where the font data is stored
	char prefix[32];			// this is prepended to the settings used to store this font's data in the db
	DWORD flags;				// bitwise OR of the FIDF_* flags above
	FontSettingsW deffontsettings; // defaults, valid if flags & FIDF_DEFAULTVALID
	int order;					// controls the order in the font group in which the fonts are listed in the UI (if order fields are equal,
								// they will be ordered alphabetically by name)
	wchar_t backgroundGroup[64];
	wchar_t backgroundName[64];
}
	FontIDW;

#if defined( _UNICODE )
  #define FontIDT FontIDW
#else
  #define FontIDT FontID
#endif

typedef struct ColourID_tag {
	int      cbSize;
	char     group[64];
	char     name[64];
	char     dbSettingsGroup[32];
	char     setting[32];
	DWORD    flags;		// not used
	COLORREF defcolour; // default value
	int      order;
}
	ColourID;

// a font identifier structure - used for registering a font, and getting one out again
typedef struct ColourIDW_tag {
	int cbSize;
	wchar_t group[64];
	wchar_t name[64];
	char dbSettingsGroup[32];
	char setting[32];
	DWORD flags;		// not used
	COLORREF defcolour; // default value
	int order;
}
	ColourIDW;

#if defined( _UNICODE )
  #define ColourIDT ColourIDW
#else
  #define ColourIDT ColourID
#endif

// register a font
// wparam = (FontID *)&font_id
// lparam = 0
#define MS_FONT_REGISTER      "Font/Register"
#define MS_FONT_REGISTERW     "Font/RegisterW"

#if defined( _UNICODE )
  #define MS_FONT_REGISTERT MS_FONT_REGISTERW
#else
  #define MS_FONT_REGISTERT MS_FONT_REGISTER
#endif

// get a font
// will fill the logfont structure passed in with the user's choices, or the default if it was set and the user has not chosen a font yet,
// or the global default font settings otherwise (i.e. no user choice and default set, or font not registered)
// global default font is gotten using SPI_GETICONTITLELOGFONT, color COLOR_WINDOWTEXT, size 8.
// wparam = (FontID *)&font_id (only name and group matter)
// lParam = (LOGFONT *)&logfont
// returns the font's colour
#define MS_FONT_GET           "Font/Get"
#define MS_FONT_GETW          "Font/GetW"

#if defined( _UNICODE )
  #define MS_FONT_GETT MS_FONT_GETW
#else
  #define MS_FONT_GETT MS_FONT_GET
#endif

// fired when a user modifies font settings, so reload your fonts
// wparam = lparam = 0
#define ME_FONT_RELOAD        "Font/Reload"

// register a colour (this should be used for everything except actual text colour for registered fonts)
// [note - a colour with name 'Background' [translated!] has special meaning and will be used as the background colour of
// the font list box in the options, for the given group]
// wparam = (ColourID *)&colour_id
// lparam = 0
#define MS_COLOUR_REGISTER    "Colour/Register"
#define MS_COLOUR_REGISTERW   "Colour/RegisterW"

#if defined( _UNICODE )
  #define MS_COLOUR_REGISTERT MS_COLOUR_REGISTERW
#else
  #define MS_COLOUR_REGISTERT MS_COLOUR_REGISTER
#endif

// get a colour
// wparam = (ColourID *)&colour_id (only name and group matter)
// rerturns the colour (as COLORREF), or -1 if not found
#define MS_COLOUR_GET         "Colour/Get"
#define MS_COLOUR_GETW        "Colour/GetW"

#if defined( _UNICODE )
  #define MS_COLOUR_GETT MS_COLOUR_GETW
#else
  #define MS_COLOUR_GETT MS_COLOUR_GET
#endif

// fired when a user modifies font settings, so reget your fonts and colours
// wparam = lparam = 0
#define ME_COLOUR_RELOAD      "Colour/Reload"

#endif // _FONT_SERVICE_API_INC