NAVTOR SDK  v.3.0
Software Development Kit for fast and efficient development of ECDIS, ECS and generic marine applications
I2DRenderTargetText Class Referenceabstract

Holds text to draw and all of appropriate text styles. More...

#include <2d_render_target_text_interface.h>

Inherits ISDKComponent.

Public Member Functions

virtual SDKResult SDK_CALLTYPE GetParent (sdk::gfx::RenderTargetSP &parent) const =0 throw ()
 Returns the parent render target instance, which created the given instance.
 
virtual SDKResult SDK_CALLTYPE SetOutputText (const SDKString &output_text)=0 throw ()
 Sets new output text string.
 
virtual SDKResult SDK_CALLTYPE GetOutputText (SDKString &output_text) const =0 throw ()
 Returns current output text string.
 
virtual SDKResult SDK_CALLTYPE SetFontFamilyName (const SDKString &font_family_name)=0 throw ()
 Sets new font family name for text.
 
virtual SDKResult SDK_CALLTYPE GetFontFamilyName (SDKString &font_family_name) const =0 throw ()
 Returns current font family name for text.
 
virtual SDKResult SDK_CALLTYPE SetFontWeight (const sdk::gfx::FontWeight &font_weight)=0 throw ()
 Sets new font weight for text.
 
virtual SDKResult SDK_CALLTYPE GetFontWeight (sdk::gfx::FontWeight &font_weight) const =0 throw ()
 Returns current font weight for text.
 
virtual SDKResult SDK_CALLTYPE SetFontStyle (const sdk::gfx::FontStyle &font_style)=0 throw ()
 Sets new font style for text.
 
virtual SDKResult SDK_CALLTYPE GetFontStyle (sdk::gfx::FontStyle &font_style) const =0 throw ()
 Returns current font style for text.
 
virtual SDKResult SDK_CALLTYPE SetFontSize (const float &font_size)=0 throw ()
 Sets new font size for text.
 
virtual SDKResult SDK_CALLTYPE GetFontSize (float &font_size) const =0 throw ()
 Returns current font size for text.
 
virtual SDKResult SDK_CALLTYPE SetFontStretch (const sdk::gfx::FontStretch &font_stretch)=0 throw ()
 Sets new font stretch for text.
 
virtual SDKResult SDK_CALLTYPE GetFontStretch (sdk::gfx::FontStretch &font_stretch) const =0 throw ()
 Returns current font stretch for text.
 
virtual SDKResult SDK_CALLTYPE SetLocaleName (const SDKString &locale_name)=0 throw ()
 Sets new locale name for text.
 
virtual SDKResult SDK_CALLTYPE GetLocaleName (SDKString &locale_name) const =0 throw ()
 Returns current locale name for text.
 
virtual SDKResult SDK_CALLTYPE SetMaxTextLayoutSize (const SDKSizeF &layout_size)=0 throw ()
 Sets maximum text layout size for given text Negative or zero value for any of size dimensions means limit is disabled.
 
virtual SDKResult SDK_CALLTYPE GetMaxTextLayoutSize (SDKSizeF &layout_size) const =0 throw ()
 Returns current maximum text layout size for given text In case no limit is set, zero will be returned as appropriate size value.
 
virtual SDKResult SDK_CALLTYPE SetAntiAliasingMode (const sdk::gfx::TextAntiAliasingMode &mode)=0 throw ()
 Sets new text anti-aliasing mode.
 
virtual SDKResult SDK_CALLTYPE GetAntiAliasingMode (sdk::gfx::TextAntiAliasingMode &mode) const =0 throw ()
 Returns current text anti-aliasing mode.
 
virtual SDKResult SDK_CALLTYPE SetStrikethrough (const bool &is_strikethrough)=0 throw ()
 Sets new text strikethrough state.
 
virtual SDKResult SDK_CALLTYPE GetStrikethrough (bool &is_strikethrough) const =0 throw ()
 Returns current text strikethrough state.
 
virtual SDKResult SDK_CALLTYPE SetUnderline (const bool &is_underlined)=0 throw ()
 Sets new text underline state.
 
virtual SDKResult SDK_CALLTYPE GetUnderline (bool &is_underlined) const =0 throw ()
 Returns current text underline state.
 
virtual SDKResult SDK_CALLTYPE SetReadingDirection (const sdk::gfx::TextReadingDirection &reading_direction)=0 throw ()
 Sets new reading direction for text.
 
virtual SDKResult SDK_CALLTYPE GetReadingDirection (sdk::gfx::TextReadingDirection &reading_direction) const =0 throw ()
 Returns current reading direction for text.
 
virtual SDKResult SDK_CALLTYPE SetVerticalAlignment (const sdk::gfx::TextVerticalAlignment &alignment)=0 throw ()
 Sets new vertical alignment type.
 
virtual SDKResult SDK_CALLTYPE GetVerticalAlignment (sdk::gfx::TextVerticalAlignment &alignment) const =0 throw ()
 Returns current vertical alignment type.
 
virtual SDKResult SDK_CALLTYPE SetHorizontalAlignment (const sdk::gfx::TextHorizontalAlignment &alignment)=0 throw ()
 Sets new horizontal alignment type.
 
virtual SDKResult SDK_CALLTYPE GetHorizontalAlignment (sdk::gfx::TextHorizontalAlignment &alignment) const =0 throw ()
 Returns current horizontal alignment type.
 
virtual SDKResult SDK_CALLTYPE SetWordWrapping (const sdk::gfx::TextWordWrapping &word_wrapping)=0 throw ()
 Sets new word wrapping type.
 
virtual SDKResult SDK_CALLTYPE GetWordWrapping (sdk::gfx::TextWordWrapping &word_wrapping) const =0 throw ()
 Returns current word wrapping type.
 

Detailed Description

Holds text to draw and all of appropriate text styles.


The documentation for this class was generated from the following file: