NAVTOR SDK  v.3.0
Software Development Kit for fast and efficient development of ECDIS, ECS and generic marine applications
gl2d_font_interface.h
Go to the documentation of this file.
1 #ifndef SDK_GL2D_FONT_INTERFACE_H_
12 #define SDK_GL2D_FONT_INTERFACE_H_
13 #pragma once
14 
15 #include <base/inc/platform.h>
16 #include <base/inc/base_types.h>
17 #include <base/inc/sdk_component_base.h>
20 #include <visualizationlayer/inc/vis_const.h>
21 
22 SDK_GL2D_BEGIN_NAMESPACE
23 
26 
29 typedef SDKUInt32 GL2DFontID;
30 
33 static const GL2DFontID kGL2DUnknownFontID = 0UL;
34 
38 {
39 };
40 
44 {
48 };
49 
53 {
57 };
58 
62 class IGL2DFont : public ISDKProperties
63 {
64  public:
66  virtual void SDK_CALLTYPE Dump() const throw() = 0;
67 
69  virtual IGL2DFontsStorageSP SDK_CALLTYPE GetParent() const throw() = 0;
70 
72  virtual GL2DFontID SDK_CALLTYPE GetID() const throw() = 0;
74  virtual SDKResult SDK_CALLTYPE GetFilePath(
75  SDKString& file_path) const throw() = 0;
77  virtual SDKUInt32 SDK_CALLTYPE GetFaceIndex() const throw() = 0;
78 
80  virtual SDKResult SDK_CALLTYPE GetFamilyName(
81  SDKString& family_name) const throw() = 0;
83  virtual SDKResult SDK_CALLTYPE GetStyleName(
84  SDKString& style_name) const throw() = 0;
86  virtual SDKUInt32 SDK_CALLTYPE GetFacesCount() const throw() = 0;
87 
89  virtual SDKUInt32 SDK_CALLTYPE GetUnitsPerEM() const throw() = 0;
91  virtual SDKInt32 SDK_CALLTYPE GetAscender() const throw() = 0;
93  virtual SDKInt32 SDK_CALLTYPE GetDescender() const throw() = 0;
95  virtual SDKUInt32 SDK_CALLTYPE GetHeight() const throw() = 0;
97  virtual SDKRect2D SDK_CALLTYPE GetBoundingBox() const throw() = 0;
98 
100  virtual SDKInt32 SDK_CALLTYPE GetUnderlinePosition() const throw() = 0;
102  virtual SDKUInt32 SDK_CALLTYPE GetUnderlineThickness() const throw() = 0;
103 
105  virtual SDKUInt32 SDK_CALLTYPE GetFaceFlags() const throw() = 0;
107  virtual SDKUInt32 SDK_CALLTYPE GetStyleFlags() const throw() = 0;
108 
111  virtual bool SDK_CALLTYPE IsValidStringForFont(
112  const SDKString& string_to_check) const throw() = 0;
113 
114  SDK_IMPLEMENT_IID(IGL2DFont)
115  SDK_END_INTERFACE(IGL2DFont)
116 };
117 SDK_DECLARE_IID(IGL2DFont)
118 
119 SDK_GL2D_END_NAMESPACE
120 
121 #endif // SDK_GL2D_FONT_INTERFACE_H_
IGL2DFont::IsValidStringForFont
virtual bool SDK_CALLTYPE IsValidStringForFont(const SDKString &string_to_check) const =0
Checks, if given string can be rendered by given font (means given font contains appropriate glyph fo...
IGL2DFont::GetFaceFlags
virtual SDKUInt32 SDK_CALLTYPE GetFaceFlags() const =0
Returns font face flags (see GL2DFontFaceFlags)
IGL2DFont::GetUnderlineThickness
virtual SDKUInt32 SDK_CALLTYPE GetUnderlineThickness() const =0
Returns font underline thickness (in font units, see GetUnitsPerEM method)
base_types.h
SDK base types.
IGL2DFont::GetUnitsPerEM
virtual SDKUInt32 SDK_CALLTYPE GetUnitsPerEM() const =0
Returns units per EM.
IGL2DFont::GetAscender
virtual SDKInt32 SDK_CALLTYPE GetAscender() const =0
Returns font ascender (in font units, see GetUnitsPerEM method)
kGL2DFontStyleFlag_Italic
@ kGL2DFontStyleFlag_Italic
Italic.
Definition: gl2d_font_interface.h:55
properties_interface.h
Object generic properties interface.
IGL2DFont::GetBoundingBox
virtual SDKRect2D SDK_CALLTYPE GetBoundingBox() const =0
Returns font bounding box (in font units, see GetUnitsPerEM method)
kGL2DFontFaceFlag_Scalable
@ kGL2DFontFaceFlag_Scalable
Font is scalable.
Definition: gl2d_font_interface.h:46
kGL2DFontStyleFlag_NoFlags
@ kGL2DFontStyleFlag_NoFlags
No additional font style flags.
Definition: gl2d_font_interface.h:54
SDKResult
SDKInt32 SDKResult
Type of all error or return codes which SDK functions can end with.
Definition: sdk_results.h:17
IGL2DFont::GetFilePath
virtual SDKResult SDK_CALLTYPE GetFilePath(SDKString &file_path) const =0
Returns font file path.
IGL2DFont
Provides with information about single registered font from GL2D fonts storage.
Definition: gl2d_font_interface.h:62
GL2DFontPropertyIDs
GL2DFontPropertyIDs
Generic GL2D Font properties.
Definition: gl2d_font_interface.h:37
IGL2DFont::GetID
virtual GL2DFontID SDK_CALLTYPE GetID() const =0
Returns font ID.
IGL2DFont::GetFacesCount
virtual SDKUInt32 SDK_CALLTYPE GetFacesCount() const =0
Returns font faces count.
kGL2DFontStyleFlag_Bold
@ kGL2DFontStyleFlag_Bold
Bold.
Definition: gl2d_font_interface.h:56
platform.h
Describes the platform constants.
IGL2DFont::GetFamilyName
virtual SDKResult SDK_CALLTYPE GetFamilyName(SDKString &family_name) const =0
Returns font family name.
GL2DFontID
SDKUInt32 GL2DFontID
Font ID.
Definition: gl2d_font_interface.h:29
IGL2DFont::GetStyleName
virtual SDKResult SDK_CALLTYPE GetStyleName(SDKString &style_name) const =0
Returns font style name.
IGL2DFont::GetStyleFlags
virtual SDKUInt32 SDK_CALLTYPE GetStyleFlags() const =0
Returns font style flags (see GL2DFontStyleFlags)
IGL2DFontsStorage
GL2D fonts storage, which allows to register/unregister/manage fonts collection. Only registered font...
Definition: gl2d_fonts_storage_interface.h:36
geometry_base_types.h
Geometry base types.
IGL2DFont::Dump
virtual void SDK_CALLTYPE Dump() const =0
Dumps given object.
IGL2DFont::GetFaceIndex
virtual SDKUInt32 SDK_CALLTYPE GetFaceIndex() const =0
Returns font face index.
IGL2DFont::GetParent
virtual IGL2DFontsStorageSP SDK_CALLTYPE GetParent() const =0
Returns parent storage object.
kGL2DUnknownFontID
static const GL2DFontID kGL2DUnknownFontID
Unknown Font ID.
Definition: gl2d_font_interface.h:33
GL2DFontStyleFlags
GL2DFontStyleFlags
GL2D Font style flags.
Definition: gl2d_font_interface.h:52
IGL2DFont::GetDescender
virtual SDKInt32 SDK_CALLTYPE GetDescender() const =0
Returns font descender (in font units, see GetUnitsPerEM method)
FWD_DECL_INTERFACE
FWD_DECL_INTERFACE(ILWEParserWrapper)
Provides a wrapper around the message parser to get, add or remove the.
kGL2DFontFaceFlag_NoFlags
@ kGL2DFontFaceFlag_NoFlags
No additional font face flags.
Definition: gl2d_font_interface.h:45
kGL2DFontFaceFlag_FixedWidth
@ kGL2DFontFaceFlag_FixedWidth
Font has fixed width characters.
Definition: gl2d_font_interface.h:47
IGL2DFont::GetUnderlinePosition
virtual SDKInt32 SDK_CALLTYPE GetUnderlinePosition() const =0
Returns font underline position (in font units, see GetUnitsPerEM method)
GL2DFontFaceFlags
GL2DFontFaceFlags
GL2D Font face flag.
Definition: gl2d_font_interface.h:43
IGL2DFont::GetHeight
virtual SDKUInt32 SDK_CALLTYPE GetHeight() const =0
Returns font height (in font units, see GetUnitsPerEM method)