NAVTOR SDK  v.3.0
Software Development Kit for fast and efficient development of ECDIS, ECS and generic marine applications
gl2d_texts_visibility_state_interface.h
Go to the documentation of this file.
1 #ifndef SDK_GL2D_TEXTS_VISIBILITY_STATE_INTERFACE_H_
12 #define SDK_GL2D_TEXTS_VISIBILITY_STATE_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>
19 #include <visualizationlayer/inc/vis_const.h>
20 
21 SDK_GL2D_BEGIN_NAMESPACE
22 
25 
28 typedef SDKUInt64 GL2DTextID;
29 static const GL2DTextID kGL2DUndefinedTextID = 0ULL;
30 
34 static const GL2DTextBoxID kGL2DUndefinedTextBoxID = kGL2DUndefinedTextID;
35 
39 {
40 };
41 
45 class IGL2DTextsVisState : public ISDKProperties
46 {
47 public:
49  virtual SDKUInt32 SDK_CALLTYPE GetEntriesCount() const throw() = 0;
50 
52  virtual SDKResult SDK_CALLTYPE GetEntry(const SDKUInt32& entry_idx,
53  GL2DTextID& text_id, bool& is_visible) const throw() = 0;
54 
55  SDK_IMPLEMENT_IID(IGL2DTextsVisState)
56  SDK_END_INTERFACE(IGL2DTextsVisState)
57 };
58 SDK_DECLARE_IID(IGL2DTextsVisState)
59 
63 {
64 };
65 
69 class IGL2DTextBoxesVisState : public ISDKProperties
70 {
71 public:
73  virtual SDKUInt32 SDK_CALLTYPE GetEntriesCount() const throw() = 0;
74 
76  virtual SDKResult SDK_CALLTYPE GetEntry(const SDKUInt32& entry_idx,
77  GL2DTextBoxID& textbox_id, bool& is_visible) const throw() = 0;
78 
79  SDK_IMPLEMENT_IID(IGL2DTextBoxesVisState)
80  SDK_END_INTERFACE(IGL2DTextBoxesVisState)
81 };
82 SDK_DECLARE_IID(IGL2DTextBoxesVisState)
83 
84 SDK_GL2D_END_NAMESPACE
85 
86 #endif // SDK_GL2D_TEXTS_VISIBILITY_STATE_INTERFACE_H_
base_types.h
SDK base types.
IGL2DTextBoxesVisState::GetEntriesCount
virtual SDKUInt32 SDK_CALLTYPE GetEntriesCount() const =0
Returns total number of entries.
IGL2DTextsVisState
GL2D texts visibility state, describes visibility state of several texts.
Definition: gl2d_texts_visibility_state_interface.h:45
properties_interface.h
Object generic properties interface.
GL2DTextBoxesVisStatePropertyIDs
GL2DTextBoxesVisStatePropertyIDs
Generic GL2D Text Boxes Visibility State properties.
Definition: gl2d_texts_visibility_state_interface.h:62
IGL2DTextBoxesVisState::GetEntry
virtual SDKResult SDK_CALLTYPE GetEntry(const SDKUInt32 &entry_idx, GL2DTextBoxID &textbox_id, bool &is_visible) const =0
Returns given text box ID and it's visibility state by index.
IGL2DTextsVisState::GetEntriesCount
virtual SDKUInt32 SDK_CALLTYPE GetEntriesCount() const =0
Returns total number of entries.
SDKResult
SDKInt32 SDKResult
Type of all error or return codes which SDK functions can end with.
Definition: sdk_results.h:17
IGL2DTextsVisState::GetEntry
virtual SDKResult SDK_CALLTYPE GetEntry(const SDKUInt32 &entry_idx, GL2DTextID &text_id, bool &is_visible) const =0
Returns given text ID and it's visibility state by index.
GL2DTextsVisStatePropertyIDs
GL2DTextsVisStatePropertyIDs
Generic GL2D Texts Visibility State properties.
Definition: gl2d_texts_visibility_state_interface.h:38
IGL2DTextBoxesVisState
GL2D text boxes visibility state, describes visibility state of several text boxes.
Definition: gl2d_texts_visibility_state_interface.h:69
platform.h
Describes the platform constants.
GL2DTextBoxID
GL2DTextID GL2DTextBoxID
Unique text box entry ID.
Definition: gl2d_texts_visibility_state_interface.h:33
FWD_DECL_INTERFACE
FWD_DECL_INTERFACE(ILWEParserWrapper)
Provides a wrapper around the message parser to get, add or remove the.
GL2DTextID
SDKUInt64 GL2DTextID
Generic GL2D text ID.
Definition: gl2d_texts_visibility_state_interface.h:28