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

GL2D Latin1 bordered texts collection object. More...

#include <gl2d_latin1_bordered_texts_interface.h>

Inheritance diagram for IGL2DLatin1BorderedTexts:
IGL2DLatin1Texts

Public Member Functions

virtual void SDK_CALLTYPE Dump () const =0 throw ()
 Dumps given object.
 
virtual IGL2DCanvasSP SDK_CALLTYPE GetParent () const =0 throw ()
 Returns parent canvas object.
 
virtual SDKUInt32 SDK_CALLTYPE GetMemSize () const =0 throw ()
 Returns OpenGL memory size used for texts Statistics only - value refreshed after FinishEdit call.
 
virtual SDKUInt32 SDK_CALLTYPE GetActiveTextPositionsCount () const =0 throw ()
 Returns total number of active (visible) text positions in given texts collection object Statistics only - value refreshed after FinishEdit call.
 
virtual SDKUInt32 SDK_CALLTYPE GetVertexCount () const =0 throw ()
 Returns number of vertexes to use for all of texts Statistics only - value refreshed after FinishEdit call.
 
virtual IGL2DFontSP SDK_CALLTYPE GetFont () const =0 throw ()
 Returns appropriate Font object, common for all of texts.
 
GL2DFontID SDK_CALLTYPE GetFontID () const
 Returns appropriate Font ID, common for all of texts.
 
virtual float SDK_CALLTYPE GetFontSize () const =0 throw ()
 Returns font size, common for all of texts.
 
virtual SDKColorF SDK_CALLTYPE GetColor () const =0 throw ()
 Returns texts color, common for all of texts.
 
virtual GL2DTextReadingDirection SDK_CALLTYPE GetReadingDirection () const throw ()
 Returns reading direction, common for all of texts.
 
virtual float SDK_CALLTYPE GetBorderWidth () const =0 throw ()
 Returns texts border width, in pixels, common for all of texts.
 
virtual SDKColorF SDK_CALLTYPE GetBorderColor () const =0 throw ()
 Returns texts border color, common for all of texts.
 
virtual SDKUInt32 SDK_CALLTYPE GetTextsCount () const =0 throw ()
 Returns total number of text entries in given collection.
 
virtual GL2DLatin1TextID SDK_CALLTYPE Index2TextID (const SDKUInt32 &index) const =0 throw ()
 Returns text ID by it's index.
 
virtual SDKResult SDK_CALLTYPE StartEdit ()=0 throw ()
 Starts texts collection edit process, call for this method in case you want to change anything in given collection, after all of changes were applied, call for FinishEdit method - this will initiate internal GL buffers regeneration and only after that updated texts can be displayed.
 
virtual SDKResult SDK_CALLTYPE FinishEdit ()=0 throw ()
 Finishes previously started edit texts collection operation.
 
virtual bool SDK_CALLTYPE IsEditing () const =0 throw ()
 Checks, if texts collection edit operation in progress now.
 
virtual bool SDK_CALLTYPE IsLatin1Text (const SDKString &text_string) const =0 throw ()
 Checks, if given text is Latin1 and supported by given container.
 
virtual GL2DLatin1TextID SDK_CALLTYPE AddText (const SDKString &text_string, const SDKPointF2D &text_position, const GL2DTextPivotPoint &pivot_point, const SDKPointF2D &pivot_point_offset)=0 throw ()
 Adds new text to given collection StartEdit method should be called before calling this one kGL2DUndefinedLatin1TextID means given text is not Latin1.
 
virtual SDKResult SDK_CALLTYPE RemoveText (const GL2DLatin1TextID &text_id)=0 throw ()
 Removes text from collection by it's ID StartEdit method should be called before calling this one.
 
virtual SDKResult SDK_CALLTYPE Toggle (const GL2DLatin1TextID &text_id, const bool &visible)=0 throw ()
 Toggles given text position on/off StartEdit method should be called before calling this one.
 
virtual SDKResult SDK_CALLTYPE Toggle (const IGL2DTextsVisStateSP &texts_visibility_state)=0 throw ()
 Toggles several texts on/off.
 
virtual SDKResult SDK_CALLTYPE IsVisible (const GL2DLatin1TextID &text_id, bool &is_visible) const =0 throw ()
 Returns text position visibility state.
 
virtual SDKResult SDK_CALLTYPE GetTextString (const GL2DLatin1TextID &text_id, SDKString &text_string) const =0 throw ()
 Returns text string by text ID.
 
virtual SDKResult SDK_CALLTYPE GetPosition (const GL2DLatin1TextID &text_id, SDKPointF2D &position) const =0 throw ()
 Returns text position by text ID.
 
virtual SDKResult SDK_CALLTYPE GetPivotPoint (const GL2DLatin1TextID &text_id, GL2DTextPivotPoint &pivot_point) const =0 throw ()
 Returns text pivot point by text ID.
 
virtual SDKResult SDK_CALLTYPE GetPivotPointOffset (const GL2DLatin1TextID &text_id, SDKPointF2D &pivot_point_offset) const =0 throw ()
 Returns text pivot point offset by text ID.
 
- Public Member Functions inherited from IGL2DLatin1Texts
GL2DFontID SDK_CALLTYPE GetFontID () const
 Returns appropriate Font ID, common for all of texts.
 

Detailed Description

GL2D Latin1 bordered texts collection object.


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