summaryrefslogtreecommitdiff
path: root/font_service/docs/m_fontservice.h
diff options
context:
space:
mode:
authorsje <sje@4f64403b-2f21-0410-a795-97e2b3489a10>2007-01-12 15:27:59 +0000
committersje <sje@4f64403b-2f21-0410-a795-97e2b3489a10>2007-01-12 15:27:59 +0000
commitc7de44ca7e96c0b522d0d92ac39e09d95777177f (patch)
treee65510d49589f33a4c9e954589ff5ca4990ca2a5 /font_service/docs/m_fontservice.h
parent11ca24e66168aa95ed6b82c76f49373f71a6d701 (diff)
git-svn-id: https://server.scottellis.com.au/svn/mim_plugs@73 4f64403b-2f21-0410-a795-97e2b3489a10
Diffstat (limited to 'font_service/docs/m_fontservice.h')
-rw-r--r--font_service/docs/m_fontservice.h175
1 files changed, 105 insertions, 70 deletions
diff --git a/font_service/docs/m_fontservice.h b/font_service/docs/m_fontservice.h
index 08e4dec..3159d4f 100644
--- a/font_service/docs/m_fontservice.h
+++ b/font_service/docs/m_fontservice.h
@@ -27,40 +27,108 @@
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;
- char szFace[LF_FACESIZE];
-} FontSettings;
+ 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;
- 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
+ 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
- FontSettings deffontsettings; // defaults, valid if flags & FIDF_DEFAULTVALID
+ 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)
-} FontID;
+ 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;
- char group[64];
- char name[64];
+ wchar_t group[64];
+ wchar_t name[64];
char dbSettingsGroup[32];
char setting[32];
DWORD flags; // not used
COLORREF defcolour; // default value
int order;
-} ColourID;
+}
+ 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_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,
@@ -69,80 +137,47 @@ typedef struct ColourID_tag {
// 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_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"
+#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
+// [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_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_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"
-
-
-
-//////////////////// Example ///////////////
-#ifdef I_AM_A_CONSTANT_THAT_IS_NEVER_DEFINED_BUT_ALLOWS_THE_CODE_BELOW_NOT_TO_BE_COMMENTED
-
-
-// In the modules loaded event handler, register your fonts
-int testOnModulesLoaded(WPARAM wParam, LPARAM lParam) {
- FontID fid = {0};
- fid.cbSize = sizeof(fid);
- strncpy(fid.name, "Test Font", 64);
- strncpy(fid.group, "My Group", 64);
- strncpy(fid.dbSettingsGroup, "MyPlugin", 32);
- strncpy(fid.prefix, "testFont", 32);
- fid.order = 0;
-
- // you could register the font at this point - getting it will get either the global default or what the user has set it
- // to - but we'll set a default font:
-
- fid.flags = FIDF_DEFAULTVALID;
-
- fid.deffontsettings.charset = DEFAULT_CHARSET;
- fid.deffontsettings.colour = RGB(255, 0, 0);
- fid.deffontsettings.size = 8;
- fid.deffontsettings.style = DBFONTF_BOLD;
- strncpy(fid.deffontsettings.szFace, "Arial", LF_FACESIZE);
-
- CallService(MS_FONT_REGISTER, (WPARAM)&fid, 0);
-
- // if you add more fonts, and leave the 'order' field at 0, they will be ordered alphabetically
-
- // .....
-
- return 0;
-}
-
-// Later, when you need the LOGFONT structure for drawing with a font, do this
-void InSomeCodeSomewhere() {
- //.....
- LOGFONT lf;
- COLORREF col;
- FontID fid;
- strncpy(fid.name, "Test Font", 64);
- strncpy(fid.group, "My Group", 64);
-
- col = (COLORREF)CallService(MS_FONT_GET, (WPARAM)&fid, (LPARAM)&lf);
-
- // then procede to use the font
- //....
-}
-
-#endif // example code
+#define ME_COLOUR_RELOAD "Colour/Reload"
#endif // _FONT_SERVICE_API_INC
-