NAVTOR SDK  v.3.0
Software Development Kit for fast and efficient development of ECDIS, ECS and generic marine applications
2d_render_target_text_interface.h
Go to the documentation of this file.
1 #ifndef SDK_2D_RENDER_TARGET_TEXT_INTERFACE_H_
11 #define SDK_2D_RENDER_TARGET_TEXT_INTERFACE_H_
12 
13 #include <base/inc/platform.h>
15 #include "2d_graphics_consts.h"
16 #include "2d_graphics_objects.h"
17 
18 namespace sdk {
19 namespace gfx {
20 
23 class I2DRenderTargetText : public sdk::ISDKComponent
24 {
25  public:
27  virtual SDKResult SDK_CALLTYPE GetParent(sdk::gfx::RenderTargetSP& parent) const throw() = 0;
28 
30  virtual SDKResult SDK_CALLTYPE SetOutputText(const SDKString& output_text) throw() = 0;
32  virtual SDKResult SDK_CALLTYPE GetOutputText(SDKString& output_text) const throw() = 0;
33 
35  virtual SDKResult SDK_CALLTYPE SetFontFamilyName(const SDKString& font_family_name) throw() = 0;
37  virtual SDKResult SDK_CALLTYPE GetFontFamilyName(SDKString& font_family_name) const throw() = 0;
38 
40  virtual SDKResult SDK_CALLTYPE SetFontWeight(const sdk::gfx::FontWeight& font_weight) throw() = 0;
42  virtual SDKResult SDK_CALLTYPE GetFontWeight(sdk::gfx::FontWeight& font_weight) const throw() = 0;
43 
45  virtual SDKResult SDK_CALLTYPE SetFontStyle(const sdk::gfx::FontStyle& font_style) throw() = 0;
47  virtual SDKResult SDK_CALLTYPE GetFontStyle(sdk::gfx::FontStyle& font_style) const throw() = 0;
48 
50  virtual SDKResult SDK_CALLTYPE SetFontSize(const float& font_size) throw() = 0;
52  virtual SDKResult SDK_CALLTYPE GetFontSize(float& font_size) const throw() = 0;
53 
55  virtual SDKResult SDK_CALLTYPE SetFontStretch(const sdk::gfx::FontStretch& font_stretch) throw() = 0;
57  virtual SDKResult SDK_CALLTYPE GetFontStretch(sdk::gfx::FontStretch& font_stretch) const throw() = 0;
58 
60  virtual SDKResult SDK_CALLTYPE SetLocaleName(const SDKString& locale_name) throw() = 0;
62  virtual SDKResult SDK_CALLTYPE GetLocaleName(SDKString& locale_name) const throw() = 0;
63 
66  virtual SDKResult SDK_CALLTYPE SetMaxTextLayoutSize(const SDKSizeF& layout_size) throw() = 0;
69  virtual SDKResult SDK_CALLTYPE GetMaxTextLayoutSize(SDKSizeF& layout_size) const throw() = 0;
70 
72  virtual SDKResult SDK_CALLTYPE SetAntiAliasingMode(
73  const sdk::gfx::TextAntiAliasingMode& mode) throw() = 0;
75  virtual SDKResult SDK_CALLTYPE GetAntiAliasingMode(
76  sdk::gfx::TextAntiAliasingMode& mode) const throw() = 0;
77 
79  virtual SDKResult SDK_CALLTYPE SetStrikethrough(const bool& is_strikethrough) throw() = 0;
81  virtual SDKResult SDK_CALLTYPE GetStrikethrough(bool& is_strikethrough) const throw() = 0;
82 
84  virtual SDKResult SDK_CALLTYPE SetUnderline(const bool& is_underlined) throw() = 0;
86  virtual SDKResult SDK_CALLTYPE GetUnderline(bool& is_underlined) const throw() = 0;
87 
89  virtual SDKResult SDK_CALLTYPE SetReadingDirection(
90  const sdk::gfx::TextReadingDirection& reading_direction) throw() = 0;
92  virtual SDKResult SDK_CALLTYPE GetReadingDirection(
93  sdk::gfx::TextReadingDirection& reading_direction) const throw() = 0;
94 
96  virtual SDKResult SDK_CALLTYPE SetVerticalAlignment(
97  const sdk::gfx::TextVerticalAlignment& alignment) throw() = 0;
99  virtual SDKResult SDK_CALLTYPE GetVerticalAlignment(
100  sdk::gfx::TextVerticalAlignment& alignment) const throw() = 0;
101 
103  virtual SDKResult SDK_CALLTYPE SetHorizontalAlignment(
104  const sdk::gfx::TextHorizontalAlignment& alignment) throw() = 0;
106  virtual SDKResult SDK_CALLTYPE GetHorizontalAlignment(
107  sdk::gfx::TextHorizontalAlignment& alignment) const throw() = 0;
108 
110  virtual SDKResult SDK_CALLTYPE SetWordWrapping(
111  const sdk::gfx::TextWordWrapping& word_wrapping) throw() = 0;
113  virtual SDKResult SDK_CALLTYPE GetWordWrapping(
114  sdk::gfx::TextWordWrapping& word_wrapping) const throw() = 0;
115 
117  SDK_IMPLEMENT_IID(I2DRenderTargetText)
118  SDK_END_INTERFACE(I2DRenderTargetText)
119 };
120 SDK_DECLARE_IID(I2DRenderTargetText)
121 } // namespace gfx
122 } // namespace sdk
123 
124 #endif // SDK_2D_RENDER_TARGET_TEXT_INTERFACE_H_
sdk::gfx::I2DRenderTargetText::GetAntiAliasingMode
virtual SDKResult SDK_CALLTYPE GetAntiAliasingMode(sdk::gfx::TextAntiAliasingMode &mode) const =0
Returns current text anti-aliasing mode.
sdk::gfx::I2DRenderTargetText::SetFontStretch
virtual SDKResult SDK_CALLTYPE SetFontStretch(const sdk::gfx::FontStretch &font_stretch)=0
Sets new font stretch for text.
sdk::gfx::I2DRenderTargetText::GetWordWrapping
virtual SDKResult SDK_CALLTYPE GetWordWrapping(sdk::gfx::TextWordWrapping &word_wrapping) const =0
Returns current word wrapping type.
sdk::gfx::I2DRenderTargetText::SetAntiAliasingMode
virtual SDKResult SDK_CALLTYPE SetAntiAliasingMode(const sdk::gfx::TextAntiAliasingMode &mode)=0
Sets new text anti-aliasing mode.
sdk::gfx::I2DRenderTargetText::SetUnderline
virtual SDKResult SDK_CALLTYPE SetUnderline(const bool &is_underlined)=0
Sets new text underline state.
sdk::gfx::I2DRenderTargetText
Holds text to draw and all of appropriate text styles.
Definition: 2d_render_target_text_interface.h:23
sdk::gfx::I2DRenderTargetText::GetMaxTextLayoutSize
virtual SDKResult SDK_CALLTYPE GetMaxTextLayoutSize(SDKSizeF &layout_size) const =0
Returns current maximum text layout size for given text In case no limit is set, zero will be returne...
sdk::gfx::I2DRenderTargetText::SetFontSize
virtual SDKResult SDK_CALLTYPE SetFontSize(const float &font_size)=0
Sets new font size for text.
sdk::gfx::I2DRenderTargetText::SetVerticalAlignment
virtual SDKResult SDK_CALLTYPE SetVerticalAlignment(const sdk::gfx::TextVerticalAlignment &alignment)=0
Sets new vertical alignment type.
sdk::gfx::TextHorizontalAlignment
TextHorizontalAlignment
Text horizontal alignment type.
Definition: 2d_graphics_consts.h:141
sdk::gfx::I2DRenderTargetText::SetHorizontalAlignment
virtual SDKResult SDK_CALLTYPE SetHorizontalAlignment(const sdk::gfx::TextHorizontalAlignment &alignment)=0
Sets new horizontal alignment type.
sdk::gfx::TextVerticalAlignment
TextVerticalAlignment
Text vertical alignment type.
Definition: 2d_graphics_consts.h:132
2d_graphics_consts.h
Description of all of supported graphics constants.
SDKResult
SDKInt32 SDKResult
Type of all error or return codes which SDK functions can end with.
Definition: sdk_results.h:17
sdk::gfx::I2DRenderTargetText::GetFontStretch
virtual SDKResult SDK_CALLTYPE GetFontStretch(sdk::gfx::FontStretch &font_stretch) const =0
Returns current font stretch for text.
sdk::gfx::I2DRenderTargetText::GetUnderline
virtual SDKResult SDK_CALLTYPE GetUnderline(bool &is_underlined) const =0
Returns current text underline state.
sdk::gfx::I2DRenderTargetText::GetFontSize
virtual SDKResult SDK_CALLTYPE GetFontSize(float &font_size) const =0
Returns current font size for text.
sdk::gfx::I2DRenderTargetText::GetVerticalAlignment
virtual SDKResult SDK_CALLTYPE GetVerticalAlignment(sdk::gfx::TextVerticalAlignment &alignment) const =0
Returns current vertical alignment type.
sdk::gfx::I2DRenderTargetText::GetParent
virtual SDKResult SDK_CALLTYPE GetParent(sdk::gfx::RenderTargetSP &parent) const =0
Returns the parent render target instance, which created the given instance.
sdk::gfx::I2DRenderTargetText::SetReadingDirection
virtual SDKResult SDK_CALLTYPE SetReadingDirection(const sdk::gfx::TextReadingDirection &reading_direction)=0
Sets new reading direction for text.
sdk::gfx::I2DRenderTargetText::GetStrikethrough
virtual SDKResult SDK_CALLTYPE GetStrikethrough(bool &is_strikethrough) const =0
Returns current text strikethrough state.
sdk::gfx::I2DRenderTargetText::GetReadingDirection
virtual SDKResult SDK_CALLTYPE GetReadingDirection(sdk::gfx::TextReadingDirection &reading_direction) const =0
Returns current reading direction for text.
sdk_component_interface.h
Common base SDK interfaces.
sdk::gfx::I2DRenderTargetText::SetStrikethrough
virtual SDKResult SDK_CALLTYPE SetStrikethrough(const bool &is_strikethrough)=0
Sets new text strikethrough state.
sdk::gfx::I2DRenderTargetText::SetLocaleName
virtual SDKResult SDK_CALLTYPE SetLocaleName(const SDKString &locale_name)=0
Sets new locale name for text.
sdk::gfx::I2DRenderTargetText::GetLocaleName
virtual SDKResult SDK_CALLTYPE GetLocaleName(SDKString &locale_name) const =0
Returns current locale name for text.
platform.h
Describes the platform constants.
sdk::gfx::TextWordWrapping
TextWordWrapping
Text word wrapping types.
Definition: 2d_graphics_consts.h:150
sdk::gfx::FontStyle
FontStyle
Possible font styles.
Definition: 2d_graphics_consts.h:175
sdk::gfx::TextAntiAliasingMode
TextAntiAliasingMode
Possible text anti-aliasing modes.
Definition: 2d_graphics_consts.h:115
sdk::gfx::I2DRenderTargetText::GetFontStyle
virtual SDKResult SDK_CALLTYPE GetFontStyle(sdk::gfx::FontStyle &font_style) const =0
Returns current font style for text.
sdk::gfx::I2DRenderTargetText::GetFontWeight
virtual SDKResult SDK_CALLTYPE GetFontWeight(sdk::gfx::FontWeight &font_weight) const =0
Returns current font weight for text.
sdk::gfx::I2DRenderTargetText::SetWordWrapping
virtual SDKResult SDK_CALLTYPE SetWordWrapping(const sdk::gfx::TextWordWrapping &word_wrapping)=0
Sets new word wrapping type.
sdk::gfx::I2DRenderTargetText::SetFontStyle
virtual SDKResult SDK_CALLTYPE SetFontStyle(const sdk::gfx::FontStyle &font_style)=0
Sets new font style for text.
sdk::gfx::I2DRenderTargetText::SetMaxTextLayoutSize
virtual SDKResult SDK_CALLTYPE SetMaxTextLayoutSize(const SDKSizeF &layout_size)=0
Sets maximum text layout size for given text Negative or zero value for any of size dimensions means ...
sdk::gfx::FontWeight
FontWeight
Possible font weights.
Definition: 2d_graphics_consts.h:158
sdk::gfx::I2DRenderTargetText::GetHorizontalAlignment
virtual SDKResult SDK_CALLTYPE GetHorizontalAlignment(sdk::gfx::TextHorizontalAlignment &alignment) const =0
Returns current horizontal alignment type.
sdk::gfx::I2DRenderTargetText::SetFontFamilyName
virtual SDKResult SDK_CALLTYPE SetFontFamilyName(const SDKString &font_family_name)=0
Sets new font family name for text.
sdk::gfx::FontStretch
FontStretch
Possible font stretches.
Definition: 2d_graphics_consts.h:186
sdk::gfx::I2DRenderTargetText::SetFontWeight
virtual SDKResult SDK_CALLTYPE SetFontWeight(const sdk::gfx::FontWeight &font_weight)=0
Sets new font weight for text.
sdk::gfx::I2DRenderTargetText::SetOutputText
virtual SDKResult SDK_CALLTYPE SetOutputText(const SDKString &output_text)=0
Sets new output text string.
SDKSizeF
SizeF.
Definition: geometry_base_types.h:1111
sdk::gfx::I2DRenderTargetText::GetOutputText
virtual SDKResult SDK_CALLTYPE GetOutputText(SDKString &output_text) const =0
Returns current output text string.
sdk::gfx::TextReadingDirection
TextReadingDirection
Text reading direction types.
Definition: 2d_graphics_consts.h:124
sdk::gfx::I2DRenderTargetText::GetFontFamilyName
virtual SDKResult SDK_CALLTYPE GetFontFamilyName(SDKString &font_family_name) const =0
Returns current font family name for text.